1TSMOKE(1)                          SmokePing                         TSMOKE(1)
2
3
4

NAME

6       tSmoke - Commandline tool for sending SmokePing information
7

SYNOPSIS

9       tSmoke [ --testmail | --morning | --weekly | --version | --help | --man
10       | --slaves ]
11
12        Options:
13
14        --man      Show the manpage
15        --help     Help :-)
16        --version  Show SmokePing Version
17        --testmail Send a test message
18        --listrrds List the RRDs used by this Smokeping
19        --morning  Send a morning synopsis
20        --weekly   Send a weekly status report
21        --to       E-mail address to send message (i.e. '--to=xyz@company.com.invalid'
22        --detail   How much detail to send in weekly report (i.e. '--detail=1')
23        --quiet    Do not print welcome
24        --slaves   Enable slave support assumes all slaves unless csv list of slaves
25                   is added (i.e. '--slaves' or '--slaves=slave1[,slave2...]')
26

DESCRIPTION

28       The tSmoke tool is a commandline tool which interfaces with the
29       SmokePing system.  Its main function is to send a message indicating
30       the current status of the systems being monitored by Smokeping or an
31       HTML mail file containing the status over the past day, past week and
32       past month including an overview.
33
34       Typical crontab used to invoke this are
35
36        # Quick morning alert to see what's down
37        0 6 * * * /usr/local/smokeping/bin/tSmoke.pl --q --to=mobilephone@att.net.invalid --morning
38        # Weekly report on the percent availability of network systems with no detail
39        0 8 * * * /usr/local/smokeping/bin/tSmoke.pl --q --to=mailbox@company.com.invalid --weekly --detail=0
40

SETUP

42       When installing tSmoke, some variables must be adjusted to fit your
43       local system.
44
45       We need to use the following libraries:
46
47       Smokeping
48       RRDTool Perl bindings
49       Getopt::Long
50
51       Set up your libraries:
52
53        use lib "/usr/local/smokeping/lib";
54        use lib "/usr/local/rrdtool-1.0.39/lib/perl";
55
56       Point to your Smokeping config file
57
58        my $cfgfile = "/usr/local/smokeping/etc/config";
59
60       Modify the Smokeping config file to include a path for tmail in the
61       General section:
62
63        tmail = /usr/local/smokeping/etc/tmail
64

SEE ALSO

66       smokeping(1), smokeping_config(5)
67

69       Copyright (c) 2003 by Dan McGinn-Combs. All right reserved.
70

LICENSE

72       This program is free software; you can redistribute it and/or modify it
73       under the terms of the GNU General Public License as published by the
74       Free Software Foundation; either version 2 of the License, or (at your
75       option) any later version.
76
77       This program is distributed in the hope that it will be useful, but
78       WITHOUT ANY WARRANTY; without even the implied warranty of
79       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
80       General Public License for more details.
81
82       You should have received a copy of the GNU General Public License along
83       with this program; if not, write to the Free Software Foundation, Inc.,
84       675 Mass Ave, Cambridge, MA 02139, USA.
85

AUTHOR

87       Dan McGinn-Combs <d.mcginn-combs@mindspring.com>
88
89       Modified for Smokeping official distribution by Niko Tyni
90       <ntyni@iki.fi>
91
92
93
942.8.2                             2023-07-22                         TSMOKE(1)
Impressum