aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDouglas Gilbert <dgilbert@interlog.com>2019-03-02 01:03:55 +0000
committerDouglas Gilbert <dgilbert@interlog.com>2019-03-02 01:03:55 +0000
commit8bdc5521368ade1b8ecaecf194f03ad74f845fed (patch)
tree790ea0d014de7d3a5922794b336c848ac5d5533a /doc
parent9ddcd0ac08f1c6a46d681bc349f3f523e8da4fcf (diff)
downloadsg3_utils-8bdc5521368ade1b8ecaecf194f03ad74f845fed.tar.gz
sg_lib: extend small SNTL to support read capacity
git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@812 6180dd3e-e324-4e3e-922d-17de1ae2f315
Diffstat (limited to 'doc')
-rw-r--r--doc/sg3_utils.813
-rw-r--r--doc/sg_dd.86
-rw-r--r--doc/sg_xcopy.84
-rw-r--r--doc/sgm_dd.86
-rw-r--r--doc/sgp_dd.86
5 files changed, 23 insertions, 12 deletions
diff --git a/doc/sg3_utils.8 b/doc/sg3_utils.8
index e3e4b70b..836e1769 100644
--- a/doc/sg3_utils.8
+++ b/doc/sg3_utils.8
@@ -1,4 +1,4 @@
-.TH SG3_UTILS "8" "January 2019" "sg3_utils\-1.45" SG3_UTILS
+.TH SG3_UTILS "8" "February 2019" "sg3_utils\-1.45" SG3_UTILS
.SH NAME
sg3_utils \- a package of utilities for sending SCSI commands
.SH SYNOPSIS
@@ -260,6 +260,12 @@ package assume they are talking to a SCSI device and decode any response
accordingly. One easy way for users to see the underlying device is a
NVMe device is the standard INQUIRY response Vendor Identification field
of "NVMe " (an 8 character long string with 4 spaces to the right).
+.PP
+The following SCSI commands are currently supported by the SNTL library:
+INQUIRY, MODE SELECT(10), MODE SENSE(10), READ CAPACITY(10 and 16),
+RECEIVE DIAGNOSTIC RESULTS, REQUEST SENSE, REPORT LUNS, REPORT SUPPORTED
+OPERATION CODES, REPORT SUPPORTED TASK MANAGEMENT FUNCTIONS, SEND
+DIAGNOSTICS, and TEST UNIT READY.
.SH EXIT STATUS
To aid scripts that call these utilities, the exit status is set to indicate
success (0) or failure (1 or more). Note that some of the lower values
@@ -407,6 +413,11 @@ like "shouldn't/can't get here". Perhaps the author should be informed.
.B 33
the command sent to \fIDEVICE\fR has timed out.
.TP
+.B 34
+this is a Windows only exit status and indicates that the Windows error
+number (32 bits) cannot meaningfully be mapped to an equivalent Unix error
+number returned as the exit status (7 bits).
+.TP
.B 36
no error has occurred plus the utility wants to convey a boolean value
of false. The corresponding true value is conveyed by a 0 exit status.
diff --git a/doc/sg_dd.8 b/doc/sg_dd.8
index 881d11ed..872c43cf 100644
--- a/doc/sg_dd.8
+++ b/doc/sg_dd.8
@@ -1,4 +1,4 @@
-.TH SG_DD "8" "August 2018" "sg3_utils\-1.43" SG3_UTILS
+.TH SG_DD "8" "February 2019" "sg3_utils\-1.45" SG3_UTILS
.SH NAME
sg_dd \- copy data to and from files and devices, especially SCSI
devices
@@ -101,7 +101,7 @@ copy \fICOUNT\fR blocks from \fIIFILE\fR to \fIOFILE\fR. Default is the
minimum (of \fIIFILE\fR and \fIOFILE\fR) number of blocks that sg devices
report from SCSI READ CAPACITY commands or that block devices (or their
partitions) report. Normal files are not probed for their size. If
-\fIskip=SKIP\fR or \fIskip=SEEK\fR are given and the count is derived (i.e.
+\fIskip=SKIP\fR or \fIseek=SEEK\fR are given and the count is derived (i.e.
not explicitly given) then the derived count is scaled back so that the
copy will not overrun the device. If the file name is a block device
partition and \fICOUNT\fR is not given then the size of the partition
@@ -491,7 +491,7 @@ Written by Douglas Gilbert and Peter Allworth.
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 2000\-2018 Douglas Gilbert
+Copyright \(co 2000\-2019 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_xcopy.8 b/doc/sg_xcopy.8
index ccd470ec..197fc37b 100644
--- a/doc/sg_xcopy.8
+++ b/doc/sg_xcopy.8
@@ -1,4 +1,4 @@
-.TH SG_XCOPY "8" "January 2019" "sg3_utils\-1.45" SG3_UTILS
+.TH SG_XCOPY "8" "February 2019" "sg3_utils\-1.45" SG3_UTILS
.SH NAME
sg_xcopy \- copy data to and from files and devices using SCSI EXTENDED
COPY (XCOPY)
@@ -88,7 +88,7 @@ minimum (\fIIFILE\fR if \fIdc=0\fR or \fIOFILE\fR if \fIdc=1\fR)
number of blocks that SCSI devices report from SCSI READ CAPACITY
commands or that block devices (or their partitions) report. Normal
files are not probed for their size. If \fIskip=SKIP\fR or
-\fIskip=SEEK\fR are given and the count is derived (i.e. not
+\fIseek=SEEK\fR are given and the count is derived (i.e. not
explicitly given) then the derived count is scaled back so that the
copy will not overrun the device. If the file name is a block device
partition and \fICOUNT\fR is not given then the size of the partition
diff --git a/doc/sgm_dd.8 b/doc/sgm_dd.8
index 346bedb9..58782d72 100644
--- a/doc/sgm_dd.8
+++ b/doc/sgm_dd.8
@@ -1,4 +1,4 @@
-.TH SGM_DD "8" "June 2018" "sg3_utils\-1.43" SG3_UTILS
+.TH SGM_DD "8" "February 2019" "sg3_utils\-1.45" SG3_UTILS
.SH NAME
sgm_dd \- copy data to and from files and devices, especially SCSI
devices
@@ -66,7 +66,7 @@ copy \fICOUNT\fR blocks from \fIIFILE\fR to \fIOFILE\fR. Default is the
minimum (of \fIIFILE\fR and \fIOFILE\fR) number of blocks that sg devices
report from SCSI READ CAPACITY commands or that block devices (or their
partitions) report. Normal files are not probed for their size. If
-\fIskip=SKIP\fR or \fIskip=SEEK\fR are given and the count is derived (i.e.
+\fIskip=SKIP\fR or \fIseek=SEEK\fR are given and the count is derived (i.e.
not explicitly given) then the derived count is scaled back so that the
copy will not overrun the device. If the file name is a block device
partition and \fICOUNT\fR is not given then the size of the partition rather
@@ -269,7 +269,7 @@ Written by Douglas Gilbert and Peter Allworth.
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 2000\-2018 Douglas Gilbert
+Copyright \(co 2000\-2019 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/sgp_dd.8 b/doc/sgp_dd.8
index 0c997121..bd18d2a5 100644
--- a/doc/sgp_dd.8
+++ b/doc/sgp_dd.8
@@ -1,4 +1,4 @@
-.TH SGP_DD "8" "June 2018" "sg3_utils\-1.43" SG3_UTILS
+.TH SGP_DD "8" "February 2019" "sg3_utils\-1.45" SG3_UTILS
.SH NAME
sgp_dd \- copy data to and from files and devices, especially SCSI
devices
@@ -61,7 +61,7 @@ copy \fICOUNT\fR blocks from \fIIFILE\fR to \fIOFILE\fR. Default is the
minimum (of \fIIFILE\fR and \fIOFILE\fR) number of blocks that sg devices
report from SCSI READ CAPACITY commands or that block devices (or their
partitions) report. Normal files are not probed for their size. If
-\fIskip=SKIP\fR or \fIskip=SEEK\fR are given and the count is deduced (i.e.
+\fIskip=SKIP\fR or \fIseek=SEEK\fR are given and the count is deduced (i.e.
not explicitly given) then that count is scaled back so that the copy will
not overrun the device. If the file name is a block device partition and
\fICOUNT\fR is not given then the size of the partition rather than the
@@ -314,7 +314,7 @@ Written by Douglas Gilbert and Peter Allworth.
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 2000\-2017 Douglas Gilbert
+Copyright \(co 2000\-2019 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.