aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDouglas Gilbert <dgilbert@interlog.com>2018-03-21 10:43:08 +0000
committerDouglas Gilbert <dgilbert@interlog.com>2018-03-21 10:43:08 +0000
commita5fb8b06e1f2cd46757f35e8d38fa8757edfaa96 (patch)
treeae4ea1c1ce83032fc0cf74d929eee3efcbc1ccf5 /doc
parent760a4bdf5dd5679cf17b4eacf8c5e178cec30839 (diff)
downloadsg3_utils-a5fb8b06e1f2cd46757f35e8d38fa8757edfaa96.tar.gz
sg_turs: add --low option; testing/sg_tst_async.cpp + tst_sg_lib.c additions
git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@763 6180dd3e-e324-4e3e-922d-17de1ae2f315
Diffstat (limited to 'doc')
-rw-r--r--doc/sg_ses.812
-rw-r--r--doc/sg_turs.817
2 files changed, 18 insertions, 11 deletions
diff --git a/doc/sg_ses.8 b/doc/sg_ses.8
index 10e660ad..b838267b 100644
--- a/doc/sg_ses.8
+++ b/doc/sg_ses.8
@@ -314,7 +314,7 @@ later invocation using the \fI\-\-data=\fR option. A dpage less its first
the full dpage contents is output in binary to stdout.
.br
when \fI\-rr\fR is used together with the \fI\-\-data=\-\fR or
-\fI\-\-data=FN\fR then stdin or file FN is decoded as a binary stream that
+\fI\-\-data=@FN\fR then stdin or file FN is decoded as a binary stream that
continues to be read until an end of file (EOF). Once that data is read then
the internal raw option is cleared to 0 so the output is not effected. So
the \fI\-rr\fR option either changes how the input or output is treated,
@@ -498,11 +498,11 @@ The \fI\-\-clear=STR\fR, \fI\-\-get=STR\fR and \fI\-\-set=STR\fR options can
be used up to 8 times in the same invocation. Any <acronym>s used in the
\fISTR\fR operands must refer to the same dpage.
.PP
-When multiple of these options are used, they are applied in the order in
-which they appear on the command line. So if options contradict each other,
-the last one appearing on the command line will be enforced. When there
-are multiple \fI\-\-clear=STR\fR and \fI\-\-set=STR\fR options, then the
-dpage they refer to is only written after the last one.
+When multiple of these options are used (maximum: 8), they are applied in the
+order in which they appear on the command line. So if options contradict each
+other, the last one appearing on the command line will be enforced. When
+there are multiple \fI\-\-clear=STR\fR and \fI\-\-set=STR\fR options, then
+the dpage they refer to is only written after the last one.
.SH DATA SUPPLIED
This section describes the two scenarios that can occur when the
\fI\-\-data=\fR option is given. These scenarios are the same irrespective
diff --git a/doc/sg_turs.8 b/doc/sg_turs.8
index d37f8fd4..66e6ad3a 100644
--- a/doc/sg_turs.8
+++ b/doc/sg_turs.8
@@ -1,9 +1,9 @@
-.TH SG_TURS "8" "October 2017" "sg3_utils\-1.43" SG3_UTILS
+.TH SG_TURS "8" "March 2018" "sg3_utils\-1.43" SG3_UTILS
.SH NAME
sg_turs \- send one or more SCSI TEST UNIT READY commands
.SH SYNOPSIS
.B sg_turs
-[\fI\-\-help\fR] [\fI\-\-number=NUM\fR] [\fI\-\-num=NUM\fR]
+[\fI\-\-help\fR] [\fI\-\-low\fR] [\fI\-\-number=NUM\fR] [\fI\-\-num=NUM\fR]
[\fI\-\-progress\fR] [\fI\-\-time\fR] [\fI\-\-verbose\fR] [\fI\-\-version\fR]
\fIDEVICE\fR
.PP
@@ -15,8 +15,8 @@ sg_turs \- send one or more SCSI TEST UNIT READY commands
.PP
This utility sends one or more SCSI TEST UNIT READY commands to the
\fIDEVICE\fR. This may be useful for timing the per command overhead.
-Note that TEST UNIT READY has no associated data, just a 6 byte command
-and a returned SCSI status value.
+Note that TEST UNIT READY has no associated data, just a 6 byte
+command (with each byte a zero) and a returned SCSI status value.
.PP
This utility supports two command line syntaxes, the preferred one is
shown first in the synopsis and explained in this section. A later section
@@ -27,6 +27,13 @@ Arguments to long options are mandatory for short options as well.
\fB\-h\fR, \fB\-\-help\fR
print out the usage message then exit.
.TP
+\fB\-l\fR, \fB\-\-low\fR
+when [\fI\-\-progress\fR] is not being used, this utility tries to complete
+the SCSI TEST UNIT READY command(s) as quickly as possible. Usually it
+calls a library function to do each TUR (sg_ll_test_unit_ready). With this
+option it uses the lower level sg_pt interface (see sg_pt.h) to save a
+little time on each TUR.
+.TP
\fB\-n\fR, \fB\-\-number\fR=\fINUM\fR
performs TEST UNIT READY \fINUM\fR times. If not given defaults to 1.
These suffix multipliers are permitted: c C *1; w W *2; b B *512;
@@ -121,7 +128,7 @@ using \fI\-\-old\fR (or \fI\-O\fR) as the first command line option.
.SH AUTHORS
Written by D. Gilbert
.SH COPYRIGHT
-Copyright \(co 2000\-2017 Douglas Gilbert
+Copyright \(co 2000\-2018 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.