add both man page and man page asciidoc source for fcping. Signed-off-by: Yi Zou <[email protected]> Reviewed-by: Daniel Petcher <[email protected]> Reviewed-by: Ross B. Brattain <[email protected]> ---
Makefile.am | 2 - doc/Makefile | 2 - doc/fcping.8 | 204 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/fcping.txt | 120 +++++++++++++++++++++++++++++++++ 4 files changed, 326 insertions(+), 2 deletions(-) create mode 100644 doc/fcping.8 create mode 100644 doc/fcping.txt diff --git a/Makefile.am b/Makefile.am index 6e126c0..71b6b84 100644 --- a/Makefile.am +++ b/Makefile.am @@ -45,7 +45,7 @@ dist_fcoe_config_DATA = etc/cfg-ethx ## man pages for fcoeadm and fcoemon dist_man_MANS = doc/fcoeadm.8 doc/fcoemon.8 doc/fipvlan.8 doc/fcrls.8 \ - doc/fcnsq.8 + doc/fcnsq.8 doc/fcping.8 ## init script for fcoemon dist_noinst_SCRIPTS = etc/initd/initd.suse etc/initd/initd.fedora \ diff --git a/doc/Makefile b/doc/Makefile index 2f27dff..0b5f461 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,7 +1,7 @@ ## known to work with asciidoc version 8.4.5 ## and the DocBook XSL Stylesheets version 1.75.2 -MAN_8_TXT := fcoeadm.txt fcoemon.txt fipvlan.txt fcrls.txt fcnsq.txt +MAN_8_TXT := fcoeadm.txt fcoemon.txt fipvlan.txt fcrls.txt fcnsq.txt fcping.txt MAN_TXT := $(MAN_8_TXT) MAN_8 := $(patsubst %.txt,%.8,$(MAN_8_TXT)) MAN := $(MAN_8) diff --git a/doc/fcping.8 b/doc/fcping.8 new file mode 100644 index 0000000..0d4c71f --- /dev/null +++ b/doc/fcping.8 @@ -0,0 +1,204 @@ +'\" t +.\" Title: fcping +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> +.\" Date: 06/04/2010 +.\" Manual: Open-FCoE Tools +.\" Source: Open-FCoE +.\" Language: English +.\" +.TH "FCPING" "8" "06/04/2010" "Open\-FCoE" "Open\-FCoE Tools" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +fcping \- Fibre Channel Ping (ELS ECHO) tool +.SH "SYNOPSIS" +.sp +\fBfcping\fR [\-fqx] [ \-i \fIinterval\fR ] [ \-c \fIcount\fR ] [ \-s \fIsize\fR ] \-h \fIsource\fR \fItarget\fR +.sp +source = \fIinterface\fR | \fIMAC\fR | \fIWWPN\fR | \fIFC\-ID\fR +.sp +target = \-F \fIWWPN\fR | \-N \fIWWPN\fR | \-F \fIFC\-ID\fR +.SH "DESCRIPTION" +.sp +The \fBfcping\fR command performs the Fibre Channel FC\-LS\-2 ECHO ELS command and displays the reply\&. The max payload for \fBfcping\fR is 2108 bytes\&. When no \fB\-c\fR is given, \fBfcping\fR will continue until user interrupts\&. +.SH "OPTIONS" +.PP +\fB\-f\fR +.RS 4 +Flood ping +.RE +.PP +\fB\-q\fR +.RS 4 +Quiet! just print summary +.RE +.PP +\fB\-x\fR +.RS 4 +Hex dump of responses +.RE +.PP +\fB\-i\fR \fIinterval\fR +.RS 4 +Wait +\fIinterval\fR +seconds between each ping +.RE +.PP +\fB\-c\fR \fIcount\fR +.RS 4 +Stop after sending +\fIcount\fR +pings +.RE +.PP +\fB\-h\fR \fIsource\fR +.RS 4 +Source is +\fIinterface\fR +like ethX, +\fIMAC\fR +address, +\fIWWPN\fR, or +\fIFC\-ID\fR +.RE +.PP +\fB\-s\fR \fIsize\fR +.RS 4 +Byte\-length of ping request payload (max 2108) +.RE +.PP +\fB\-F\fR \fIFC\-ID\fR +.RS 4 +Destination port ID +.RE +.PP +\fB\-P\fR \fIWWPN\fR +.RS 4 +Destination world\-wide port name +.RE +.PP +\fB\-N\fR \fIWWNN\fR +.RS 4 +Destination world\-wide node name +.RE +.SH "EXAMPLES" +.sp +Sends ELS ECHO to Port FC\-ID 0xbf0027 from interface n0\&.170 with max 3 pings\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +fcping \-c 3 \-h n0\&.170 \-F 0xbf0027 +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +sending echo to 0xBF0027 +echo 1 accepted 16\&.170 ms +echo 2 accepted 7\&.053 ms +echo 3 accepted 6\&.803 ms +3 frames sent, 3 received 0 errors, 0\&.000% loss, avg\&. rt time 10\&.009 ms +.fi +.if n \{\ +.RE +.\} +.sp +Sends ELS ECHO to WWNN 0x1000001B213C9DDA from interface n0\&.170 with max 3 pings and payload size 1500 bytes +.sp +.if n \{\ +.RS 4 +.\} +.nf +fcping \-c 3 \-h n0\&.170 \-s 1500 \-N 0x1000001B213C9DDA +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +sending echo to 0xBF0027 +echo 1 accepted 6\&.597 ms +echo 2 accepted 6\&.925 ms +echo 3 accepted 12\&.419 ms +3 frames sent, 3 received 0 errors, 0\&.000% loss, avg\&. rt time 8\&.647 ms +.fi +.if n \{\ +.RE +.\} +.sp +Sends ELS ECHO to WWNN 0x1000001B213C9DDA from interface n0\&.170 continuously with payload of 32 bytes and hex\-dump the reply to the screen +.sp +.if n \{\ +.RS 4 +.\} +.nf +fcping \-x \-h n0\&.170 \-s 32 \-N 0x1000001B213C9DDA +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +sending echo to 0xBF0027 +echo 1 accepted 6\&.937 ms +response length 32 + 0 02000000 00000001 00010203 04050607 + 10 08090a0b 0c0d0e0f 10111213 14151617 +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +echo 2 accepted 6\&.923 ms +response length 32 + 0 02000000 00000002 00010203 04050607 + 10 08090a0b 0c0d0e0f 10111213 14151617 +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +echo 3 accepted 84\&.929 ms +response length 32 + 0 02000000 00000003 00010203 04050607 + 10 08090a0b 0c0d0e0f 10111213 14151617 +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.sp +\fBfcoeadm\fR(8) +.SH "SUPPORT" +.sp +\fBfcping\fR is part of the \fIfcoe\-utils\fR package, maintained through the \fIOpen\-FCoE\fR project\&. Resources for both developers and users can be found at the \fIOpen\-FCoE\fR website http://open\-fcoe\&.org/\&;. diff --git a/doc/fcping.txt b/doc/fcping.txt new file mode 100644 index 0000000..5f57519 --- /dev/null +++ b/doc/fcping.txt @@ -0,0 +1,120 @@ +/////////////////////////////////////////////////////////////////////////// +// vim:syntax=asciidoc:tw=75: +// +// This is an asciidoc text file, which will be converted into a UNIX man +// page using asciidoc and the DocBook XSL stylesheets. +// +// If you are going to update this documentation, please modify this file +// and then regenerate the nroff formated man page using the Makefile. +/////////////////////////////////////////////////////////////////////////// + +fcping(8) +========== +:man source: Open-FCoE +:man manual: Open-FCoE Tools + +NAME +---- +fcping - Fibre Channel Ping (ELS ECHO) tool + +SYNOPSIS +-------- +*fcping* [-fqx] [ -i _interval_ ] [ -c _count_ ] [ -s _size_ ] -h _source_ _target_ + +source = _interface_ | _MAC_ | _WWPN_ | _FC-ID_ + +target = -F _WWPN_ | -N _WWPN_ | -F _FC-ID_ + +DESCRIPTION +----------- +The *fcping* command performs the Fibre Channel FC-LS-2 ECHO ELS command +and displays the reply. The max payload for *fcping* is 2108 bytes. When +no *-c* is given, *fcping* will continue until user interrupts. + +OPTIONS +------- +*-f*:: + Flood ping + +*-q*:: + Quiet! just print summary + +*-x*:: + Hex dump of responses + +*-i* _interval_:: + Wait _interval_ seconds between each ping + +*-c* _count_:: + Stop after sending _count_ pings + +*-h* _source_:: + Source is _interface_ like ethX, _MAC_ address, _WWPN_, or _FC-ID_ + +*-s* _size_:: + Byte-length of ping request payload (max 2108) + +*-F* _FC-ID_:: + Destination port ID + +*-P* _WWPN_:: + Destination world-wide port name + +*-N* _WWNN_:: + Destination world-wide node name + +EXAMPLES +-------- +Sends ELS ECHO to Port FC-ID 0xbf0027 from interface n0.170 with max 3 pings. + + fcping -c 3 -h n0.170 -F 0xbf0027 + + sending echo to 0xBF0027 + echo 1 accepted 16.170 ms + echo 2 accepted 7.053 ms + echo 3 accepted 6.803 ms + 3 frames sent, 3 received 0 errors, 0.000% loss, avg. rt time 10.009 ms + + +Sends ELS ECHO to WWNN 0x1000001B213C9DDA from interface n0.170 with max 3 pings +and payload size 1500 bytes + + fcping -c 3 -h n0.170 -s 1500 -N 0x1000001B213C9DDA + + sending echo to 0xBF0027 + echo 1 accepted 6.597 ms + echo 2 accepted 6.925 ms + echo 3 accepted 12.419 ms + 3 frames sent, 3 received 0 errors, 0.000% loss, avg. rt time 8.647 ms + +Sends ELS ECHO to WWNN 0x1000001B213C9DDA from interface n0.170 continuously +with payload of 32 bytes and hex-dump the reply to the screen + + fcping -x -h n0.170 -s 32 -N 0x1000001B213C9DDA + + sending echo to 0xBF0027 + echo 1 accepted 6.937 ms + response length 32 + 0 02000000 00000001 00010203 04050607 + 10 08090a0b 0c0d0e0f 10111213 14151617 + + echo 2 accepted 6.923 ms + response length 32 + 0 02000000 00000002 00010203 04050607 + 10 08090a0b 0c0d0e0f 10111213 14151617 + + echo 3 accepted 84.929 ms + response length 32 + 0 02000000 00000003 00010203 04050607 + 10 08090a0b 0c0d0e0f 10111213 14151617 + + +SEE ALSO +-------- +*fcoeadm*(8) + +SUPPORT +------- +*fcping* is part of the _fcoe-utils_ package, maintained through the +_Open-FCoE_ project. Resources for both developers and users can be found +at the _Open-FCoE_ website <http://open-fcoe.org/>. _______________________________________________ devel mailing list [email protected] http://www.open-fcoe.org/mailman/listinfo/devel
