src/mans/oping.pod

   1 =head1 NAME
   2
   3 oping - send ICMP ECHO_REQUEST to network hosts
   4
   5 =head1 SYNOPSIS
   6
   7 B<oping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] I<host> [I<host> [I<host> ...]]
   8
   9 B<oping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] B<-f> I<filename>
  10
  11 B<noping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] I<host> [I<host> [I<host> ...]]
  12
  13 B<noping> [B<-4> | B<-6>] [B<-c> I<count>] [B<-i> I<interval>] B<-f> I<filename>
  14
  15 =head1 DESCRIPTION
  16
  17 B<oping> uses ICMPv4 or ICMPv6 ECHO_REQUEST packets to measure a hosts
  18 reachability and the network latency. In contrast to the original L<ping(8)>
  19 utility B<oping> can send ICMP packets to multiple hosts in parallel and wait
  20 for all ECHO_RESPONSE packets to arrive. In contrast to the B<fping> utility
  21 (URL is listed in L<"SEE ALSO">) B<oping> can use both, IPv4 and IPv6
  22 transparently and side by side.
  23
  24 B<noping> is an ncurses-based front-end to I<liboping> which displays ping
  25 statistics online and highlights aberrant round-trip times if the terminal
  26 supports colors.
  27
  28 =head1 OPTIONS
  29
  30 =over 4
  31
  32 =item B<-4>
  33
  34 Force the use of IPv4.
  35
  36 =item B<-6>
  37
  38 Force the use of IPv6.
  39
  40 =item B<-c> I<count>
  41
  42 Send (and receive) I<count> ICMP packets, then stop and exit.
  43
  44 =item B<-i> I<interval>
  45
  46 Send one ICMP packet (per host) each I<interval> seconds. This can be a
  47 floating-point number to specify sub-second precision.
  48
  49 =item B<-t> I<ttl>
  50
  51 Set the IP Time to Live to I<ttl>. This must be a number between (and
  52 including) 1E<nbsp>andE<nbsp>255. If omitted, the value B<64> is used.
  53
  54 =item B<-I> I<address>
  55
  56 Set the source address to use. You may either specify an IP number or a
  57 hostname. You B<cannot> pass the interface name, as you can with GNU's
  58 L<ping(8)> - use the B<-D> option for that purpose.
  59
  60 =item B<-D> I<interface name>
  61
  62 Set the outgoing network device to use.
  63
  64 =item B<-f> I<filename>
  65
  66 Instead of specifying hostnames on the command line, read them from
  67 I<filename>. If I<filename> is B<->, read from C<STDIN>.
  68
  69 If the real user ID (as returned by L<getuid(2)>) and the effective user ID (as
  70 returned by L<geteuid(2)>) differ, the only argument allowed for this option is
  71 "-" (i.E<nbsp>e. standard input). This is meant to avoid security issues when
  72 I<oping> is installed with the SUID-bit.
  73
  74 =item B<-Q> I<qos>
  75
  76 Specify the I<Quality of Service> (QoS) for outgoing packets. This is a
  77 somewhat tricky option, since the meaning of the bits in the IPv4 header has
  78 been revised several times.
  79
  80 The currently recommended method is I<Differentiated Services> which is used in
  81 IPv6 headers as well. There are shortcuts for 13E<nbsp>predefined
  82 I<per-hop behaviors> (PHBs):
  83
  84 =over 4
  85
  86 =item B<ef>
  87
  88 Selects the I<Expedited Forwarding> (EF) per-hop behavior, as defined in
  89 I<RFCE<nbsp>3246>. This PHB is characterised by low delay, low loss and low
  90 jitter, i.e. high priority traffic.
  91
  92 =item  B<af>I<c>I<p>
  93
  94 Selects one of 12E<nbsp>differentiated services code points (DSCPs), which are
  95 organized in four I<classes> with three I<priorities> each. Therefore, I<c>
  96 must be a number betweenE<nbsp>1 throughE<nbsp>4 and I<p> must be a number
  97 betweenE<nbsp>1 throughE<nbsp>3, for example "af13", "af22" and "af41". In each
  98 class, the lower priority number takes precedence over the higher priority
  99 number.
 100
 101 =back
 102
 103 The old definition of the same bits in the IPv4 header was as I<Type of
 104 Service> (ToS) field, specified in I<RFCE<nbsp>1349>. It defined four possible
 105 values which have appropriate aliases. Please note that this use of the bits is
 106 B<deprecated> and the meaning is limited to IPv4!
 107
 108 =over 4
 109
 110 =item B<lowdelay>
 111
 112 Minimize delay
 113
 114 =item B<throughput>
 115
 116 Maximize throughput
 117
 118 =item B<reliability>
 119
 120 Maximize reliability
 121
 122 =item B<mincost>
 123
 124 Minimize monetary cost
 125
 126 =back
 127
 128 Alternatively, you can also specify the byte manually. You can use either a
 129 decimal number (0-255), a hexadecimal number (0x00-0xff) or an octal number
 130 (00-0377) using the usual "0x" and "0" prefixes for hexadecimal and octal
 131 respectively.
 132
 133 =back
 134
 135 =head1 COLORS
 136
 137 If supported by the terminal, I<noping> will highlight the round-trip times
 138 (RTT) using the colors green, yellow and red. Green signals RTTs that are in
 139 the "expected" range, yellow marks moderately unusual times and times that
 140 differ a lot from the expected value are printed in red.
 141
 142 The information used to categorize round-trip times is the I<average>
 143 round-trip time and the I<standard deviation>. RTTs that differ from the
 144 average by less than the standard deviation are considered to be "normal" and
 145 are printed in green. Times that differ from the average more than the standard
 146 deviation but less than twice the standard deviation are considered "moderately
 147 unusual" and are printed in yellow. Times differing more than twice the
 148 standard deviation from the average are considered to be "unusual" and are
 149 printed in red.
 150
 151 =head1 SEE ALSO
 152
 153 L<ping(8)>, L<http://www.fping.com/>, L<liboping(3)>
 154
 155 =head1 AUTHOR
 156
 157 liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
 158 Its homepage can be found at L<http://verplant.org/liboping/>.
 159
 160 (c) 2005-2010 by Florian octo Forster.