aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDouglas Gilbert <dgilbert@interlog.com>2021-12-23 05:11:07 +0000
committerDouglas Gilbert <dgilbert@interlog.com>2021-12-23 05:11:07 +0000
commitc7c79e01652ac14b34b62aa727dae5aabaffdba5 (patch)
treefc4dd131175cecbbb8c0e47df16228e7e3de475c /doc
parentcee35c89cc98e880c7aa52e7b900363ae74e9653 (diff)
downloadsg3_utils-c7c79e01652ac14b34b62aa727dae5aabaffdba5.tar.gz
sg_logs: tweak the meaning of --list option; sg_opcodes: cleanup error reporting
git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@925 6180dd3e-e324-4e3e-922d-17de1ae2f315
Diffstat (limited to 'doc')
-rw-r--r--doc/sg3_utils.82
-rw-r--r--doc/sg_logs.824
2 files changed, 15 insertions, 11 deletions
diff --git a/doc/sg3_utils.8 b/doc/sg3_utils.8
index 25a0d0b6..954126f6 100644
--- a/doc/sg3_utils.8
+++ b/doc/sg3_utils.8
@@ -445,7 +445,7 @@ number returned as the exit status (7 bits).
a transport error has occurred. This will either be in the driver (e.g. HBA
driver) or in the interconnect between the host (initiator) and the
device (target). For example in SAS an expander can run out of paths and
-thus be unable to return the user data for a READ command.
+thus be unable to return the user data from a READ command.
.TP
.B 36
no error has occurred plus the utility wants to convey a boolean value
diff --git a/doc/sg_logs.8 b/doc/sg_logs.8
index 43fd1901..7df65b6a 100644
--- a/doc/sg_logs.8
+++ b/doc/sg_logs.8
@@ -1,4 +1,4 @@
-.TH SG_LOGS "8" "August 2021" "sg3_utils\-1.47" SG3_UTILS
+.TH SG_LOGS "8" "December 2021" "sg3_utils\-1.48" SG3_UTILS
.SH NAME
sg_logs \- access log pages with SCSI LOG SENSE command
.SH SYNOPSIS
@@ -54,6 +54,10 @@ SENSE command. The third form shows the options that can be used to send a
LOG SELECT command. The fourth form groups various management options.
The last form shows the older, deprecated command line interface which is
maintained for backward compatibility.
+.PP
+When no options are given, just a \fIDEVICE\fR, that is equivalent to calling
+this utility with the \fI\-\-list\fR option. In that case the names of the
+supported log pages (and not any subpages) are listed out.
.SH OPTIONS
Arguments to long options are mandatory for short options as well.
The options are arranged in alphabetical order based on the long
@@ -159,14 +163,13 @@ is ignored. If the \fI\-\-raw\fR option is also given then \fIFN\fR is
treated as binary.
.TP
\fB\-l\fR, \fB\-\-list\fR
-lists the names of all logs sense pages supported by this device. This is
-done by reading the "supported log pages" log page. When used
-twice (e.g. '\-ll') lists the names of all logs sense pages and subpages
-supported by this device, excluding pages whose subpage number is
-0xff (apart from page 0x0,0xff). When used three times then all supported
-pages and subpages reported by the device are list. So the page/subpage
-names and not thrie content is shown with this option. There is a list of
-common log page codes below.
+lists the names of the logs sense pages supported by this device. This is
+done by reading the "supported log pages" log page. When used once only
+log pages, but not subpages, are listed. When used two or more
+times (e.g. '\-ll') lists the names of all logs sense pages and subpages
+supported by this device, including pages whose subpage number is
+0xff. So the page/subpage names but not their contents is shown with this
+option.
.TP
\fB\-m\fR, \fB\-\-maxlen\fR=\fILEN\fR
sets the "allocation length" field in the LOG SENSE cdb. The is the maximum
@@ -222,7 +225,8 @@ should be selected. The default value is 0.
.TP
\fB\-q\fR, \fB\-\-pcb\fR
show Parameter Control Byte settings (only relevant when log parameters
-being output in ASCII).
+being output in ASCII). This byte includes the DU and TSD bits plus
+the 'Format and linking' field (2 bits wide).
.TP
\fB\-Q\fR, \fB\-\-ppc\fR
sets the Parameter Pointer Control (PPC) bit in the LOG SENSE cdb. Default