Rename "ToS" to "QoS" everywhere, to account for DSCP being used in IPv6 …

[liboping.git] / src / mans / ping_setopt.pod

diff --git a/src/mans/ping_setopt.pod b/src/mans/ping_setopt.pod
index ad85979c7829cac5c11786c098f9d5dcb81917b2..582b3559b4231a734c8a0f0330103ba7810925a5 100644 (file)
--- a/src/mans/ping_setopt.pod
+++ b/src/mans/ping_setopt.pod
@@ -10,7 +10,7 @@ ping_setopt - Set options for a liboping object
 
 =head1 DESCRIPTION
 
-The B<ping_setopt> method sets options that effect all hosts associated with
+The B<ping_setopt> method sets options that apply to all hosts associated with
 the object I<obj> and hosts that are yet to be added to the object.
 
 The I<obj> argument is a pointer to an I<liboping> object, as returned by
@@ -39,7 +39,7 @@ 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
+option only affects hosts that are being added B<after> this option has been
 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.
 
@@ -63,8 +63,17 @@ the source address assigned.
 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.E<nbsp>g. C<eth0>). Please note that this might not be supported by all
-operating systems. In that case, B<ping_setopt> sets the error to C<operation
-not supported>.
+operating systems. In that case, B<ping_setopt> sets the error to
+C<operation not supported>.
+
+=item B<PING_OPT_QOS>
+
+Sets the I<Quality of Service> flags that should be used when crafting ICMP and
+ICMPv6 packets. The memory pointed to by I<val> is interpreted as a C<uint8_t>.
+The byte is passed to L<setsockopt(2)> without modification, using the
+C<IP_TOS> (IPv4) or C<IPV6_TCLASS> (IPv6) option. It is the caller's
+responsibility to chose a valid bit combination. For details, read the L<ip(7)>
+and L<ipv6(7)> manual pages, as well as I<RFCE<nbsp>2474>.
 
 =back
 
@@ -84,6 +93,6 @@ L<liboping(3)>
 =head1 AUTHOR
 
 liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
-It's homepage can be found at L<http://verplant.org/liboping/>.
+Its homepage can be found at L<http://verplant.org/liboping/>.
 
-(c) 2005-2009 by Florian octo Forster.
+(c) 2005-2010 by Florian octo Forster.