Merge pull request #5 from xtaran/master

Typo and man-page fixups
pull/8/head
David Schweikert 13 years ago
commit 19b041904b

@ -7,10 +7,6 @@ fping \- send ICMP ECHO_REQUEST packets to network hosts
[ \fIsystems...\fR ] [ \fIsystems...\fR ]
.SH DESCRIPTION .SH DESCRIPTION
.NXR "fping command"
.NXR "ICMP ECHO_REQUEST"
.B fping .B fping
is a program like is a program like
.B ping(8) .B ping(8)
@ -42,11 +38,11 @@ Unlike
is meant to be used in scripts, so its output is designed to be is meant to be used in scripts, so its output is designed to be
easy to parse. easy to parse.
.SH OPTIONS .SH OPTIONS
.IP \fB-a\fR 5 .IP \fB\-a\fR 5
Show systems that are alive. Show systems that are alive.
.IP \fB-A\fR 5 .IP \fB\-A\fR 5
Display targets by address rather than DNS name. Display targets by address rather than DNS name.
.IP \fB-b\fIn\fR 5 .IP \fB\-b\fIn\fR 5
Number of bytes of ping data to send. The minimum size (normally 12) Number of bytes of ping data to send. The minimum size (normally 12)
allows room for the data that allows room for the data that
.B fping .B fping
@ -57,95 +53,95 @@ header (8 bytes), so the minimum total size is 40 bytes. Default is
.B ping. .B ping.
Maximum is the theoretical maximum IP datagram size (64K), though most Maximum is the theoretical maximum IP datagram size (64K), though most
systems limit this to a smaller, system-dependent number. systems limit this to a smaller, system-dependent number.
.IP \fB-B\fIn\fR 5 .IP \fB\-B\fIn\fR 5
In the default mode, In the default mode,
.B fping .B fping
sends several requests to a target before giving up, waiting longer for sends several requests to a target before giving up, waiting longer for
a reply on each successive request. This parameter is the value by a reply on each successive request. This parameter is the value by
which the wait time is multiplied on each successive request; it must which the wait time is multiplied on each successive request; it must
be entered as a floating-point number (x.y). The default is 1.5. be entered as a floating-point number (x.y). The default is 1.5.
.IP \fB-c\fR 5 .IP \fB\-c\fR 5
Number of request packets to send to each target. In this mode, a Number of request packets to send to each target. In this mode, a
line is displayed for each received response (this can suppressed with line is displayed for each received response (this can suppressed with
-q or -Q). Also, statistics about responses for each target are displayed \-q or \-Q). Also, statistics about responses for each target are displayed
when all requests have been sent (or when interrupted). when all requests have been sent (or when interrupted).
.IP \fB-C\fR 5 .IP \fB-C\fR 5
Similar to -c, but the per-target statistics are displayed in a format Similar to \-c, but the per-target statistics are displayed in a format
designed for automated response-time statistics gathering. For designed for automated response-time statistics gathering. For
example: example:
% fping -C 5 -q somehost % fping \-C 5 \-q somehost
somehost : 91.7 37.0 29.2 - 36.8 somehost : 91.7 37.0 29.2 \- 36.8
shows the response time in milliseconds for each of the five requests, shows the response time in milliseconds for each of the five requests,
with the "-" indicating that no response was received to the fourth with the "\-" indicating that no response was received to the fourth
request. request.
.IP \fB-d\fR 5 .IP \fB\-d\fR 5
Use DNS to lookup address of return ping packet. This allows you to give Use DNS to lookup address of return ping packet. This allows you to give
fping a list of IP addresses as input and print hostnames in the output. fping a list of IP addresses as input and print hostnames in the output.
.IP \fB-e\fR 5 .IP \fB\-e\fR 5
Show elapsed (round-trip) time of packets. Show elapsed (round-trip) time of packets.
.IP \fB-f\fR 5 .IP \fB\-f\fR 5
Read list of targets from a file. This option can only be used by the Read list of targets from a file. This option can only be used by the
root user. Regular users should pipe in the file via stdin: root user. Regular users should pipe in the file via stdin:
% fping < targets_file % fping < targets_file
.IP \fB-g\fR 5 .IP \fB\-g\fR 5
Generate a target list from a supplied IP netmask, or a starting and ending IP. Generate a target list from a supplied IP netmask, or a starting and ending IP.
Specify the netmask or start/end in the targets portion of the command line. Specify the netmask or start/end in the targets portion of the command line.
ex. To ping the class C 192.168.1.x, the specified command line could look like either: ex. To ping the class C 192.168.1.x, the specified command line could look like either:
fping -g 192.168.1.0/24 fping \-g 192.168.1.0/24
or or
fping -g 192.168.1.0 192.168.1.255 fping -g 192.168.1.0 192.168.1.255
.IP \fB-h\fR 5 .IP \fB\-h\fR 5
Print usage message. Print usage message.
.IP \fB-i\fIn\fR 5 .IP \fB\-i\fIn\fR 5
The minimum amount of time (in milliseconds) between sending a ping packet to any target (default is 25). The minimum amount of time (in milliseconds) between sending a ping packet to any target (default is 25).
.IP \fB-l\fR 5 .IP \fB\-l\fR 5
Loop sending packets to each target indefinitely. Can be interrupted Loop sending packets to each target indefinitely. Can be interrupted
with ctl-C; statistics about responses for each target are then displayed. with Ctrl-C; statistics about responses for each target are then displayed.
.IP \fB-m\fR 5 .IP \fB\-m\fR 5
Send pings to each of a target host's multiple interfaces. Send pings to each of a target host's multiple interfaces.
.IP \fB-n\fR 5 .IP \fB\-n\fR 5
Same as -d. Same as \-d.
.IP \fB-p\fR 5 .IP \fB\-p\fR 5
In looping or counting modes (-l, -c, or -C), this parameter sets the In looping or counting modes (\-l, \-c, or \-C), this parameter sets the
time in milliseconds that time in milliseconds that
.B fping .B fping
waits between successive packets to an individual target. Default is waits between successive packets to an individual target. Default is
1000. 1000.
.IP \fB-q\fR 5 .IP \fB\-q\fR 5
Quiet. Don't show per-target results, just set final exit status. Quiet. Don't show per-target results, just set final exit status.
.IP \fB-Q\fIn\fR 5 .IP \fB\-Q\fIn\fR 5
Like -q, but show summary results every n seconds. Like \-q, but show summary results every n seconds.
.IP \fB-r\fIn\fR 5 .IP \fB\-r\fIn\fR 5
Retry limit (default 3). This is the number of times an attempt at pinging Retry limit (default 3). This is the number of times an attempt at pinging
a target will be made, not including the first try. a target will be made, not including the first try.
.IP \fB-s\fR 5 .IP \fB\-s\fR 5
Print cumulative statistics upon exit. Print cumulative statistics upon exit.
.IP \fB-S\fIaddr\fR 5 .IP \fB\-S\fIaddr\fR 5
Set source address. Set source address.
.IP \fB-I\fIif\fR 5 .IP \fB\-I\fIif\fR 5
Set the interface (requires SO_BINDTODEVICE support) Set the interface (requires SO_BINDTODEVICE support)
.IP \fB-t\fIn\fR 5 .IP \fB\-t\fIn\fR 5
Initial target timeout in milliseconds (default 500). In the default Initial target timeout in milliseconds (default 500). In the default
mode, this is the amount of time that mode, this is the amount of time that
.B fping .B fping
waits for a response to its first request. Successive timeouts are waits for a response to its first request. Successive timeouts are
multiplied by the backoff factor. multiplied by the backoff factor.
.IP \fB-T\fIn\fR 5 .IP \fB\-T\fIn\fR 5
Ignored (for compatibility with fping 2.4). Ignored (for compatibility with fping 2.4).
.IP \fB-u\fR 5 .IP \fB\-u\fR 5
Show targets that are unreachable. Show targets that are unreachable.
.IP \fB-T\fIn\fR 5 .IP \fB\-T\fIn\fR 5
Set the typ of service flag (TOS). \fIn\fR can be either decimal or hexadecimal (0xh) format. Set the typ of service flag (TOS). \fIn\fR can be either decimal or hexadecimal (0xh) format.
.IP \fB-v\fR 5 .IP \fB\-v\fR 5
Print Print
.B fping .B fping
version information. version information.
@ -180,7 +176,7 @@ if ($#output != -1) {
close MAIL; close MAIL;
} }
.ni .fi
Another good example is when you want to perform an action only on hosts Another good example is when you want to perform an action only on hosts
that are currently reachable. that are currently reachable.
.nf .nf
@ -193,7 +189,7 @@ foreach $host (split(/\\n/,$hosts_to_backup)) {
# do it # do it
} }
.ni .fi
.SH AUTHORS .SH AUTHORS
.nf .nf
@ -202,7 +198,7 @@ RL "Bob" Morgan, Stanford University, versions 2.x
David Papp, versions 2.3x and up, David Papp, versions 2.3x and up,
David Schweikert, versions 3.0 and up David Schweikert, versions 3.0 and up
fping website: http://www.fping.org fping website: http://www.fping.org
.ni .fi
.SH DIAGNOSTICS .SH DIAGNOSTICS
Exit status is 0 if all the hosts are reachable, 1 if some hosts were Exit status is 0 if all the hosts are reachable, 1 if some hosts were
unreachable, 2 if any IP addresses were not found, 3 for invalid unreachable, 2 if any IP addresses were not found, 3 for invalid
@ -210,8 +206,8 @@ command line arguments, and 4 for a system call failure.
.SH BUGS .SH BUGS
Ha! If we knew of any we would have fixed them! Ha! If we knew of any we would have fixed them!
.SH RESTRICTIONS .SH RESTRICTIONS
If certain options are used (i.e, a low value for -i and -t, and a If certain options are used (i.e, a low value for \-i and \-t, and a
high value for -r) it is possible to flood the network. This program high value for \-r) it is possible to flood the network. This program
must be installed as setuid root in order to open up a raw socket, must be installed as setuid root in order to open up a raw socket,
or must be run by root. In order to stop mere mortals from hosing the or must be run by root. In order to stop mere mortals from hosing the
network (when fping is installed setuid root) , normal users can't specify network (when fping is installed setuid root) , normal users can't specify
@ -222,7 +218,6 @@ the following:
-r n where n > 20 -r n where n > 20
-t n where n < 250 msec -t n where n < 250 msec
.ni .fi
.SH SEE ALSO .SH SEE ALSO
netstat(1), ping(8), ifconfig(8c) netstat(1), ping(8), ifconfig(8c)

@ -170,7 +170,7 @@ char *icmp_type_str[19] =
"", "",
"", "",
"ICMP Time Exceeded", /* 11 */ "ICMP Time Exceeded", /* 11 */
"ICMP Paramter Problem", /* 12 */ "ICMP Parameter Problem", /* 12 */
"ICMP Timestamp Request", /* 13 */ "ICMP Timestamp Request", /* 13 */
"ICMP Timestamp Reply", /* 14 */ "ICMP Timestamp Reply", /* 14 */
"ICMP Information Request", /* 15 */ "ICMP Information Request", /* 15 */

Loading…
Cancel
Save