Add comment headers to configuration and map files
[blkdevalias.git] / blkdevalias.conf.5
1 .TH BLKDEVALIAS.CONF 5 "BLKDEVALIAS 0.08" "Red Hat" \" -*- nroff -*-
2 .SH NAME
3 blkdevalias.conf \- block device alias configuration file
4 .SH SYNOPSIS
5 .B /etc/blkdevalias/blkdevalias.conf
6 .SH DESCRIPTION
7 \fBblkdevalias\fP is a tool to manage persistent storage device aliases and
8 permissions. The \fIblkdevalias.conf\fP file stores global configuration
9 parameters affecting all \fBblkdevalias\fP managed devices.
10
11 Configuration options are specified by setting shell-style variables in the
12 file. Order is not significant; options may appear in any order but if any
13 option is specified more than once only the final value will be used.
14
15 The configuration file may be manually edited but is automatically generated
16 by the \fBblkdevalias\fP \fIconfigure\fP command. Comments and manual edits
17 will not be preserved if this command is issued.
18 .TP
19 \fBBA_DEV_PATH\fP The path relative to \fI/dev\fP under which symbolic links
20 will be created for managed devices. For example setting this option to
21 "\fIblkdevalias/disks\fP" will cause links to appear under
22 .br
23 \fI/dev/blkdevalias/disks\fP.
24 .TP
25 \fBBA_USER\fP Name of the UNIX user account to own managed devices.
26 .TP
27 \fBBA_GROUP\fP Name of the UNIX group account to own managed devices.
28 .TP
29 \fBBA_MODE\fP File mode (permissions) to be used for managed devices.
30 .SH FILES
31 .I /etc/blkdevalias/blkdevalias.conf
32 .br
33 .SH SEE ALSO
34 .BR blkdevalias (8),
35 .BR blkdevalias.map (5),
36 .SH AUTHORS
37 The \fBblkdevalias\fP program was written by Bryn M. Reeves, <bmr@redhat.com>.
38
39 \fBblkdevalias\fP is Copyright © Red Hat, Inc. 2012-2013. It is free
40 software; see the GNU General Public License version 2 for copying conditions.
41
42 There is NO WARRANTY.
43