| .TH SG_TURS "8" "May 2014" "sg3_utils\-1.39" SG3_UTILS |
| .SH NAME |
| sg_turs \- send one or more SCSI TEST UNIT READY commands |
| .SH SYNOPSIS |
| .B sg_turs |
| [\fI\-\-help\fR] [\fI\-\-number=NUM\fR] [\fI\-\-progress\fR] [\fI\-\-time\fR] |
| [\fI\-\-verbose\fR] [\fI\-\-version\fR] \fIDEVICE\fR |
| .PP |
| .B sg_turs |
| [\fI\-n=NUM\fR] [\fI\-p\fR] [\fI\-t\fR] [\fI\-v\fR] [\fI\-V\fR] |
| \fIDEVICE\fR |
| .SH DESCRIPTION |
| .\" Add any additional description here |
| .PP |
| This utility sends one or more SCSI TEST UNIT READY commands to the |
| \fIDEVICE\fR. This may be useful for timing the per command overhead. |
| Note that TEST UNIT READY has no associated data, just a 6 byte command |
| and a returned SCSI status value. |
| .PP |
| This utility supports two command line syntaxes, the preferred one is |
| shown first in the synopsis and explained in this section. A later section |
| on the old command line syntax outlines the second group of options. |
| .SH OPTIONS |
| Arguments to long options are mandatory for short options as well. |
| .TP |
| \fB\-h\fR, \fB\-\-help\fR |
| print out the usage message then exit. |
| .TP |
| \fB\-n\fR, \fB\-\-number\fR=\fINUM\fR |
| performs TEST UNIT READY \fINUM\fR times. If not given defaults to 1. |
| These suffix multipliers are permitted: c C *1; w W *2; b B *512; |
| k K KiB *1,024; KB *1,000; m M MiB *1,048,576; MB *1,000,000; |
| g G GiB *1,073,741,824; and GB *1,000,000,000 . Also a suffix of the |
| form "x<n>" multiplies the leading number by <n>. Alternatively a hex |
| number may be given, prefixed by either '0x' or has a trailing 'h'. |
| .TP |
| \fB\-O\fR, \fB\-\-old\fR |
| switch to older style options. |
| .TP |
| \fB\-p\fR, \fB\-\-progress\fR |
| show progress indication (a percentage) if available. If \fI\-\-number=NUM\fR |
| is given, \fINUM\fR is greater than 1 and an initial progress indication |
| was detected then this utility waits 30 seconds before subsequent checks. |
| Exits when \fINUM\fR is reached or there are no more progress indications. |
| Ignores \fI\-\-time\fR option. See NOTES section below. |
| .TP |
| \fB\-t\fR, \fB\-\-time\fR |
| after completing the requested number of TEST UNIT READY commands, outputs |
| the total duration and the average number of commands executed per second. |
| .TP |
| \fB\-v\fR, \fB\-\-verbose\fR |
| increase level or verbosity. |
| .TP |
| \fB\-V\fR, \fB\-\-version\fR |
| print version string then exit. |
| .SH NOTES |
| The progress indication is optionally part of the sense data. When a prior |
| command that takes a long time to complete (and typically precludes other |
| media access commands) is still underway, the progress indication can be used |
| to determine how long before the device returns to its normal state. |
| .PP |
| The SCSI FORMAT command for disks used with the IMMED bit set is an example |
| of an operation that takes a significant amount of time and precludes other |
| media access during that time. The IMMED bit set instructs the FORMAT command |
| to return control to the application client once the format has commenced (see |
| SBC\-3). Several long duration SCSI commands associated with tape drives also |
| use the progress indication (see SSC\-3). |
| .PP |
| The \fIDEVICE\fR is opened with a read\-only flag (e.g. in Unix with the |
| O_RDONLY flag). |
| .PP |
| Early standards suggested that the SCSI TEST UNIT READY command be used for |
| polling the progress indication. More recent standards seem to suggest |
| the SCSI REQUEST SENSE command should be used instead. |
| .SH EXIT STATUS |
| The exit status of sg_turs is 0 when it is successful (e.g. in the case of |
| a mechanical disk, it is spun up and ready to accept commands). For this |
| utility the other exit status of interest is 2 corresponding to |
| the "not ready" sense key. For other exit status values see the sg3_utils(8) |
| man page. |
| .SH OLDER COMMAND LINE OPTIONS |
| The options in this section were the only ones available prior to sg3_utils |
| version 1.23 . In sg3_utils version 1.23 and later these older options can |
| be selected by either setting the SG3_UTILS_OLD_OPTS environment variable |
| or using '\-\-old' (or '\-O) as the first option. |
| .TP |
| \fB\-n\fR=\fINUM\fR |
| performs TEST UNIT READY \fINUM\fR times. If not given defaults to 1. |
| Equivalent to \fI\-\-number=NUM\fR in the main description. |
| .TP |
| \fB\-N\fR |
| switch to the newer style options. |
| .TP |
| \fB\-p\fR |
| show progress indication (a percentage) if available. |
| Equivalent to \fI\-\-progress\fR in the main description. |
| .TP |
| \fB\-t\fR |
| after completing the requested number of TEST UNIT READY commands, outputs |
| the total duration and the average number of commands executed per second. |
| Equivalent to \fI\-\-time\fR in the main description. |
| .TP |
| \fB\-v\fR |
| increase level of verbosity. |
| .TP |
| \fB\-V\fR |
| print out version string then exit. |
| .SH AUTHORS |
| Written by D. Gilbert |
| .SH COPYRIGHT |
| Copyright \(co 2000\-2014 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. |
| .SH "SEE ALSO" |
| .B sg_inq, sg_request (sg3_utils) |