Code

liboping(3), oping(1): Correct licensing information.
[liboping.git] / src / mans / oping.pod
index 5582286ffc7b2f334b216e42851c5c6c79e12c10..5a90ce70f83bfe5e4865b379b91f0acff06ab452 100644 (file)
@@ -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<count> ICMP packets, then stop and exit.
 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
@@ -79,6 +85,12 @@ 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. 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
@@ -166,6 +178,12 @@ I<Explicit Congestion Notification> (ECN), even if the deprecated
 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
@@ -205,7 +223,7 @@ whiskers and 2.5% above.
 
   |----------[#####|##########]--------------------------------------------|
   ^          ^     ^          ^                                            ^
- 2.75%      25%   50%        75%                                         97.5%
+ 2.5%       25%   50%        75%                                         97.5%
 
 =item B<histogram>
 
@@ -220,6 +238,50 @@ 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<percent>
 
 Configures the latency percentile to report. I<percent> must be a number
@@ -256,13 +318,24 @@ 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<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
 
 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>.
 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.