oping(8): Document "noping", too.
[liboping.git] / src / mans / oping.pod
1 =head1 NAME
2
3 oping - send ICMP ECHO_REQUEST to network hosts
4
5 =head1 SYNOPSIS
6
7 B<oping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] I<host> [I<host> [I<host> ...]]
8
9 B<oping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] B<-f> I<filename>
10
11 B<noping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] I<host> [I<host> [I<host> ...]]
12
13 B<noping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] B<-f> I<filename>
14
15 =head1 DESCRIPTION
16
17 B<oping> uses ICMPv4 or ICMPv6 ECHO_REQUEST packets to measure a hosts
18 reachability and the network latency. In contrast to the original L<ping(8)>
19 utility B<oping> can send ICMP packets to multiple hosts in parallel and wait
20 for all ECHO_RESPONSE packets to arrive. In contrast to the B<fping> utility
21 (URL is listed in L<"SEE ALSO">) B<oping> can use both, IPv4 and IPv6
22 transparently and side by side.
23
24 B<noping> is an ncurses-based front-end to I<liboping> which displays ping
25 statistics online and highlights aberrant round-trip times if the terminal
26 supports colors.
27
28 =head1 OPTIONS
29
30 =over 4
31
32 =item B<-4>
33
34 Force the use of IPv4. 
35
36 =item B<-6>
37
38 Force the use of IPv6.
39
40 =item B<-c> I<count>
41
42 Send (and receive) I<count> ICMP packets, then stop and exit.
43
44 =item B<-i> I<interval>
45
46 Send one ICMP packet (per host) each I<interval> seconds. This can be a
47 floating-point number to specify sub-second precision.
48
49 =item B<-t> I<ttl>
50
51 Set the IP Time to Live to I<ttl>. This must be a number between (and
52 including) 1E<nbsp>andE<nbsp>255. If omitted, the value B<64> is used.
53
54 =item B<-I> I<address>
55
56 Set the source address to use. You may either specify an IP number or a
57 hostname. You B<cannot> pass the interface name, as you can with GNU's
58 L<ping(8)> - use the B<-D> option for that purpose.
59
60 =item B<-D> I<interface name>
61
62 Set the outgoing network device to use.
63
64 =item B<-f> I<filename>
65
66 Instead of specifying hostnames on the command line, read them from
67 I<filename>. If I<filename> is B<->, read from C<STDIN>.
68
69 If the real user ID (as returned by L<getuid(2)>) and the effective user ID (as
70 returned by L<geteuid(2)>) differ, the only argument allowed for this option is
71 "-" (i.E<nbsp>e. standard input). This is meant to avoid security issues when
72 I<oping> is installed with the SUID-bit.
73
74 =back
75
76 =head1 SEE ALSO
77
78 L<ping(8)>, L<http://www.fping.com/>, L<liboping(3)>
79
80 =head1 AUTHOR
81
82 liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
83 Its homepage can be found at L<http://verplant.org/liboping/>.
84
85 (c) 2005-2010 by Florian octo Forster.