add both man page and man page assciidoc source for fcnsq
Signed-off-by: Yi Zou <[email protected]>
Reviewed-by: Daniel Petcher <[email protected]>
Reviewed-by: Ross B. Brattain <[email protected]>
---
Makefile.am | 3 +
doc/Makefile | 2 -
doc/fcnsq.8 | 128 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
doc/fcnsq.txt | 93 +++++++++++++++++++++++++++++++++++++++++
4 files changed, 224 insertions(+), 2 deletions(-)
create mode 100644 doc/fcnsq.8
create mode 100644 doc/fcnsq.txt
diff --git a/Makefile.am b/Makefile.am
index b65e512..6e126c0 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -44,7 +44,8 @@ fcoe_configdir = ${sysconfdir}/fcoe
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
+dist_man_MANS = doc/fcoeadm.8 doc/fcoemon.8 doc/fipvlan.8 doc/fcrls.8 \
+ doc/fcnsq.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 78b5ea8..2f27dff 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
+MAN_8_TXT := fcoeadm.txt fcoemon.txt fipvlan.txt fcrls.txt fcnsq.txt
MAN_TXT := $(MAN_8_TXT)
MAN_8 := $(patsubst %.txt,%.8,$(MAN_8_TXT))
MAN := $(MAN_8)
diff --git a/doc/fcnsq.8 b/doc/fcnsq.8
new file mode 100644
index 0000000..7ba6d7e
--- /dev/null
+++ b/doc/fcnsq.8
@@ -0,0 +1,128 @@
+'\" t
+.\" Title: fcnsq
+.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\" Date: 06/09/2010
+.\" Manual: Open-FCoE Tools
+.\" Source: Open-FCoE
+.\" Language: English
+.\"
+.TH "FCNSQ" "8" "06/09/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"
+fcnsq \- Fibre Channel Name Server Query Tool
+.SH "SYNOPSIS"
+.sp
+\fBfcnsq\fR \fIhost\fR \-\-gpn \fIport_id\fR [\-q | \-\-quiet]
+.sp
+\fBfcnsq\fR \fIhost\fR \-\-gnn \fIport_id\fR [\-q | \-\-quiet]
+.sp
+\fBfcnsq\fR \fIhost\fR \-\-gspn \fIport_id\fR [\-q | \-\-quiet]
+.sp
+\fBfcnsq\fR \fIhost\fR \-\-gsnn \fIwwpn\fR [\-q | \-\-quiet]
+.sp
+\fBfcnsq\fR ?
+.SH "DESCRIPTION"
+.sp
+The \fBfcnsq\fR command performs Fibre Channel Name Server queries for a
user\-specified FC Host\&. The supported name server query commands include:
Get Port Name (GPN), Get Node Name (GNN), Get Symbolic Node Name (GSNN), and
Get Symbolic Port Name (GSPN) as described in FC\-GS\-3 for the Common
Transport (CT) services\&.
+.sp
+\fBfcnsq\fR takes the host bsg name as the input for the target host\&. Host
bsg name must be a valid bsg device, e\&.g\&., "host12" as derived from
/dev/bsg/fc_host12\&. For each name server query command, the argument is
either a Port ID or a World Wide Port Name\&. Port IDs and World Wide Names
must be specified in hexadecimal\&. To disable verbose output, use the
\fB\-\-quiet\fR option\&.
+.SH "OPTIONS"
+.PP
+\fBhost\fR \fB\-\-gpn\fR \fIport_id\fR
+.RS 4
+Get Port Name by Port ID for
+\fIhost\fR\&.
+.RE
+.PP
+\fBhost\fR \fB\-\-gnn\fR \fIport_id\fR
+.RS 4
+Get Node Name by Port ID for
+\fIhost\fR\&.
+.RE
+.PP
+\fBhost\fR \fB\-\-gspn\fR \fIport_id\fR
+.RS 4
+Get Symbolic Port Name by Port ID for
+\fIhost\fR\&.
+.RE
+.PP
+\fBhost\fR \fB\-\-gsnn\fR \fIwwpn\fR
+.RS 4
+Get Symbolic Node Name by World Wide Port Name for
+\fIhost\fR\&.
+.RE
+.PP
+\fB\-q\fR, \fB\-\-quiet\fR
+.RS 4
+Disable verbose output\&.
+.RE
+.PP
+\fB?\fR
+.RS 4
+Display a help message with basic usage instructions\&.
+.RE
+.SH "EXAMPLES"
+.sp
+Query Get Port Name (GPN) from host12 for Port ID 0xbf0027
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+fcnsq host12 \-\-gpn bf0027
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Query Get Node Name (GNN) from host12 for Port ID 0xbf0027
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+fcnsq host12 \-\-gnn bf0027
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Query Get Symbolic Port Name (GSPN) from host12 for Port ID 0xbf0027
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+fcnsq host12 \-\-gspn bf0027
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Query Get Symbolic Node Name (GSNN) from host12 for WWWPN 0x1000001B213C9DDA
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+fcnsq host12 \-\-gsnn 0x1000001B213C9DDA
+.fi
+.if n \{\
+.RE
+.\}
+.SH "SEE ALSO"
+.sp
+\fBfcoeadm\fR(8)
+.SH "SUPPORT"
+.sp
+\fBfcnsq\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/fcnsq.txt b/doc/fcnsq.txt
new file mode 100644
index 0000000..3d84c8b
--- /dev/null
+++ b/doc/fcnsq.txt
@@ -0,0 +1,93 @@
+///////////////////////////////////////////////////////////////////////////
+// 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.
+///////////////////////////////////////////////////////////////////////////
+
+fcnsq(8)
+==========
+:man source: Open-FCoE
+:man manual: Open-FCoE Tools
+
+NAME
+----
+fcnsq - Fibre Channel Name Server Query Tool
+
+SYNOPSIS
+--------
+*fcnsq* _host_ --gpn _port_id_ [-q | --quiet]
+
+*fcnsq* _host_ --gnn _port_id_ [-q | --quiet]
+
+*fcnsq* _host_ --gspn _port_id_ [-q | --quiet]
+
+*fcnsq* _host_ --gsnn _wwpn_ [-q | --quiet]
+
+*fcnsq* ?
+
+DESCRIPTION
+-----------
+The *fcnsq* command performs Fibre Channel Name Server queries
+for a user-specified FC Host. The supported name server query commands
+include: Get Port Name (GPN), Get Node Name (GNN), Get Symbolic Node Name
+(GSNN), and Get Symbolic Port Name (GSPN) as described in FC-GS-3 for the
+Common Transport (CT) services.
+
+*fcnsq* takes the host bsg name as the input for the target host. Host
+bsg name must be a valid bsg device, e.g., "host12" as derived from
+/dev/bsg/fc_host12. For each name server query command, the argument is
+either a Port ID or a World Wide Port Name. Port IDs and World Wide Names
+must be specified in hexadecimal. To disable verbose output, use the *--quiet*
+option.
+
+OPTIONS
+-------
+*host* *--gpn* _port_id_::
+ Get Port Name by Port ID for _host_.
+
+*host* *--gnn* _port_id_::
+ Get Node Name by Port ID for _host_.
+
+*host* *--gspn* _port_id_::
+ Get Symbolic Port Name by Port ID for _host_.
+
+*host* *--gsnn* _wwpn_::
+ Get Symbolic Node Name by World Wide Port Name for _host_.
+
+*-q*, *--quiet*::
+ Disable verbose output.
+
+*?*::
+ Display a help message with basic usage instructions.
+
+EXAMPLES
+--------
+Query Get Port Name (GPN) from host12 for Port ID 0xbf0027
+
+ fcnsq host12 --gpn bf0027
+
+Query Get Node Name (GNN) from host12 for Port ID 0xbf0027
+
+ fcnsq host12 --gnn bf0027
+
+Query Get Symbolic Port Name (GSPN) from host12 for Port ID 0xbf0027
+
+ fcnsq host12 --gspn bf0027
+
+Query Get Symbolic Node Name (GSNN) from host12 for WWWPN 0x1000001B213C9DDA
+
+ fcnsq host12 --gsnn 0x1000001B213C9DDA
+
+SEE ALSO
+--------
+*fcoeadm*(8)
+
+SUPPORT
+-------
+*fcnsq* 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
