X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fmans%2Fping_setopt.pod;h=582b3559b4231a734c8a0f0330103ba7810925a5;hb=e2f5c048b5f0b31f38be7e315a6cd0c3bc095b3f;hp=fefc8ca2edc6f6516f3feae732b681afea2464bd;hpb=6fa5005cc728176caa79249705874f7aa8521eeb;p=liboping.git diff --git a/src/mans/ping_setopt.pod b/src/mans/ping_setopt.pod index fefc8ca..582b355 100644 --- a/src/mans/ping_setopt.pod +++ b/src/mans/ping_setopt.pod @@ -10,14 +10,16 @@ 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 -constants: +constants. You can check if the required constant is supported by the library +at compile time using C<#ifdef>. It is recommended to check for desired +features using the C define. =over 4 @@ -37,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. @@ -51,14 +53,32 @@ 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 the L +and L manual pages, as well as I2474>. + =back The I argument is a pointer to the new value. It must not be NULL. It is -dereferences depending on the value of the I argument, see above. The +dereferenced depending on the value of the I argument, see above. The memory pointed to by I is not changed. =head1 RETURN VALUE @@ -73,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, 2006 by Florian octo Forster. +(c) 2005-2010 by Florian octo Forster.