util: fix test for text_version

[thirdparty/mdadm.git] / mdadm.8

diff --git a/mdadm.8 b/mdadm.8
index 539d499f467f1cc5ac02dadd11b5c3de175377ed..04fea60dddf84f958482a352d46b59ee362a1df1 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
@@ -46,20 +46,23 @@ and
 is not a Software RAID mechanism, but does involve
 multiple devices:
 each device is a path to one common physical storage device.
+New installations should not use md/multipath as it is not well
+supported and has no ongoing development.  Use the Device Mapper based
+multipath-tools instead.
 
 .B FAULTY
 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
 managed as a set.  This is similar to the set of devices connected to
 a hardware RAID controller.  The set of devices may contain a number
-of different RAID arrays each utilising some (or all) blocks from a
+of different RAID arrays each utilising some (or all) of the blocks from a
 number of the devices in the set.  For example, two devices in a 5-device set
-might form a RAID1 used the whole devices.  The remaining three might
+might form a RAID1 using the whole devices.  The remaining three might
 have a RAID5 over the first half of each device, and a RAID0 over the
 second half.
 
@@ -70,45 +73,8 @@ the arrays in the container.  So when
 .I mdadm
 creates a
 .B CONTAINER
-device, it just represents the metadata.  Other normal arrays (RAID1
-etc) can be created inside that container.
-
-
-.\".I mdadm
-.\"is a program that can be used to create, manage, and monitor
-.\"MD devices.  As
-.\"such it provides a similar set of functionality to the
-.\".B raidtools
-.\"packages.
-.\"The key differences between
-.\".I mdadm
-.\"and
-.\".B raidtools
-.\"are:
-.\".IP \(bu 4
-.\".I mdadm
-.\"is a single program and not a collection of programs.
-.\".IP \(bu 4
-.\".I mdadm
-.\"can perform (almost) all of its functions without having a
-.\"configuration file and does not use one by default.  Also
-.\".I mdadm
-.\"helps with management of the configuration
-.\"file.
-.\".IP \(bu 4
-.\".I mdadm
-.\"can provide information about your arrays (through Query, Detail, and Examine)
-.\"that
-.\".B  raidtools
-.\"cannot.
-.\".P
-.\".I mdadm
-.\"does not use
-.\".IR /etc/raidtab ,
-.\"the
-.\".B raidtools
-.\"configuration file, at all.  It has a different configuration file
-.\"with a different format and a different purpose.
+device, the device just represents the metadata.  Other normal arrays (RAID1
+etc) can be created inside the container.
 
 .SH MODES
 mdadm has several major modes of operation:
@@ -163,7 +129,7 @@ This provides a convenient interface to a
 system.  As each device is detected,
 .I mdadm
 has a chance to include it in some array as appropriate.
-.P
+
 If a
 .B CONTAINER
 is passed to
@@ -364,9 +330,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 +978,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 +1082,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 +1541,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.