Code

src/oping.c: Added -D <interface name> command line option.
[liboping.git] / src / mans / oping.pod
1 =head1 NAME
3 oping - send ICMP ECHO_REQUEST to network hosts
5 =head1 SYNOPSIS
7 B<oping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] I<host> [I<host> [I<host> ...]]
9 B<oping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] B<-f> I<filename>
11 =head1 DESCRIPTION
13 oping uses ICMPv4 or ICMPv6 ECHO_REQUEST packets to measure a hosts
14 reachability and the network latency. In contrast to the original L<ping(8)>
15 utility B<oping> can send ICMP packets to multiple hosts in parallel and wait
16 for all ECHO_RESPONSE packets to arrive. In contrast to the
17 B<fping> utility (URL is listed in L<"SEE ALSO">) B<oping> can use both, IPv4
18 and IPv6 transparently and side by side.
20 =head1 OPTIONS
22 =over 4
24 =item B<-4>
26 Force the use of IPv4. 
28 =item B<-6>
30 Force the use of IPv6.
32 =item B<-c> I<count>
34 Send (and receive) I<count> ICMP packets, then stop and exit.
36 =item B<-i> I<interval>
38 Send one ICMP packet (per host) each I<interval> seconds. This can be a
39 floating-point number to specify sub-second precision.
41 =item B<-t> I<ttl>
43 Set the IP Time to Live to I<ttl>. This must be a number between (and
44 including) 1E<nbsp>andE<nbsp>255. If omitted, the value B<64> is used.
46 =item B<-I> I<address>
48 Set the source address to use. You may either specify an IP number or a
49 hostname. You B<cannot> pass the interface name, as you can with GNU's
50 L<ping(8)> - use the B<-D> option for that purpose.
52 =item B<-D> I<interface name>
54 Set the outgoing network device to use.
56 =item B<-f> I<filename>
58 Instead of specifying hostnames on the command line, read them from
59 I<filename>. If I<filename> is B<->, read from C<STDIN>.
61 =back
63 =head1 SEE ALSO
65 L<ping(8)>, L<http://www.fping.com/>, L<liboping(3)>
67 =head1 AUTHOR
69 liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
70 It's homepage can be found at L<http://verplant.org/liboping/>.
72 (c) 2005-2009 by Florian octo Forster.