diff options
Diffstat (limited to 'sg_ident.8')
| -rw-r--r-- | sg_ident.8 | 88 |
1 files changed, 44 insertions, 44 deletions
@@ -1,86 +1,86 @@ -.TH SG_IDENT "8" "October 2006" "sg3_utils-1.22" SG3_UTILS +.TH SG_IDENT "8" "January 2007" "sg3_utils\-1.23" SG3_UTILS .SH NAME -sg_ident \- report or set identifying information +sg_ident \- sends a SCSI REPORT or SET IDENTIFYING INFORMATION command .SH SYNOPSIS .B sg_ident -[\fI--ascii\fR] [\fI--clear\fR] [\fI--help\fR] [\fI--itype=<n>\fR] -[\fI--raw\fR] [\fI--set\fR] [\fI--verbose\fR] [\fI--version\fR] -\fI<scsi_device>\fR +[\fI\-\-ascii\fR] [\fI\-\-clear\fR] [\fI\-\-help\fR] [\fI\-\-itype=IT\fR] +[\fI\-\-raw\fR] [\fI\-\-set\fR] [\fI\-\-verbose\fR] [\fI\-\-version\fR] +\fIDEVICE\fR .SH DESCRIPTION .\" Add any additional description here .PP -Send a REPORT IDENTIFYING INFORMATION or SET IDENTIFYING INFORMATION -SCSI command to the given device. Prior to SPC-4 (revison 7) these +Send a SCSI REPORT IDENTIFYING INFORMATION or SET IDENTIFYING INFORMATION +command to \fIDEVICE\fR. Prior to SPC\-4 (revison 7) these commands were called REPORT DEVICE IDENTIFIER and SET DEVICE IDENTIFIER respectively. SCSI devices that support these two commands allow users to write (set) identifying information and report it back at some later time. The information is persistent (i.e. stored on some -non-volatile medium within the SCSI device that will survive a power +non\-volatile medium within the SCSI device that will survive a power outage). .PP Typically the space allocated for the information is limited: -SPC-4 (revision 7) states that for information type 0, the minimum +SPC\-4 (revision 7) states that for information type 0, the minimum length is 64 bytes and the maximum is 512 bytes. For other information types (1 to 126 inclusive) the maximum length is 256 bytes. Also information types 1 to 126 (inclusive) should contain a null -terminated UTF-8 string. The author has seen older disks that only +terminated UTF\-8 string. The author has seen older disks that only support 16 bytes. .PP The default action when no options are given is to invoke the Report Identifying Information command with the information type defaulting to zero. Error reports are sent to stderr. By default the information is -shown in ASCII-HEX (up to 16 bytes per line) with an ASCII representation +shown in ASCII\-HEX (up to 16 bytes per line) with an ASCII representation to the right with dots replacing non printable characters. +.SH OPTIONS +Arguments to long options are mandatory for short options as well. .TP ---ascii | -A +\fB\-A\fR, \fB\-\-ascii\fR invokes the Report Identifying Information command and if anything is -found interprets it as ASCII (or UTF-8 depending on the locale) +found interprets it as ASCII (or UTF\-8 depending on the locale) and prints the information to stdout. .TP ---clear | -C +\fB\-C\fR, \fB\-\-clear\fR invokes the Set Identifying Information command with an information length of zero. This has the effect of clearing the existing information. .TP ---help | -h +\fB\-h\fR, \fB\-\-help\fR output the usage message then exit. .TP ---itype=<n> | -i <n> -sets the information type. Defaults to zero. The maximum value is -127 which is special and cannot be used with '--set' or '--clear'. -The information type of 127 (if supported) causes the REPORT IDENTIFYING -INFORMATION command to respond with a list of available information -types and their maximum lengths in bytes. The odd numbered information -types between 3 and 125 (inclusive) are not to be used (as they clash -with the SCC-2 standard). +\fB\-i\fR, \fB\-\-itype\fR=\fIIT\fR +where \fIIT\fR is the information type. Defaults to zero. The maximum value +is 127 which is special and cannot be used with \fI\-\-set\fR or +\fI\-\-clear\fR. The information type of 127 (if supported) causes the REPORT +IDENTIFYING INFORMATION command to respond with a list of available +information types and their maximum lengths in bytes. The odd numbered +information types between 3 and 125 (inclusive) are not to be used (as they +clash with the SCC\-2 standard). .TP ---raw | -r +\fB\-r\fR, \fB\-\-raw\fR invokes the Report Identifying information command and if anything is found sends the information (which may be binary) to stdout. Nothing else is sent to stdout however error reports, if any, are sent to stderr. .TP ---set | -S -first read stdin until an EOF is detected then invokes the Set Identifying +\fB\-S\fR, \fB\-\-set\fR +first reads stdin until an EOF is detected then invokes the Set Identifying Information command to set what has been fetched from stdin as the information. The amount of data read must be between 1 and 512 bytes length (inclusive). .TP ---verbose | -v +\fB\-v\fR, \fB\-\-verbose\fR increase the level of verbosity, (i.e. debug output). .TP ---version | -V +\fB\-V\fR, \fB\-\-version\fR print the version string and then exit. .PP -This utility facilitates users writing their own information to +This utility permits users to write their own identifying information to their SCSI devices. There are several other types of descriptors (or -designators) that the user cannot change. These include the SCSI -INQUIRY command with its standard vendor and product identification -strings and the product revision level; plus the large amount of -information provided by the "Device Identification" VPD page (see -sg_vpd). -There is also the READ MEDIA SERIAL NUMBER command (see sg_rmsn). -The MMC-4 command set for CDs and DVDs has a "media serial number" -feature (0x109) [and a "logical unit serial number" feature]. These -can be viewed with sg_get_config. +designators) that the user cannot change. These include the SCSI INQUIRY +command with its standard vendor and product identification strings and the +product revision level; plus the large amount of information provided by +the "Device Identification" VPD page (see sg_vpd). There is also the READ +MEDIA SERIAL NUMBER command (see sg_rmsn). The MMC\-4 command set for CD +and DVDs has a "media serial number" feature (0x109) [and a "logical unit +serial number" feature]. These can be viewed with the sg_get_config utility. .SH EXAMPLES First, to see if there is an existing information whose format is unknown (for information type 0), use no options: @@ -91,18 +91,18 @@ is unknown (for information type 0), use no options: .PP If it is ASCII then it can printed as such: .PP - # sg_ident --ascii /dev/sdb + # sg_ident \-\-ascii /dev/sdb .br 1234567890 .PP The information can be copied to a file, cleared and then -re-asserted with this sequence: +re\-asserted with this sequence: .PP - # sg_ident --raw /dev/sdb > t + # sg_ident \-\-raw /dev/sdb > t .br - # sg_ident --clear /dev/sdb + # sg_ident \-\-clear /dev/sdb .br - # cat t | sg_ident --set /dev/sdb + # cat t | sg_ident \-\-set /dev/sdb .SH EXIT STATUS The exit status of sg_ident is 0 when it is successful. Otherwise see the sg3_utils(8) man page. @@ -111,7 +111,7 @@ Written by Douglas Gilbert. .SH "REPORTING BUGS" Report bugs to <dgilbert at interlog dot com>. .SH COPYRIGHT -Copyright \(co 2005-2006 Douglas Gilbert +Copyright \(co 2005\-2007 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. |