oping(8): Document the colors used by noping.

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

diff --git a/src/mans/oping.pod b/src/mans/oping.pod
index 29784a8..6005b00 100644 (file)
--- a/src/mans/oping.pod
+++ b/src/mans/oping.pod
@@ -8,14 +8,22 @@ B<oping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] I<host> [I<host> [
 
 B<oping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] B<-f> I<filename>
 
+B<noping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] I<host> [I<host> [I<host> ...]]
+
+B<noping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] B<-f> I<filename>
+
 =head1 DESCRIPTION
 
-oping uses ICMPv4 or ICMPv6 ECHO_REQUEST packets to measure a hosts
+B<oping> uses ICMPv4 or ICMPv6 ECHO_REQUEST packets to measure a hosts
 reachability and the network latency. In contrast to the original L<ping(8)>
 utility B<oping> can send ICMP packets to multiple hosts in parallel and wait
-for all ECHO_RESPONSE packets to arrive. In contrast to the
-B<fping> utility (URL is listed in L<"SEE ALSO">) B<oping> can use both, IPv4
-and IPv6 transparently and side by side.
+for all ECHO_RESPONSE packets to arrive. In contrast to the B<fping> utility
+(URL is listed in L<"SEE ALSO">) B<oping> can use both, IPv4 and IPv6
+transparently and side by side.
+
+B<noping> is an ncurses-based front-end to I<liboping> which displays ping
+statistics online and highlights aberrant round-trip times if the terminal
+supports colors.
 
 =head1 OPTIONS
 
@@ -45,16 +53,42 @@ including) 1E<nbsp>andE<nbsp>255. If omitted, the value B<64> is used.
 
 =item B<-I> I<address>
 
-Set the source address to use. You B<cannot> pass the interface name, as you
-can with GNU's L<ping(8)>.
+Set the source address to use. You may either specify an IP number or a
+hostname. You B<cannot> pass the interface name, as you can with GNU's
+L<ping(8)> - use the B<-D> option for that purpose.
+
+=item B<-D> I<interface name>
+
+Set the outgoing network device to use.
 
 =item B<-f> I<filename>
 
 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
+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.
+
 =back
 
+=head1 COLORS
+
+If supported by the terminal, I<noping> will highlight the round-trip times
+(RTT) using the colors green, yellow and red. Green signals RTTs that are in
+the "expected" range, yellow marks moderately unusual times and times that
+differ a lot from the expected value are printed in red.
+
+The information used to categorize round-trip times is the I<average>
+round-trip time and the I<standard deviation>. RTTs that differ from the
+average by less than the standard deviation are considered to be "normal" and
+are printed in green. Times that differ from the average more than the standard
+deviation but less than twice the standard deviation are considered "moderately
+unusual" and are printed in yellow. Times differing more than twice the
+standard deviation from the average are considered to be "unusual" and are
+printed in red.
+
 =head1 SEE ALSO
 
 L<ping(8)>, L<http://www.fping.com/>, L<liboping(3)>
@@ -62,6 +96,6 @@ 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>.
-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.