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

« back to all changes in this revision

Viewing changes to doc/smokeping.html

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