.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "TSMOKE.DIST 1"
.TH TSMOKE.DIST 1 "2008-07-24" "2.4.2" "SmokePing"
.SH "NAME"
tSmoke \- Commandline tool for sending SmokePing information
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBtSmoke\fR [ \fB\-\-testmail\fR | \fB\-\-morning\fR | \fB\-\-weekly\fR | \fB\-\-version\fR | \fB\-\-help\fR | \fB\-\-man\fR]
.PP
.Vb 1
\& Options:
.Ve
.PP
.Vb 10
\& \-\-man      Show the manpage
\& \-\-help     Help :\-)
\& \-\-version  Show SmokePing Version
\& \-\-testmail Send a test message
\& \-\-listrrds List the RRDs used by this Smokeping
\& \-\-morning  Send a morning synopsis
\& \-\-weekly   Send a weekly status report
\& \-\-to       E\-mail address to send message (i.e. \(aq\-\-to=xyz@company.com.invalid\(aq
\& \-\-detail   How much detail to send in weekly report (i.e. \(aq\-\-detail=1\(aq)
\& \-\-quiet    Do not print welcome
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fBtSmoke\fR tool is a commandline tool which interfaces with the SmokePing system.
Its main function is to send a message indicating the current status of the systems
being monitored by Smokeping or an \s-1HTML\s0 mail file containing the status over the past day,
past week and past month including an overview.
.PP
Typical crontab used to invoke this are
.PP
.Vb 4
\& # Quick morning alert to see what\(aqs down
\& 0 6 * * * /usr/local/smokeping/bin/tSmoke.pl \-\-q \-\-to=mobilephone@att.net.invalid \-\-morning
\& # Weekly report on the percent availability of network systems with no detail
\& 0 8 * * * /usr/local/smokeping/bin/tSmoke.pl \-\-q \-\-to=mailbox@company.com.invalid \-\-weekly \-\-detail=0
.Ve
.SH "SETUP"
.IX Header "SETUP"
When installing tSmoke, some variables must be adjusted to fit your local system.
.PP
We need to use the following \fBlibraries\fR:
.IP "Smokeping" 4
.IX Item "Smokeping"
.PD 0
.IP "RRDTool Perl bindings" 4
.IX Item "RRDTool Perl bindings"
.IP "Getopt::Long" 4
.IX Item "Getopt::Long"
.PD
.PP
Set up your libraries:
.PP
.Vb 2
\& use lib "/usr/local/smokeping/lib";
\& use lib "/usr/local/rrdtool\-1.0.39/lib/perl";
.Ve
.PP
Point to your Smokeping \fBconfig\fR file
.PP
.Vb 1
\& my $cfgfile = "/usr/local/smokeping/etc/config";
.Ve
.PP
Modify the Smokeping config file to include a path for tmail in the
General section:
.PP
.Vb 1
\& tmail = /usr/local/smokeping/etc/tmail
.Ve
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2003 by Dan McGinn\-Combs. All right reserved.
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it
and/or modify it under the terms of the \s-1GNU\s0 General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later
version.
.PP
This program is distributed in the hope that it will be
useful, but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied
warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0
\&\s-1PURPOSE\s0.  See the \s-1GNU\s0 General Public License for more
details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public
License along with this program; if not, write to the Free
Software Foundation, Inc., 675 Mass Ave, Cambridge, \s-1MA\s0
02139, \s-1USA\s0.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dan McGinn-Combs <d.mcginn\-combs@mindspring.com>
.PP
Modified for Smokeping official distribution by Niko Tyni <ntyni@iki.fi>