X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fmans%2Fping_setopt.pod;h=70be1b6c11bca4d8a00e60b0dd9403fa9730fbea;hb=138ea1eeeb00196386faab0740a9cfafc8394f97;hp=4235e286e7bb5e561f959de39ef6c4e5430a5416;hpb=d8317db37713620112fdfb7c0a51f9c6be4a0cc2;p=liboping.git diff --git a/src/mans/ping_setopt.pod b/src/mans/ping_setopt.pod index 4235e28..70be1b6 100644 --- a/src/mans/ping_setopt.pod +++ b/src/mans/ping_setopt.pod @@ -10,10 +10,10 @@ ping_setopt - Set options for a liboping object =head1 DESCRIPTION -The B method sets options that effect all hosts associated with +The B method sets options that apply to all hosts associated with the object I and hosts that are yet to be added to the object. -The I argument is a pointer to an liboping object, as returned by +The I argument is a pointer to an I object, as returned by L. The I argument specifies the option to set. Use one of the following @@ -39,7 +39,7 @@ values are 1 through 255. Default is B. The address family to use. The memory pointed to by I is interpreted as an integer and must be either B, B, or B. This -option only effects hosts that are being added B this option has been +option only affects hosts that are being added B this option has been set. Default is B. If you change this option, and a source address is set (see B) that setting will be reset. @@ -53,10 +53,28 @@ L command. =item B 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 +null-terminated string specifying either a numerical network address or +network hostname. This option will ignore the address family setting (as set with B) and will set the object's address family according to the source address assigned. +=item B + +Set the outgoing network device to be used. The value passed must be a +char-pointer to a null-terminated string specifying an interface name +(e.Eg. C). Please note that this might not be supported by all +operating systems. In that case, B sets the error to +C. + +=item B + +Sets the I flags that should be used when crafting ICMP and +ICMPv6 packets. The memory pointed to by I is interpreted as a C. +The byte is passed to L without modification, using the +C (IPv4) or C (IPv6) option. It is the caller's +responsibility to chose a valid bit combination. For details, read L and +L. + =back The I argument is a pointer to the new value. It must not be NULL. It is @@ -75,6 +93,6 @@ L =head1 AUTHOR liboping is written by Florian octo Forster Eocto at verplant.orgE. -It's homepage can be found at L. +Its homepage can be found at L. (c) 2005-2009 by Florian octo Forster.