← Back to branch summary

~ubuntu-branches/ubuntu/edgy/smokeping/edgy-proposed

« back to all changes in this revision

Viewing changes to doc/smokeping.pod

  • Committer: Bazaar Package Importer
  • Author(s): Jose Carlos Garcia Sogo
  • Date: 2002-04-02 15:02:08 UTC
  • Revision ID: james.westby@ubuntu.com-20020402150208-8eycqntc07q6gig5
Tags: upstream-1.6
Import upstream version 1.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/smokeping.pod
 
1
=head1 NAME
 
2
 
 
3
smokeping - Commandline tool for SmokePing
 
4
 
 
5
=head1 SYNOPSIS
 
6
 
 
7
B<smokeping> [ B<--email> | B<--makepod> | B<--version> | B<--restart> ]
 
8
 
 
9
 Options:
 
10
 
 
11
 --email    Send SmokePing Agents to all Targets marked DYNAMIC
 
12
 --makepod  Create POD documentation on Config file
 
13
 --version  Show SmokePing Version
 
14
 --debug    Run Only once and do not Fork
 
15
 --restart  Restart SmokePing
 
16
 --nodemon  Do no demonize the process (no fork)
 
17
 
 
18
=head1 DESCRIPTION
 
19
 
 
20
The B<smokeping> tool is the commandline part of the SmokePing system. Its
 
21
main function is to run as a daemon and send Pings to all the Targets you
 
22
have specified in the Config file. When you call B<smokeping> without
 
23
arguments it will start as a daemon and do it's work.
 
24
 
 
25
If called with an argument, then further functions can be activated, as seen
 
26
in the Synopsis above. The B<--email> function is explained in the
 
27
documentation on the config file.
 
28
 
 
29
The B<--makepod> does get used internally to produce the documentation on
 
30
the SmokePing configuration file.
 
31
 
 
32
Please refer to the installation document for detailed setup instructions.
 
33
 
 
34
=head1 SETUP
 
35
 
 
36
When installing SmokePing, this file has to be adjusted to fit your
 
37
local system. Three paths have to be entered.
 
38
 
 
39
 use lib qw(/usr/pack/rrdtool-1.0.33-to/lib/perl);
 
40
 
 
41
One pointing to your B<rrdtool> installation
 
42
 
 
43
 use lib qw(/home/oetiker/public_html/smokeping/lib);
 
44
 
 
45
One pointing to the place where you have installed the SmokePing libraries
 
46
 
 
47
 use Smokeping;
 
48
 
 
49
 Smokeping::main("/home/oetiker/.smokeping/config");
 
50
 
 
51
The third path is the argument to the Smokeping::main command. It points to
 
52
the SmokePing configuration file.
 
53
 
 
54
=head1 COPYRIGHT
 
55
 
 
56
Copyright (c) 2001 by Tobias Oetiker. All right reserved.
 
57
 
 
58
=head1 LICENSE
 
59
 
 
60
This program is free software; you can redistribute it
 
61
and/or modify it under the terms of the GNU General Public
 
62
License as published by the Free Software Foundation; either
 
63
version 2 of the License, or (at your option) any later
 
64
version.
 
65
 
 
66
This program is distributed in the hope that it will be
 
67
useful, but WITHOUT ANY WARRANTY; without even the implied
 
68
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 
69
PURPOSE.  See the GNU General Public License for more
 
70
details.
 
71
 
 
72
You should have received a copy of the GNU General Public
 
73
License along with this program; if not, write to the Free
 
74
Software Foundation, Inc., 675 Mass Ave, Cambridge, MA
 
75
02139, USA.
 
76
 
 
77
=head1 AUTHOR
 
78
 
 
79
Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
 
80
 
 
81
=cut