Skip to content

Commit

Permalink
Improve man page
Browse files Browse the repository at this point in the history
Newly added options are documented.

Resolves: tt#21
  • Loading branch information
jfriesse committed Dec 22, 2010
1 parent f0b4634 commit 52d99d7
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions omping.8
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@
.\"
.\" Author: Jan Friesse <[email protected]>

.TH omping 8 2010-11-18
.TH omping 8 2010-12-22
.SH NAME
omping \- test IP multicast
.SH SYNOPSIS
\fBping\fR [\fB-46FVv\fR] [\fB-i \fIinterval\fR] [\fB-m \fImcast_addr\fR] [\fB-p \fIport\fR] [\fB-t
\fIttl\fR] \fIremote_addr...
\fBping\fR [\fB-46FqVv\fR] [\fB-i \fIinterval\fR] [\fB-M \fItransport_method\fR]
[\fB-m \fImcast_addr\fR] [\fB-p \fIport\fR] [\fB-t \fIttl\fR] \fIremote_addr...
.SH DESCRIPTION
\fBomping\fR is program which uses User Datagram Protocol to determine if computer is able to send
and/or receive IP Unicast and Multicast packets from the network. It's designed to be used in very
Expand All @@ -38,10 +38,16 @@ Force usage of IPv6.
.IP \fB-F\fR
Allow entering of arguments which are not allowed or not recommended by the specification. This is
typically the interval parameter. This option may be used multiple times.
.IP \fB-q\fR
Quiet output. Nothing is displayed except state changes and summary. Option can be used twice and
then only summary is displayed.
.IP \fB-V\fR
Display version and quit.
.IP \fB-v\fR
Set level of verbosity. Parameter can be used multiple times to achieve higher verbosity.
.IP \fB-M \fItransport_method\fR
Set transport method to use. This can be \fBasm\fR for Any-source Multicast and \fBssm\fR for
Source-specific Multicast.
.IP \fB-i\ \fIinterval\fR
Wait \fIinterval\fR seconds between sending each request packet. The default is to wait for one
second between each packet.
Expand All @@ -56,6 +62,13 @@ Time-To-Live of sent packets.
List of addresses to test. One of them must be address of local internet interface. This
local address is used for bind and listening on for unicast packets. It's also used to determine
which interface should be used for sending multicast replies.
.PP
When using \fBomping\fR for fault isolation, it should first be run against local internet
interface only, to verify that the local network interface is up and running, and firewall
is correctly configured. This mode is available by entering only local IP address.

Program is normally terminated by SIGINT. After signal receive summary is displayed. You can also
display summary during running by sending SIGINFO or SIGUSR1 signal.
.SH EXAMPLE
The following commands and output is a typical way how to find-out and solve network problems
using omping. In this situation, we have 3 computers named node-01, node-02 and node-03 with IP addresses
Expand Down Expand Up @@ -115,14 +128,10 @@ node-03 : multicast, xmt/rcv/%loss = 289/289/0%, min/avg/max = 0.325/0.356/0.548
.IP \[bu] 2
Packet duplicate detection is not implemented.
.IP \[bu]
SSM multicast is not implemented.
.IP \[bu]
Actually computed RTT is not RTT taken from packet, but end-to-end delivery.
.IP \[bu]
It's impossible to set size of send/receive buffer.
.IP \[bu]
No quite mode.
.IP \[bu]
No count mode.
.SH SEE ALSO
.PP
Expand Down

0 comments on commit 52d99d7

Please sign in to comment.