From: Florian Forster <octo@leeloo.lan.home.verplant.org>
Date: Sun, 13 Jun 2010 18:33:57 +0000 (+0200)
Subject: oping(8): Document the colors used by noping.
X-Git-Tag: liboping-1.4.0^0
X-Git-Url: https://git.tokkee.org/?p=liboping.git;a=commitdiff_plain;h=12b51be67146bf5619acb1110b54c291fcca6652;hp=d04a88204731486497bd450de3e84c1849a5ead3

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

diff --git a/src/mans/oping.pod b/src/mans/oping.pod
index 0664514..6005b00 100644
--- a/src/mans/oping.pod
+++ b/src/mans/oping.pod
@@ -73,6 +73,22 @@ 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)>