Add blkdevalias.8 man page
authorBryn M. Reeves <bmr@redhat.com>
Mon, 21 Jan 2013 14:52:43 +0000 (14:52 +0000)
committerBryn M. Reeves <bmr@redhat.com>
Mon, 21 Jan 2013 14:52:43 +0000 (14:52 +0000)
blkdevalias.8 [new file with mode: 0644]

diff --git a/blkdevalias.8 b/blkdevalias.8
new file mode 100644 (file)
index 0000000..613185d
--- /dev/null
@@ -0,0 +1,65 @@
+.TH BLKDEVALIAS 8 "BLKDEVALIAS 0.08" "Red Hat" \" -*- nroff -*-
+.SH NAME
+blkdevalias \- a tool for managing persistent udev aliases and permissions
+.SH SYNOPSIS
+.B blkdevalias
+[configure|createdisk|deletedisk|listdisks|scandisks|querydisk|map]
+.SH DESCRIPTION
+\fBblkdevalias\fP is a tool to manage persistent storage device aliases and
+permissions. The \fBblkdevalias\fP script provides commands to allow the
+user to create, remove and list the set of aliases and to control the
+default user and group ownership and mode (permissions) of managed
+devices.
+.LP
+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
+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.
+.TP
+\fBdeletedisk [ALIAS] \fP \(em Delete a previously created block device alias.
+.TP
+\fBlistdisks\fP \(em List currently assigned block device aliases.
+.TP
+\fBquerydisk [ALIAS] \fP \(em Query an alias to check whether it is valid.
+.TP
+\fBscandisks\fP \(em Not used by blkdevalias. Provided for compatibility.
+.SH OPTIONS
+The following options are available for some commands.
+.TP
+.B \-d ", " \-\-device
+Causes \fBquerydisk\fP to display major and minor number of a managed device.
+.LP
+.SH ENVIRONMENT VARIABLES
+.TP
+.B BA_DEBUG
+When set to the value "yes" causes additional debug messages to be written on stderr.
+.SH BUGS & KNOWN ISSUES
+The WWIDs used by \fBblkdevalias\fP are a property of the underlying
+storage. This means that devices are assigned aliases by their
+identity rather than their content so that if the content of a device
+is moved from one disk to another the mapping must be updated.
+
+Systems that use labels to identify the devices do not suffer this
+limitation.
+
+Root privileges or \fBsudo\fP(8) are currently required to immediately apply
+changes to the active set of devices using the tool.
+.SH DIAGNOSTICS
+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.
+.SH FILES
+.I /etc/blkdevalias/blkdevalias.conf
+.br
+.I /etc/blkdevalias/blkdevalias.map
+.SH SEE ALSO
+.BR udev (8),
+.BR scsi_id (8),
+.BR blkid (8),
+.BR multipath (8),