From: Florian Forster <ff@octo.it>
Date: Fri, 10 Oct 2014 10:53:40 +0000 (+0200)
Subject: oping manual page: Document the "-g histogram" option.
X-Git-Tag: liboping-1.8.0~12
X-Git-Url: https://git.octo.it/?p=liboping.git;a=commitdiff_plain;h=d85b13b65a33de75bd8731f713db2cce7bcc41d7

oping manual page: Document the "-g histogram" option.
---

diff --git a/src/mans/oping.pod b/src/mans/oping.pod
index 8ed738e..313789c 100644
--- a/src/mans/oping.pod
+++ b/src/mans/oping.pod
@@ -171,7 +171,7 @@ packets.
 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<-g> B<none>|B<prettyping>|B<boxplot>
+=item B<-g> B<none>|B<prettyping>|B<boxplot>|B<histogram>
 
 I<noping only> Selects the graph to display.
 
@@ -179,7 +179,7 @@ I<noping only> Selects the graph to display.
 
 =item B<none>
 
-Do not shot a graph.
+Do not show a graph.
 
 =item B<prettyping>
 
@@ -189,7 +189,7 @@ This is the default.
 
 =item B<boxplot>
 
-Shows a box plot where the x-axis, i.e. the width of the window, is the
+Show a I<box plot> where the x-axis, i.e. the width of the window, is the
 round-trip time. The entire width of the window it the ping interval, set with
 the B<-i> option.
 
@@ -197,6 +197,24 @@ The box is sized so it contains 50% of the replies. The vertical line shows the
 median. The whiskers are sized to contain 95% of the replies -- 2.5% below the
 whiskers and 2.5% above.
 
+  |----------[#####|##########]--------------------------------------------|
+  ^          ^     ^          ^                                            ^
+ 2.75%      25%   50%        75%                                         97.5%
+
+=item B<histogram>
+
+Show a I<histrogram> of the round-trip times. The width of the window is taken
+as round-trip time from 0ms on the left to the I<interval> (the B<-i> option,
+default 1000ms) on the right.
+
+The height of the graph is scaled so that the most-used buckets vertically fills
+the line. The buckets are colored green up to and including the median, yellow
+up to and including the 95th percentile and red for the remainder.
+
+In addition, the histogram is colored, if supported by the terminal. The green
+bars include the median (50% of responses), yellow bars include the 95th
+percentile and outliers are colored red.
+
 =back
 
 =item B<-P> I<percent>
diff --git a/src/oping.c b/src/oping.c
index 381c8f3..367227a 100644
--- a/src/oping.c
+++ b/src/oping.c
@@ -378,6 +378,7 @@ static void usage_exit (const char *name, int status) /* {{{ */
 			"  -f filename  filename to read hosts from\n"
 #if USE_NCURSES
 			"  -u / -U      force / disable UTF-8 output\n"
+			"  -g graph     graph type to draw\n"
 #endif
 			"  -P percent   Report the n'th percentile of latency\n"
 			"  -Z percent   Exit with non-zero exit status if more than this percentage of\n"