aboutsummaryrefslogtreecommitdiff
path: root/sg_scan.8
diff options
context:
space:
mode:
Diffstat (limited to 'sg_scan.8')
-rw-r--r--sg_scan.841
1 files changed, 21 insertions, 20 deletions
diff --git a/sg_scan.8 b/sg_scan.8
index 126ca972..81da76c5 100644
--- a/sg_scan.8
+++ b/sg_scan.8
@@ -1,51 +1,52 @@
-.TH SG_SCAN "8" "June 2006" "sg3_utils-1.21" SG3_UTILS
+.TH SG_SCAN "8" "December 2006" "sg3_utils\-1.23" SG3_UTILS
.SH NAME
sg_scan \- does a scan of sg devices (or given SCSI/ATAPI/ATA devices) and
prints the results
.SH SYNOPSIS
.B sg_scan
-[\fI-a\fR]
-[\fI-i\fR]
-[\fI-n\fR]
-[\fI-w\fR]
-[\fI-x\fR]
-[\fI<sam_dev>\fR]*
+[\fI\-a\fR]
+[\fI\-i\fR]
+[\fI\-n\fR]
+[\fI\-w\fR]
+[\fI\-x\fR]
+[\fIDEVICE\fR]*
.SH DESCRIPTION
.\" Add any additional description here
.PP
-If no <sam_dev> device names are given, sg_scan does a scan of the sg
+If no \fIDEVICE\fR names are given, sg_scan does a scan of the sg
devices and outputs a line of information for each sg device that is
-currently bound to a SCSI device. Once any <sam_dev> is given only the
-given <sam_dev>s are scanned.
-Devices are opened with the O_NONBLOCK flag so that the scan will
+currently bound to a SCSI device. If one or more \fIDEVICE\fRs are given
+only those devices are scanned.
+Each device is opened with the O_NONBLOCK flag so that the scan will
not "hang" on any device that another process holds an O_EXCL lock on.
.PP
-Any given <sam_devs> device names are expected to comply
+Any given \fIDEVICE\fR name is expected to comply
with (to some extent) the Storage Architecture Model (SAM see www.t10.org).
Any device names associated with the Linux SCSI subsystem (e.g. /dev/sda
and /dev/st0m) are suitable. Devices names associated with ATAPI
devices (e.g. most CD/DVD drives and ATAPI tape drives) are also suitable.
If the device does not fall into the above categories then an ATA
IDENTIFY command is tried.
+.SH OPTIONS
.TP
--a
+\fB\-a\fR
do alphabetical scan (i.e. sga, sgb, sgc). Note that sg device nodes with
an alphabetical index have been deprecated since the linux kernel 2.2
series.
.TP
--i
+\fB\-i\fR
do a SCSI INQUIRY, output results in a second (indented) line. If the device
is an ATA disk then output information from an ATA IDENTIFY command
.TP
--n
+\fB\-n\fR
do numeric scan (i.e. sg0, sg1...) [default]
.TP
--w
-use a read/write flag when opening sg device (default is read-only)
+\fB\-w\fR
+use a read/write flag when opening sg device (default is read\-only)
.TP
--x
+\fB\-x\fR
extra information output about queuing
-.PP
+.SH NOTES
This utility was written at a time when hotplugging of SCSI devices
was not supported in Linux. It used a simple algorithm to scan sg
device nodes in ascending numeric or alphabetical order, stopping
@@ -64,7 +65,7 @@ the sg3_utils(8) man page.
.SH AUTHORS
Written by D. Gilbert and F. Jansen
.SH COPYRIGHT
-Copyright \(co 1999-2006 Douglas Gilbert
+Copyright \(co 1999\-2006 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.