aboutsummaryrefslogtreecommitdiff
path: root/doc/sg_read_buffer.8
diff options
context:
space:
mode:
authorDouglas Gilbert <dgilbert@interlog.com>2019-05-15 14:30:29 +0000
committerDouglas Gilbert <dgilbert@interlog.com>2019-05-15 14:30:29 +0000
commit28903a1cc840874d25f0a6f2b9360bf800e3d46a (patch)
tree1ec51363339eef1cbbdac5a17e9d2add84b96d22 /doc/sg_read_buffer.8
parent3a5deb427c87030be41c99aa0b3fa26d9d79ec67 (diff)
downloadsg3_utils-28903a1cc840874d25f0a6f2b9360bf800e3d46a.tar.gz
sg_read_buffer: decode read microcode status page, add --inhex=FN option
git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@822 6180dd3e-e324-4e3e-922d-17de1ae2f315
Diffstat (limited to 'doc/sg_read_buffer.8')
-rw-r--r--doc/sg_read_buffer.823
1 files changed, 19 insertions, 4 deletions
diff --git a/doc/sg_read_buffer.8 b/doc/sg_read_buffer.8
index d133cce0..422f0fa1 100644
--- a/doc/sg_read_buffer.8
+++ b/doc/sg_read_buffer.8
@@ -1,11 +1,12 @@
-.TH SG_READ_BUFFER "8" "January 2019" "sg3_utils\-1.45" SG3_UTILS
+.TH SG_READ_BUFFER "8" "May 2019" "sg3_utils\-1.45" SG3_UTILS
.SH NAME
sg_read_buffer \- send SCSI READ BUFFER command
.SH SYNOPSIS
.B sg_read_buffer
-[\fI\-\-help\fR] [\fI\-\-hex\fR] [\fI\-\-id=ID\fR] [\fI\-\-length=LEN\fR]
-[\fI\-\-mode=MO\fR] [\fI\-\-offset=OFF\fR] [\fI\-\-raw\fR]
-[\fI\-\-readonly\fR] [\fI\-\-verbose\fR] [\fI\-\-version\fR] \fIDEVICE\fR
+[\fI\-\-help\fR] [\fI\-\-hex\fR] [\fI\-\-id=ID\fR] [\fI\-\-inhex=FN\fR]
+[\fI\-\-length=LEN\fR] [\fI\-\-mode=MO\fR] [\fI\-\-offset=OFF\fR]
+[\fI\-\-raw\fR] [\fI\-\-readonly\fR] [\fI\-\-specific=MS\fR]
+[\fI\-\-verbose\fR] [\fI\-\-version\fR] \fIDEVICE\fR
.SH DESCRIPTION
.\" Add any additional description here
.PP
@@ -31,6 +32,16 @@ right of each line.
this option sets the buffer id field in the cdb. \fIID\fR is a value between
0 (default) and 255 inclusive.
.TP
+\fB\-I\fR, \fB\-\-inhex\fR=\fIFN\fR
+\fIFN\fR is expected to be a file name (or '\-' for stdin) which contains
+ASCII hexadecimal or binary representing a READ BUFFER response. If known
+this utility will then decode that response. It is preferable to also
+supply the \fI\-\-mode=MO\fR and \fI\-\-specific=MS\fR options, since these
+are not present in the response. The hexadecimal should be arranged as 1 or
+2 digits representing a byte each of which is whitespace or comma separated.
+Anything from and including a hash mark to the end of line is ignored. If the
+\fI\-\-raw\fR option is also given then \fIFN\fR is treated as binary.
+.TP
\fB\-l\fR, \fB\-\-length\fR=\fILEN\fR
where \fILEN\fR is the length, in bytes, that is placed in the "allocation
length" field in the cdb. The default value is 4 (bytes). The device may
@@ -54,6 +65,10 @@ if a response is received then it is sent in binary to stdout.
open the \fIDEVICE\fR read\-only (e.g. in Unix with the O_RDONLY flag).
The default is to open it read\-write.
.TP
+\fB\-S\fR, \fB\-\-specific\fR=\fIMS\fR
+this option sets the mode specific field in the cdb. \fIMS\fR is a value
+between 0 and 7 as this is a 3 bit field.
+.TP
\fB\-v\fR, \fB\-\-verbose\fR
increase the level of verbosity, (i.e. debug output).
.TP