X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fmans%2Foping.pod;h=917a6da0917f2f685606eb7b9859bd8e2f96007e;hb=fe85c13e095749191a4dc7bc5e066b1c922702f6;hp=19d45042f6d237c451fb4649b6d75bce60bd6368;hpb=ee13385b1c68103b7d57a745ee8a1ae908406df6;p=liboping.git diff --git a/src/mans/oping.pod b/src/mans/oping.pod index 19d4504..917a6da 100644 --- a/src/mans/oping.pod +++ b/src/mans/oping.pod @@ -31,7 +31,7 @@ supports colors. =item B<-4> -Force the use of IPv4. +Force the use of IPv4. =item B<-6> @@ -46,6 +46,12 @@ Send (and receive) I ICMP packets, then stop and exit. Send one ICMP packet (per host) each I seconds. This can be a floating-point number to specify sub-second precision. +=item B<-w> I + +Specifies the time to wait for an C 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 Set the IP Time to Live to I. This must be a number between (and @@ -79,6 +85,12 @@ real user ID (as returned by L) and the effective user ID (as returned by L) differ, the only argument allowed for this option is "-" (i.e. standard input). +=item B<-O> I + +Write measurements in I (CSV) format to I. +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 Specify the I (QoS) for outgoing packets. This is a @@ -166,30 +178,118 @@ I (ECN), even if the deprecated I (ToS) aliases were used to specify the bits of outgoing packets. +=item B<-m> I + +I Sets the I (an integer number) on outgoing packets. This +can be used by L and other networking infrastructure for filtering +and routing. + =item B<-u>|B<-U> I 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|B|B|B + +I Selects the graph to display. + +=over 4 + +=item B + +Do not show a graph. + +=item B + +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 + +Show a I 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. + +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.5% 25% 50% 75% 97.5% + +=item B + +Show a I of the round-trip times. The width of the window is taken +as round-trip time from 0ms on the left to the I (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 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 + +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 + =item B<-P> I Configures the latency percentile to report. I must be a number 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<-cE5> 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 divides the -I (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 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 the actual percentile -by at most 1000th of I. +e.g. if B<-cE5> 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 @@ -212,22 +312,30 @@ If supported by the terminal, I will highlight the round-trip times 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 -round-trip time and the I. 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. 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. +=head1 INTERACTIVE KEYBOARD CONTROLS + +When running I, the type of graph being displayed can be +changed by using the B key. A new host can be added at any time +with the B key. + =head1 SEE ALSO -L, L, L +L, L, L + +=head1 LICENSE + +I and I are licensed under the GPL 2. +No other version of the license is applicable. =head1 AUTHOR liboping is written by Florian "octo" Forster Eff at octo.itE. -Its homepage can be found at L. +Its homepage can be found at L. -Copyright (c) 2005-2011 by Florian "octo" Forster. +Copyright (c) 2006-2017 by Florian "octo" Forster.