chiark / gitweb /
scsi_id: make sure, we do not have slashes in values
[elogind.git] / extras / scsi_id / scsi_id.8
index 69dd2a998ada9ca4ab58df578c6a6be8c5ee984e..5f4d997ce92b53dc870f095c4633583efefa8f6e 100644 (file)
@@ -17,7 +17,7 @@ with a non\-zero value.
 \fBscsi_id\fP is primarily for use by other utilities such as \fBudev\fP
 that require a unique SCSI identifier.
 
-By default all devices are assume black listed, the \fB\-g\fP option must
+By default all devices are assume black listed, the \fB\-\-whitelisted\fP option must
 be specified on the command line or in the config file for any useful
 behaviour.
 
@@ -33,7 +33,7 @@ by page 0x80. For example:
 
 .sp
 .nf
-# scsi_id -p 0x80 -s /block/sdg
+# /lib/udev/scsi_id \-\-page=0x80 \-\-whitelisted \-\-device=/dev/sda
 SIBM     3542           1T05078453
 .fi
 .P
@@ -45,102 +45,71 @@ identifier starts with the NAA value of 6):
 
 .sp
 .nf
-# /sbin/scsi_id -p 0x83 -s /block/sdg
+# /lib/udev/scsi_id \-\-page=0x83 \-\-whitelisted \-\-device=/dev/sda
 3600a0b80000b174b000000d63efc5c8c
 .fi
 .P
 
 .SH OPTIONS
 .TP
-.BI subsystem
-When called with only a single argument without a leading \-, runs in a hotplug
-mode, and expects the environment variable DEVPATH to specify the
-corresponding sysfs device. See section below on usage with \fBudev\fP.
-.TP
-.BI \-b
+.BI \-\-blacklisted
 The default behaviour \- treat the device as black listed, and do nothing
 unless a white listed device is found in the scsi_id config\-file.
 .TP
-.BI \-d "\| device\^"
-Instead
-of determining and creating a device node based on a sysfs dev
-entry as done for the \fB\-s\fP, send SG_IO commands to 
-\fBdevice\fP, such as \fB/dev/sdc\fP.
+.BI \-\-device=\| device\^
+Send SG_IO commands to \fBdevice\fP, such as \fB/dev/sdc\fP.
 .TP
-.BI \-f "\| config\-file"
+.BI \-\-config=\| config\-file
 Read configuration and black/white list entries from
 .B config\-file 
 rather than the default
 .B /etc/scsi_id.config
 file.
 .TP
-.BI \-g
-Treat the device as white listed. The \fB\-g\fP option must be specified
+.BI \-\-whitelisted
+Treat the device as white listed. The \fB\-\-whitelisted\fP option must be specified
 on the command line or in the scsi_id configuration file for 
 .B scsi_id
 to generate any output.
 .TP
-.BI \-i
-Prefix the identification string with the  driver model (sysfs) bus id of
-the SCSI device.
+.BI \-\-page=\| 0x80 | 0x83 | pre-spc3-83
+Use SCSI INQUIRY VPD page code 0x80, 0x83, or pre-spc3-83.
+.sp
+The default
+behaviour is to query the available VPD pages, and use page 0x83 if found,
+else page 0x80 if found, else nothing.
+.sp
+Page pre-spc3-83 should only be utilized for those scsi devices which
+are not compliant with the SPC-2 or SPC-3 format for page 83.  While this
+option is used for older model 4, 5, and 6 EMC Symmetrix devices, its
+use with SPC-2 or SPC-3 compliant devices will fallback to the page 83
+format supported by these devices.
 .TP
-.BI \-p "\| 0x80 | 0x83"
-Use SCSI INQUIRY VPD page code 0x80 or 0x83. The default behaviour is to
-query the available VPD pages, and use page 0x83 if found, else page 0x80
-if found, else nothing.
+.BI \-\-replace-whitespace
+Reformat the output : replace all whitespaces by underscores.
 .TP
-.BI \-s "\| sysfs\-device"
-Generate an id for the
-.B sysfs\-device.
-The sysfs mount point must not be included. For example, use /block/sd,
-not /sys/block/sd.
+.BI \-\-export
+Export all data in KEY=<value> format used to import in other programs.
 .TP
-.BI \-v
+.BI \-\-verbose
 Generate verbose debugging output.
 .TP
-.BI \-V
+.BI \-\-version
 Display version number and exit.
 .RE
 
-.SH USAGE WITH UDEV 
-If \fBscsi_id\fP is invoked with one argument without a leading \-, it
-assumes it is called for a hotplug event, and looks for the sysfs device
-in the DEVPATH environment variable. 
-
-This mode is used when run via the \fBudev\fP PROGRAM key. Passing any
-arguments or options as part of the PROGRAM rule breaks this assumption,
-and the results will likely not be as expected.
-
-When in this mode, all errors and warnings are sent via syslog.
-
-To determine the specific value needed in a RESULT key, use the \-s option,
-for example:
-
-.sp
-.nf
-/sbin/scsi_id -s /block/sda
-.fi
-.P
-
-An example \fBudev\fP rule using \fBscsi_id\fP, that will name a block
-device and any partitions for the device matching the \fBscsi_id\fP output
-of 312345:
-
-.sp
-.nf
-BUS="scsi", PROGRAM="/sbin/scsi_id", RESULT="312345", NAME="disk%n"
-.fi
-.P
-
 .SH "FILES"
 .nf
 .ft B
 .ft
-/etc/scsi_id.config                  configuration and black/white list entries
+.TP
+\fI/etc/scsi_id.config\fP
+configuration and black/white list entries
+.RE
 .fi
 .LP
 .SH "SEE ALSO"
-.BR udev (8), hotplug (8)
+.BR udev (7)
 .SH AUTHORS
 Developed by Patrick Mansfield <patmans@us.ibm.com> based on SCSI ID
 source included in earlier linux 2.5 kernels, sg_utils source, and SCSI