X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fmans%2Foping.pod;h=90d6b02af50da94f79dd4aadd2fb3e05e6fbe509;hb=136979e1219be92af91ff2b90e32086f71ad2de0;hp=44cb6c32d7071e02e95b47f0d6aaf46e9e2e4d9c;hpb=6fa5005cc728176caa79249705874f7aa8521eeb;p=liboping.git diff --git a/src/mans/oping.pod b/src/mans/oping.pod index 44cb6c3..90d6b02 100644 --- a/src/mans/oping.pod +++ b/src/mans/oping.pod @@ -6,14 +6,24 @@ oping - send ICMP ECHO_REQUEST to network hosts B [B<-4> | B<-6>] [B<-c> I] [B<-i> I] I [I [I ...]] +B [B<-4> | B<-6>] [B<-c> I] [B<-i> I] B<-f> I + +B [B<-4> | B<-6>] [B<-c> I] [B<-i> I] I [I [I ...]] + +B [B<-4> | B<-6>] [B<-c> I] [B<-i> I] B<-f> I + =head1 DESCRIPTION -oping uses ICMPv4 or ICMPv6 ECHO_REQUEST packets to measure a hosts +B uses ICMPv4 or ICMPv6 ECHO_REQUEST packets to measure a hosts reachability and the network latency. In contrast to the original L utility B can send ICMP packets to multiple hosts in parallel and wait -for all ECHO_RESPONSE packets to arrive. In contrast to the -B utility (URL is listed in L<"SEE ALSO">) B can use both, IPv4 -and IPv6 transparently and side by side. +for all ECHO_RESPONSE packets to arrive. In contrast to the B utility +(URL is listed in L<"SEE ALSO">) B can use both, IPv4 and IPv6 +transparently and side by side. + +B is an ncurses-based front-end to I which displays ping +statistics online and highlights aberrant round-trip times if the terminal +supports colors. =head1 OPTIONS @@ -25,7 +35,7 @@ Force the use of IPv4. =item B<-6> -Force the use of IPv6 +Force the use of IPv6. =item B<-c> I @@ -36,21 +46,108 @@ 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<-t> I + +Set the IP Time to Live to I. This must be a number between (and +including) 1EandE255. If omitted, the value B<64> is used. + =item B<-I> I
-Set the source address to use. You B pass the interface name, as you -can with GNU's L. +Set the source address to use. You may either specify an IP number or a +hostname. You B pass the interface name, as you can with GNU's +L - use the B<-D> option for that purpose. + +=item B<-D> I + +Set the outgoing network device to use. + +=item B<-f> I + +Instead of specifying hostnames on the command line, read them from +I. If I is B<->, read from C. + +If the 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.Ee. standard input). This is meant to avoid security issues when +I is installed with the SUID-bit. + +=item B<-Q> I + +Specify the I (QoS) for outgoing packets. This is a +somewhat tricky option, since the meaning of the bits in the IPv4 header has +been revised several times. + +The currently recommended method is I which is used in +IPv6 headers as well. There are shortcuts for 13Epredefined +I (PHBs): + +=over 4 + +=item B + +Selects the I (EF) per-hop behavior, as defined in +I3246>. This PHB is characterised by low delay, low loss and low +jitter, i.e. high priority traffic. + +=item BII

+ +Selects one of 12Edifferentiated services code points (DSCPs), which are +organized in four I with three I each. Therefore, I +must be a number betweenE1 throughE4 and I

must be a number +betweenE1 throughE3, for example "af13", "af22" and "af41". In each +class, the lower priority number takes precedence over the higher priority +number. =back -=head1 BUGS +The old definition of the same bits in the IPv4 header was as I (ToS) field, specified in I1349>. It defined four possible +values which have appropriate aliases. Please note that this use of the bits is +B and the meaning is limited to IPv4! =over 4 -=item The TTL cannot be set +=item B + +Minimize delay + +=item B + +Maximize throughput + +=item B + +Maximize reliability + +=item B + +Minimize monetary cost + +=back + +Alternatively, you can also specify the byte manually. You can use either a +decimal number (0-255), a hexadecimal number (0x00-0xff) or an octal number +(00-0377) using the usual "0x" and "0" prefixes for hexadecimal and octal +respectively. =back +=head1 COLORS + +If supported by the terminal, I 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 +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 +printed in red. + =head1 SEE ALSO L, L, L @@ -58,6 +155,6 @@ L, L, L =head1 AUTHOR liboping is written by Florian octo Forster Eocto at verplant.orgE. -It's homepage can be found at L. +Its homepage can be found at L. -(c) 2005, 2006 by Florian octo Forster. +(c) 2005-2010 by Florian octo Forster.