From: Florian Forster <octo@leeloo.lan.home.verplant.org>
Date: Tue, 26 Oct 2010 13:10:04 +0000 (+0200)
Subject: ping_setopt(3): Document the new "PING_OPT_TOS" option.
X-Git-Tag: liboping-1.5.0~3^2~15
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=08ea19df86112d4fe3451b77b56f0511423231af;p=liboping.git

ping_setopt(3): Document the new "PING_OPT_TOS" option.
---

diff --git a/src/mans/ping_setopt.pod b/src/mans/ping_setopt.pod
index df9cc59..70be1b6 100644
--- a/src/mans/ping_setopt.pod
+++ b/src/mans/ping_setopt.pod
@@ -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_TOS>
+
+Sets the I<Type 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 L<ip(7)> and
+L<ipv6(7)>.
 
 =back