diff options
author | Douglas Gilbert <dgilbert@interlog.com> | 2022-04-21 02:37:15 +0000 |
---|---|---|
committer | Douglas Gilbert <dgilbert@interlog.com> | 2022-04-21 02:37:15 +0000 |
commit | 8cd2200ba1758cd127a1b95ab1808cde4f56713c (patch) | |
tree | 81f7e8e9c995548351865b77c13092ebf40d7174 /doc | |
parent | f26bb872bf4f043a1b817c808a6947fcb03ecda4 (diff) | |
download | sg3_utils-8cd2200ba1758cd127a1b95ab1808cde4f56713c.tar.gz |
sg_opcodes: add --inhex=FN to process earlier -HHH, add experimental --json[=JO] option; sg_turs: change nanosleep() to Sleep() in MinGW
git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@945 6180dd3e-e324-4e3e-922d-17de1ae2f315
Diffstat (limited to 'doc')
-rw-r--r-- | doc/sg_logs.8 | 5 | ||||
-rw-r--r-- | doc/sg_opcodes.8 | 48 |
2 files changed, 39 insertions, 14 deletions
diff --git a/doc/sg_logs.8 b/doc/sg_logs.8 index 84ccccd1..60f4faa6 100644 --- a/doc/sg_logs.8 +++ b/doc/sg_logs.8 @@ -1,4 +1,4 @@ -.TH SG_LOGS "8" "March 2022" "sg3_utils\-1.48" SG3_UTILS +.TH SG_LOGS "8" "April 2022" "sg3_utils\-1.48" SG3_UTILS .SH NAME sg_logs \- access log pages with SCSI LOG SENSE command .SH SYNOPSIS @@ -184,6 +184,9 @@ arranged as 1 or 2 digits representing a byte each of which is whitespace or comma separated. Anything from and including a hash mark to the end of line is ignored. If the \fI\-\-raw\fR option is also given then \fIFN\fR is treated as binary. +.br +For compatibility with other utilities in this package "inhex" may also be +used as this (long) option name. .TP \fB\-l\fR, \fB\-\-list\fR lists the names of the logs sense pages supported by this device. This is diff --git a/doc/sg_opcodes.8 b/doc/sg_opcodes.8 index bdae3b5c..e7a1f19d 100644 --- a/doc/sg_opcodes.8 +++ b/doc/sg_opcodes.8 @@ -1,19 +1,20 @@ -.TH SG_OPCODES "8" "October 2021" "sg3_utils\-1.47" SG3_UTILS +.TH SG_OPCODES "8" "April 2022" "sg3_utils\-1.48" SG3_UTILS .SH NAME sg_opcodes \- report supported SCSI commands or task management functions .SH SYNOPSIS .B sg_opcodes [\fI\-\-alpha\fR] [\fI\-\-compact\fR] [\fI\-\-enumerate\fR] [\fI\-\-help\fR] -[\fI\-\-hex\fR] [\fI\-\-mask\fR] [\fI\-\-mlu\fR] [\fI\-\-no-inquiry\fR] -[\fI\-\-opcode=OP[,SA]\fR] [\fI\-\-pdt=DT\fR] [\fI\-\-raw\fR] -[\fI\-\-rctd\fR] [\fI\-\-repd\fR] [\fI\-\-sa=SA\fR] [\fI\-\-tmf\fR] -[\fI\-\-unsorted\fR] [\fI\-\-verbose\fR] [\fI\-\-version\fR] \fIDEVICE\fR +[\fI\-\-hex\fR] [\fI\-\-inhex=FN\fR] [\fI\-\-json[=JO\fR]] [\fI\-\-mask\fR] +[\fI\-\-mlu\fR] [\fI\-\-no-inquiry\fR] [\fI\-\-opcode=OP[,SA]\fR] +[\fI\-\-pdt=DT\fR] [\fI\-\-raw\fR] [\fI\-\-rctd\fR] [\fI\-\-repd\fR] +[\fI\-\-sa=SA\fR] [\fI\-\-tmf\fR] [\fI\-\-unsorted\fR] [\fI\-\-verbose\fR] +[\fI\-\-version\fR] \fIDEVICE\fR .PP .B sg_opcodes -[\fI\-a\fR] [\fI\-c\fR] [\fI\-e\fR] [\fI\-H\fR] [\fI\-m\fR] [\fI\-M\fR] -[\fI\-n\fR] [\fI\-o=OP\fR] [\fI\-p=DT\fR] [\fI\-q\fR] [\fI\-R\fR] -[\fI\-s=SA\fR] [\fI\-t\fR] [\fI\-u\fR] [\fI\-v\fR] [\fI\-V\fR] [\fI\-?\fR] -\fIDEVICE\fR +[\fI\-a\fR] [\fI\-c\fR] [\fI\-e\fR] [\fI\-H\fR] [\fI\-i=FN\fR] [\fI\-j\fR] +[\fI\-m\fR] [\fI\-M\fR] [\fI\-n\fR] [\fI\-o=OP\fR] [\fI\-p=DT\fR] [\fI\-q\fR] +[\fI\-R\fR] [\fI\-s=SA\fR] [\fI\-t\fR] [\fI\-u\fR] [\fI\-v\fR] [\fI\-V\fR] +[\fI\-?\fR] \fIDEVICE\fR .SH DESCRIPTION .\" Add any additional description here .PP @@ -74,7 +75,27 @@ outputs the usage message summarizing command line options then exits. Ignores \fIDEVICE\fR if given. .TP \fB\-H\fR, \fB\-\-hex\fR -outputs the response in ASCII hexadecimal to stdout. +outputs the response in ASCII hexadecimal to stdout. When used once or +twice, each line starts with a relative (hex) address starting at 0 +on the first hex line output. The difference is when used twice the +hexadecimal bytes are rendered in ASCII at the right of each line; +non\-printable characters are replaced by "." . +.br +When used three or more times, there is no leading relative address +on each line. This output is suitable for being redirected to a file +which can later by given to the \fI\-\-inhex=FN\fR option. +.TP +\fB\-i\fR, \fB\-\-inhex\fR=\fIFN\fR +where \fIFN\fR is a file name whose contents are assumed to be ASCII +hexadecimal. If \fIDEVICE\fR is also given then \fIDEVICE\fR is ignored, +a warning is issued and the utility continues, decoding the file named +\fIFN\fR. See the "FORMAT OF FILES CONTAINING ASCII HEX" section in the +sg3_utils manpage for more information. If the \fI\-\-raw\fR option is +also given then the contents of \fIFN\fR are treated as binary. +.TP +\fB\-j\fR, \fB\-\-json[\fR=\fIJO\fR] +output is in JSON format instead of human readable form. This is an +EXPERIMENTAL feature; more information to follow. .TP \fB\-m\fR, \fB\-\-mask\fR additionally prints out the cdb mask in hex. So a 12 byte cdb will have @@ -127,8 +148,9 @@ suppress this utility doing an INQUIRY command since the main reason for doing that is to find the peripheral device type of the \fIDEVICE\fR. .TP \fB\-r\fR, \fB\-\-raw\fR -output the response in binary to stdout. Error messages and warnings, if -any, are sent to stderr. +output response in binary (to stdout) unless the \fI\-\-inhex=FN\fR option +is also given. In that case the input file name (\fIFN\fR) is decoded as +binary (and the output is _not_ in binary (but may be hex)). .TP \fB\-R\fR, \fB\-\-rctd\fR set report command timeout descriptor (RCTD) bit in the cdb. The response @@ -309,7 +331,7 @@ Written by Douglas Gilbert .SH "REPORTING BUGS" Report bugs to <dgilbert at interlog dot com>. .SH COPYRIGHT -Copyright \(co 2004\-2021 Douglas Gilbert +Copyright \(co 2004\-2022 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. |