aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDouglas Gilbert <dgilbert@interlog.com>2009-04-02 16:49:49 +0000
committerDouglas Gilbert <dgilbert@interlog.com>2009-04-02 16:49:49 +0000
commitb15dc3d385fa5f94350c0b4f721c026560891d28 (patch)
tree46864e78f70f9478864f4d1b47362d70b1fc0e29 /doc
parentee25b125e45c7e8dfeb82b518d563cf6ea831f4b (diff)
downloadsg3_utils-b15dc3d385fa5f94350c0b4f721c026560891d28.tar.gz
Allow various comma separated list arguments to take space separator
git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@242 6180dd3e-e324-4e3e-922d-17de1ae2f315
Diffstat (limited to 'doc')
-rw-r--r--doc/sg_persist.811
-rw-r--r--doc/sg_reassign.87
-rw-r--r--doc/sg_senddiag.811
-rw-r--r--doc/sg_ses.813
-rw-r--r--doc/sg_wr_mode.828
5 files changed, 38 insertions, 32 deletions
diff --git a/doc/sg_persist.8 b/doc/sg_persist.8
index 59103c1a..c727567c 100644
--- a/doc/sg_persist.8
+++ b/doc/sg_persist.8
@@ -1,4 +1,4 @@
-.TH SG_PERSIST "8" "March 2009" "sg3_utils\-1.27" SG3_UTILS
+.TH SG_PERSIST "8" "April 2009" "sg3_utils\-1.27" SG3_UTILS
.SH NAME
sg_persist \- sends a SCSI PERSISTENT RESERVE (IN or OUT) command
to manipulate registrations and reservations
@@ -213,10 +213,11 @@ existing key' sub\-commands. The latter two sub\-commands can take multiple
transportIDs in a list but only one is supported with this option
variant (use the \fI\-\-transport\-id=\-\fR variant if multiple
transportIDs are required). \fIH,H...\fR is a comma separated list of hex
-bytes which represent the transportID. The list of hex numbers will be
-padded out with zeros to 24 bytes which is the minimum length of a
-transportID. A transportID longer than 24 bytes (e.g. for iSCSI) is
-padded with zeros so its length is a multiple of 4.
+bytes which represent the transportID. A (single) space separated list
+of hex bytes is also allowed but the list needs to be in quotes. The list
+of hex numbers will be padded out with zeros to 24 bytes which is the
+minimum length of a transportID. A transportID longer than 24 bytes (e.g.
+for iSCSI) is padded with zeros so its length is a multiple of 4.
.TP
\fB\-X\fR, \fB\-\-transport\-id=\-\fR
a transportID is required for the PROUT 'register and move' sub\-command
diff --git a/doc/sg_reassign.8 b/doc/sg_reassign.8
index 9d1e489d..46db8002 100644
--- a/doc/sg_reassign.8
+++ b/doc/sg_reassign.8
@@ -1,4 +1,4 @@
-.TH SG_REASSIGN "8" "January 2007" "sg3_utils\-1.23" SG3_UTILS
+.TH SG_REASSIGN "8" "April 2009" "sg3_utils\-1.27" SG3_UTILS
.SH NAME
sg_reassign \- sends a SCSI REASSIGN BLOCKS command
.SH SYNOPSIS
@@ -32,7 +32,8 @@ Arguments to long options are mandatory for short options as well.
where \fIA,A...\fR is a string of comma separated numbers. Each number
is interpreted as decimal unless prefixed by '0x' or '0X' (or it has a
trailing 'h' or 'H'). If multiple logical block addresses are given they
-must be separated by a comma. At least one address must be given.
+must be separated by a comma or a (single) space. A string that contains
+any space separators needs to be quoted. At least one address must be given.
.TP
\fB\-a\fR, \fB\-\-address\fR=\-
reads one or more logical block addresses from stdin. These may be comma,
@@ -135,7 +136,7 @@ Written by Douglas Gilbert.
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 2005\-2007 Douglas Gilbert
+Copyright \(co 2005\-2009 Douglas Gilbert
.br
This software is distributed under a FreeBSD license. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
diff --git a/doc/sg_senddiag.8 b/doc/sg_senddiag.8
index f40253c7..e79c4b18 100644
--- a/doc/sg_senddiag.8
+++ b/doc/sg_senddiag.8
@@ -1,4 +1,4 @@
-.TH SG_SENDDIAG "8" "October 2007" "sg3_utils\-1.25" SG3_UTILS
+.TH SG_SENDDIAG "8" "April 2009" "sg3_utils\-1.27" SG3_UTILS
.SH NAME
sg_senddiag \- performs a SCSI SEND DIAGNOSTIC command
.SH SYNOPSIS
@@ -67,9 +67,10 @@ bit is set (as required by SPC\-3).
.TP
\fB\-r\fR, \fB\-\-raw\fR=\fIH,H...\fR
string of comma separated hex numbers each of which should resolve to
-a byte value (i.e. 0 to ff inclusive). This sequence forms a diagnostic
-page to be sent with the SCSI SEND DIAGNOSTIC command. Mostly likely
-the \fI\-\-pf\fR option should also be given.
+a byte value (i.e. 0 to ff inclusive). A (single) space separated string
+of hex bytes is also allowed but the list needs to be in quotes. This
+sequence forms a diagnostic page to be sent with the SCSI SEND DIAGNOSTIC
+command. Mostly likely the \fI\-\-pf\fR option should also be given.
.TP
\fB\-r\fR, \fB\-\-raw=\-\fR
reads sequence of bytes from stdin. The sequence may be comma, space, tab
@@ -244,7 +245,7 @@ Written by Doug Gilbert
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 2003\-2007 Douglas Gilbert
+Copyright \(co 2003\-2009 Douglas Gilbert
.br
This software is distributed under the GPL version 2. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
diff --git a/doc/sg_ses.8 b/doc/sg_ses.8
index f0e2c18b..eca97c26 100644
--- a/doc/sg_ses.8
+++ b/doc/sg_ses.8
@@ -1,4 +1,4 @@
-.TH SG_SES "8" "March 2008" "sg3_utils\-1.26" SG3_UTILS
+.TH SG_SES "8" "April 2009" "sg3_utils\-1.27" SG3_UTILS
.SH NAME
sg_ses \- send controls and fetch status from a SCSI Enclosure
Services (SES) device
@@ -39,10 +39,11 @@ The Enclosure control, String Out, Threshold Out, Array control (obsolete
in SES\-2) and Subenclosure String Out diagnostic pages can be set currently.
.TP
\fB\-d\fR, \fB\-\-data\fR=\fIH,H...\fR
-permits a string of comma separated (ASCII) hex digits to be
-specified (limit 512). This allows the parameters to a control diagnostic
-page to be specified. The string given should not include the first 4
-bytes (i.e. page code and length). See next entry for using stdin.
+permits a string of comma separated (ASCII) hex bytes to be specified (limit
+512). A (single) space separated string of hex bytes is also allowed but
+the list needs to be in quotes. This allows the parameters to a control
+diagnostic page to be specified. The string given should not include the
+first 4 bytes (i.e. page code and length). See next entry for using stdin.
.TP
\fB\-d\fR, \fB\-\-data\fR=\-
reads a data string from stdin. Spaces, tabs and line feeds additionally
@@ -148,7 +149,7 @@ Written by Douglas Gilbert.
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 2004\-2007 Douglas Gilbert
+Copyright \(co 2004\-2009 Douglas Gilbert
.br
This software is distributed under a FreeBSD license. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
diff --git a/doc/sg_wr_mode.8 b/doc/sg_wr_mode.8
index dfe7365d..e115504c 100644
--- a/doc/sg_wr_mode.8
+++ b/doc/sg_wr_mode.8
@@ -1,4 +1,4 @@
-.TH SG_WR_MODE "8" "March 2008" "sg3_utils\-1.26" SG3_UTILS
+.TH SG_WR_MODE "8" "April 2009" "sg3_utils\-1.27" SG3_UTILS
.SH NAME
sg_wr_mode \- write mode page
.SH SYNOPSIS
@@ -53,12 +53,13 @@ Arguments to long options are mandatory for short options as well.
.TP
\fB\-c\fR, \fB\-\-contents\fR=\fIH,H...\fR
where \fIH,H...\fR is a string of comma separated hex numbers each of
-which should resolve to a byte value (i.e. 0 to ff inclusive). This is the
-new contents of the mode page to be written to \fIDEVICE\fR, potentially
-filtered by the mask string.
+which should resolve to a byte value (i.e. 0 to ff inclusive). A (single)
+space separated string of hex numbers is also allowed but the list needs to
+be in quotes. This is the new contents of the mode page to be written to
+\fIDEVICE\fR, potentially filtered by the mask string.
.TP
\fB\-c\fR, \fB\-\-contents\fR=-
-reads contents string from stdin. The numbers in the string may be comma,
+reads contents string from stdin. The hex numbers in the string may be comma,
space, tab or linefeed (newline) separated. If a line contains "#" then the
remaining characters on that line are ignored. Otherwise each non separator
character should resolve to a byte value (i.e. 0 to ff inclusive). This
@@ -89,13 +90,14 @@ don't support the 10 byte variants hence this option.
.TP
\fB\-m\fR, \fB\-\-mask\fR=\fIM,M...\fR
where \fIM,M...\fR is a string of comma separated hex numbers each of which
-should resolve to a byte value (i.e. 0 to ff inclusive). The mask
-chooses (bit by bit) whether the new mode page comes from the contents (mask
-bit set) or from the existing mode page (mask bit clear). If the mask string
-is shorter than the contents string then the remaining bytes are taken from
-the contents string. If the contents string is shorter than the existing
-mode page then the remaining bytes are taken from the existing mode
-page (i.e. they are left unaltered).
+should resolve to a byte value (i.e. 0 to ff inclusive). A (single) space
+separated string of hex numbers is also allowed but the list needs to be in
+quotes. The mask chooses (bit by bit) whether the new mode page comes from
+the contents (mask bit set) or from the existing mode page (mask bit clear).
+If the mask string is shorter than the contents string then the remaining
+bytes are taken from the contents string. If the contents string is shorter
+than the existing mode page then the remaining bytes are taken from the
+existing mode page (i.e. they are left unaltered).
.TP
\fB\-p\fR, \fB\-\-page\fR=\fIPG\fR
where \fIPG\fR is the page code value to fetch and modify. The page code is
@@ -188,7 +190,7 @@ Written by Douglas Gilbert.
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 2004\-2008 Douglas Gilbert
+Copyright \(co 2004\-2009 Douglas Gilbert
.br
This software is distributed under a FreeBSD license. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.