]> git.ipfire.org Git - thirdparty/mdadm.git/blame - ReadMe.c
--wait or -W will wait for resync activity to finish on the given devices.
[thirdparty/mdadm.git] / ReadMe.c
CommitLineData
64c4757e 1/*
9a9dab36 2 * mdadm - manage Linux "md" devices aka RAID arrays.
64c4757e 3 *
4f589ad0 4 * Copyright (C) 2001-2006 Neil Brown <neilb@suse.de>
64c4757e
NB
5 *
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 *
21 * Author: Neil Brown
22 * Email: <neilb@cse.unsw.edu.au>
23 * Paper: Neil Brown
24 * School of Computer Science and Engineering
25 * The University of New South Wales
26 * Sydney, 2052
27 * Australia
28 */
29
9a9dab36 30#include "mdadm.h"
64c4757e 31
9255bbc8 32char Version[] = Name " - v2.5.6 - 9 November 2006\n";
4b1ac34b 33
64c4757e
NB
34/*
35 * File: ReadMe.c
36 *
37 * This file contains general comments about the implementation
9a9dab36 38 * and the various usage messages that can be displayed by mdadm
64c4757e 39 *
9a9dab36 40 * mdadm is a single program that can be used to control Linux md devices.
64c4757e
NB
41 * It is intended to provide all the functionality of the mdtools and
42 * raidtools but with a very different interface.
9a9dab36 43 * mdadm can perform all functions without a configuration file.
64c4757e
NB
44 * There is the option of using a configuration file, but not in the same
45 * way that raidtools uses one
46 * raidtools uses a configuration file to describe how to create a RAID
47 * array, and also uses this file partially to start a previously
48 * created RAID array. Further, raidtools requires the configuration
49 * file for such things as stopping a raid array which needs to know
50 * nothing about the array.
51 *
9a9dab36 52 * The configuration file that can be used by mdadm lists two
64c4757e
NB
53 * different things:
54 * 1/ a mapping from uuid to md device to identify which arrays are
55 * expect and what names (numbers) they should be given
56 * 2/ a list of devices that should be scanned for md sub-devices
57 *
58 *
59 */
60
61/*
dd0781e5 62 * mdadm has 7 major modes of operation:
64c4757e 63 * 1/ Create
5787fa49 64 * This mode is used to create a new array with a superblock
64c4757e
NB
65 * It can progress in several step create-add-add-run
66 * or it can all happen with one command
67 * 2/ Assemble
68 * This mode is used to assemble the parts of a previously created
69 * array into an active array. Components can be explicitly given
9a9dab36 70 * or can be searched for. mdadm (optionally) check that the components
5787fa49 71 * do form a bona-fide array, and can, on request, fiddle superblock
64c4757e
NB
72 * version numbers so as to assemble a faulty array.
73 * 3/ Build
74 * This is for building legacy arrays without superblocks
75 * 4/ Manage
e0d19036
NB
76 * This is for doing something to one or more devices
77 * in an array, such as add,remove,fail.
78 * run/stop/readonly/readwrite are also available
79 * 5/ Misc
80 * This is for doing things to individual devices.
81 * They might be parts of an array so
82 * zero-superblock, examine might be appropriate
83 * They might be md arrays so
84 * run,stop,rw,ro,detail might be appropriate
85 * Also query will treat it as either
86 * 6/ Monitor
87 * This mode never exits but just monitors arrays and reports changes.
dd0781e5
NB
88 * 7/ Grow
89 * This mode allows for changing of key attributes of a raid array, such
90 * as size, number of devices, and possibly even layout.
91 * At the time if writing, there is only minimal support.
64c4757e
NB
92 */
93
b90c0e9a
NB
94char short_options[]="-ABCDEFGQhVXWvqbc:i:l:p:m:n:x:u:c:d:z:U:sarfRSow1tye:";
95char short_bitmap_auto_options[]="-ABCDEFGQhVXWvqb:c:i:l:p:m:n:x:u:c:d:z:U:sa:rfRSow1tye:";
773135f5 96
64c4757e
NB
97struct option long_options[] = {
98 {"manage", 0, 0, '@'},
e0d19036 99 {"misc", 0, 0, '#'},
64c4757e
NB
100 {"assemble", 0, 0, 'A'},
101 {"build", 0, 0, 'B'},
102 {"create", 0, 0, 'C'},
103 {"detail", 0, 0, 'D'},
104 {"examine", 0, 0, 'E'},
52826846 105 {"follow", 0, 0, 'F'},
dd0781e5 106 {"grow", 0, 0, 'G'},
e0d19036
NB
107 {"zero-superblock", 0, 0, 'K'}, /* deliberately no a short_option */
108 {"query", 0, 0, 'Q'},
c82f047c 109 {"examine-bitmap", 0, 0, 'X'},
52826846
NB
110
111 /* synonyms */
112 {"monitor", 0, 0, 'F'},
113
64c4757e
NB
114 /* after those will normally come the name of the md device */
115 {"help", 0, 0, 'h'},
56eedc1a 116 {"help-options",0,0,'h'},
64c4757e
NB
117 {"version", 0, 0, 'V'},
118 {"verbose", 0, 0, 'v'},
dab6685f 119 {"quiet", 0, 0, 'q'},
64c4757e
NB
120
121 /* For create or build: */
122 {"chunk", 1, 0, 'c'},
123 {"rounding", 1, 0, 'c'}, /* for linear, chunk is really a rounding number */
98c6faba 124 {"level", 1, 0, 'l'}, /* 0,1,4,5,6,linear */
5787fa49 125 {"parity", 1, 0, 'p'}, /* {left,right}-{a,}symmetric */
64c4757e
NB
126 {"layout", 1, 0, 'p'},
127 {"raid-disks",1, 0, 'n'},
b83d95f3 128 {"raid-devices",1, 0, 'n'},
64c4757e 129 {"spare-disks",1,0, 'x'},
b83d95f3 130 {"spare-devices",1,0, 'x'},
dd0781e5 131 {"size", 1, 0, 'z'},
c82f047c 132 {"auto", 1, 0, 'a'}, /* also for --assemble */
997aed5d 133 {"assume-clean",0,0, AssumeClean },
f9ce90ba 134 {"metadata", 1, 0, 'e'}, /* superblock format */
c82f047c 135 {"bitmap", 1, 0, 'b'},
997aed5d
NB
136 {"bitmap-chunk", 1, 0, BitmapChunk},
137 {"write-behind", 2, 0, WriteBehind},
dfd4d8ee 138 {"write-mostly",0, 0, 'W'},
997aed5d
NB
139 {"re-add", 0, 0, ReAdd},
140 {"homehost", 1, 0, HomeHost},
589395d6 141 {"auto-update-homehost", 0, 0, AutoHomeHost},
38098016 142 {"symlinks", 1, 0, Symlinks},
64c4757e
NB
143
144 /* For assemble */
145 {"uuid", 1, 0, 'u'},
52826846 146 {"super-minor",1,0, 'm'},
947fd4dd 147 {"name", 1, 0, 'N'},
64c4757e
NB
148 {"config", 1, 0, 'c'},
149 {"scan", 0, 0, 's'},
150 {"force", 0, 0, 'f'},
5787fa49 151 {"update", 1, 0, 'U'},
dfd4d8ee 152
64c4757e
NB
153 /* Management */
154 {"add", 0, 0, 'a'},
155 {"remove", 0, 0, 'r'},
156 {"fail", 0, 0, 'f'},
157 {"set-faulty",0, 0, 'f'},
158 {"run", 0, 0, 'R'},
159 {"stop", 0, 0, 'S'},
160 {"readonly", 0, 0, 'o'},
161 {"readwrite", 0, 0, 'w'},
997aed5d 162 {"no-degraded",0,0, NoDegraded },
b90c0e9a 163 {"wait", 0, 0, 'W'},
52826846 164
cd29a5c8
NB
165 /* For Detail/Examine */
166 {"brief", 0, 0, 'b'},
997aed5d 167 {"sparc2.2", 0, 0, Sparc22},
feb716e9 168 {"test", 0, 0, 't'},
cd29a5c8 169
52826846
NB
170 /* For Follow/monitor */
171 {"mail", 1, 0, 'm'},
172 {"program", 1, 0, 'p'},
173 {"alert", 1, 0, 'p'},
174 {"delay", 1, 0, 'd'},
56eedc1a
NB
175 {"daemonise", 0, 0, 'f'},
176 {"daemonize", 0, 0, 'f'},
aa88f531 177 {"oneshot", 0, 0, '1'},
b5e64645 178 {"pid-file", 1, 0, 'i'},
90cf1ddd 179 {"syslog", 0, 0, 'y'},
06b0d786 180 /* For Grow */
997aed5d 181 {"backup-file", 1,0, BackupFile},
64c4757e
NB
182
183 {0, 0, 0, 0}
184};
185
186char Usage[] =
9a9dab36 187"Usage: mdadm --help\n"
64c4757e
NB
188" for help\n"
189;
190
191char Help[] =
e5a5d81e
NB
192"mdadm is used for building, managing, and monitoring\n"
193"Linux md devices (aka RAID arrays)\n"
9a9dab36 194"Usage: mdadm --create device options...\n"
e5a5d81e 195" Create a new array from unused devices.\n"
9a9dab36 196" mdadm --assemble device options...\n"
e968ba60 197" Assemble a previously created array.\n"
9a9dab36 198" mdadm --build device options...\n"
e5a5d81e 199" Create or assemble an array without metadata.\n"
e0d19036 200" mdadm --manage device options...\n"
e968ba60 201" make changes to an existing array.\n"
e0d19036 202" mdadm --misc options... devices\n"
e968ba60 203" report on or modify various md related devices.\n"
e0d19036 204" mdadm --monitor options...\n"
e968ba60 205" Monitor one or more array for significant changes.\n"
9a9dab36 206" mdadm device options...\n"
e968ba60 207" Shorthand for --manage.\n"
e5a5d81e
NB
208"Any parameter that does not start with '-' is treated as a device name\n"
209"or, for --examine-bitmap, a file name.\n"
210"The first such name is often the name of an md device. Subsequent\n"
211"names are often names of component devices.\n"
212"\n"
56eedc1a 213" For detailed help on the above major modes use --help after the mode\n"
e0d19036 214" e.g.\n"
9a9dab36 215" mdadm --assemble --help\n"
56eedc1a
NB
216" For general help on options use\n"
217" mdadm --help-options\n"
218;
219
220char OptionHelp[] =
64c4757e 221"Any parameter that does not start with '-' is treated as a device name\n"
c82f047c 222"or, for --examine-bitmap, a file name.\n"
e0d19036 223"The first such name is often the name of an md device. Subsequent\n"
e5a5d81e 224"names are often names of component devices.\n"
52826846 225"\n"
e0d19036 226"Some common options are:\n"
56eedc1a 227" --help -h : General help message or, after above option,\n"
64c4757e 228" mode specific help message\n"
56eedc1a 229" --help-options : This help message\n"
9a9dab36 230" --version -V : Print version information for mdadm\n"
64c4757e 231" --verbose -v : Be more verbose about what is happening\n"
dab6685f 232" --quiet -q : Don't print un-necessary messages\n"
e0d19036
NB
233" --brief -b : Be less verbose, more brief\n"
234" --force -f : Override normal checks and be more forceful\n"
235"\n"
236" --assemble -A : Assemble an array\n"
e5a5d81e 237" --build -B : Build an array without metadata\n"
e0d19036
NB
238" --create -C : Create a new array\n"
239" --detail -D : Display details of an array\n"
5787fa49 240" --examine -E : Examine superblock on an array component\n"
c82f047c 241" --examine-bitmap -X: Display the detail of a bitmap file\n"
e0d19036
NB
242" --monitor -F : monitor (follow) some arrays\n"
243" --query -Q : Display general information about how a\n"
244" device relates to the md driver\n"
245;
246/*
64c4757e
NB
247"\n"
248" For create or build:\n"
c82f047c 249" --bitmap= -b : File to store bitmap in - may pre-exist for --build\n"
64c4757e 250" --chunk= -c : chunk size of kibibytes\n"
5787fa49 251" --rounding= : rounding factor for linear array (==chunk size)\n"
98c6faba
NB
252" --level= -l : raid level: 0,1,4,5,6,linear,mp. 0 or linear for build\n"
253" --parity= -p : raid5/6 parity algorithm: {left,right}-{,a}symmetric\n"
64c4757e 254" --layout= : same as --parity\n"
b83d95f3
NB
255" --raid-devices= -n : number of active devices in array\n"
256" --spare-devices= -x: number of spares (eXtras) devices in initial array\n"
e5329c37 257" --size= -z : Size (in K) of each drive in RAID1/4/5/6/10 - optional\n"
52826846
NB
258" --force -f : Honour devices as listed on command line. Don't\n"
259" : insert a missing drive for RAID5.\n"
dd0781e5
NB
260" --auto(=p) -a : Automatically allocate new (partitioned) md array if needed.\n"
261" --assume-clean : Assume the array is already in-sync. This is dangerous.\n"
c82f047c
NB
262" --bitmap-chunk= : chunksize of bitmap in bitmap file (Kilobytes)\n"
263" --delay= -d : seconds between bitmap updates\n"
dfd4d8ee 264" --write-behind= : number of simultaneous write-behind requests to allow (requires bitmap)\n"
947fd4dd 265" --name= -N : Textual name for array - max 32 characters\n"
64c4757e
NB
266"\n"
267" For assemble:\n"
c82f047c 268" --bitmap= -b : File to find bitmap information in\n"
64c4757e
NB
269" --uuid= -u : uuid of array to assemble. Devices which don't\n"
270" have this uuid are excluded\n"
52826846
NB
271" --super-minor= -m : minor number to look for in super-block when\n"
272" choosing devices to use.\n"
947fd4dd 273" --name= -N : Array name to look for in super-block.\n"
64c4757e
NB
274" --config= -c : config file\n"
275" --scan -s : scan config file for missing information\n"
276" --force -f : Assemble the array even if some superblocks appear out-of-date\n"
cbfbcb0b 277" --update= -U : Update superblock: try '-A --update=?' for list of options.\n"
dd0781e5 278" --auto(=p) -a : Automatically allocate new (partitioned) md array if needed.\n"
b8a8ccf9 279" --no-degraded : Do not start any degraded arrays - default unless --scan.\n"
64c4757e 280"\n"
cd29a5c8
NB
281" For detail or examine:\n"
282" --brief -b : Just print device name and UUID\n"
283"\n"
52826846
NB
284" For follow/monitor:\n"
285" --mail= -m : Address to mail alerts of failure to\n"
286" --program= -p : Program to run when an event is detected\n"
287" --alert= : same as --program\n"
288" --delay= -d : seconds of delay between polling state. default=60\n"
289"\n"
64c4757e
NB
290" General management:\n"
291" --add -a : add, or hotadd subsequent devices\n"
292" --remove -r : remove subsequent devices\n"
293" --fail -f : mark subsequent devices a faulty\n"
294" --set-faulty : same as --fail\n"
295" --run -R : start a partially built array\n"
5787fa49 296" --stop -S : deactivate array, releasing all resources\n"
64c4757e
NB
297" --readonly -o : mark array as readonly\n"
298" --readwrite -w : mark array as readwrite\n"
9a9dab36 299" --zero-superblock : erase the MD superblock from a device.\n"
b90c0e9a 300" --wait -W : wait for recovery/resync/reshape to finish.\n"
64c4757e 301;
e0d19036 302*/
64c4757e
NB
303
304char Help_create[] =
b83d95f3 305"Usage: mdadm --create device -chunk=X --level=Y --raid-devices=Z devices\n"
64c4757e 306"\n"
aa88f531
NB
307" This usage will initialise a new md array, associate some\n"
308" devices with it, and activate the array. In order to create an\n"
309" array with some devices missing, use the special word 'missing' in\n"
310" place of the relevant device name.\n"
64c4757e 311"\n"
aa88f531 312" Before devices are added, they are checked to see if they already contain\n"
e0d19036 313" raid superblocks or filesystems. They are also checked to see if\n"
64c4757e 314" the variance in device size exceeds 1%.\n"
aa88f531
NB
315" If any discrepancy is found, the user will be prompted for confirmation\n"
316" before the array is created. The presence of a '--run' can override this\n"
64c4757e
NB
317" caution.\n"
318"\n"
e0d19036
NB
319" If the --size option is given then only that many kilobytes of each\n"
320" device is used, no matter how big each device is.\n"
682c7051 321" If no --size is given, the apparent size of the smallest drive given\n"
e0d19036
NB
322" is used for raid level 1 and greater, and the full device is used for\n"
323" other levels.\n"
682c7051 324"\n"
e0d19036 325" Options that are valid with --create (-C) are:\n"
c82f047c 326" --bitmap= : Create a bitmap for the array with the given filename\n"
e0d19036 327" --chunk= -c : chunk size of kibibytes\n"
5787fa49 328" --rounding= : rounding factor for linear array (==chunk size)\n"
98c6faba
NB
329" --level= -l : raid level: 0,1,4,5,6,linear,multipath and synonyms\n"
330" --parity= -p : raid5/6 parity algorithm: {left,right}-{,a}symmetric\n"
e0d19036 331" --layout= : same as --parity\n"
b83d95f3
NB
332" --raid-devices= -n : number of active devices in array\n"
333" --spare-devices= -x: number of spares (eXtras) devices in initial array\n"
e5329c37 334" --size= -z : Size (in K) of each drive in RAID1/4/5/6/10 - optional\n"
e0d19036
NB
335" --force -f : Honour devices as listed on command line. Don't\n"
336" : insert a missing drive for RAID5.\n"
aa88f531 337" --run -R : insist of running the array even if not all\n"
e0d19036 338" : devices are present or some look odd.\n"
aa88f531 339" --readonly -o : start the array readonly - not supported yet.\n"
947fd4dd 340" --name= -N : Textual name for array - max 32 characters\n"
c82f047c
NB
341" --bitmap-chunk= : bitmap chunksize in Kilobytes.\n"
342" --delay= -d : bitmap update delay in seconds.\n"
64c4757e
NB
343"\n"
344;
345
346char Help_build[] =
b83d95f3 347"Usage: mdadm --build device -chunk=X --level=Y --raid-devices=Z devices\n"
64c4757e
NB
348"\n"
349" This usage is similar to --create. The difference is that it creates\n"
e0d19036 350" a legacy array without a superblock. With these arrays there is no\n"
64c4757e
NB
351" different between initially creating the array and subsequently\n"
352" assembling the array, except that hopefully there is useful data\n"
353" there in the second case.\n"
354"\n"
e0d19036 355" The level may only be 0, raid0, or linear.\n"
64c4757e 356" All devices must be listed and the array will be started once complete.\n"
e0d19036 357" Options that are valid with --build (-B) are:\n"
c82f047c 358" --bitmap= : file to store/find bitmap information in.\n"
e0d19036 359" --chunk= -c : chunk size of kibibytes\n"
5787fa49 360" --rounding= : rounding factor for linear array (==chunk size)\n"
e0d19036 361" --level= -l : 0, raid0, or linear\n"
c82f047c
NB
362" --raid-devices= -n : number of active devices in array\n"
363" --bitmap-chunk= : bitmap chunksize in Kilobytes.\n"
364" --delay= -d : bitmap update delay in seconds.\n"
64c4757e
NB
365;
366
367char Help_assemble[] =
9a9dab36
NB
368"Usage: mdadm --assemble device options...\n"
369" mdadm --assemble --scan options...\n"
64c4757e
NB
370"\n"
371"This usage assembles one or more raid arrays from pre-existing\n"
372"components.\n"
e0d19036 373"For each array, mdadm needs to know the md device, the identity of\n"
52826846
NB
374"the array, and a number of sub devices. These can be found in a number\n"
375"of ways.\n"
376"\n"
377"The md device is either given on the command line or is found listed\n"
378"in the config file. The array identity is determined either from the\n"
e0d19036 379"--uuid or --super-minor commandline arguments, from the config file,\n"
52826846 380"or from the first component device on the command line.\n"
64c4757e 381"\n"
52826846
NB
382"The different combinations of these are as follows:\n"
383" If the --scan option is not given, then only devices and identities\n"
384" listed on the command line are considered.\n"
e0d19036 385" The first device will be the array device, and the remainder will be\n"
52826846
NB
386" examined when looking for components.\n"
387" If an explicit identity is given with --uuid or --super-minor, then\n"
e0d19036 388" only devices with a superblock which matches that identity is considered,\n"
52826846 389" otherwise every device listed is considered.\n"
64c4757e 390"\n"
52826846
NB
391" If the --scan option is given, and no devices are listed, then\n"
392" every array listed in the config file is considered for assembly.\n"
e0d19036 393" The identity of candidate devices are determined from the config file.\n"
64c4757e 394"\n"
52826846
NB
395" If the --scan option is given as well as one or more devices, then\n"
396" Those devices are md devices that are to be assembled. Their identity\n"
397" and components are determined from the config file.\n"
64c4757e 398"\n"
b8a8ccf9
NB
399" If mdadm can not find all of the components for an array, it will assemble\n"
400" it but not activate it unless --run or --scan is given. To preserve this\n"
401" behaviour even with --scan, add --no-degraded. Note that \"all of the\n"
402" components\" means as many as were present the last time the array was running\n"
403" as recorded in the superblock. If the array was already degraded, and\n"
404" the missing device is not a new problem, it will still be assembled. It\n"
405" is only newly missing devices that cause the array not to be started.\n"
406"\n"
e0d19036 407"Options that are valid with --assemble (-A) are:\n"
c82f047c 408" --bitmap= : bitmap file to use wit the array\n"
e0d19036
NB
409" --uuid= -u : uuid of array to assemble. Devices which don't\n"
410" have this uuid are excluded\n"
411" --super-minor= -m : minor number to look for in super-block when\n"
412" choosing devices to use.\n"
947fd4dd 413" --name= -N : Array name to look for in super-block.\n"
e0d19036
NB
414" --config= -c : config file\n"
415" --scan -s : scan config file for missing information\n"
416" --run -R : Try to start the array even if not enough devices\n"
417" for a full array are present\n"
418" --force -f : Assemble the array even if some superblocks appear\n"
419" : out-of-date. This involves modifying the superblocks.\n"
cbfbcb0b 420" --update= -U : Update superblock: try '-A --update=?' for option list.\n"
b8a8ccf9 421" --no-degraded : Assemble but do not start degraded arrays.\n"
e0d19036
NB
422;
423
424char Help_manage[] =
425"Usage: mdadm arraydevice options component devices...\n"
426"\n"
427"This usage is for managing the component devices within an array.\n"
428"The --manage option is not needed and is assumed if the first argument\n"
429"is a device name or a management option.\n"
430"The first device listed will be taken to be an md array device, and\n"
431"subsequent devices are (potential) components of that array.\n"
432"\n"
433"Options that are valid with management mode are:\n"
434" --add -a : hotadd subsequent devices to the array\n"
435" --remove -r : remove subsequent devices, which must not be active\n"
436" --fail -f : mark subsequent devices a faulty\n"
437" --set-faulty : same as --fail\n"
438" --run -R : start a partially built array\n"
5787fa49 439" --stop -S : deactivate array, releasing all resources\n"
e0d19036
NB
440" --readonly -o : mark array as readonly\n"
441" --readwrite -w : mark array as readwrite\n"
442;
443
444char Help_misc[] =
445"Usage: mdadm misc_option devices...\n"
446"\n"
447"This usage is for performing some task on one or more devices, which\n"
448"may be arrays or components, depending on the task.\n"
449"The --misc option is not needed (though it is allowed) and is assumed\n"
450"if the first argument in a misc option.\n"
451"\n"
452"Options that are valid with the miscellaneous mode are:\n"
453" --query -Q : Display general information about how a\n"
454" device relates to the md driver\n"
455" --detail -D : Display details of an array\n"
5787fa49 456" --examine -E : Examine superblock on an array component\n"
c82f047c 457" --examine-bitmap -X: Display contents of a bitmap file\n"
e0d19036
NB
458" --zero-superblock : erase the MD superblock from a device.\n"
459" --run -R : start a partially built array\n"
5787fa49 460" --stop -S : deactivate array, releasing all resources\n"
e0d19036
NB
461" --readonly -o : mark array as readonly\n"
462" --readwrite -w : mark array as readwrite\n"
feb716e9 463" --test -t : exit status 0 if ok, 1 if degrade, 2 if dead, 4 if missing\n"
b90c0e9a 464" --wait -W : wait for resync/rebuild/recovery to finish\n"
e0d19036
NB
465;
466
467char Help_monitor[] =
468"Usage: mdadm --monitor options devices\n"
469"\n"
470"This usage causes mdadm to monitor a number of md arrays by periodically\n"
471"polling their status and acting on any changes.\n"
472"If any devices are listed then those devices are monitored, otherwise\n"
473"all devices listed in the config file are monitored.\n"
474"The address for mailing advisories to, and the program to handle\n"
475"each change can be specified in the config file or on the command line.\n"
476"If no mail address or program are specified, then mdadm reports all\n"
477"state changes to stdout.\n"
478"\n"
dd0781e5 479"Options that are valid with the monitor (-F --follow) mode are:\n"
e0d19036
NB
480" --mail= -m : Address to mail alerts of failure to\n"
481" --program= -p : Program to run when an event is detected\n"
482" --alert= : same as --program\n"
483" --delay= -d : seconds of delay between polling state. default=60\n"
484" --config= -c : specify a different config file\n"
485" --scan -s : find mail-address/program in config file\n"
d013a55e 486" --daemonise -f : Fork and continue in child, parent exits\n"
b5e64645 487" --pid-file= -i : In daemon mode write pid to specified file instead of stdout\n"
aa88f531 488" --oneshot -1 : Check for degraded arrays, then exit\n"
98c6faba 489" --test -t : Generate a TestMessage event against each array at startup\n"
e0d19036
NB
490;
491
dd0781e5
NB
492char Help_grow[] =
493"Usage: mdadm --grow device options\n"
494"\n"
495"This usage causes mdadm to attempt to reconfigure a running array.\n"
496"This is only possibly if the kernel being used supports a particular\n"
497"reconfiguration. This version only supports changing the number of\n"
498"devices in a RAID1, and changing the active size of all devices in\n"
499"a RAID1/4/5/6.\n"
500"\n"
891d2994 501"Options that are valid with the grow (-G --grow) mode are:\n"
dd0781e5
NB
502" --size= -z : Change the active size of devices in an array.\n"
503" : This is useful if all devices have been replaced\n"
504" : with larger devices.\n"
505" --raid-disks= -n : Change the number of active devices in a RAID1\n"
506" : array.\n"
507;
e0d19036
NB
508
509
510
511char Help_config[] =
512"The /etc/mdadm.conf config file:\n\n"
513" The config file contains, apart from blank lines and comment lines that\n"
514" start with a hash(#), four sorts of configuration lines: array lines, \n"
515" device lines, mailaddr lines and program lines.\n"
516" Each configuration line is constructed of a number of space separated\n"
517" words, and can be continued on subsequent physical lines by indenting\n"
518" those lines.\n"
519"\n"
520" A device line starts with the word 'device' and then has a number of words\n"
521" which identify devices. These words should be names of devices in the\n"
522" filesystem, and can contain wildcards. There can be multiple words or each\n"
523" device line, and multiple device lines. All devices so listed are checked\n"
524" for relevant super blocks when assembling arrays.\n"
525"\n"
526" An array line start with the word 'array'. This is followed by the name of\n"
527" the array device in the filesystem, e.g. '/dev/md2'. Subsequent words\n"
528" describe the identity of the array, used to recognise devices to include in the\n"
529" array. The identity can be given as a UUID with a word starting 'uuid=', or\n"
530" as a minor-number stored in the superblock using 'super-minor=', or as a list\n"
531" of devices. This is given as a comma separated list of names, possibly\n"
5787fa49 532" containing wildcards, preceded by 'devices='. If multiple critea are given,\n"
e0d19036
NB
533" than a device must match all of them to be considered.\n"
534"\n"
535" A mailaddr line starts with the word 'mailaddr' and should contain exactly\n"
536" one Email address. 'mdadm --monitor --scan' will send alerts of failed drives\n"
537" to this Email address."
538"\n"
539" A program line starts with the word 'program' and should contain exactly\n"
540" one program name. 'mdadm --monitor --scan' will run this program when any\n"
541" event is detected.\n"
64c4757e
NB
542"\n"
543;
682c7051
NB
544
545
546/* name/number mappings */
547
548mapping_t r5layout[] = {
cd29a5c8
NB
549 { "left-asymmetric", 0},
550 { "right-asymmetric", 1},
551 { "left-symmetric", 2},
552 { "right-symmetric", 3},
682c7051
NB
553
554 { "default", 2},
555 { "la", 0},
556 { "ra", 1},
557 { "ls", 2},
558 { "rs", 3},
559 { NULL, 0}
560};
561
562mapping_t pers[] = {
563 { "linear", -1},
564 { "raid0", 0},
565 { "0", 0},
566 { "stripe", 0},
567 { "raid1", 1},
568 { "1", 1},
569 { "mirror", 1},
570 { "raid4", 4},
571 { "4", 4},
572 { "raid5", 5},
573 { "5", 5},
e0d19036
NB
574 { "multipath", -4},
575 { "mp", -4},
98c6faba
NB
576 { "raid6", 6},
577 { "6", 6},
e5329c37
NB
578 { "raid10", 10},
579 { "10", 10},
b5e64645 580 { "faulty", -5},
682c7051
NB
581 { NULL, 0}
582};
e0d19036
NB
583
584
585mapping_t modes[] = {
586 { "assemble", ASSEMBLE},
587 { "build", BUILD},
588 { "create", CREATE},
589 { "manage", MANAGE},
590 { "misc", MISC},
591 { "monitor", MONITOR},
dd0781e5 592 { "grow", GROW},
e0d19036 593};
b5e64645
NB
594
595mapping_t faultylayout[] = {
596 { "write-transient", WriteTransient },
597 { "wt", WriteTransient },
598 { "read-transient", ReadTransient },
599 { "rt", ReadTransient },
600 { "write-persistent", WritePersistent },
601 { "wp", WritePersistent },
602 { "read-persistent", ReadPersistent },
603 { "rp", ReadPersistent },
604 { "write-all", WriteAll },
605 { "wa", WriteAll },
606 { "read-fixable", ReadFixable },
607 { "rf", ReadFixable },
608
609 { "clear", ClearErrors},
610 { "flush", ClearFaults},
611 { "none", ClearErrors},
612 { "default", ClearErrors},
613 { NULL, 0}
614};