Add comment headers to configuration and map files
[blkdevalias.git] / blkdevalias.map.5
1 .TH BLKDEVALIAS.MAP 5 "BLKDEVALIAS 0.08" "Red Hat" \" -*- nroff -*-
2 .SH NAME
3 blkdevalias.map \- block device alias table
4 .SH SYNOPSIS
5 .B /etc/blkdevalias/blkdevalias.map
6 .SH DESCRIPTION
7 \fBblkdevalias\fP is a tool to manage persistent storage device aliases and
8 permissions. The \fIblkdevalias.map\fP file stores the table of managed
9 device identifiers and options.
10
11 This file is maintained automatically and in normal use should not be edited
12 manually: the format of records and fields is not fixed and is subject to
13 change in future versions.
14
15 Records are currently line-oriented and consist of whitespace delimited fields
16 of text.
17
18 .TP
19 .B WWID
20 .br
21 The WWID value for the alias. When \fBblkdevalias\fP is called by \fIudev\fP to
22 map an alias request this value is used to select a matching alias.
23 .TP
24 .B ALIAS
25 .br
26 The name to be used for the alias symbolic link.
27 .TP
28 .B TYPE
29 .br
30 The expected device type (SCSI, multipath, etc.). When \fBblkdevalias\fP is
31 called by \fIudev\fP to map an alias request it will reject devices with a
32 matching WWID unless they also match the expected type.
33 .TP
34 .B PARTITION
35 Partition number on the target device. Since all partitions on a disk share the
36 WWID of the underlying device aliases that target a partition on a disk must
37 also match this field. A value of '0' in this field signifies a whole-disk or
38 non-partitionable device.
39 .SH FILES
40 .I /etc/blkdevalias/blkdevalias.map
41 .br
42 .SH SEE ALSO
43 .BR blkdevalias (8),
44 .BR blkdevalias.conf (5),
45 .BR udev (8)
46 .SH AUTHORS
47 The \fBblkdevalias\fP program was written by Bryn M. Reeves, <bmr@redhat.com>.
48
49 \fBblkdevalias\fP is Copyright © Red Hat, Inc. 2012-2013. It is free
50 software; see the GNU General Public License version 2 for copying conditions.
51
52 There is NO WARRANTY.
53