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