Code

Update the manpages: Added information about setting the source address.
authorFlorian Forster <octo@verplant.org>
Mon, 12 Jun 2006 21:03:05 +0000 (23:03 +0200)
committerFlorian Forster <octo@verplant.org>
Mon, 12 Jun 2006 21:03:05 +0000 (23:03 +0200)
src/mans/oping.pod
src/mans/ping_setopt.pod

index e6ef195e74777d056636ccdd33e24d3ec7bc3f71..44cb6c32d7071e02e95b47f0d6aaf46e9e2e4d9c 100644 (file)
@@ -36,6 +36,11 @@ Send (and receive) I<count> ICMP packets, then stop and exit.
 Send one ICMP packet (per host) each I<interval> seconds. This can be a
 floating-point number to specify sub-second precision.
 
+=item B<-I> I<address>
+
+Set the source address to use. You B<cannot> pass the interface name, as you
+can with GNU's L<ping(8)>.
+
 =back
 
 =head1 BUGS
index 9c73929410e485249b52898b9d47e4d045f77b88..fefc8ca2edc6f6516f3feae732b681afea2464bd 100644 (file)
@@ -38,7 +38,8 @@ values are 1 through 255. Default is B<PING_DEF_TTL>.
 The address family to use. The memory pointed to by I<val> is interpreted as an
 integer and must be either B<AF_UNSPEC>, B<AF_INET>, or B<AF_INET6>. This
 option only effects hosts that are being added B<after> this option has been
-set. Default is B<PING_DEF_AF>.
+set. Default is B<PING_DEF_AF>. If you change this option, and a source address
+is set (see B<PING_OPT_SOURCE>) that setting will be reset.
 
 =item B<PING_OPT_DATA>
 
@@ -47,6 +48,13 @@ null-terminated string. By default a 56 byte long string is used so that the
 packet size of an ICMPv4 packet is exactly 64 bytes. That's the behavior of the
 L<ping(1)> command.
 
+=item B<PING_OPT_SOURCE>
+
+Set the source address to use. The value passed must be a char-pointer to a
+null-terminated string. This option will ignore the address family setting (as
+set with B<PING_OPT_AF>) and will set the object's address family according to
+the source address assigned.
+
 =back
 
 The I<val> argument is a pointer to the new value. It must not be NULL. It is