summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Seiler <christian@iwakd.de>2015-05-29 13:35:05 +0200
committerMike Christie <michaelc@cs.wisc.edu>2015-06-05 14:07:09 -0500
commit6aa2c9bda44d5a05481c5cc0bff82bbef6d800d2 (patch)
tree08775445f625abb242224c1c15b3c3721321cee1 /doc
parentdf602f02d7de39e76660e14a065f6a2e99733067 (diff)
downloadopen-iscsi-6aa2c9bda44d5a05481c5cc0bff82bbef6d800d2.tar.gz
Reformat man page synopsis sections
Reformat the synopsis section of the iscsiadm(8) and iscsi_discovery(8) man pages to follow traditional man page style more closely. Thanks to Ulrich Windl for the suggestion.
Diffstat (limited to 'doc')
-rw-r--r--doc/iscsi_discovery.812
-rw-r--r--doc/iscsiadm.8172
2 files changed, 166 insertions, 18 deletions
diff --git a/doc/iscsi_discovery.8 b/doc/iscsi_discovery.8
index a4affc6..e28065c 100644
--- a/doc/iscsi_discovery.8
+++ b/doc/iscsi_discovery.8
@@ -8,7 +8,17 @@
.SH NAME
iscsi_discovery \- discover iSCSI targets
.SH SYNOPSIS
-.B iscsi_discovery <IP> [-p <port>] [-d] [-t <tcp|iser> [-f]] [-m] [-l]
+.B iscsi_discovery
+.I <IP>
+.RB [ -p
+.IR <port> ]
+.RB [ -d ]
+.RB [\ -t
+.IR <tcp|iser>
+.RB [ -f ]
+.R ]
+.RB [ -m ]
+.RB [ -l ]
.SH DESCRIPTION
Perform send-targets discovery to the specified IP. If a discovery record
diff --git a/doc/iscsiadm.8 b/doc/iscsiadm.8
index 64ef2e0..f046236 100644
--- a/doc/iscsiadm.8
+++ b/doc/iscsiadm.8
@@ -2,23 +2,161 @@
.SH NAME
iscsiadm \- open-iscsi administration utility
.SH SYNOPSIS
-\fBiscsiadm\fR \-m discoverydb [ \-hV ] [ \-d debug_level ] [ \-P printlevel ] [ \-I iface \-t type \-p ip:port [ \-lD ] ] | [ [ \-p ip:port -t type ] \
-[ \-o operation ] [ \-n name ] [ \-v value ] [ \-lD ] ]
-
-\fBiscsiadm\fR \-m discovery [ \-hV ] [ \-d debug_level ] [ \-P printlevel ] [ \-I iface \-t type \-p ip:port [ \-l ] ] | [ [ \-p ip:port ] [ \-l | \-D ] ]
-
-\fBiscsiadm\fR \-m node [ \-hV ] [ \-d debug_level ] [ \-P printlevel ] [ \-L all,manual,automatic ] [ \-U all,manual,automatic ] [ \-S ] [ [ \-T targetname \-p ip:port \-I iface ] [ \-l | \-u | \-R | \-s] ]
-[ [ \-o operation ] [ \-n name ] [ \-v value ] [ \-p ip:port ] ]
-
-\fBiscsiadm\fR \-m session [ \-hV ] [ \-d debug_level ] [ \-P printlevel ] [ \-r sessionid | sysfsdir [ \-R ] [ \-u | \-s | \-o new ] ]
-
-\fBiscsiadm\fR \-m iface [ \-hV ] [ \-d debug_level ] [ \-P printlevel ] [ \-I ifacename | \-H hostno|MAC ] [ [ \-o operation ] [ \-n name ] [ \-v value ] ] [ \-C ping [ \-a ip ] [ \-b packetsize ] [ \-c count ] [ \-i interval ] ]
-
-\fBiscsiadm\fR \-m fw [ \-d debug_level ] [\-l]
-
-\fBiscsiadm\fR \-m host [ \-P printlevel ] [ \-H hostno|MAC ] [ [ \-C chap [ \-x chap_tbl_idx ] ] | [ \-C flashnode [ \-A portal_type ] [ \-x flashnode_idx ] ] | [ \-C stats ] ] [ [ \-o operation ] [ \-n name ] [ \-v value ] ]
-
-\fBiscsiadm\fR \-k priority
+.B iscsiadm
+.B \-m discoverydb
+.RB [ \-hV ]
+.RB [ \-d
+.IR debug_level ]
+.RB [ \-P
+.IR printlevel ]
+.R [\
+.BI \-I\ iface\ \-t\ type\ \-p\ ip:port
+.RB [ \-lD ]
+.R ] | [
+.RB [ \-p
+.I ip:port
+.B \-t
+.IR type ]
+.RB [ \-o
+.IR operation ]
+.RB [ \-n
+.IR name ]
+.RB [ \-v
+.IR value ]
+.RB [ \-lD ]
+.R ]
+
+.B iscsiadm
+.B \-m discovery
+.RB [ \-hV ]
+.RB [ \-d
+.IR debug_level ]
+.RB [ \-P
+.IR printlevel ]
+.R [\
+.BI \-I\ iface\ \-t\ type\ \-p\ ip:port
+.RB [ \-l ]
+.R ] | [
+.RB [ \-p
+.IR ip:port ]
+.RB [ \-l | \-D ]
+.R ]
+
+.B iscsiadm
+.B \-m node
+.RB [ \-hV ]
+.RB [ \-d
+.IR debug_level ]
+.RB [ \-P
+.IR printlevel ]
+.RB [ \-L
+.IR all,manual,automatic ]
+.RB [ \-U
+.IR all,manual,automatic ]
+.RB [ \-S ]
+.R [
+.RB [ \-T
+.IB targetname\ \-p\ ip:port\ \-I\ iface
+.R ]
+.RB [ \-l | \-u | \-R | \-s ]
+.R ]
+.R [
+.RB [ \-o
+.IR operation ]
+.RB [ \-n
+.IR name ]
+.RB [ \-v
+.IR value ]
+.RB [ \-p
+.IR ip:port ]
+.R ]
+
+.B iscsiadm
+.B \-m session
+.RB[ \-hV ]
+.RB [ \-d
+.IR debug_level ]
+.RB [ \-P
+.IR printlevel ]
+.R [
+.B \-r
+.IR sessionid | sysfsdir
+.RB [ \-R ]
+.RB [ \-u | \-s | \-o
+.IR new ]
+.R ]
+
+.B iscsiadm
+.B \-m iface
+.RB [ \-hV ]
+.RB [ \-d
+.IR debug_level ]
+.RB [ \-P
+.IR printlevel ]
+.R [
+.BI \-I\ ifacename
+.R |
+.BI \-H\ hostno|MAC
+.R ]
+.R [
+.RB [ \-o
+.IR operation ]
+.RB [ \-n
+.IR name ]
+.RB [ \-v
+.IR value ]
+.R ]
+.R [
+.BI \-C\ ping
+.RB [ \-a
+.IR ip ]
+.RB [ \-b
+.IR packetsize ]
+.RB [ \-c
+.IR count ]
+.RB [ \-i
+.IR interval ]
+.R ]
+
+.B iscsiadm
+.B \-m fw
+.RB [ \-d
+.IR debug_level ]
+.RB [ \-l ]
+
+.B iscsiadm
+.B \-m host
+.RB [ \-P
+.IR printlevel ]
+.RB [ \-H
+.IR hostno|MAC ]
+.R [
+.RB [\ \-C
+.IR chap
+.RB [ \-x
+.IR chap_tbl_idx ]
+.R ] |
+.RB [\ \-C
+.IR flashnode
+.RB [ \-A
+.IR portal_type ]
+.RB [ \-x
+.IR flashnode_idx ]
+.R ] |
+.RB [\ \-C
+.IR stats \ ]
+.R ]
+.R [
+.RB [ \-o
+.IR operation ]
+.RB [ \-n
+.IR name ]
+.RB [ \-v
+.IR value ]
+.R ]
+
+.B iscsiadm
+.B \-k priority
.SH "DESCRIPTION"
The iscsiadm utility is a command-line tool allowing discovery and login