Allow autoassembly to choose it's own name for the array.

[thirdparty/mdadm.git] / mdadm.conf.5

diff --git a/mdadm.conf.5 b/mdadm.conf.5
index e5b3ebfe2c86ff9b10511727d9fa315db7975a64..b7d915e5f676b1d9b91c6f612181a95b47f6a681 100644 (file)
--- a/mdadm.conf.5
+++ b/mdadm.conf.5
@@ -61,6 +61,8 @@ but only the major and minor device numbers.  It scans
 .I /dev
 to find the name that matches the numbers.
 
+If no DEVICE line is present, then "DEVICE partitions" is assumed.
+
 For example:
 .IP
 DEVICE /dev/hda* /dev/hdc*
@@ -151,6 +153,18 @@ also have a number appended to indicate how many partitions to create
 device files for, e.g.
 .BR auto=mdp5 .
 The default is 4.
+
+.TP
+.B bitmap=
+The option specifies a file in which a write-intent bitmap should be
+found.  When assembling the array,
+.I mdadm
+will provide this file to the
+.B md
+driver as the bitmap file.  This has the same function as the
+.B --bitmap-file
+option to
+.BR --assemble .
 .RE
 
 .TP
@@ -169,6 +183,20 @@ option).  There should only be one
 line and it should have only one address.
 
 
+.TP
+.B MAILFROM
+The
+.B mailfrom
+line (which can only be abbreviate at leat 5 characters) gives an
+address to appear in the "From" address for alert mails.  This can be
+useful if you want to explicitly set a domain, as the default from
+address is "root" with no domain.  All words on this line are
+catenated with spaces to form the address.
+
+Note that this value cannot be set via the
+.I mdadm
+commandline.  It is only settable via the config file.
+
 .TP
 .B PROGRAM
 The
@@ -184,6 +212,41 @@ There should only be one
 .B program
 line and it should be give only one program.
 
+
+.TP
+.B CREATE
+The
+.B create
+line gives default values to be used when creating device entries for
+arrays.
+These include:
+
+.RS 4
+.TP
+.B owner=
+.TP
+.B group=
+These can give user/group ids or names to use instead of system
+defaults (root/wheel or root/disk).
+.TP
+.B mode=
+An octal file mode such as 0660 can be given to override the default
+of 0600.
+.TP
+.B auto=
+This corresponds to the
+.B --auto
+flag to mdadm.  Give
+.BR yes ,
+.BR md ,
+.BR mdp ,
+.B part
+- possibly followed by a number of partitions - to indicate how
+missing device entries should be created.
+
+.RE
+
+
 .SH EXAMPLE
 DEVICE /dev/sd[bcdjkl]1
 .br
@@ -201,7 +264,7 @@ ARRAY /dev/md1 superminor=1
 .br
 # /dev/md2 is made from precisey these two devices
 .br
-ARRAY /dev/md2 devices=/dev/hda1,/dev/hda2
+ARRAY /dev/md2 devices=/dev/hda1,/dev/hdb1
 
 # /dev/md4 and /dev/md5 are a spare-group and spares
 .br
@@ -226,7 +289,8 @@ ARRAY /dev/md/home UUID=9187a482:5dde19d9:eea3cc4a:d646ab8b
 MAILADDR root@mydomain.tld
 .br
 PROGRAM /usr/sbin/handle-mdadm-events
-
+.br
+CREATE group=system mode=0640 auto=part-8
 
 .SH SEE ALSO
 .BR mdadm (8),