mdadm-0.7.2

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

diff --git a/mdadm.conf.5 b/mdadm.conf.5
index 59235bc0d5af77e15197078f981017c6729446f6..f8c0e34a0440232c763d23262a7b0a540ef962c2 100644 (file)
--- a/mdadm.conf.5
+++ b/mdadm.conf.5
@@ -6,17 +6,17 @@ mdadm.conf \- configuration for management of Software Raid with mdadm
 .SH DESCRIPTION
 .PP
 .B mdadm
-is a tools for creating an managing RAID devices using the
+is a tool for creating, managing, and monitoring RAID devices using the
 .B md
 driver in Linux.
 .PP
 Some common tasks, such as assembling all arrays, can be simplified
-by describing the devices and array in this configuations file.
+by describing the devices and array in this configuation file.
 
 .SS SYNTAX
 The file should be seen as a collection of words separated by white
 space (space, tab, or newline).
-Any word that being with a hash sign (#) starts a comment and that
+Any word that beings with a hash sign (#) starts a comment and that
 word together with the remainder of the line are ignored.
 
 Any line that start with white space (space or tab) is treated as
@@ -45,10 +45,58 @@ and each device name can contain wild cards as defined by
 
 Also, there may be several device lines present in the file.
 
+For example:
+.IP
+DEVICE /dev/hda* /dev/hdc*
+.br
+DEV    /dev/sd*
+.br
+DEVICE /dev/discs/disc*/disc
+
 .TP
 .B ARRAY
+The ARRAY lines identify actual arrays.  The second word on the line
+should be the name of the device where the array is normally
+assembled, such as
+.BR  /dev/md1 .
+Subsequent words identify the array. If multiple identities are given,
+then the array must match ALL identities to be considered a match.
+Each identity word has a tag, and equals sign, and some value.
+The options are:
+
+.RS 4
+.TP
+.B uuid=
+The value should be a 128 bit uuid in hexadecimal, with punctuation
+interspersed if desired.  This must match the uuid stored in the
+superblock.
+.TP
+.B super-minor=
+The value is an integer which indicates the minor number that was
+stored in the superblock when the array was created. When an array is
+created as /dev/mdX, then the minor number X is stored.
+.TP
+.B devices=
+The value is a comma separated list of device names. Precisely these
+devices will be used to assemble the array.  Note that the devices
+listed there must also be listed on a DEVICE line.
+.TP
+.B level=
+The value is a raid level.  This is not normally used to
+identify an array, but is supported so that the output of
+
+.B "mdadm --examine --scan"
+
+can be use directly in the configuration file.
+.TP
+.B disks=
+The value is the number of disks in a complete active array.  As with
+.B level=
+this is mainly for compatibility with the output of
 
+.BR "mdadm --examine --scan" .
+.RE
 .SH SEE ALSO
-mdadm (8),
-md (4).
+.BR mdadm (8),
+.BR md (4).