aboutsummaryrefslogtreecommitdiff
path: root/doc/sg_rep_zones.8
diff options
context:
space:
mode:
authorDouglas Gilbert <dgilbert@interlog.com>2014-05-27 23:26:04 +0000
committerDouglas Gilbert <dgilbert@interlog.com>2014-05-27 23:26:04 +0000
commit4d770f100b237146adc51e9f4bdd194e83252d50 (patch)
treefa2f096759f5d40aadd57d15e3798fb2a796b859 /doc/sg_rep_zones.8
parenteebe59ce63d30da476a04e294a3c06ff5ae20aab (diff)
downloadsg3_utils-4d770f100b237146adc51e9f4bdd194e83252d50.tar.gz
new utils: sg_rep_zones+sg_reset_wp; new Linux udev scripts; sg_inq --export work; sg_logs lto5+6 work
git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@584 6180dd3e-e324-4e3e-922d-17de1ae2f315
Diffstat (limited to 'doc/sg_rep_zones.8')
-rw-r--r--doc/sg_rep_zones.872
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/sg_rep_zones.8 b/doc/sg_rep_zones.8
new file mode 100644
index 00000000..fe111606
--- /dev/null
+++ b/doc/sg_rep_zones.8
@@ -0,0 +1,72 @@
+.TH SG_REP_ZONES "8" "May 2014" "sg3_utils\-1.39" SG3_UTILS
+.SH NAME
+sg_rep_zones \- send SCSI REPORT ZONES command
+.SH SYNOPSIS
+.B sg_rep_zones
+[\fI\-\-help\fR] [\fI\-\-hex\fR] [\fI\-\-maxlen=LEN\fR] [\fI\-\-raw\fR]
+[\fI\-\-readonly\fR] [\fI\-\-report=OPT\fR] [\fI\-\-start=LBA\fR]
+[\fI\-\-verbose\fR] [\fI\-\-version\fR] \fIDEVICE\fR
+.SH DESCRIPTION
+.\" Add any additional description here
+.PP
+Sends a SCSI REPORT ZONES command to \fIDEVICE\fR and outputs the data
+returned. This command is found in the ZBC draft standard whose most
+recent revision is 1a.
+.SH OPTIONS
+Arguments to long options are mandatory for short options as well.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+output the usage message then exit.
+.TP
+\fB\-H\fR, \fB\-\-hex\fR
+output the response in hexadecimal to stdout. When used once the whole
+response is output in ASCII hexadecimal with a leading address (starting at
+0) on each line. When used twice each zone descriptor in the response is
+output separately in hexadecimal. When used thrice the whole response is
+output in hexadecimal with no leading address (on each line).
+.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)
+then 8192 is used. The maximum allowed value of \fILEN\fR is 1048576.
+.TP
+\fB\-r\fR, \fB\-\-raw\fR
+output the SCSI response (i.e. the data-out buffer) in binary (to stdout).
+.TP
+\fB\-R\fR, \fB\-\-readonly\fR
+open the \fIDEVICE\fR read\-only (e.g. in Unix with the O_RDONLY flag).
+The default is to open it read\-write.
+.TP
+\fB\-o\fR, \fB\-\-report\fR=\fIOPT\fR
+where \fIOPT\fR will become the contents of the REPORTING OPTION field
+in the cdb. The default value is 0 which means report a list or all zones.
+Some other values are 1 for list full zones; 2 for list all open zones; 3
+for list all empty zones; 4 for list all read only zones; 5 for list all
+offline zones; and 6 for list all zones with the RESET bit set.
+.TP
+\fB\-s\fR, \fB\-\-start\fR=\fILBA\fR
+where \fILBA\fR is a zone start logical block address (LBA) of the first
+zone to be reported. The default value is 0. \fILBA\fR must be a zone
+start LBA otherwise an ILLEGAL REQUEST sense key is returned. Assumed to be
+in decimal unless prefixed with '0x' or has a trailing 'h' which indicate
+hexadecimal.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+increase the level of verbosity, (i.e. debug output).
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+print the version string and then exit.
+.SH EXIT STATUS
+The exit status of sg_rep_zones is 0 when it is successful. Otherwise see
+the sg3_utils(8) man page.
+.SH AUTHORS
+Written by Douglas Gilbert.
+.SH "REPORTING BUGS"
+Report bugs to <dgilbert at interlog dot com>.
+.SH COPYRIGHT
+Copyright \(co 2014 Douglas Gilbert
+.br
+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 sg_reset_wp(sg3_utils)