Merge branch 'bp/exit'

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

diff --git a/src/mans/oping.pod b/src/mans/oping.pod
index dba318c14dec50e0446803652d8e586062d1d7f1..b6ce0b2b7f35d12355cf4dbc1e222ab15ecbaec7 100644 (file)
--- a/src/mans/oping.pod
+++ b/src/mans/oping.pod
@@ -66,10 +66,18 @@ Set the outgoing network device to use.
 Instead of specifying hostnames on the command line, read them from
 I<filename>. If I<filename> is B<->, read from C<STDIN>.
 
-If the real user ID (as returned by L<getuid(2)>) and the effective user ID (as
+If I<oping> is installed with the SetUID-bit, it will set the effective UID to
+the real UID before opening the file. In the special (but common) case that
+I<oping> is owned by the super-user (UIDE<nbsp>0), this means that privileges
+are temporarily dropped before opening the file, in order to prevent users from
+reading arbitrary files on the system.
+
+If your system doesn't provide I<saved set-user IDs> (this was an optional
+feature before POSIXE<nbsp>2001), the behavior is different because it is not
+possible to I<temporarily> drop privileges. The alternative behavior is: If the
+real user ID (as returned by L<getuid(2)>) and the effective user ID (as
 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.
+"-" (i.e. standard input).
 
 =item B<-Q> I<qos>
 
@@ -78,7 +86,7 @@ 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
+IPv6 headers as well. There are shortcuts for various predefined
 I<per-hop behaviors> (PHBs):
 
 =over 4
@@ -158,6 +166,23 @@ I<Explicit Congestion Notification> (ECN), even if the deprecated
 I<Type of Service> (ToS) aliases were used to specify the bits of outgoing
 packets.
 
+=item B<-u>|B<-U>
+
+I<noping only> B<-u> forces UTF-8 output, B<-U> disables UTF-8 output. If
+neither is given, the codeset is automatically determined from the locale.
+
+=item B<-Z> I<percent>
+
+If any hosts have a drop rate higher than I<percent>, where I<percent> is a
+number between zero and 100 inclusively, exit with a non-zero exit status.
+Since it is not possible to have a higher drop rate than 100%, passing this
+limit will effectively disable the feature (the default). Setting the option to
+zero means that the exit status will only be zero if I<all> replies for I<all>
+hosts have been received.
+
+The exit status will indicate the number of hosts with more than I<percent>
+packets lost, up to a number of 255 failing hosts.
+
 =back
 
 =head1 COLORS
@@ -182,7 +207,7 @@ L<ping(8)>, L<http://www.fping.com/>, L<liboping(3)>
 
 =head1 AUTHOR
 
-liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
+liboping is written by Florian "octo" Forster E<lt>ff at octo.itE<gt>.
 Its homepage can be found at L<http://verplant.org/liboping/>.
 
-(c) 2005-2010 by Florian octo Forster.
+Copyright (c) 2005-2011 by Florian "octo" Forster.