aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDouglas Gilbert <dgilbert@interlog.com>2013-05-08 13:21:30 +0000
committerDouglas Gilbert <dgilbert@interlog.com>2013-05-08 13:21:30 +0000
commit02ec79b083e6bd32b71937f0b3b6b0108769c184 (patch)
treecfdea6d63740f214ba6de984af36df0df265587d /doc
parenteac58c25208cc3d1ef6a7f4feaf711c161350451 (diff)
downloadsg3_utils-02ec79b083e6bd32b71937f0b3b6b0108769c184.tar.gz
sg_xcopy: add --on_src and --on_dst options; C++ cleanup
git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@494 6180dd3e-e324-4e3e-922d-17de1ae2f315
Diffstat (limited to 'doc')
-rw-r--r--doc/sg_inq.84
-rw-r--r--doc/sg_map.813
-rw-r--r--doc/sg_map26.82
-rw-r--r--doc/sg_xcopy.837
-rw-r--r--doc/sginfo.819
5 files changed, 49 insertions, 26 deletions
diff --git a/doc/sg_inq.8 b/doc/sg_inq.8
index 08b46e34..dd00c67b 100644
--- a/doc/sg_inq.8
+++ b/doc/sg_inq.8
@@ -1,4 +1,4 @@
-.TH SG_INQ "8" "March 2013" "sg3_utils\-1.36" SG3_UTILS
+.TH SG_INQ "8" "May 2013" "sg3_utils\-1.36" SG3_UTILS
.SH NAME
sg_inq \- issue SCSI INQUIRY command, output and decode response
.SH SYNOPSIS
@@ -90,7 +90,7 @@ number VPD page 0x80 is given it prints out information in the form:
page is given it prints out information in the form:
"SCSI_VENDOR=<vendor>", "SCSI_MODEL=<model>", and
"SCSI_REVISION=<rev>", taken from the standard inquiry. This may be
-useful for tools like udev in Linux.
+useful for tools like udev(7) in Linux.
.TP
\fB\-E\fR, \fB\-x\fR, \fB\-\-extended\fR
prints the extended INQUIRY VPD page [0x86].
diff --git a/doc/sg_map.8 b/doc/sg_map.8
index ebb2037f..5cbb4c2a 100644
--- a/doc/sg_map.8
+++ b/doc/sg_map.8
@@ -1,4 +1,4 @@
-.TH SG_MAP "8" "December 2006" "sg3_utils\-1.23" SG3_UTILS
+.TH SG_MAP "8" "May 2013" "sg3_utils\-1.36" SG3_UTILS
.SH NAME
sg_map \- displays mapping between Linux sg and other SCSI devices
.SH SYNOPSIS
@@ -14,6 +14,11 @@ sg devices and finds the corresponding SCSI disk, cdrom or tape
device name (if any). Scanners are an example of SCSI devices
that have no alternate SCSI device name apart from their sg device
name.
+.PP
+This utility is deprecated and has not been updated for years, only very
+obvious bugs will be fixed. Unless a very old version of Linux is being
+used (e.g. 2.4 series or earlier), then please use a utility like lsscsi(8)
+or the facilities offered by udev(8).
.SH OPTIONS
.TP
\fB\-a\fR
@@ -159,7 +164,7 @@ Written by Douglas Gilbert
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 2000\-2006 Douglas Gilbert
+Copyright \(co 2000\-2013 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.
@@ -171,3 +176,7 @@ warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.B scsidev(8)
,
.B devfsd(8)
+,
+.B lsscsi(8)
+,
+.B udev(7)
diff --git a/doc/sg_map26.8 b/doc/sg_map26.8
index 2cef1544..cb826e2b 100644
--- a/doc/sg_map26.8
+++ b/doc/sg_map26.8
@@ -158,4 +158,4 @@ Copyright \(co 2005\-2012 Douglas Gilbert
This software is distributed under a FreeBSD license. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH "SEE ALSO"
-.B udev(8), udevinfo(8), lsscsi(lsscsi)
+.B udev(7), lsscsi(lsscsi)
diff --git a/doc/sg_xcopy.8 b/doc/sg_xcopy.8
index 1d151c21..231c83c6 100644
--- a/doc/sg_xcopy.8
+++ b/doc/sg_xcopy.8
@@ -1,4 +1,4 @@
-.TH SG_XCOPY "8" "February 2013" "sg3_utils\-1.36" SG3_UTILS
+.TH SG_XCOPY "8" "May 2013" "sg3_utils\-1.36" SG3_UTILS
.SH NAME
sg_xcopy \- copy data to and from files and devices using SCSI EXTENDED
COPY (XCOPY)
@@ -10,22 +10,26 @@ COPY (XCOPY)
[\fI\-\-version\fR]
.PP
[\fIbpt=BPT\fR] [\fIcat=\fR0|1] [\fIdc=\fR0|1]
-[\fIid_usage=\fRhold|discard|disable] [\fIlist_id=ID\fR]
-[\fIprio=PRIO\fR] [\fItime=\fR0|1] [\fIverbose=VERB\fR] [\fI\-h\fR]
-[\fI\-V\fR]
+[\fIid_usage=\fRhold|discard|disable] [\fIlist_id=ID\fR] [\fIprio=PRIO\fR]
+[\fItime=\fR0|1] [\fIverbose=VERB\fR] [\fI\-\-on_dst|\-\-on_src\fR]
+[\fI\-\-verbose\fR]
.SH DESCRIPTION
.\" Add any additional description here
.PP
Copy data to and from any files. Specialized for "files" that are Linux SCSI
-devices that support the SCSI EXTENDED COPY command. Similar syntax and
-semantics to
+devices that support the SCSI EXTENDED COPY (XCOPY) command. Similar syntax
+and semantics to
.B dd(1)
but with no "conversions" is supported.
.PP
The first group in the synopsis above are "standard" Unix
.B dd(1)
operands. The second group are extra options added by this utility.
-Both groups are defined below.
+Both groups are defined below in combined, alphabetical order.
+.PP
+By default the XCOPY command is sent to \fIIFILE\fR. This can be changed
+with the \fI\-\-on_dst\fR option which causes the XCOPY command to be sent
+to \fIOFILE\fR instead.
.SH OPTIONS
.TP
\fBbpt\fR=\fIBPT\fR
@@ -139,16 +143,21 @@ A value of 1 reports extra information that is not repetitive. A value
repetitive. Values of 3 and 4 yield output for all SCSI commands (and
Unix read() and write() calls) so there can be a lot of output.
.TP
-\fB\-\-help\fR
+\fB\-h\fR, \fB\-\-help\fR
outputs usage message and exits.
.TP
-\fB\-\-version\fR
-outputs version number information and exits.
+\fB\-\-on_dst\fR
+send the XCOPY command to the output file/device.
.TP
-\fB\-h\fR
-outputs usage message and exits.
+\fB\-\-on_src\fR
+send the XCOPY command to the input file/device. This is the default when
+this option and \fI\-\-on_dst\fR are not given.
.TP
-\fB\-V\fR
+\fB\-v\fR, \fB\-\-verbose\fR
+equivalent to \fIverbose=1\fR. When used twice, equivalent to
+\fIverbose=2\fR, etc.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
outputs version number information and exits.
.SH FLAGS
Here is a list of flags and their meanings:
@@ -234,7 +243,7 @@ The status of the SCSI EXTENDED COPY command can be queried with
.PP
Currently only block\-to\-block transfers are implemented; \fIIFILE\fR
and \fIOFILE\fR must refer to a SCSI block device.
-PP
+.PP
No account is taken of partitions so, for example, /dev/sbc2, /dev/sdc,
/dev/sg2, and /dev/bsg/3:0:0:1 would all refer to the same thing: the
whole logical unit (i.e. the whole disk) starting at LBA 0. So any
diff --git a/doc/sginfo.8 b/doc/sginfo.8
index 5f4e8000..8d570b10 100644
--- a/doc/sginfo.8
+++ b/doc/sginfo.8
@@ -1,4 +1,4 @@
-.TH SGINFO "8" "February 2012" "sg3_utils\-1.34" SG3_UTILS
+.TH SGINFO "8" "May 2013" "sg3_utils\-1.36" SG3_UTILS
.SH NAME
sginfo \- access mode page information for a SCSI (or ATAPI) device
.SH SYNOPSIS
@@ -18,11 +18,14 @@ information. If permitted, mode page information can be altered. In
addition information from the INQUIRY and READ DEFECTS commands are also
available.
.PP
-Those interested in SCSI mode pages may find the
+This utility is in legacy mode, only obvious bugs will be fixed. Options
+like \fI\-l\fR (to list devices) are broken in recent versions of
+Linux (e.g. 2.6 series and later); the lsscsi(8) utility can be used
+instead. Also mode pages are not being updated as http://www.t10.org
+adds and modifies mode page fields. Those interested in SCSI mode pages
+may find the
.B sdparm
-utility easier use, especially for changing parameters. Also the author
-considers this utility legacy so the mode pages are not being updated
-as http://www.t10.org adds and modifies mode page fields.
+utility more up to date and easier use, especially for changing parameters.
.PP
Four sets of values are maintained by a SCSI device for each mode
page: current (active), default (manufacturer's supplied values),
@@ -113,7 +116,9 @@ Display the response to a standard INQUIRY command.
Access the Informational Exceptions mode page.
.TP
\fB\-l\fR
-List known SCSI devices on the system.
+Deprecated. Only use in old versions of Linux (e.g. 2.4 and
+earlier). Please use lsscsi(8) in the Linux 2.6 series and
+later. List known SCSI devices on the system.
.TP
\fB\-n\fR
Access information in the Notch and Partition mode page.
@@ -316,5 +321,5 @@ version 2.25 of sginfo.
This software is distributed under the GPL version 2. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH "SEE ALSO"
-.B scsiinfo(internet); sg_modes, sg_inq, sg_vpd (sg3_utils),
+.B lsscsi(lsscsi), scsiinfo(internet); sg_modes, sg_inq, sg_vpd (sg3_utils),
.B sdparm(sdparm)