From: Florian Forster <octo@leeloo.lan.home.verplant.org>
Date: Tue, 26 Oct 2010 16:22:37 +0000 (+0200)
Subject: oping(8): Document the "-Q" option.
X-Git-Tag: liboping-1.5.0~3^2~7
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=136979e1219be92af91ff2b90e32086f71ad2de0;p=liboping.git

oping(8): Document the "-Q" option.
---

diff --git a/src/mans/oping.pod b/src/mans/oping.pod
index 6005b00..90d6b02 100644
--- a/src/mans/oping.pod
+++ b/src/mans/oping.pod
@@ -71,6 +71,65 @@ returned by L<geteuid(2)>) differ, the only argument allowed for this option is
 "-" (i.E<nbsp>e. standard input). This is meant to avoid security issues when
 I<oping> is installed with the SUID-bit.
 
+=item B<-Q> I<qos>
+
+Specify the I<Quality of Service> (QoS) for outgoing packets. This is a
+somewhat tricky option, since the meaning of the bits in the IPv4 header has
+been revised several times.
+
+The currently recommended method is I<Differentiated Services> which is used in
+IPv6 headers as well. There are shortcuts for 13E<nbsp>predefined
+I<per-hop behaviors> (PHBs):
+
+=over 4
+
+=item B<ef>
+
+Selects the I<Expedited Forwarding> (EF) per-hop behavior, as defined in
+I<RFCE<nbsp>3246>. This PHB is characterised by low delay, low loss and low
+jitter, i.e. high priority traffic.
+
+=item  B<af>I<c>I<p>
+
+Selects one of 12E<nbsp>differentiated services code points (DSCPs), which are
+organized in four I<classes> with three I<priorities> each. Therefore, I<c>
+must be a number betweenE<nbsp>1 throughE<nbsp>4 and I<p> must be a number
+betweenE<nbsp>1 throughE<nbsp>3, for example "af13", "af22" and "af41". In each
+class, the lower priority number takes precedence over the higher priority
+number.
+
+=back
+
+The old definition of the same bits in the IPv4 header was as I<Type of
+Service> (ToS) field, specified in I<RFCE<nbsp>1349>. It defined four possible
+values which have appropriate aliases. Please note that this use of the bits is
+B<deprecated> and the meaning is limited to IPv4!
+
+=over 4
+
+=item B<lowdelay>
+
+Minimize delay
+
+=item B<throughput>
+
+Maximize throughput
+
+=item B<reliability>
+
+Maximize reliability
+
+=item B<mincost>
+
+Minimize monetary cost
+
+=back
+
+Alternatively, you can also specify the byte manually. You can use either a
+decimal number (0-255), a hexadecimal number (0x00-0xff) or an octal number
+(00-0377) using the usual "0x" and "0" prefixes for hexadecimal and octal
+respectively.
+
 =back
 
 =head1 COLORS