From 270cd7304dd379ee490df57120d281641c292398 Mon Sep 17 00:00:00 2001 From: Douglas Gilbert Date: Tue, 19 Jul 2022 04:02:56 +0000 Subject: another round of sgj_* function renaming; sg_inq+sg_vpd: add new Block Limits VPD page code git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@961 6180dd3e-e324-4e3e-922d-17de1ae2f315 --- doc/sg3_utils.8 | 19 +++++++++++++------ doc/sg3_utils_json.8 | 11 ++++++++--- doc/sg_inq.8 | 2 +- 3 files changed, 22 insertions(+), 10 deletions(-) (limited to 'doc') diff --git a/doc/sg3_utils.8 b/doc/sg3_utils.8 index 92fd1d33..ab592361 100644 --- a/doc/sg3_utils.8 +++ b/doc/sg3_utils.8 @@ -754,18 +754,25 @@ hexadecimal values separated by whitespace. "Whitespace consists of either spaces, tabs, blank lines, or any combination thereof". Hyphens (e.g. '\-') are also allowed as separators. Each one or two digit ASCII hex pair is decoded into a byte (i.e. 8 bits). The following will be decoded to -valid (ascending valued) bytes: '0', '01', '3', 'c', 'F', '4a', 'cC', 'ff'. -Lines containing only whitespace are ignored. The contents of any line -containing a hash mark ('#') is ignored from that point until the end of that -line. Users are encouraged to use hash marks to introduce comments in hex -files. The author uses the extension'.hex' on such files. Examples can be -found in the 'inhex' directory. +valid (ascending valued) bytes: '0', '01', '3', 'c', 'F', '4a', 'cC' +and 'ff'. Lines containing only whitespace are ignored. The contents of any +line containing a hash mark ('#') are ignored from that point until the end +of that line. Users are encouraged to use hash marks to introduce comments +in hex files. The author uses the extension '.hex' on such files. Examples +can be found in the 'inhex' directory. Note that this format does _not_ +have an index (counter) value at the beginning of each line (like, for +example, the hexdump utility outputs). .PP The hexadecimal format described in the previous paragraph can be converted to binary using the sg_decode_sense utility with these options: "\fI\-\-inhex=HFN \-\-nodecode \-\-write=WFN\fR". The input (in hex) is in the \fIHFN\fR file while the output is placed in the \fIWFN\fR file. +.PP +To convert a binary file into a hexadecimal form that can be given as input +to various sg3_utils utilities, the sg_decode_sense utility can also be +used with these options: "\fI\-\-binary=BFN \-\-nodecode \-HHH\fR" and the +hex output will be sent to the console (stdout). .SH MICROCODE AND FIRMWARE There are two standardized methods for downloading microcode (i.e. device firmware) to a SCSI device. The more general way is with the SCSI WRITE diff --git a/doc/sg3_utils_json.8 b/doc/sg3_utils_json.8 index e8080b59..be2983a6 100644 --- a/doc/sg3_utils_json.8 +++ b/doc/sg3_utils_json.8 @@ -263,14 +263,19 @@ As stated above, the default output is in human readable form using 7 bit ASCII. The \fI\-\-json[=JO]\fR option is designed to be an alternative to that human readable form. There are other alternative output formats such as the response output as a hexadecimal sequence of bytes or -in "raw" binary; both of those take precedence over the \fI\-\-json[=JO]\fR -option. Other specialized output format (e.g. 'sg_inq \-\-export') will -usually take precedence over JSON output. +in "raw" binary output; both of those take precedence over the +\fI\-\-json[=JO]\fR option. Other specialized output +format (e.g. 'sg_inq \-\-export') will usually take precedence over JSON +output. .PP When the \fI\-\-raw\fR option is used together with the \fI\-\-inhex=FN\fR option only the data input to the utility is interpreted as binary. So the output format defaults to human readable form and thus can be changed to JSON if the \fI\-\-json[=JO]\fR option is also used. +.PP +There is typically only one form of JSON output so options like +\fI\-\-brief\fR and \fI\-\-quiet\fR are ignored in the JSON output. In some +cases (i.e 'sg_inq \-\-descriptors') the JSON output is expanded. .SH AUTHORS Written by Douglas Gilbert. Some utilities have been contributed, see the CREDITS file and individual source files (in the 'src' directory). diff --git a/doc/sg_inq.8 b/doc/sg_inq.8 index 759d7165..a7b4ef9f 100644 --- a/doc/sg_inq.8 +++ b/doc/sg_inq.8 @@ -1,4 +1,4 @@ -.TH SG_INQ "8" "January 2022" "sg3_utils\-1.48" SG3_UTILS +.TH SG_INQ "8" "July 2022" "sg3_utils\-1.48" SG3_UTILS .SH NAME sg_inq \- issue SCSI INQUIRY command and/or decode its response .SH SYNOPSIS -- cgit v1.2.3