Allow --auto to still be meaningful when --scan is given

[thirdparty/mdadm.git] / mdadm.8

diff --git a/mdadm.8 b/mdadm.8
index 896448da6d6b47a75f4b7118e0cc5329e03b16ca..dfbb74c180457ba3b1634458a32cb454f30ea9ec 100644 (file)
--- a/mdadm.8
+++ b/mdadm.8
@@ -1,5 +1,5 @@
 .\" -*- nroff -*-
-.TH MDADM 8 "" v1.10.0
+.TH MDADM 8 "" v2.0-devel-1
 .SH NAME
 mdadm \- manage MD devices
 .I aka
@@ -92,7 +92,7 @@ information so as to assemble a faulty array.
 
 .TP
 .B Build
-Build a legacy array without per-device superblocks.
+Build an array without per-device superblocks.
 
 .TP
 .B Create
@@ -165,6 +165,10 @@ mode.
 .BR -G ", " --grow
 Change the size or shape of an active array.
 
+.TP
+.BR -X ", " --examine-bitmap
+Report information about a bitmap file.
+
 .TP
 .BR -h ", " --help
 Display help message or, after above option, mode specific help
@@ -190,6 +194,18 @@ Be less verbose.  This is used with
 and
 .BR --examine .
 
+.TP
+.BR -b ", " --bitmap=
+Give the name of a bitmap file to use with this array.  Can be used
+with --create (file should not exist) or --assemble (file should
+exist).
+
+.TP
+.BR --bitmap-chunk=
+Set the Chunksize of the bitmap. Each bit corresponds to that many
+Kilobytes of storage. Default is 4.
+
+
 .TP
 .BR -f ", " --force
 Be more forceful about certain operations.  See the various modes of
@@ -234,6 +250,24 @@ in which case
 says to get a list of array devices from
 .BR /proc/mdstat .
 
+.TP
+.B -e ", " --metadata=
+Declare the style of superblock (raid metadata) to be used.  The
+default is 0.90 for --create, and to guess for other operations.
+
+Options are:
+.RS
+.IP "0, 0.90, default"
+Use the original 0.90 format superblock.  This format limits arrays to
+28 componenet devices and limits component devices of levels 1 and
+greater to 2 terabytes.
+.IP "1, 1.0, 1.1, 1.2"
+Use the new version-1 format superblock.  This has few restrictions.
+The different subversion store the superblock at different locations
+on the device, either at the end (for 1.0), at the start (for 1.1) or
+4K from the start (for 1.2).
+.RE
+
 .SH For create or build:
 
 .TP
@@ -301,6 +335,16 @@ must be specified before the fault mode is specified.
 .BR --layout=
 same as --parity
 
+.TP
+.BR -b ", " --bitmap=
+Specify a file to store a write-intent bitmap in.  The file should not
+exist unless --force is also given.  The same file should be provided
+when assembling the array.
+
+.TP
+.BR --bitmap-chunk=
+Specifty the chunksize for the bitmap.
+
 .TP
 .BR -n ", " --raid-devices=
 Specify the number of active devices in the array.  This, plus the
@@ -344,6 +388,9 @@ for RAID level 1/4/5/6. If the array was created with a size smaller
 than the currently active drives, the extra space can be accessed
 using
 .BR --grow .
+The size can be given as
+.B max
+which means to choose the largest size that fits all on all current drives.
 
 .TP
 .BR --assume-clean
@@ -388,6 +435,14 @@ from this.  See DEVICE NAMES below.
 The argumentment can also come immediately after
 "-a".  e.g. "-ap".
 
+If
+.I --scan
+is also given, then any
+.I auto=
+entries in the config file will over-ride the
+.I --auto
+instruction given on the command line.
+
 For partitionable arrays,
 .I mdadm
 will create the device file for the whole array and for the first 4
@@ -449,6 +504,10 @@ an attempt will be made to start it anyway.
 .BR -a ", " "--auto{=no,yes,md,mdp,part}"
 See this option under Create and Build options.
 
+.TP
+.BR -b ", " --bitmap=
+Specify the bitmap file that was given when the array was created.
+
 .TP
 .BR -U ", " --update=
 Update the superblock on each device while assembling the array.  The
@@ -1006,6 +1065,16 @@ The different events are:
 An md array which previously was configured appears to no longer be
 configured.
 
+If
+.I mdadm
+was told to monitor an array which is RAID0 or Linear, then it will
+report
+.B DeviceDisappeared
+with the extra information
+.BR Wrong-Level .
+This is because RAID0 and Linear do not support the device-failed,
+hot-spare and resync operations which are monitored.
+
 .TP
 .B RebuildStarted
 An md array started reconstruction.
@@ -1057,6 +1126,18 @@ A spare drive has been moved from one array in a
 .B spare-group
 to another to allow a failed drive to be replaced.
 
+.TP
+.B SparesMissing
+If
+.I mdadm
+has been told, via the config file, that an array should have a certain
+number of spare devices, and
+.I mdadm
+detects that it has fewer that this number when it first sees the
+array, it will report a
+.B SparesMissing
+message.
+
 .TP
 .B TestMessage
 An array was found at startup, and the