aboutsummaryrefslogtreecommitdiff
path: root/doc/sg_xcopy.8
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/sg_xcopy.8
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/sg_xcopy.8')
-rw-r--r--doc/sg_xcopy.837
1 files changed, 23 insertions, 14 deletions
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