]> git.ipfire.org Git - thirdparty/mdadm.git/blobdiff - mdadm.8
Initial DDF support code.
[thirdparty/mdadm.git] / mdadm.8
diff --git a/mdadm.8 b/mdadm.8
index 4f7126e7e9b97989b5f3b38d55a52e27d04879e1..a5d8e0dce018fd612f1a02e43e9eb5ba6867b16a 100644 (file)
--- a/mdadm.8
+++ b/mdadm.8
@@ -1,11 +1,11 @@
 .\" -*- nroff -*-
-''' Copyright Neil Brown and others.
-'''   This program is free software; you can redistribute it and/or modify
-'''   it under the terms of the GNU General Public License as published by
-'''   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 "" v2.6.2
+.\" Copyright Neil Brown and others.
+.\"   This program is free software; you can redistribute it and/or modify
+.\"   it under the terms of the GNU General Public License as published by
+.\"   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 "" v2.6.5
 .SH NAME
 mdadm \- manage MD devices
 .I aka
@@ -50,41 +50,41 @@ 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 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
-'''.B mdadm
-'''and
-'''.B raidtools
-'''are:
-'''.IP \(bu 4
-'''.B mdadm
-'''is a single program and not a collection of programs.
-'''.IP \(bu 4
-'''.B mdadm
-'''can perform (almost) all of its functions without having a
-'''configuration file and does not use one by default.  Also
-'''.B mdadm
-'''helps with management of the configuration
-'''file.
-'''.IP \(bu 4
-'''.B 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.
+.\".B 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
+.\".B mdadm
+.\"and
+.\".B raidtools
+.\"are:
+.\".IP \(bu 4
+.\".B mdadm
+.\"is a single program and not a collection of programs.
+.\".IP \(bu 4
+.\".B mdadm
+.\"can perform (almost) all of its functions without having a
+.\"configuration file and does not use one by default.  Also
+.\".B mdadm
+.\"helps with management of the configuration
+.\"file.
+.\".IP \(bu 4
+.\".B 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.
 
 .SH MODES
 mdadm has several major modes of operation:
@@ -113,8 +113,8 @@ what you are doing.
 .TP
 .B Create
 Create a new array with per-device superblocks.
-'''It can progress
-'''in several step create-add-add-run or it can all happen with one command.
+.\"It can progress
+.\"in several step create-add-add-run or it can all happen with one command.
 
 .TP
 .B "Follow or Monitor"
@@ -150,8 +150,8 @@ adding new spares and removing faulty devices.
 This is an 'everything else' mode that supports operations on active
 arrays, operations on component devices such as erasing old superblocks, and
 information gathering operations.
-'''This mode allows operations on independent devices such as examine MD
-'''superblocks, erasing old superblocks and stopping active arrays.
+.\"This mode allows operations on independent devices such as examine MD
+.\"superblocks, erasing old superblocks and stopping active arrays.
 
 .TP
 .B Auto-detect
@@ -946,7 +946,9 @@ Print detail of one or more md devices.
 .TP
 .BR \-Y ", " \-\-export
 When used with
-.BR \-\-detail ,
+.B \-\-detail
+or
+.BR \-\-examine ,
 output will be formatted as
 .B key=value
 pairs for easy import into the environment.
@@ -1368,14 +1370,14 @@ recipe for disaster.  Also, using
 when creating a v0.90 array will silently override any
 .B \-\-homehost=
 setting.
-'''If the
-'''.B \-\-size
-'''option is given, it is not necessary to list any component-devices in this command.
-'''They can be added later, before a
-'''.B \-\-run.
-'''If no
-'''.B \-\-size
-'''is given, the apparent size of the smallest drive given is used.
+.\"If the
+.\".B \-\-size
+.\"option is given, it is not necessary to list any component-devices in this command.
+.\"They can be added later, before a
+.\".B \-\-run.
+.\"If no
+.\".B \-\-size
+.\"is given, the apparent size of the smallest drive given is used.
 
 The General Management options that are valid with
 .B \-\-create
@@ -1423,14 +1425,14 @@ Usage:
 MISC mode includes a number of distinct operations that
 operate on distinct devices.  The operations are:
 .TP
-\-\-query
+.B \-\-query
 The device is examined to see if it is
 (1) an active md array, or
 (2) a component of an md array.
 The information discovered is reported.
 
 .TP
-\-\-detail
+.B \-\-detail
 The device should be an active md device.
 .B   mdadm
 will display a detailed description of the array.
@@ -1463,7 +1465,7 @@ There was an error while trying to get information about the device.
 .RE
 
 .TP
-\-\-examine
+.B \-\-examine
 The device should be a component of an md array.
 .B mdadm
 will read the md superblock of the device and display the contents.
@@ -1482,27 +1484,27 @@ without listing any devices will cause all devices listed in the
 config file to be examined.
 
 .TP
-\-\-stop
+.B \-\-stop
 The devices should be active md arrays which will be deactivated, as
 long as they are not currently in use.
 
 .TP
-\-\-run
+.B \-\-run
 This will fully activate a partially assembled md array.
 
 .TP
-\-\-readonly
+.B \-\-readonly
 This will mark an active array as read-only, providing that it is
 not currently being used.
 
 .TP
-\-\-readwrite
+.B \-\-readwrite
 This will change a
 .B readonly
 array back to being read/write.
 
 .TP
-\-\-scan
+.B \-\-scan
 For all operations except
 .BR \-\-examine ,
 .B \-\-scan
@@ -2103,26 +2105,30 @@ package, and does not use the
 configuration file at all.
 
 .SH SEE ALSO
-For information on the various levels of
-RAID, check out:
+For further information on MD and the various levels of
+RAID, see:
 
 .IP
-.UR   http://ostenfeld.dk/~jakob/Software\-RAID.HOWTO/
-http://ostenfeld.dk/~jakob/Software\-RAID.HOWTO/
+.UR  http://unthought.net/Software-RAID.HOWTO/
+http://unthought.net/Software\-RAID.HOWTO/
+.UE
+.IP
+.UR http://linux-raid.osdl.org/
+http://linux\-raid.osdl.org/
 .UE
-'''.PP
-'''for new releases of the RAID driver check out:
-'''
-'''.IP
-'''.UR  ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches
-'''ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches
-'''.UE
-'''.PP
-'''or
-'''.IP
-'''.UR http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/
-'''http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/
-'''.UE
+.\".PP
+.\"for new releases of the RAID driver check out:
+.\"
+.\".IP
+.\".UR  ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches
+.\"ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches
+.\".UE
+.\".PP
+.\"or
+.\".IP
+.\".UR http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/
+.\"http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/
+.\".UE
 .PP
 The latest version of
 .I mdadm