aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDouglas Gilbert <dgilbert@interlog.com>2013-03-15 03:57:42 +0000
committerDouglas Gilbert <dgilbert@interlog.com>2013-03-15 03:57:42 +0000
commit2d978766260dc0dfc2b956f15f4e4c9f11b75911 (patch)
tree2aa416fd8487a27ce216b9c619358b4c65cc002e /doc
parente2a8a0b0661fa14d45e9b088329e38eb3f349a7f (diff)
downloadsg3_utils-2d978766260dc0dfc2b956f15f4e4c9f11b75911.tar.gz
sg_luns: make --linux Linux only; in --test make trailing B a W (for wrong LUN flip)
git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@490 6180dd3e-e324-4e3e-922d-17de1ae2f315
Diffstat (limited to 'doc')
-rw-r--r--doc/sg3_utils.816
-rw-r--r--doc/sg_luns.826
-rw-r--r--doc/sg_prevent.82
-rw-r--r--doc/sg_scan.8.win324
4 files changed, 32 insertions, 16 deletions
diff --git a/doc/sg3_utils.8 b/doc/sg3_utils.8
index 2b82f9bf..2ccc40bf 100644
--- a/doc/sg3_utils.8
+++ b/doc/sg3_utils.8
@@ -1,4 +1,4 @@
-.TH SG3_UTILS "8" "December 2012" "sg3_utils\-1.35" SG3_UTILS
+.TH SG3_UTILS "8" "March 2013" "sg3_utils\-1.36" SG3_UTILS
.SH NAME
sg3_utils \- a package of utilities for sending SCSI commands
.SH SYNOPSIS
@@ -108,10 +108,10 @@ order as devices are discovered (and sometimes rediscovered).
Some storage devices have a SCSI lower level device name which starts
with a SCSI (pseudo) adapter name of the form "SCSI<n>:". To this is added
sub\-addressing in the form of a "bus" number, a "target" identifier and
-a "lun" (logical unit number). The "bus" number is also known as a "PathId".
+a LUN (Logical Unit Number). The "bus" number is also known as a "PathId".
These are assembled to form a device name of the
form: "SCSI<n>:<bus>,<target>,<lun>". The trailing ",<lun>" may be omitted
-in which case a lun of zero is assumed. This lower level device name cannot
+in which case a LUN of zero is assumed. This lower level device name cannot
often be used directly since Windows blocks attempts to use it if a class
driver has "claimed" the device. There are SCSI device types (e.g.
Automation/Drive interface type) for which there is no class driver. At
@@ -126,8 +126,8 @@ utilities in this package.
A single device (e.g. a disk) can have many device names. For
example: "PD0" can also be "C:", "D:" and "SCSI0:0,1,0". The two volume names
reflect that the disk has two partitions on it. Disk partitions that are
-not recognised by Windows are not usually given a volume name. However
-Vista does show a volume name for a disk which has no partitions recognised
+not recognized by Windows are not usually given a volume name. However
+Vista does show a volume name for a disk which has no partitions recognized
by it and when selected invites the user to format it (which may be rather
unfriendly to other OSes).
.PP
@@ -272,7 +272,7 @@ If an option takes a numeric argument then that argument is assumed to
be decimal unless otherwise indicated (e.g. with a leading "0x", a
trailing "h" or as noted in the usage message).
.PP
-Some options are used uniformally in most of the utilities in this
+Some options are used uniformly in most of the utilities in this
package. Those options are listed below. Note that there are some
exceptions.
.TP
@@ -387,7 +387,7 @@ the 'utils' subdirectory.
.SH WEB SITE
There is a web page discussing this package at
http://sg.danny.cz/sg/sg3_utils.html . The device naming used by this
-package on various operating system is discussed in the page:
+package on various operating systems is discussed at:
http://sg.danny.cz/sg/device_name.html .
.SH AUTHORS
Written by Douglas Gilbert. Some utilities have been contributed, see the
@@ -395,7 +395,7 @@ CREDITS file and individual source files (in the 'src' directory).
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 1999\-2012 Douglas Gilbert
+Copyright \(co 1999\-2013 Douglas Gilbert
.br
Some utilities are distributed under a GPL version 2 license while
others, usually more recent ones, are under a FreeBSD license. The files
diff --git a/doc/sg_luns.8 b/doc/sg_luns.8
index aa38d472..f79ceac2 100644
--- a/doc/sg_luns.8
+++ b/doc/sg_luns.8
@@ -1,11 +1,11 @@
-.TH SG_LUNS "8" "February 2013" "sg3_utils\-1.36" SG3_UTILS
+.TH SG_LUNS "8" "March 2013" "sg3_utils\-1.36" SG3_UTILS
.SH NAME
sg_luns \- send SCSI REPORT LUNS command or decode LUN
.SH SYNOPSIS
.B sg_luns
-[\fI\-\-decode\fR] [\fI\-\-help\fR] [\fI\-\-hex\fR] [\fI\-\-maxlen=LEN\fR]
-[\fI\-\-quiet\fR] [\fI\-\-raw\fR] [\fI\-\-select=SR\fR]
-[\fI\-\-verbose\fR] [\fI\-\-version\fR] \fIDEVICE\fR
+[\fI\-\-decode\fR] [\fI\-\-help\fR] [\fI\-\-hex\fR] [\fI\-\-linux\fR]
+[\fI\-\-maxlen=LEN\fR] [\fI\-\-quiet\fR] [\fI\-\-raw\fR]
+[\fI\-\-select=SR\fR] [\fI\-\-verbose\fR] [\fI\-\-version\fR] \fIDEVICE\fR
.PP
.B sg_luns
\fI\-\-test=LUNHEX\fR [\fI\-\-hex\fR] [\fI\-\-verbose\fR]
@@ -38,6 +38,13 @@ in ASCII hex then exit. When given twice it causes the decode option to
output values in hex rather than decimal. When this option is used with
\fI\-\-test=LUNHEX\fR then decoded component fields are output in hex.
.TP
+\fB\-l\fR, \fB\-\-linux\fR
+this option is only available in Linux. After the T10 representation of
+each 64 bit LUN (in 16 hexadecimal digits), if this option is given then
+to the right, in square brackets, is the Linux LUN integer in decimal.
+If the \fI\-\-hex\fR option is given twice (e.g. \-HH) as well then the
+Linux LUN integer is output in hexadecimal.
+.TP
\fB\-m\fR, \fB\-\-maxlen\fR=\fILEN\fR
where \fILEN\fR is the (maximum) response length in bytes. It is placed in
the cdb's "allocation length" field. If not given (or \fILEN\fR is zero)
@@ -181,6 +188,15 @@ I_T Nexus):
.br
REPORT LUNS well known logical unit
.PP
+The following example uses the \fI\-\-linux\fR option and is not available
+in other operating systems.
+.PP
+ # sg_luns \-q \-s 2 \-l /dev/sg1
+.br
+ 0001000000000000 [1]
+.br
+ c101000000000000 [49409]
+.PP
Now we use the \fI\-\-test=\fR option to decode LUNS input on the command
line (rather than send a REPORT LUNS command and act on the response):
.PP
@@ -220,7 +236,7 @@ Linux LUN 49409 translates to in the T10 world:
And the mapping between T10 and Linux LUN representations can be done the
other way:
.PP
- # sg_luns -t c101L
+ # sg_luns \-t c101L
.br
Linux 'word flipped' integer LUN representation: 49409
.br
diff --git a/doc/sg_prevent.8 b/doc/sg_prevent.8
index df1268c4..3548ffba 100644
--- a/doc/sg_prevent.8
+++ b/doc/sg_prevent.8
@@ -35,7 +35,7 @@ persistent removal. "Persistent" in this context means that the
initiator (port) that successfully uses code 3 blocks other initiators (ports)
from allowing removal. A "persistent prevent" state can be cleared by the
owner allowing persistent removal (code 2) or a power cycle (or anything that
-resets the device (lun)) or some special commands (e.g. various service
+resets the device (LU)) or some special commands (e.g. various service
actions of Persistent Reserve Out, see SPC\-3).
.TP
\fB\-v\fR, \fB\-\-verbose\fR
diff --git a/doc/sg_scan.8.win32 b/doc/sg_scan.8.win32
index 89bd4ab9..d68e85aa 100644
--- a/doc/sg_scan.8.win32
+++ b/doc/sg_scan.8.win32
@@ -28,10 +28,10 @@ sometimes rediscovered).
Some storage devices have a SCSI lower level device name which starts
with a SCSI (pseudo) adapter name of the form "SCSI<n>:". To this is added
sub\-addressing in the form of a "bus" number, a "target" identifier and
-a "lun" (logical unit number). The "bus" number is also known as a "PathId".
+a LUN (Logical Unit Number). The "bus" number is also known as a "PathId".
These components are combined by the utility to make a device name of the
form: "SCSI<n>:<bus>,<target>,<lun>". This utility allows the
-trailing ",<lun>" to be omitted in which case a lun of zero is assumed. This
+trailing ",<lun>" to be omitted in which case a LUN of zero is assumed. This
lower level device name cannot often be used directly since Windows blocks
attempts to use it if a class driver has "claimed" the device. There are
SCSI device types (e.g. Automation/Drive interface type) for which there is