.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH MRTG-PING-PROBE 1 "April 14, 2003"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
mrtg-ping-probe \- ping probe module for Multi Router Traffic Grapher
.SH DESCRIPTION
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
.\" respectively.
\fBmrtg-ping-probe\fP is a ping probe module for MRTG 2.x.  It is used to 
monitor the round trip time and packet loss to networked devices.  MRTG 
uses the output of mrtg-ping-probe to generate graphs visualizing minimum 
and maximum round trip times or packet loss.
.PP
mrtg-ping-probe is not run directly, but is called by MRTG as a helper when 
it needs to determine ping time to a host.
.PP
Act responsibly: do not use mrtg-ping-probe to ping devices without the 
owner's permission.  Just imagine if 10,000 people decided to ping 
your hosts!  mrtg-ping-probe is meant to be used within your network 
to get round trip time performance figures for your network. 
.SH OPTIONS
To use mrtg-ping-probe you need to configure MRTG to call it from within the 
definition of a target host. This is done in the MRTG config file, which is 
usually /etc/mrtg.conf.
.PP
Here's an example snippet: change the target name and IP address to suit your 
needs.
.PP
Target[your.target.ping]: `/usr/bin/mrtg-ping-probe 123.456.789.123`
.br
SetEnv[your.target.ping]: MRTG_INT_IP="123.456.789.123" MRTG_INT_DESCR="ping"
.br
MaxBytes[your.target.ping]: 100
.br
AbsMax[your.target.ping]: 200
.br
Options[your.target.ping]: gauge, growright
.br
YLegend[your.target.ping]: ping time (ms)
.br
ShortLegend[your.target.ping]: ms
.br
Legend1[your.target.ping]: Maximum Round Trip Time in ms
.br
Legend2[your.target.ping]: Minimum Round Trip Time in ms
.br
Legend3[your.target.ping]: Maximal 5 Minute Maximum Round Trip Time in ms
.br
Legend4[your.target.ping]: Maximal 5 Minute Minimum Round Trip Time in ms
.br
LegendI[your.target.ping]: &nbsp;Max:
.br
LegendO[your.target.ping]: &nbsp;Min:
.PP
Pay close attention to the backticks in the first line which tell MRTG to 
execute the nominated external program. Note also that you need to use the 
"gauge" option, since the results of subsequent ping probes are independant 
values and not an incrementing counter.
.SH SEE ALSO
.BR mrtg (1).
.PP
The latest release of mrtg-ping-probe can be found on the web at 
http://pwo.de/projects/mrtg/
.SH AUTHOR
This manual page was written by Jonathan Oxer <jon@debian.org>,
for the Debian project (but may be used by others).