Update the manpages: Added information about setting the source address.
[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 =head1 DESCRIPTION
10
11 oping uses ICMPv4 or ICMPv6 ECHO_REQUEST packets to measure a hosts
12 reachability and the network latency. In contrast to the original L<ping(8)>
13 utility B<oping> can send ICMP packets to multiple hosts in parallel and wait
14 for all ECHO_RESPONSE packets to arrive. In contrast to the
15 B<fping> utility (URL is listed in L<"SEE ALSO">) B<oping> can use both, IPv4
16 and IPv6 transparently and side by side.
17
18 =head1 OPTIONS
19
20 =over 4
21
22 =item B<-4>
23
24 Force the use of IPv4. 
25
26 =item B<-6>
27
28 Force the use of IPv6
29
30 =item B<-c> I<count>
31
32 Send (and receive) I<count> ICMP packets, then stop and exit.
33
34 =item B<-i> I<interval>
35
36 Send one ICMP packet (per host) each I<interval> seconds. This can be a
37 floating-point number to specify sub-second precision.
38
39 =item B<-I> I<address>
40
41 Set the source address to use. You B<cannot> pass the interface name, as you
42 can with GNU's L<ping(8)>.
43
44 =back
45
46 =head1 BUGS
47
48 =over 4
49
50 =item The TTL cannot be set
51
52 =back
53
54 =head1 SEE ALSO
55
56 L<ping(8)>, L<http://www.fping.com/>, L<liboping(3)>
57
58 =head1 AUTHOR
59
60 liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
61 It's homepage can be found at L<http://verplant.org/liboping/>.
62
63 (c) 2005, 2006 by Florian octo Forster.