Release mdadm-3.3.3

[thirdparty/mdadm.git] / mdadm.8.in

diff --git a/mdadm.8.in b/mdadm.8.in
index ced1b509f756c77652681ce395a8593db690edf7..912ee4c4fa4ac4d83c85b20c6c0cbf920eb9abf4 100644 (file)
--- a/mdadm.8.in
+++ b/mdadm.8.in
@@ -5,7 +5,7 @@
 .\"   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 8 "" v3.3
+.TH MDADM 8 "" v3.3.3
 .SH NAME
 mdadm \- manage MD devices
 .I aka
@@ -214,7 +214,7 @@ to detect and assemble arrays \(em possibly in an
 
 .P
 If a device is given before any options, or if the first option is
-and of
+one of
 .BR \-\-add ,
 .BR \-\-re\-add ,
 .BR \-\-add\-spare ,
@@ -393,6 +393,13 @@ will be allowed to use 'local' names (i.e. not ending in '_' followed
 by a digit string).  See below under
 .BR "Auto Assembly" .
 
+The special name "\fBany\fP" can be used as a wild card.  If an array
+is created with
+.B --homehost=any
+then the name "\fBany\fP" will be stored in the array and it can be
+assembled in the same way on any host.  If an array is assembled with
+this option, then the homehost recorded on the array will be ignored.
+
 .TP
 .B \-\-prefer=
 When
@@ -1086,7 +1093,7 @@ argument given to this flag can be one of
 .BR devicesize ,
 .BR no\-bitmap ,
 .BR bbl ,
-.BR no-\bbl ,
+.BR no\-bbl ,
 .BR metadata ,
 or
 .BR super\-minor .
@@ -1588,6 +1595,31 @@ successfully waited.  For native arrays this returns immediately as the
 kernel handles dirty-clean transitions at shutdown.  No action is taken
 if safe-mode handling is disabled.
 
+.TP
+.B \-\-action=
+Set the "sync_action" for all md devices given to one of
+.BR idle ,
+.BR frozen ,
+.BR check ,
+.BR repair .
+Setting to
+.B idle
+will abort any currently running action though some actions will
+automatically restart.
+Setting to
+.B frozen
+will abort any current action and ensure no other action starts
+automatically.
+
+Details of
+.B check
+and
+.B repair
+can be found it
+.IR md (4)
+under
+.BR "SCRUBBING AND MISMATCHES" .
+
 .SH For Incremental Assembly mode:
 .TP
 .BR \-\-rebuild\-map ", " \-r
@@ -2171,11 +2203,11 @@ option.  Currently only
 .B name
 is supported.
 
-The 
+The
 .B name
 option updates the subarray name in the metadata, it may not affect the
 device node name or the device node symlink until the subarray is
-re\-assembled.  If updating 
+re\-assembled.  If updating
 .B name
 would change the UUID of an active subarray this operation is blocked,
 and the command will end in an error.
@@ -2861,6 +2893,20 @@ to '1', the
 .I mdadm
 will create and devices that are needed.
 
+.TP
+.B MDADM_NO_SYSTEMCTL
+If
+.I mdadm
+detects that
+.I systemd
+is in use it will normally request
+.I systemd
+to start various background tasks (particularly
+.IR mdmon )
+rather than forking and running them in the background.  This can be
+suppressed by setting
+.BR MDADM_NO_SYSTEMCTL=1 .
+
 .TP
 .B IMSM_NO_PLATFORM
 A key value of IMSM metadata is that it allows interoperability with
@@ -2877,6 +2923,18 @@ environment.  This can be useful for testing or for disaster
 recovery.  You should be aware that interoperability may be
 compromised by setting this value.
 
+.TP
+.B MDADM_GROW_ALLOW_OLD
+If an array is stopped while it is performing a reshape and that
+reshape was making use of a backup file, then when the array is
+re-assembled
+.I mdadm
+will sometimes complain that the backup file is too old.  If this
+happens and you are certain it is the right backup file, you can
+over-ride this check by setting
+.B MDADM_GROW_ALLOW_OLD=1
+in the environment.
+
 .TP
 .B MDADM_CONF_AUTO
 Any string given in this variable is added to the start of the
@@ -3113,7 +3171,7 @@ Partition numbers should be indicated by adding "pMM" to these, thus "/dev/md/d1
 From kernel version 2.6.28 the "non-partitioned array" can actually
 be partitioned.  So the "md_d\fBNN\fP"
 names are no longer needed, and
-partitions such as "/dev/md\fBNN\fPp\fBXX\fp"
+partitions such as "/dev/md\fBNN\fPp\fBXX\fP"
 are possible.
 .PP
 From kernel version 2.6.29 standard names can be non-numeric following