Stuff like..

[thirdparty/mdadm.git] / mdadm.8

diff --git a/mdadm.8 b/mdadm.8
index aa39a2365dd73d3274a63de1b663605e1f9ecd89..44bcecfc69d7aa3b466c7155060bc5cb9bee550d 100644 (file)
--- a/mdadm.8
+++ b/mdadm.8
@@ -1,5 +1,5 @@
 .\" -*- nroff -*-
-.TH MDADM 8 "" v2.1
+.TH MDADM 8 "" v2.2
 .SH NAME
 mdadm \- manage MD devices
 .I aka
@@ -476,9 +476,12 @@ which means to choose the largest size that fits on all current drives.
 .BR --assume-clean
 Tell
 .I mdadm
-that the array pre-existed and is known to be clean.  This is only
-really useful for Building RAID1 array.  Only use this if you really
-know what you are doing.  This is currently only supported for --build.
+that the array pre-existed and is known to be clean.  It can be useful
+when trying to recover from a major failure as you can be sure that no
+data will be affected unless you actually write to the array.  It can
+also be used when creating a RAID1 or RAID10 if you want to avoid the
+initial resync, however this practice - while normally safe - is not
+recommended.   Use this ony if you really know what you are doing.
 
 .TP
 .BR -N ", " --name=
@@ -516,8 +519,8 @@ will not try to be so clever.
 Instruct mdadm to create the device file if needed, possibly allocating
 an unused minor number.  "md" causes a non-partitionable array
 to be used.  "mdp", "part" or "p" causes a partitionable array (2.6 and
-later) to be used.  "yes" requires the named md device to have a
-'standard' format, and the type and minor number will be determined
+later) to be used.  "yes" requires the named md device to haveo
+a 'standard' format, and the type and minor number will be determined
 from this.  See DEVICE NAMES below.
 
 The argument can also come immediately after
@@ -607,6 +610,7 @@ Update the superblock on each device while assembling the array.  The
 argument given to this flag can be one of
 .BR sparc2.2 ,
 .BR summaries ,
+.BR uuid ,
 .BR resync ,
 .BR byteorder ,
 or
@@ -614,7 +618,7 @@ or
 
 The
 .B sparc2.2
-option will  adjust the superblock of an array what was created on a Sparc
+option will adjust the superblock of an array what was created on a Sparc
 machine running a patched 2.2 Linux kernel.  This kernel got the
 alignment of part of the superblock wrong.  You can use the
 .B "--examine --sparc2.2"
@@ -630,6 +634,14 @@ field on each superblock to match the minor number of the array being
 assembled.  This is not needed on 2.6 and later kernels as they make
 this adjustment automatically.
 
+The
+.B uuid
+option will change the uuid of the array.  If a UUID is given with the
+"--uuid" option that UUID will be used as a new UUID and with
+.B NOT
+be used to help identify the devices in the array.
+If no "--uuid" is given, a random uuid is chosen.
+
 The
 .B resync
 option will cause the array to be marked
@@ -747,6 +759,11 @@ Give a mail address to send alerts to.
 .BR -p ", " --program ", " --alert
 Give a program to be run whenever an event is detected.
 
+.TP
+.BR -y ", " --syslog
+Cause all events to be reported through 'syslog'.  The messages have
+facility of 'daemon' and varying priorities.
+
 .TP
 .BR -d ", " --delay
 Give a delay in seconds.
@@ -1186,7 +1203,7 @@ The different events are:
 .TP
 .B DeviceDisappeared
 An md array which previously was configured appears to no longer be
-configured.
+configured. (syslog priority: Critical)
 
 If
 .I mdadm
@@ -1200,39 +1217,41 @@ hot-spare and resync operations which are monitored.
 
 .TP
 .B RebuildStarted
-An md array started reconstruction.
+An md array started reconstruction. (syslog priority: Warning)
 
 .TP
 .BI Rebuild NN
 Where
 .I NN
 is 20, 40, 60, or 80, this indicates that rebuild has passed that many
-percentage of the total.
+percentage of the total. (syslog priority: Warning)
 
 .TP
 .B RebuildFinished
 An md array that was rebuilding, isn't any more, either because it
-finished normally or was aborted.
+finished normally or was aborted. (syslog priority: Warning)
 
 .TP
 .B Fail
-An active component device of an array has been marked as faulty.
+An active component device of an array has been marked as
+faulty. (syslog priority: Critical)
 
 .TP
 .B FailSpare
 A spare component device which was being rebuilt to replace a faulty
-device has failed.
+device has failed. (syslog priority: Critial)
 
 .TP
 .B SpareActive
 A spare component device which was being rebuilt to replace a faulty
 device as been successfully rebuild and has been made active.
+(syslog priority: Info)
 
 .TP
 .B NewArray
 A new md array has been detected in the
 .B /proc/mdstat
-file.
+file.   (syslog priority: Info)
 
 .TP
 .B DegradedArray
@@ -1242,12 +1261,14 @@ generated when
 notices a drive failure which causes degradation, but only when
 .I mdadm
 notices that an array is degraded when it first sees the array.
+(syslog priority: Critial)
 
 .TP
 .B MoveSpare
 A spare drive has been moved from one array in a
 .B spare-group
 to another to allow a failed drive to be replaced.
+(syslog priority: Info)
 
 .TP
 .B SparesMissing
@@ -1260,12 +1281,14 @@ detects that it has fewer that this number when it first sees the
 array, it will report a
 .B SparesMissing
 message.
+(syslog priority: Info)
 
 .TP
 .B TestMessage
 An array was found at startup, and the
 .B --test
 flag was given.
+(syslog priority: Info)
 .RE
 
 Only