imsm: add the ddf field

[thirdparty/mdadm.git] / mdadm.8

diff --git a/mdadm.8 b/mdadm.8
index 539d499f467f1cc5ac02dadd11b5c3de175377ed..064d70a0f720e37a37df56aed48eec874cff94e0 100644 (file)
--- a/mdadm.8
+++ b/mdadm.8
@@ -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.0-devel2
+.TH MDADM 8 "" v3.0-devel3
 .SH NAME
 mdadm \- manage MD devices
 .I aka
@@ -51,7 +51,7 @@ each device is a path to one common physical storage device.
 is also not true RAID, and it only involves one device.  It
 provides a layer over a true device that can be used to inject faults.
 
-B CONTAINER
+.B CONTAINER
 is different again.  A
 .B CONTAINER
 is a collection of devices that are
@@ -364,9 +364,13 @@ creating a DDF array a
 .B CONTAINER
 will be created, and normal arrays can be created in that container.
 .IP imsm
-Use the Intel Matrix Storage Manager metadata format.  This creates a
+Use the Intel(R) Matrix Storage Manager metadata format.  This creates a
 .B CONTAINER
-which is managed in a similar manner to DDF.
+which is managed in a similar manner to DDF, and is supported by an
+option-rom on some platforms:
+.IP
+.B http://www.intel.com/design/chipsets/matrixstorage_sb.htm
+.PP
 .RE
 
 .TP
@@ -1008,6 +1012,11 @@ Information about what is discovered is presented.
 .BR \-D ", " \-\-detail
 Print detail of one or more md devices.
 
+.TP
+.BR \-\-detail\-platform
+Print detail of the platform's raid capabilities (firmware / hardware
+topology) for a given metadata format.
+
 .TP
 .BR \-Y ", " \-\-export
 When used with
@@ -1107,6 +1116,11 @@ uses to help track which arrays are currently being assembled.
 Run any array assembled as soon as a minimal number of devices are
 available, rather than waiting until all expected devices are present.
 
+.TP
+.B \-\-no\-degraded
+This allows the hot-plug system to prevent arrays from running when it knows
+that more disks may arrive later in the discovery process.
+
 .TP
 .BR \-\-scan ", " \-s
 Only meaningful with
@@ -1561,6 +1575,26 @@ The array has multiple failed devices such that it is unusable.
 There was an error while trying to get information about the device.
 .RE
 
+.TP
+.B \-\-detail\-platform
+Print detail of the platform's raid capabilities (firmware / hardware
+topology).  If the metadata is specified with
+.B \-e
+or
+.B \-\-metadata=
+then the return status will be:
+.RS
+.TP
+0
+metadata successfully enumerated its platform components on this system
+.TP
+1
+metadata is platform independent
+.TP
+2
+metadata failed to find its platform components on this system
+.RE
+
 .TP
 .B \-\-examine
 The device should be a component of an md array.