Add blkdevalias.map.5
authorBryn M. Reeves <bmr@redhat.com>
Mon, 21 Jan 2013 20:25:23 +0000 (20:25 +0000)
committerBryn M. Reeves <bmr@redhat.com>
Mon, 21 Jan 2013 20:25:40 +0000 (20:25 +0000)
Document the map file format.

blkdevalias.map.5 [new file with mode: 0644]

diff --git a/blkdevalias.map.5 b/blkdevalias.map.5
new file mode 100644 (file)
index 0000000..f534394
--- /dev/null
@@ -0,0 +1,53 @@
+.TH BLKDEVALIAS.MAP 5 "BLKDEVALIAS 0.08" "Red Hat" \" -*- nroff -*-
+.SH NAME
+blkdevalias.map \- block device alias table
+.SH SYNOPSIS
+.B /etc/blkdevalias/blkdevalias.map
+.SH DESCRIPTION
+\fBblkdevalias\fP is a tool to manage persistent storage device aliases and
+permissions. The \fIblkdevalias.map\fP file stores the table of managed
+device identifiers and options.
+
+This file is maintained automatically and in normal use should not be edited
+manually: the format of records and fields is not fixed and is subject to
+change in future versions.
+
+Records are currently line-oriented and consist of whitespace delimited fields
+of text.
+
+.TP
+.B WWID
+.br
+The WWID value for the alias. When \fBblkdevalias\fP is called by \fIudev\fP to
+map an alias request this value is used to select a matching alias.
+.TP
+.B ALIAS
+.br
+The name to be used for the alias symbolic link.
+.TP
+.B TYPE
+.br
+The expected device type (SCSI, multipath, etc.). When \fBblkdevalias\fP is
+called by \fIudev\fP to map an alias request it will reject devices with a
+matching WWID unless they also match the expected type.
+.TP
+.B PARTITION
+Partition number on the target device. Since all partitions on a disk share the
+WWID of the underlying device aliases that target a partition on a disk must
+also match this field. A value of '0' in this field signifies a whole-disk or
+non-partitionable device.
+.SH FILES
+.I /etc/blkdevalias/blkdevalias.map
+.br
+.SH SEE ALSO
+.BR blkdevalias (8),
+.BR blkdevalias.conf (5),
+.BR udev (8)
+.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.
+