![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/src/mans/oping.pod b/src/mans/oping.pod
index 313789c7d37fd89fa85bc8ec85721070ef4a4045..5a90ce70f83bfe5e4865b379b91f0acff06ab452 100644 (file)
--- a/src/mans/oping.pod
+++ b/src/mans/oping.pod
=item B<-4>
=item B<-4>
-Force the use of IPv4.
+Force the use of IPv4.
=item B<-6>
=item B<-6>
Send one ICMP packet (per host) each I<interval> seconds. This can be a
floating-point number to specify sub-second precision.
Send one ICMP packet (per host) each I<interval> seconds. This can be a
floating-point number to specify sub-second precision.
+=item B<-w> I<timeout>
+
+Specifies the time to wait for an C<ECHO REPLY> packet before giving up, in
+seconds. This can be a floating point number for sub-second precision. Defaults
+to B<1.0> seconds.
+
=item B<-t> I<ttl>
Set the IP Time to Live to I<ttl>. This must be a number between (and
=item B<-t> I<ttl>
Set the IP Time to Live to I<ttl>. This must be a number between (and
returned by L<geteuid(2)>) differ, the only argument allowed for this option is
"-" (i.e. standard input).
returned by L<geteuid(2)>) differ, the only argument allowed for this option is
"-" (i.e. standard input).
+=item B<-O> I<filename>
+
+Write measurements in I<Comma Separated Values> (CSV) format to I<filename>.
+This option writes three columns per row: wall clock time in (fractional)
+seconds since epoch, hostname and the round trip time in milliseconds.
+
=item B<-Q> I<qos>
Specify the I<Quality of Service> (QoS) for outgoing packets. This is a
=item B<-Q> I<qos>
Specify the I<Quality of Service> (QoS) for outgoing packets. This is a
I<Type of Service> (ToS) aliases were used to specify the bits of outgoing
packets.
I<Type of Service> (ToS) aliases were used to specify the bits of outgoing
packets.
+=item B<-m> I<mark>
+
+I<Linux only> Sets the I<mark> (an integer number) on outgoing packets. This
+can be used by L<iptables(8)> and other networking infrastructure for filtering
+and routing.
+
=item B<-u>|B<-U>
I<noping only> B<-u> forces UTF-8 output, B<-U> disables UTF-8 output. If
=item B<-u>|B<-U>
I<noping only> B<-u> forces UTF-8 output, B<-U> disables UTF-8 output. If
=item B<prettyping>
=item B<prettyping>
-Show a graph with time on the x-axis in a round-robin fashion, i.e. continue on
-the left if the right edge is reached. The y-axis shows the round-trip time.
-This is the default.
+Show a graph with time on the x-axis, the y-axis shows the round-trip time.
+This is the default graph.
+
+If your terminal supports unicode and colors, they are used to improve
+the precision of the data shown: a green box is drawn for round-trip times up
+to one third of the configured timeout, the height representing the RTT. Longer
+RTTs will start to fill the box yellow (with a green background) and then red
+(with a yellow background). Lost packages are drawn as a bold red explamation
+mark.
=item B<boxplot>
=item B<boxplot>
|----------[#####|##########]--------------------------------------------|
^ ^ ^ ^ ^
|----------[#####|##########]--------------------------------------------|
^ ^ ^ ^ ^
- 2.75% 25% 50% 75% 97.5%
+ 2.5% 25% 50% 75% 97.5%
=item B<histogram>
=item B<histogram>
default 1000ms) on the right.
The height of the graph is scaled so that the most-used buckets vertically fills
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.
+the line. The buckets are colored green up to and including the 80th
+percentile, yellow up to and including the 95th percentile and red for the
+remainder.
+
+=back
+
+=item B<-b>
+
+Audible bell. Print a ASCII BEL character (\a or 0x07) when a packet
+is received before the timeout occurs. This can be useful in order to
+monitory hosts' connectivity without looking physically at the
+console, for example to trace network cables (start audible beep,
+disconnect cable N: if beep stops, the cable was in use) or to tell
+when a host returns from a reboot.
+
+This relies on the terminal bell to be functional. To enable the
+terminal bell, use the following instructions.
+
+=over 4
+
+=item
-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.
+the visual bell is disabled in your terminal emulator, with the +vb
+commandline flag or the following in your .Xresources:
+
+ XTerm*visualBell: false
+
+=item
+
+the PC speaker module is loaded in your kernel:
+
+ modprobe pcspkr
+
+=item
+
+X11 has the terminal bell enabled:
+
+ xset b on; xset b 100
+
+=item
+
+and finally, if you are using PulseAudio, that the module-x11-bell
+module is loaded with a pre-loaded sample defined in your pulseaudio
+configuration:
+
+ load-sample-lazy x11-bell /usr/share/sounds/freedesktop/stereo/complete.oga
+ load-module module-x11-bell sample=x11-bell
=back
=back
between zero and 100, exclusively in both cases. In general, defaults to B<95>.
If B<-c> is given and a number less than 20, this would be the same as the
maximum. In this case the default is chosen so that it excludes the maximum,
between zero and 100, exclusively in both cases. In general, defaults to B<95>.
If B<-c> is given and a number less than 20, this would be the same as the
maximum. In this case the default is chosen so that it excludes the maximum,
-e.g. if B<-cE<nbsp>5> is given, the default is I<80>.
-
-The calculated percentile has roughly millisecond precision. If precision is of
-importance, read on for a more detailed explanation. In order to calculate the
-percentile without keeping all replies in memory, I<oping> divides the
-I<interval> (the B<-i> option) in 1000 "buckets". Each bucket counts the number
-of packets received in the represented time. That means that the precision
-decreases if the interval is increased, because each bucket represents a larger
-(fraction of the) response time. The code looks for the first bucket
-representing at least I<percent> responses and returns the upper-bound latency
-represented by that bucket. Since the represented percentage may be larger than
-the configured percentile, this algorithm I<overestimes> the actual percentile
-by at most 1000th of I<interval>.
+e.g. if B<-cE<nbsp>5> is given, the default is I<80>. The calculated percentile
+is based on the last 900 packets (15 minutes with the default interval).
=item B<-Z> I<percent>
=item B<-Z> I<percent>
the "expected" range, yellow marks moderately unusual times and times that
differ a lot from the expected value are printed in red.
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
+The information used to categorize round-trip times is the I<percentile>. RTTs
+in the 80th percentile are considered to be "normal" and are printed in green.
+RTTs within the 95th percentile are considered "moderately unusual" and are
+printed in yellow. RTTs above that are considered to be "unusual" and are
printed in red.
printed in red.
+=head1 INTERACTIVE KEYBOARD CONTROLS
+
+When running I<noping>, the type of graph being displayed can be
+changed by using the B<g> key. A new host can be added at any time
+with the B<a> key.
+
=head1 SEE ALSO
=head1 SEE ALSO
-L<ping(8)>, L<http://www.fping.com/>, L<liboping(3)>
+L<ping(8)>, L<http://fping.org/>, L<liboping(3)>
+
+=head1 LICENSE
+
+I<oping> and I<noping> are licensed under the GPL 2.
+No other version of the license is applicable.
=head1 AUTHOR
liboping is written by Florian "octo" Forster E<lt>ff at octo.itE<gt>.
=head1 AUTHOR
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/>.
+Its homepage can be found at L<http://noping.cc/>.
-Copyright (c) 2005-2011 by Florian "octo" Forster.
+Copyright (c) 2005-2017 by Florian "octo" Forster.