aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDouglas Gilbert <dgilbert@interlog.com>2017-11-15 06:21:21 +0000
committerDouglas Gilbert <dgilbert@interlog.com>2017-11-15 06:21:21 +0000
commitcad489950e9fc29fe8786ddee2e163831abb3322 (patch)
treef5263f4d234ec6894c61a8561a4a77c06068c7bc /doc
parent098b15e48f02ac4b501dc383456be94b25c1266b (diff)
downloadsg3_utils-cad489950e9fc29fe8786ddee2e163831abb3322.tar.gz
rename sg_write_atomic to sg_write_x; sg_inq: decode NVMe identify for Linux+FreeBSD
git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@731 6180dd3e-e324-4e3e-922d-17de1ae2f315
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am4
-rw-r--r--doc/Makefile.in6
-rw-r--r--doc/sg_dd.814
-rw-r--r--doc/sg_luns.88
-rw-r--r--doc/sg_persist.84
-rw-r--r--doc/sg_rdac.86
-rw-r--r--doc/sg_read_attr.86
-rw-r--r--doc/sg_verify.86
-rw-r--r--doc/sg_write_x.8 (renamed from doc/sg_write_atomic.8)4
9 files changed, 29 insertions, 29 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 8910e4db..b1ffa079 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -12,8 +12,8 @@ man_MANS = \
sg_sat_read_gplog.8 sg_sat_set_features.8 sg_senddiag.8 sg_ses.8 \
sg_ses_microcode.8 sg_start.8 sg_stpg.8 sg_sync.8 sg_timestamp.8 \
sg_turs.8 sg_unmap.8 sg_verify.8 sg_vpd.8 sg_wr_mode.8 \
- sg_write_atomic.8 sg_write_buffer.8 sg_write_long.8 sg_write_same.8 \
- sg_write_verify.8 sg_zone.8
+ sg_write_buffer.8 sg_write_long.8 sg_write_same.8 sg_write_verify.8 \
+ sg_write_x.8 sg_zone.8
CLEANFILES =
if OS_LINUX
diff --git a/doc/Makefile.in b/doc/Makefile.in
index 707f049a..e71f9b01 100644
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@@ -293,9 +293,9 @@ man_MANS = scsi_mandat.8 scsi_readcap.8 scsi_ready.8 scsi_satl.8 \
sg_sat_read_gplog.8 sg_sat_set_features.8 sg_senddiag.8 \
sg_ses.8 sg_ses_microcode.8 sg_start.8 sg_stpg.8 sg_sync.8 \
sg_timestamp.8 sg_turs.8 sg_unmap.8 sg_verify.8 sg_vpd.8 \
- sg_wr_mode.8 sg_write_atomic.8 sg_write_buffer.8 \
- sg_write_long.8 sg_write_same.8 sg_write_verify.8 sg_zone.8 \
- $(am__append_1) $(am__append_3) $(am__append_5)
+ sg_wr_mode.8 sg_write_buffer.8 sg_write_long.8 sg_write_same.8 \
+ sg_write_verify.8 sg_write_x.8 sg_zone.8 $(am__append_1) \
+ $(am__append_3) $(am__append_5)
CLEANFILES = $(am__append_2) $(am__append_4) $(am__append_6)
all: all-am
diff --git a/doc/sg_dd.8 b/doc/sg_dd.8
index 8e616755..0aa7a386 100644
--- a/doc/sg_dd.8
+++ b/doc/sg_dd.8
@@ -1,4 +1,4 @@
-.TH SG_DD "8" "June 2013" "sg3_utils\-1.37" SG3_UTILS
+.TH SG_DD "8" "November 2017" "sg3_utils\-1.43" SG3_UTILS
.SH NAME
sg_dd \- copy data to and from files and devices, especially SCSI
devices
@@ -151,10 +151,10 @@ unless 'oflag=append' or \fISEEK\fR is given.
\fBof2\fR=\fIOFILE2\fR
write output to \fIOFILE2\fR. The default action is not to do this additional
write (i.e. when this option is not given). \fIOFILE2\fR is assumed to be
-a normal file or a fifo (i.e. a named pipe). \fIOFILE2\fR is opened for writing,
-created if necessary, and closed at the end of the transfer. If \fIOFILE2\fR
-is a fifo (named pipe) then some other command should be consuming that
-data (e.g. 'md5sum OFILE2'), otherwise this utility will block.
+a normal file or a fifo (i.e. a named pipe). \fIOFILE2\fR is opened for
+writing, created if necessary, and closed at the end of the transfer. If
+\fIOFILE2\fR is a fifo (named pipe) then some other command should be
+consuming that data (e.g. 'md5sum OFILE2'), otherwise this utility will block.
.TP
\fBoflag\fR=\fIFLAGS\fR
where \fIFLAGS\fR is a comma separated list of one or more flags outlined
@@ -214,7 +214,7 @@ this conversion is very close to "iflag=coe" and is treated as such. See
the "coe" flag. Note that an error on \fIOFILE\fR will stop the copy.
.TP
notrunc
-this conversion is accepted for compatibilty with dd and ignored since
+this conversion is accepted for compatibility with dd and ignored since
the default action of this utility is not to truncate \fIOFILE\fR.
.TP
null
@@ -483,7 +483,7 @@ Written by Douglas Gilbert and Peter Allworth.
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 2000\-2013 Douglas Gilbert
+Copyright \(co 2000\-2017 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_luns.8 b/doc/sg_luns.8
index d9a9aafe..eb79ddf3 100644
--- a/doc/sg_luns.8
+++ b/doc/sg_luns.8
@@ -1,4 +1,4 @@
-.TH SG_LUNS "8" "May" "sg3_utils\-1.43" SG3_UTILS
+.TH SG_LUNS "8" "November" "sg3_utils\-1.43" SG3_UTILS
.SH NAME
sg_luns \- send SCSI REPORT LUNS command or decode given LUN
.SH SYNOPSIS
@@ -65,8 +65,8 @@ Linux LUN integer is output in hexadecimal.
\fB\-L\fR, \fB\-\-lu_cong\fR
this option is only considered with \fI\-\-decode\fR. When given once
then the list of LUNs is decoded as if the LU_CONG bit was set in
-each LU's coresponding INQUIRY response. When given twice the list of
-LUNs is decoded as if the LU_CONG bit was clear in each LU's coresponding
+each LU's corresponding INQUIRY response. When given twice the list of
+LUNs is decoded as if the LU_CONG bit was clear in each LU's corresponding
INQUIRY response. When this option is not given and \fI\-\-decode\fR is
given then an INQUIRY is sent to the \fIDEVICE\fR and the setting of
its LU_CONG bit is used to decode the list of LUNs.
@@ -311,7 +311,7 @@ Written by Douglas Gilbert.
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 2004\-2016 Douglas Gilbert
+Copyright \(co 2004\-2017 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.
diff --git a/doc/sg_persist.8 b/doc/sg_persist.8
index b2cb602a..ca0eb5db 100644
--- a/doc/sg_persist.8
+++ b/doc/sg_persist.8
@@ -1,4 +1,4 @@
-.TH SG_PERSIST "8" "October 2017" "sg3_utils\-1.43" SG3_UTILS
+.TH SG_PERSIST "8" "November 2017" "sg3_utils\-1.43" SG3_UTILS
.SH NAME
sg_persist \- use SCSI PERSISTENT RESERVE command to access registrations
and reservations
@@ -414,7 +414,7 @@ The above sequence of commands was tested successfully on a Seagate Savvio
The exit status of sg_persist is 0 when it is successful. Otherwise see
the sg3_utils(8) man page.
.SH ENVIRONMENT VARIABLES
-If the SG_PERSIST_IN_RDONLY enviroment variable is present and only if a
+If the SG_PERSIST_IN_RDONLY environment variable is present and only if a
PRIN command has been selected then the given \fIDEVICE\fR is opened
read\-only (e.g. in Unix that is with the O_RDONLY flag) unless
overridden. See the \fI\-\-readonly\fR option.
diff --git a/doc/sg_rdac.8 b/doc/sg_rdac.8
index 76553d7e..ddbda949 100644
--- a/doc/sg_rdac.8
+++ b/doc/sg_rdac.8
@@ -1,4 +1,4 @@
-.TH SG_RDAC "8" "April 2016" "sg3_utils\-1.43" SG3_UTILS
+.TH SG_RDAC "8" "November 2017" "sg3_utils\-1.43" SG3_UTILS
.SH NAME
sg_rdac \- display or modify SCSI RDAC Redundant Controller mode page
.SH SYNOPSIS
@@ -9,7 +9,7 @@ sg_rdac \- display or modify SCSI RDAC Redundant Controller mode page
.PP
sg_rdac displays or modifies the RDAC controller settings via the
Redundant Controller mode page (0x2C). When modifying the settings it
-allows to transfer the ownership of individual drives to the
+allows one to transfer the ownership of individual drives to the
controller the command was received on.
.SH OPTIONS
.TP
@@ -40,7 +40,7 @@ Written by Hannes Reinecke <hare at suse dot com>, based on sg_emc_trespass.
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 2006\-2016 Hannes Reinecke, Douglas Gilbert.
+Copyright \(co 2006\-2017 Hannes Reinecke, 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_read_attr.8 b/doc/sg_read_attr.8
index 191a8d82..b7c4d09e 100644
--- a/doc/sg_read_attr.8
+++ b/doc/sg_read_attr.8
@@ -1,4 +1,4 @@
-.TH SG_READ_ATTR "8" "September 2017" "sg3_utils\-1.43" SG3_UTILS
+.TH SG_READ_ATTR "8" "November 2017" "sg3_utils\-1.43" SG3_UTILS
.SH NAME
sg_read_attr \- send SCSI READ ATTRIBUTE command
.SH SYNOPSIS
@@ -37,8 +37,8 @@ is set to zero.
.TP
\fB\-f\fR, \fB\-\-filter\fR=\fIFL\fR
where \fIFL\fR is an attribute identifier in the range 0 to 65535 or \-1.
-Attribute identifiers are typical given in hexadecimal in which case the
-hex number should be prefixed by "0x" ot has a trailing "h". "\-1" is
+Attribute identifiers are typically given in hexadecimal in which case the
+hex number should be prefixed by "0x" or has a trailing "h". "\-1" is
the default value and means 'match all'; for all other values of \fIFL\fR
on the matching attribute is output.
.TP
diff --git a/doc/sg_verify.8 b/doc/sg_verify.8
index 1618c292..4e7ddf3a 100644
--- a/doc/sg_verify.8
+++ b/doc/sg_verify.8
@@ -1,4 +1,4 @@
-.TH SG_VERIFY "8" "September 2017" "sg3_utils\-1.43" SG3_UTILS
+.TH SG_VERIFY "8" "November 2017" "sg3_utils\-1.43" SG3_UTILS
.SH NAME
sg_verify \- invoke SCSI VERIFY command(s) on a block device
.SH SYNOPSIS
@@ -82,7 +82,7 @@ sets the BYTCHK field to \fIBCH\fR overriding the value (1) set by the
however sbc3r34 reserves the value 2. If this option is given then
\fI\-\-ndo=NDO\fR must also be given. If \fIBCH\fR is 3 then \fICOUNT\fR
must be 1 and \fINDO\fR should be the size of one logical block (plus the
-size of some or all of the protection infomation if \fIVRP\fR is greater
+size of some or all of the protection information if \fIVRP\fR is greater
than 0).
.TP
\fB\-g\fR, \fB\-\-group\fR=\fIGN\fR
@@ -111,7 +111,7 @@ of the device).
\fI\-\-in=FN\fR is given) or from stdin. Those bytes are placed in the
data\-out buffer associated with the SCSI VERIFY command and \fINDO\fR
is placed in the verification length field in the cdb. The default value
-for \fINDO\fR is 0 and the maximum value is dependant on the OS. If the
+for \fINDO\fR is 0 and the maximum value is dependent on the OS. If the
\fI\-\-ebytchk=BCH\fR option is not given then the BYTCHK field in the cdb
is set to 1.
.TP
diff --git a/doc/sg_write_atomic.8 b/doc/sg_write_x.8
index 5eb58d0f..a01befe3 100644
--- a/doc/sg_write_atomic.8
+++ b/doc/sg_write_x.8
@@ -1,6 +1,6 @@
-.TH SG_WRITE_ATOMIC "8" "September 2017" "sg3_utils\-1.43" SG3_UTILS
+.TH SG_WRITE_X "8" "November 2017" "sg3_utils\-1.43" SG3_UTILS
.SH NAME
-sg_write_atomic \- send SCSI WRITE ATOMIC command
+sg_write_atomic \- send SCSI WRITE ATOMIC/SCATTERED/STREAM command
.SH SYNOPSIS
.B sg_write_atomic
[\fI\-\-16\fR] [\fI\-\-32\fR] [\fI\-\-app-tag=AT\fR] [\fI\-\-boundary=AB\fR]