Can now mostly assemble DDF arrays

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

diff --git a/mdadm.conf.5 b/mdadm.conf.5
index 2b9995ba261b76a845535bdf2fbf4ac938c50834..aadfb23e3f0f515ba57b02c9a976386763115eca 100644 (file)
--- a/mdadm.conf.5
+++ b/mdadm.conf.5
@@ -1,12 +1,12 @@
-''' Copyright Neil Brown and others.
-'''   This program is free software; you can redistribute it and/or modify
-'''   it under the terms of the GNU General Public License as published by
-'''   the Free Software Foundation; either version 2 of the License, or
-'''   (at your option) any later version.
-''' See file COPYING in distribution for details.
+.\" Copyright Neil Brown and others.
+.\"   This program is free software; you can redistribute it and/or modify
+.\"   it under the terms of the GNU General Public License as published by
+.\"   the Free Software Foundation; either version 2 of the License, or
+.\"   (at your option) any later version.
+.\" See file COPYING in distribution for details.
 .TH MDADM.CONF 5
 .SH NAME
-mdadm.conf \- configuration for management of Software Raid with mdadm
+mdadm.conf \- configuration for management of Software RAID with mdadm
 .SH SYNOPSIS
 /etc/mdadm.conf
 .SH DESCRIPTION
@@ -105,7 +105,7 @@ when the array was created.  This must match the name stored in the
 superblock on a device for that device to be included in the array.
 Not all superblock formats support names.
 .TP
-.B super-minor=
+.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.
@@ -121,33 +121,33 @@ listed there must also be listed on a DEVICE line.
 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"
+.B "mdadm \-\-examine \-\-scan"
 
 can be use directly in the configuration file.
 .TP
-.B num-devices=
+.B num\-devices=
 The value is the number of devices in a complete active array.  As with
 .B level=
 this is mainly for compatibility with the output of
 
-.BR "mdadm --examine --scan" .
+.BR "mdadm \-\-examine \-\-scan" .
 
 .TP
 .B spares=
 The value is a number of spare devices to expect the array to have.
-.I mdadm --monitor
+.B mdadm \-\-monitor
 will report an array if it is found to have fewer than this number of
 spares when
-.B --monitor
+.B \-\-monitor
 starts or when
-.B --oneshot
+.B \-\-oneshot
 is used.
 
 .TP
-.B spare-group=
+.B spare\-group=
 The value is a textual name for a group of arrays.  All arrays with
 the same
-.B spare-group
+.B spare\-group
 name are considered to be part of the same group.  The significance of
 a group of arrays is that
 .B mdadm
@@ -179,15 +179,15 @@ found.  When assembling the array,
 will provide this file to the
 .B md
 driver as the bitmap file.  This has the same function as the
-.B --bitmap-file
+.B \-\-bitmap\-file
 option to
-.BR --assemble .
+.BR \-\-assemble .
 
 .TP
 .B metadata=
 Specify the metadata format that the array has.  This is mainly
 recognised for comparability with the output of
-.IR "mdadm -Es" .
+.BR "mdadm \-Es" .
 
 .RE
 
@@ -199,9 +199,9 @@ line gives an E-mail address that alerts should be
 sent to when
 .M mdadm
 is running in
-.B --monitor
+.B \-\-monitor
 mode (and was given the
-.B --scan
+.B \-\-scan
 option).  There should only be one
 .B MAILADDR
 line and it should have only one address.
@@ -211,7 +211,7 @@ line and it should have only one address.
 .B MAILFROM
 The
 .B mailfrom
-line (which can only be abbreviate at leat 5 characters) gives an
+line (which can only be abbreviated to at least 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
@@ -226,7 +226,7 @@ commandline.  It is only settable via the config file.
 The
 .B program
 line gives the name of a program to be run when
-.B "mdadm --monitor"
+.B "mdadm \-\-monitor"
 detects potentially interesting events on any of the arrays that it
 is monitoring.  This program gets run with two or three arguments, they
 being the Event, the md device, and possibly the related component
@@ -259,13 +259,13 @@ of 0600.
 .TP
 .B auto=
 This corresponds to the
-.B --auto
+.B \-\-auto
 flag to mdadm.  Give
 .BR yes ,
 .BR md ,
 .BR mdp ,
 .B part
-- possibly followed by a number of partitions - to indicate how
+\(em possibly followed by a number of partitions \(em to indicate how
 missing device entries should be created.
 
 .TP
@@ -285,7 +285,7 @@ with a name starting
 or
 .BR md_ .
 Give
-.B symlinked=no
+.B symlinks=no
 to suppress this symlink creation.
 .RE
 
@@ -295,7 +295,7 @@ DEVICE /dev/sd[bcdjkl]1
 .br
 DEVICE /dev/hda1 /dev/hdb1
 
-# /dev/md0 is known by it's UID.
+# /dev/md0 is known by its UID.
 .br
 ARRAY /dev/md0 UUID=3aaa0122:29827cfa:5331ad66:ca767371
 .br
@@ -305,7 +305,7 @@ ARRAY /dev/md0 UUID=3aaa0122:29827cfa:5331ad66:ca767371
 .br
 ARRAY /dev/md1 superminor=1
 .br
-# /dev/md2 is made from precisey these two devices
+# /dev/md2 is made from precisely these two devices
 .br
 ARRAY /dev/md2 devices=/dev/hda1,/dev/hdb1
 
@@ -315,11 +315,11 @@ ARRAY /dev/md2 devices=/dev/hda1,/dev/hdb1
 .br
 ARRAY /dev/md4 uuid=b23f3c6d:aec43a9f:fd65db85:369432df
 .br
-           spare-group=group1
+           spare\-group=group1
 .br
 ARRAY /dev/md5 uuid=19464854:03f71b1b:e0df2edd:246cc977
 .br
-           spare-group=group1
+           spare\-group=group1
 .br
 # /dev/md/home is created if need to be a partitionable md array
 .br
@@ -331,9 +331,9 @@ ARRAY /dev/md/home UUID=9187a482:5dde19d9:eea3cc4a:d646ab8b
 
 MAILADDR root@mydomain.tld
 .br
-PROGRAM /usr/sbin/handle-mdadm-events
+PROGRAM /usr/sbin/handle\-mdadm\-events
 .br
-CREATE group=system mode=0640 auto=part-8
+CREATE group=system mode=0640 auto=part\-8
 .br
 HOMEHOST <system>