sg_persist+sg_unmap: fix crash on option decode; sg_logs: expand for tape; sg_xcopy+: clean
git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@500 6180dd3e-e324-4e3e-922d-17de1ae2f315
diff --git a/doc/sg_xcopy.8 b/doc/sg_xcopy.8
index 231c83c..7ffdc0e 100644
--- a/doc/sg_xcopy.8
+++ b/doc/sg_xcopy.8
@@ -1,4 +1,4 @@
-.TH SG_XCOPY "8" "May 2013" "sg3_utils\-1.36" SG3_UTILS
+.TH SG_XCOPY "8" "June 2013" "sg3_utils\-1.37" SG3_UTILS
.SH NAME
sg_xcopy \- copy data to and from files and devices using SCSI EXTENDED
COPY (XCOPY)
@@ -10,15 +10,25 @@
[\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]
+[\fIid_usage=\fR{hold|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 (XCOPY) command. Similar syntax
-and semantics to
+devices that support the SCSI EXTENDED COPY (XCOPY) command.
+.PP
+During the draft stages of SPC\-4 the T10 committee has expanded the XCOPY
+command so that it now has two variants: "LID1" (for a List Identifier
+length of 1 byte) and "LID4" (for a List Identifier length of 4 bytes).
+This utility supports the older, LID1 variant which is also found in SPC\-3
+and earlier. While the LID1 variant in SPC\-4 is command level (binary)
+compatible with XCOPY as defined in SPC\-3, some of the command naming has
+changed. This utility uses the older, SPC\-3 XCOPY names.
+.PP
+This utility
+has similar syntax and semantics to
.B dd(1)
but with no "conversions" is supported.
.PP
@@ -50,14 +60,14 @@
which permits \fIBS\fR to be an integral multiple. Defaults to the
device block size.
.TP
-\fBcat\fR=0 | 1
+\fBcat\fR={0|1}
sets the SCSI EXTENDED COPY command segment descriptor CAT bit to 0 or
1 (default: 0). The CAT bit (in conjunction with the PAD bit) controls
the handling of residual data. See section
.B HANDLING OF RESIDUAL DATA
for details.
.TP
-\fBdc\fR=0 | 1
+\fBdc\fR={0|1}
sets the SCSI EXTENDED COPY command segment descriptor DC bit to 0 or
1 (default: 0). The DC bit controls whether \fICOUNT\fR
refers to the source (\fIdc=0\fR) or the target (\fIdc=1\fR) descriptor.
@@ -82,7 +92,7 @@
\fBibs\fR=\fIBS\fR
if given must be the same as \fIBS\fR given to 'bs=' option.
.TP
-\fBid_usage\fR=hold | discard | disable
+\fBid_usage\fR={hold|discard|disable}
sets the SCSI EXTENDED COPY command parameter list field called LIST ID
USAGE to 0 if the argument is 'hold', to 2 if the argument is 'discard',
or to '3' if the argument is 'disable'.
@@ -130,7 +140,7 @@
start reading \fISKIP\fR bs\-sized blocks from the start of \fIIFILE\fR.
Default is block 0 (i.e. start of file).
.TP
-\fBtime\fR=0 | 1
+\fBtime\fR={0|1}
when 1, times transfer and does throughput calculation, outputting the
results (to stderr) at completion. When 0 (default) doesn't perform timing.
.TP
