add '--maxlen=' option to sg_vpd and sg_inq

git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@147 6180dd3e-e324-4e3e-922d-17de1ae2f315

2 files changed, 25 insertions, 8 deletions

diff --git a/doc/sg_inq.8 b/doc/sg_inq.8
index 88e157e2..945fc50b 100644
--- a/doc/sg_inq.8
+++ b/doc/sg_inq.8
@@ -1,4 +1,4 @@
-.TH SG_INQ "8" "August 2007" "sg3_utils\-1.25" SG3_UTILS
+.TH SG_INQ "8" "February 2008" "sg3_utils\-1.26" SG3_UTILS
 .SH NAME
 sg_inq \- sends a SCSI INQUIRY or ATA IDENTIFY (PACKET) DEVICE command
 and outputs the response
@@ -6,8 +6,8 @@ and outputs the response
 .B sg_inq
 [\fI\-\-ata\fR] [\fI\-\-cmddt\fR] [\fI\-\-descriptors\fR] [\fI\-\-extended\fR]
 [\fI\-\-help\fR] [\fI\-\-hex\fR] [\fI\-\-id\fR] [\fI\-\-len=LEN\fR]
-[\fI\-\-page=PG\fR] [\fI\-\-raw\fR] [\fI\-\-verbose\fR] [\fI\-\-version\fR]
-[\fI\-\-vpd\fR] \fIDEVICE\fR
+[\fI\-\-maxlen=LEN\fR] [\fI\-\-page=PG\fR] [\fI\-\-raw\fR] [\fI\-\-verbose\fR]
+[\fI\-\-version\fR] [\fI\-\-vpd\fR] \fIDEVICE\fR
 .PP
 .B sg_inq
 [\fI\-36\fR] [\fI\-a\fR] [\fI\-A\fR] [\fI\-b\fR] [\fI\-c\fR] [\fI\-cl\fR]
@@ -110,6 +110,11 @@ length" field in the response indicates that more than 36 bytes is available.
 If \fILEN\fR is greater than 0 then only one INQUIRY command is performed.
 See paragraph below about "36 byte INQUIRYs".
 .TP
+\fB\-m\fR, \fB\-\-maxlen\fR=\fILEN\fR
+this option has the same action as the \fI\-\-len=LEN\fR option. It has
+been added for compatibility with the sg_vpd, sg_modes and sg_logs
+utilities.
+.TP
 \fB\-O\fR, \fB\-\-old\fR
 switch to older style options.
 .TP
@@ -324,7 +329,7 @@ Written by Doug Gilbert
 .SH "REPORTING BUGS"
 Report bugs to <dgilbert at interlog dot com>.
 .SH COPYRIGHT
-Copyright \(co 2001\-2007 Douglas Gilbert
+Copyright \(co 2001\-2008 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_vpd.8 b/doc/sg_vpd.8
index bdb1fd17..11f60174 100644
--- a/doc/sg_vpd.8
+++ b/doc/sg_vpd.8
@@ -1,11 +1,12 @@
-.TH SG_VPD "8" "April 2007" "sg3_utils\-1.24" SG3_UTILS
+.TH SG_VPD "8" "February 2008" "sg3_utils\-1.26" SG3_UTILS
 .SH NAME
 sg_vpd \- fetches Vital Product Data (VPD) pages using a SCSI INQUIRY command
 .SH SYNOPSIS
 .B sg_vpd
 [\fI\-\-enumerate\fR] [\fI\-\-help\fR] [\fI\-\-hex\fR] [\fI\-\-ident\fR]
-[\fI\-\-long\fR] [\fI\-\-page=PG\fR] [\fI\-\-quiet\fR] [\fI\-\-raw\fR]
-[\fI\-\-verbose\fR] [\fI\-\-version\fR] \fIDEVICE\fR
+[\fI\-\-long\fR] [\fI\-\-maxlen=LEN\fR] [\fI\-\-page=PG\fR]
+[\fI\-\-quiet\fR] [\fI\-\-raw\fR] [\fI\-\-verbose\fR] [\fI\-\-version\fR]
+\fIDEVICE\fR
 .SH DESCRIPTION
 .\" Add any additional description here
 .PP
@@ -50,6 +51,17 @@ when decoding some VPD pages, give a little more output. For example the ATA
 Information VPD page only shows the signature (in hex) and the IDENTIFY
 (PACKET) DEVICE (in hex) when this option is given.
 .TP
+\fB\-m\fR, \fB\-\-maxlen\fR=\fILEN\fR
+where \fILEN\fR is the (maximum) response length in bytes. It is placed in the
+cdb's "allocation length" field. If not given (or \fILEN\fR is zero) then
+252 is used (apart from the ATA Information VPD page which defaults to 572)
+and, if the response indicates this value is insufficient, another INQUIRY
+command is sent with a larger value in the cdb's "allocation length" field.
+If this option is given and \fILEN\fR is greater than 0 then only one INQUIRY
+command is sent. Since many simple devices implement the INQUIRY command
+badly (and do not support VPD pages) then the safest value to use for
+\fILEN\fR is 36. See the sg_inq man page for the more information. 
+.TP
 \fB\-p\fR, \fB\-\-page\fR=\fIPG\fR
 where \fIPG\fR is the VPD page to be decoded or output. The \fIPG\fR argument
 can either be an abbreviation, a number or a pair or numbers separated by a
@@ -107,7 +119,7 @@ Written by Doug Gilbert
 .SH "REPORTING BUGS"
 Report bugs to <dgilbert at interlog dot com>.
 .SH COPYRIGHT
-Copyright \(co 2006\-2007 Douglas Gilbert
+Copyright \(co 2006\-2008 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.