Document debugging and configuration in manual page
authorBryn M. Reeves <bmr@redhat.com>
Mon, 21 Jan 2013 19:45:58 +0000 (19:45 +0000)
committerBryn M. Reeves <bmr@redhat.com>
Mon, 21 Jan 2013 19:45:58 +0000 (19:45 +0000)
Add references to configuration files and the BA_DEBUG
environment variable.

blkdevalias.8

index 613185d..de5a1b3 100644 (file)
@@ -15,18 +15,18 @@ Aliases are created as symbolic links within the \fB/dev\fP directory
 using the standard Linux 2.6 udev dynamic device management
 infrastructure[1]. The administrator may specify an arbitrary directory
 under /dev in which to create the links.
-.SH BLKDEVALIAS COMMANDS
+.SH COMMANDS
 The \fBblkdevalias\fP program provides the following commands:
 .TP
 \fBconfigure\fP \(em Display the configuration information and prompt the user to specify new values to be written to \fBblkdevalias.conf\fP(5).
 .TP
-\fBcreatedisk [ALIAS] [DEVICE PATH]\fP \(em Create a new alias for an existing block device.
+\fBcreatedisk\fP [ALIAS] [DEVICE PATH] \(em Create a new alias for an existing block device.
 .TP
-\fBdeletedisk [ALIAS] \fP \(em Delete a previously created block device alias.
+\fBdeletedisk\fP [ALIAS] \(em Delete a previously created block device alias.
 .TP
-\fBlistdisks\fP \(em List currently assigned block device aliases.
+\fBlistdisks\fP [OPTION] \(em List currently assigned block device aliases.
 .TP
-\fBquerydisk [ALIAS] \fP \(em Query an alias to check whether it is valid.
+\fBquerydisk\fP [OPTION] [ALIAS] \(em Query an alias to check whether it is valid.
 .TP
 \fBscandisks\fP \(em Not used by blkdevalias. Provided for compatibility.
 .SH OPTIONS
@@ -54,12 +54,31 @@ changes to the active set of devices using the tool.
 All tools return a status code of zero on success or non-zero on failure. An
 exit status of 2 indictates that invalid arguments or options were provided
 to a command.
+
+Additional debug output may be obtained by setting the BA_DEBUG environment
+variable (see \fBENVIRONMENT VARIABLES\fP). Debugging of the udev rules
+used by blkdevalias may be accomplished by using the udevadm control command
+to raise the udev log priority (see \fBudevadm\fP(8)).
 .SH FILES
 .I /etc/blkdevalias/blkdevalias.conf
 .br
 .I /etc/blkdevalias/blkdevalias.map
 .SH SEE ALSO
+.BR blkdevalias.conf (5),
+.BR blkdevalias.map (5),
 .BR udev (8),
+.BR udevadm (8),
 .BR scsi_id (8),
 .BR blkid (8),
-.BR multipath (8),
+.BR multipath (8)
+.SH HISTORY
+The blkdevalias user interface mimics that of the oracleasm utility for many
+common operations.
+.SH AUTHORS
+The \fBblkdevalias\fP program was written by Bryn M. Reeves, <bmr@redhat.com>.
+
+\fBblkdevalias\fP is Copyright © Red Hat, Inc. 2012-2013. It is free
+software; see the GNU General Public License version 2 for copying conditions.
+
+There is NO WARRANTY.
+