aboutsummaryrefslogtreecommitdiff
path: root/doc/scsi_ready.8
diff options
context:
space:
mode:
authorDouglas Gilbert <dgilbert@interlog.com>2009-10-01 22:08:56 +0000
committerDouglas Gilbert <dgilbert@interlog.com>2009-10-01 22:08:56 +0000
commit11245306e7a00a4c77c7f1b400acdff4cf5b8201 (patch)
treebd37d8f113cc11eec86840585171ada96c43a90f /doc/scsi_ready.8
parent86d6bf41d9d7e7e60aceaf3ffad5bffd9b0821f1 (diff)
downloadsg3_utils-11245306e7a00a4c77c7f1b400acdff4cf5b8201.tar.gz
correct sg_get_lba_status parameter data length calculation; script doco and cleanup
git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@308 6180dd3e-e324-4e3e-922d-17de1ae2f315
Diffstat (limited to 'doc/scsi_ready.8')
-rw-r--r--doc/scsi_ready.840
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/scsi_ready.8 b/doc/scsi_ready.8
new file mode 100644
index 00000000..fd3e6b32
--- /dev/null
+++ b/doc/scsi_ready.8
@@ -0,0 +1,40 @@
+.TH SCSI_READY "8" "October 2009" "sg3_utils\-1.28" SG3_UTILS
+.SH NAME
+scsi_ready \- do SCSI TEST UNIT READY on devices
+.SH SYNOPSIS
+.B scsi_ready
+[\fI\-\-brief\fR] [\fI\-\-help\fR] [\fI\-\-verbose\fR]
+\fIDEVICE\fR [\fIDEVICE\fR]*
+.SH DESCRIPTION
+.\" Add any additional description here
+.PP
+This bourne shell script calls the sg_turs utility on each given
+\fIDEVICE\fR. This will send a SCSI TEST UNIT READY command to each
+\fIDEVICE\fR. Disks, tape drives and DVD/BD players amongst others
+may respond to this SCSI command.
+.SH OPTIONS
+Arguments to long options are mandatory for short options as well.
+.TP
+\fB\-b\fR, \fB\-\-brief\fR
+for each \fIDEVICE\fR given output a line containing either ' ready'
+or ' device not ready'. If \fIDEVICE\fR is not found or there is
+another serious error then an error message will appear instead.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print out the usage message then exit.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+increase level or verbosity.
+.SH EXIT STATUS
+The exit status of this script is 0 when it is successful. Otherwise the
+exit status is that of the last sg_turs utility called. See
+the sg3_utils(8) man page.
+.SH AUTHORS
+Written by D. Gilbert
+.SH COPYRIGHT
+Copyright \(co 2009 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_turs (sg3_utils)