]>
Commit | Line | Data |
---|---|---|
64c4757e | 1 | /* |
9a9dab36 | 2 | * mdadm - manage Linux "md" devices aka RAID arrays. |
64c4757e | 3 | * |
cd29a5c8 | 4 | * Copyright (C) 2001-2002 Neil Brown <neilb@cse.unsw.edu.au> |
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 | |
e793c2e5 | 32 | char Version[] = Name " - v2.0-devel-1 - DEVELOPMENT VERSION NOT FOR REGULAR USE - 18 February 2005\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 | ||
c82f047c | 94 | char short_options[]="-ABCDEFGQhVXvb::c:i:l:p:m:n:x:u:c:d:z:U:sa::rfRSow1te:"; |
64c4757e NB |
95 | struct option long_options[] = { |
96 | {"manage", 0, 0, '@'}, | |
e0d19036 | 97 | {"misc", 0, 0, '#'}, |
64c4757e NB |
98 | {"assemble", 0, 0, 'A'}, |
99 | {"build", 0, 0, 'B'}, | |
100 | {"create", 0, 0, 'C'}, | |
101 | {"detail", 0, 0, 'D'}, | |
102 | {"examine", 0, 0, 'E'}, | |
52826846 | 103 | {"follow", 0, 0, 'F'}, |
dd0781e5 | 104 | {"grow", 0, 0, 'G'}, |
e0d19036 NB |
105 | {"zero-superblock", 0, 0, 'K'}, /* deliberately no a short_option */ |
106 | {"query", 0, 0, 'Q'}, | |
c82f047c | 107 | {"examine-bitmap", 0, 0, 'X'}, |
52826846 NB |
108 | |
109 | /* synonyms */ | |
110 | {"monitor", 0, 0, 'F'}, | |
111 | ||
64c4757e NB |
112 | /* after those will normally come the name of the md device */ |
113 | {"help", 0, 0, 'h'}, | |
56eedc1a | 114 | {"help-options",0,0,'h'}, |
64c4757e NB |
115 | {"version", 0, 0, 'V'}, |
116 | {"verbose", 0, 0, 'v'}, | |
117 | ||
118 | /* For create or build: */ | |
119 | {"chunk", 1, 0, 'c'}, | |
120 | {"rounding", 1, 0, 'c'}, /* for linear, chunk is really a rounding number */ | |
98c6faba | 121 | {"level", 1, 0, 'l'}, /* 0,1,4,5,6,linear */ |
5787fa49 | 122 | {"parity", 1, 0, 'p'}, /* {left,right}-{a,}symmetric */ |
64c4757e NB |
123 | {"layout", 1, 0, 'p'}, |
124 | {"raid-disks",1, 0, 'n'}, | |
b83d95f3 | 125 | {"raid-devices",1, 0, 'n'}, |
64c4757e | 126 | {"spare-disks",1,0, 'x'}, |
b83d95f3 | 127 | {"spare-devices",1,0, 'x'}, |
dd0781e5 | 128 | {"size", 1, 0, 'z'}, |
c82f047c | 129 | {"auto", 1, 0, 'a'}, /* also for --assemble */ |
dd0781e5 | 130 | {"assume-clean",0,0, 3 }, |
f9ce90ba | 131 | {"metadata", 1, 0, 'e'}, /* superblock format */ |
c82f047c NB |
132 | {"bitmap", 1, 0, 'b'}, |
133 | {"bitmap-chunk", 1, 0, 4}, | |
64c4757e NB |
134 | |
135 | /* For assemble */ | |
136 | {"uuid", 1, 0, 'u'}, | |
52826846 | 137 | {"super-minor",1,0, 'm'}, |
64c4757e NB |
138 | {"config", 1, 0, 'c'}, |
139 | {"scan", 0, 0, 's'}, | |
140 | {"force", 0, 0, 'f'}, | |
5787fa49 | 141 | {"update", 1, 0, 'U'}, |
64c4757e NB |
142 | /* Management */ |
143 | {"add", 0, 0, 'a'}, | |
144 | {"remove", 0, 0, 'r'}, | |
145 | {"fail", 0, 0, 'f'}, | |
146 | {"set-faulty",0, 0, 'f'}, | |
147 | {"run", 0, 0, 'R'}, | |
148 | {"stop", 0, 0, 'S'}, | |
149 | {"readonly", 0, 0, 'o'}, | |
150 | {"readwrite", 0, 0, 'w'}, | |
52826846 | 151 | |
cd29a5c8 NB |
152 | /* For Detail/Examine */ |
153 | {"brief", 0, 0, 'b'}, | |
bd526cee | 154 | {"sparc2.2", 0, 0, 22}, |
feb716e9 | 155 | {"test", 0, 0, 't'}, |
cd29a5c8 | 156 | |
52826846 NB |
157 | /* For Follow/monitor */ |
158 | {"mail", 1, 0, 'm'}, | |
159 | {"program", 1, 0, 'p'}, | |
160 | {"alert", 1, 0, 'p'}, | |
161 | {"delay", 1, 0, 'd'}, | |
56eedc1a NB |
162 | {"daemonise", 0, 0, 'f'}, |
163 | {"daemonize", 0, 0, 'f'}, | |
aa88f531 | 164 | {"oneshot", 0, 0, '1'}, |
b5e64645 | 165 | {"pid-file", 1, 0, 'i'}, |
64c4757e NB |
166 | |
167 | {0, 0, 0, 0} | |
168 | }; | |
169 | ||
170 | char Usage[] = | |
9a9dab36 | 171 | "Usage: mdadm --help\n" |
64c4757e NB |
172 | " for help\n" |
173 | ; | |
174 | ||
175 | char Help[] = | |
9a9dab36 NB |
176 | "Usage: mdadm --create device options...\n" |
177 | " mdadm --assemble device options...\n" | |
178 | " mdadm --build device options...\n" | |
e0d19036 NB |
179 | " mdadm --manage device options...\n" |
180 | " mdadm --misc options... devices\n" | |
181 | " mdadm --monitor options...\n" | |
9a9dab36 | 182 | " mdadm device options...\n" |
5787fa49 | 183 | " mdadm is used for building, managing, and monitoring\n" |
56eedc1a NB |
184 | " Linux md devices (aka RAID arrays)\n" |
185 | " For detailed help on the above major modes use --help after the mode\n" | |
e0d19036 | 186 | " e.g.\n" |
9a9dab36 | 187 | " mdadm --assemble --help\n" |
56eedc1a NB |
188 | " For general help on options use\n" |
189 | " mdadm --help-options\n" | |
190 | ; | |
191 | ||
192 | char OptionHelp[] = | |
64c4757e | 193 | "Any parameter that does not start with '-' is treated as a device name\n" |
c82f047c | 194 | "or, for --examine-bitmap, a file name.\n" |
e0d19036 NB |
195 | "The first such name is often the name of an md device. Subsequent\n" |
196 | "names are often names of component devices." | |
52826846 | 197 | "\n" |
e0d19036 | 198 | "Some common options are:\n" |
56eedc1a | 199 | " --help -h : General help message or, after above option,\n" |
64c4757e | 200 | " mode specific help message\n" |
56eedc1a | 201 | " --help-options : This help message\n" |
9a9dab36 | 202 | " --version -V : Print version information for mdadm\n" |
64c4757e | 203 | " --verbose -v : Be more verbose about what is happening\n" |
e0d19036 NB |
204 | " --brief -b : Be less verbose, more brief\n" |
205 | " --force -f : Override normal checks and be more forceful\n" | |
206 | "\n" | |
207 | " --assemble -A : Assemble an array\n" | |
208 | " --build -B : Build a legacy array\n" | |
209 | " --create -C : Create a new array\n" | |
210 | " --detail -D : Display details of an array\n" | |
5787fa49 | 211 | " --examine -E : Examine superblock on an array component\n" |
c82f047c | 212 | " --examine-bitmap -X: Display the detail of a bitmap file\n" |
e0d19036 NB |
213 | " --monitor -F : monitor (follow) some arrays\n" |
214 | " --query -Q : Display general information about how a\n" | |
215 | " device relates to the md driver\n" | |
216 | ; | |
217 | /* | |
64c4757e NB |
218 | "\n" |
219 | " For create or build:\n" | |
c82f047c | 220 | " --bitmap= -b : File to store bitmap in - may pre-exist for --build\n" |
64c4757e | 221 | " --chunk= -c : chunk size of kibibytes\n" |
5787fa49 | 222 | " --rounding= : rounding factor for linear array (==chunk size)\n" |
98c6faba NB |
223 | " --level= -l : raid level: 0,1,4,5,6,linear,mp. 0 or linear for build\n" |
224 | " --parity= -p : raid5/6 parity algorithm: {left,right}-{,a}symmetric\n" | |
64c4757e | 225 | " --layout= : same as --parity\n" |
b83d95f3 NB |
226 | " --raid-devices= -n : number of active devices in array\n" |
227 | " --spare-devices= -x: number of spares (eXtras) devices in initial array\n" | |
e5329c37 | 228 | " --size= -z : Size (in K) of each drive in RAID1/4/5/6/10 - optional\n" |
52826846 NB |
229 | " --force -f : Honour devices as listed on command line. Don't\n" |
230 | " : insert a missing drive for RAID5.\n" | |
dd0781e5 NB |
231 | " --auto(=p) -a : Automatically allocate new (partitioned) md array if needed.\n" |
232 | " --assume-clean : Assume the array is already in-sync. This is dangerous.\n" | |
c82f047c NB |
233 | " --bitmap-chunk= : chunksize of bitmap in bitmap file (Kilobytes)\n" |
234 | " --delay= -d : seconds between bitmap updates\n" | |
64c4757e NB |
235 | "\n" |
236 | " For assemble:\n" | |
c82f047c | 237 | " --bitmap= -b : File to find bitmap information in\n" |
64c4757e NB |
238 | " --uuid= -u : uuid of array to assemble. Devices which don't\n" |
239 | " have this uuid are excluded\n" | |
52826846 NB |
240 | " --super-minor= -m : minor number to look for in super-block when\n" |
241 | " choosing devices to use.\n" | |
64c4757e NB |
242 | " --config= -c : config file\n" |
243 | " --scan -s : scan config file for missing information\n" | |
244 | " --force -f : Assemble the array even if some superblocks appear out-of-date\n" | |
feb716e9 | 245 | " --update= -U : Update superblock: one of sparc2.2, super-minor or summaries\n" |
dd0781e5 | 246 | " --auto(=p) -a : Automatically allocate new (partitioned) md array if needed.\n" |
64c4757e | 247 | "\n" |
cd29a5c8 NB |
248 | " For detail or examine:\n" |
249 | " --brief -b : Just print device name and UUID\n" | |
250 | "\n" | |
52826846 NB |
251 | " For follow/monitor:\n" |
252 | " --mail= -m : Address to mail alerts of failure to\n" | |
253 | " --program= -p : Program to run when an event is detected\n" | |
254 | " --alert= : same as --program\n" | |
255 | " --delay= -d : seconds of delay between polling state. default=60\n" | |
256 | "\n" | |
64c4757e NB |
257 | " General management:\n" |
258 | " --add -a : add, or hotadd subsequent devices\n" | |
259 | " --remove -r : remove subsequent devices\n" | |
260 | " --fail -f : mark subsequent devices a faulty\n" | |
261 | " --set-faulty : same as --fail\n" | |
262 | " --run -R : start a partially built array\n" | |
5787fa49 | 263 | " --stop -S : deactivate array, releasing all resources\n" |
64c4757e NB |
264 | " --readonly -o : mark array as readonly\n" |
265 | " --readwrite -w : mark array as readwrite\n" | |
9a9dab36 | 266 | " --zero-superblock : erase the MD superblock from a device.\n" |
64c4757e | 267 | ; |
e0d19036 | 268 | */ |
64c4757e NB |
269 | |
270 | char Help_create[] = | |
b83d95f3 | 271 | "Usage: mdadm --create device -chunk=X --level=Y --raid-devices=Z devices\n" |
64c4757e | 272 | "\n" |
aa88f531 NB |
273 | " This usage will initialise a new md array, associate some\n" |
274 | " devices with it, and activate the array. In order to create an\n" | |
275 | " array with some devices missing, use the special word 'missing' in\n" | |
276 | " place of the relevant device name.\n" | |
64c4757e | 277 | "\n" |
aa88f531 | 278 | " Before devices are added, they are checked to see if they already contain\n" |
e0d19036 | 279 | " raid superblocks or filesystems. They are also checked to see if\n" |
64c4757e | 280 | " the variance in device size exceeds 1%.\n" |
aa88f531 NB |
281 | " If any discrepancy is found, the user will be prompted for confirmation\n" |
282 | " before the array is created. The presence of a '--run' can override this\n" | |
64c4757e NB |
283 | " caution.\n" |
284 | "\n" | |
e0d19036 NB |
285 | " If the --size option is given then only that many kilobytes of each\n" |
286 | " device is used, no matter how big each device is.\n" | |
682c7051 | 287 | " If no --size is given, the apparent size of the smallest drive given\n" |
e0d19036 NB |
288 | " is used for raid level 1 and greater, and the full device is used for\n" |
289 | " other levels.\n" | |
682c7051 | 290 | "\n" |
e0d19036 | 291 | " Options that are valid with --create (-C) are:\n" |
c82f047c | 292 | " --bitmap= : Create a bitmap for the array with the given filename\n" |
e0d19036 | 293 | " --chunk= -c : chunk size of kibibytes\n" |
5787fa49 | 294 | " --rounding= : rounding factor for linear array (==chunk size)\n" |
98c6faba NB |
295 | " --level= -l : raid level: 0,1,4,5,6,linear,multipath and synonyms\n" |
296 | " --parity= -p : raid5/6 parity algorithm: {left,right}-{,a}symmetric\n" | |
e0d19036 | 297 | " --layout= : same as --parity\n" |
b83d95f3 NB |
298 | " --raid-devices= -n : number of active devices in array\n" |
299 | " --spare-devices= -x: number of spares (eXtras) devices in initial array\n" | |
e5329c37 | 300 | " --size= -z : Size (in K) of each drive in RAID1/4/5/6/10 - optional\n" |
e0d19036 NB |
301 | " --force -f : Honour devices as listed on command line. Don't\n" |
302 | " : insert a missing drive for RAID5.\n" | |
aa88f531 | 303 | " --run -R : insist of running the array even if not all\n" |
e0d19036 | 304 | " : devices are present or some look odd.\n" |
aa88f531 | 305 | " --readonly -o : start the array readonly - not supported yet.\n" |
c82f047c NB |
306 | " --bitmap-chunk= : bitmap chunksize in Kilobytes.\n" |
307 | " --delay= -d : bitmap update delay in seconds.\n" | |
64c4757e NB |
308 | "\n" |
309 | ; | |
310 | ||
311 | char Help_build[] = | |
b83d95f3 | 312 | "Usage: mdadm --build device -chunk=X --level=Y --raid-devices=Z devices\n" |
64c4757e NB |
313 | "\n" |
314 | " This usage is similar to --create. The difference is that it creates\n" | |
e0d19036 | 315 | " a legacy array without a superblock. With these arrays there is no\n" |
64c4757e NB |
316 | " different between initially creating the array and subsequently\n" |
317 | " assembling the array, except that hopefully there is useful data\n" | |
318 | " there in the second case.\n" | |
319 | "\n" | |
e0d19036 | 320 | " The level may only be 0, raid0, or linear.\n" |
64c4757e | 321 | " All devices must be listed and the array will be started once complete.\n" |
e0d19036 | 322 | " Options that are valid with --build (-B) are:\n" |
c82f047c | 323 | " --bitmap= : file to store/find bitmap information in.\n" |
e0d19036 | 324 | " --chunk= -c : chunk size of kibibytes\n" |
5787fa49 | 325 | " --rounding= : rounding factor for linear array (==chunk size)\n" |
e0d19036 | 326 | " --level= -l : 0, raid0, or linear\n" |
c82f047c NB |
327 | " --raid-devices= -n : number of active devices in array\n" |
328 | " --bitmap-chunk= : bitmap chunksize in Kilobytes.\n" | |
329 | " --delay= -d : bitmap update delay in seconds.\n" | |
64c4757e NB |
330 | ; |
331 | ||
332 | char Help_assemble[] = | |
9a9dab36 NB |
333 | "Usage: mdadm --assemble device options...\n" |
334 | " mdadm --assemble --scan options...\n" | |
64c4757e NB |
335 | "\n" |
336 | "This usage assembles one or more raid arrays from pre-existing\n" | |
337 | "components.\n" | |
e0d19036 | 338 | "For each array, mdadm needs to know the md device, the identity of\n" |
52826846 NB |
339 | "the array, and a number of sub devices. These can be found in a number\n" |
340 | "of ways.\n" | |
341 | "\n" | |
342 | "The md device is either given on the command line or is found listed\n" | |
343 | "in the config file. The array identity is determined either from the\n" | |
e0d19036 | 344 | "--uuid or --super-minor commandline arguments, from the config file,\n" |
52826846 | 345 | "or from the first component device on the command line.\n" |
64c4757e | 346 | "\n" |
52826846 NB |
347 | "The different combinations of these are as follows:\n" |
348 | " If the --scan option is not given, then only devices and identities\n" | |
349 | " listed on the command line are considered.\n" | |
e0d19036 | 350 | " The first device will be the array device, and the remainder will be\n" |
52826846 NB |
351 | " examined when looking for components.\n" |
352 | " If an explicit identity is given with --uuid or --super-minor, then\n" | |
e0d19036 | 353 | " only devices with a superblock which matches that identity is considered,\n" |
52826846 | 354 | " otherwise every device listed is considered.\n" |
64c4757e | 355 | "\n" |
52826846 NB |
356 | " If the --scan option is given, and no devices are listed, then\n" |
357 | " every array listed in the config file is considered for assembly.\n" | |
e0d19036 | 358 | " The identity of candidate devices are determined from the config file.\n" |
64c4757e | 359 | "\n" |
52826846 NB |
360 | " If the --scan option is given as well as one or more devices, then\n" |
361 | " Those devices are md devices that are to be assembled. Their identity\n" | |
362 | " and components are determined from the config file.\n" | |
64c4757e | 363 | "\n" |
e0d19036 | 364 | "Options that are valid with --assemble (-A) are:\n" |
c82f047c | 365 | " --bitmap= : bitmap file to use wit the array\n" |
e0d19036 NB |
366 | " --uuid= -u : uuid of array to assemble. Devices which don't\n" |
367 | " have this uuid are excluded\n" | |
368 | " --super-minor= -m : minor number to look for in super-block when\n" | |
369 | " choosing devices to use.\n" | |
370 | " --config= -c : config file\n" | |
371 | " --scan -s : scan config file for missing information\n" | |
372 | " --run -R : Try to start the array even if not enough devices\n" | |
373 | " for a full array are present\n" | |
374 | " --force -f : Assemble the array even if some superblocks appear\n" | |
375 | " : out-of-date. This involves modifying the superblocks.\n" | |
feb716e9 | 376 | " --update= -U : Update superblock: one of sparc2.2, super-minor or summaries\n" |
e0d19036 NB |
377 | ; |
378 | ||
379 | char Help_manage[] = | |
380 | "Usage: mdadm arraydevice options component devices...\n" | |
381 | "\n" | |
382 | "This usage is for managing the component devices within an array.\n" | |
383 | "The --manage option is not needed and is assumed if the first argument\n" | |
384 | "is a device name or a management option.\n" | |
385 | "The first device listed will be taken to be an md array device, and\n" | |
386 | "subsequent devices are (potential) components of that array.\n" | |
387 | "\n" | |
388 | "Options that are valid with management mode are:\n" | |
389 | " --add -a : hotadd subsequent devices to the array\n" | |
390 | " --remove -r : remove subsequent devices, which must not be active\n" | |
391 | " --fail -f : mark subsequent devices a faulty\n" | |
392 | " --set-faulty : same as --fail\n" | |
393 | " --run -R : start a partially built array\n" | |
5787fa49 | 394 | " --stop -S : deactivate array, releasing all resources\n" |
e0d19036 NB |
395 | " --readonly -o : mark array as readonly\n" |
396 | " --readwrite -w : mark array as readwrite\n" | |
397 | ; | |
398 | ||
399 | char Help_misc[] = | |
400 | "Usage: mdadm misc_option devices...\n" | |
401 | "\n" | |
402 | "This usage is for performing some task on one or more devices, which\n" | |
403 | "may be arrays or components, depending on the task.\n" | |
404 | "The --misc option is not needed (though it is allowed) and is assumed\n" | |
405 | "if the first argument in a misc option.\n" | |
406 | "\n" | |
407 | "Options that are valid with the miscellaneous mode are:\n" | |
408 | " --query -Q : Display general information about how a\n" | |
409 | " device relates to the md driver\n" | |
410 | " --detail -D : Display details of an array\n" | |
5787fa49 | 411 | " --examine -E : Examine superblock on an array component\n" |
c82f047c | 412 | " --examine-bitmap -X: Display contents of a bitmap file\n" |
e0d19036 NB |
413 | " --zero-superblock : erase the MD superblock from a device.\n" |
414 | " --run -R : start a partially built array\n" | |
5787fa49 | 415 | " --stop -S : deactivate array, releasing all resources\n" |
e0d19036 NB |
416 | " --readonly -o : mark array as readonly\n" |
417 | " --readwrite -w : mark array as readwrite\n" | |
feb716e9 | 418 | " --test -t : exit status 0 if ok, 1 if degrade, 2 if dead, 4 if missing\n" |
e0d19036 NB |
419 | ; |
420 | ||
421 | char Help_monitor[] = | |
422 | "Usage: mdadm --monitor options devices\n" | |
423 | "\n" | |
424 | "This usage causes mdadm to monitor a number of md arrays by periodically\n" | |
425 | "polling their status and acting on any changes.\n" | |
426 | "If any devices are listed then those devices are monitored, otherwise\n" | |
427 | "all devices listed in the config file are monitored.\n" | |
428 | "The address for mailing advisories to, and the program to handle\n" | |
429 | "each change can be specified in the config file or on the command line.\n" | |
430 | "If no mail address or program are specified, then mdadm reports all\n" | |
431 | "state changes to stdout.\n" | |
432 | "\n" | |
dd0781e5 | 433 | "Options that are valid with the monitor (-F --follow) mode are:\n" |
e0d19036 NB |
434 | " --mail= -m : Address to mail alerts of failure to\n" |
435 | " --program= -p : Program to run when an event is detected\n" | |
436 | " --alert= : same as --program\n" | |
437 | " --delay= -d : seconds of delay between polling state. default=60\n" | |
438 | " --config= -c : specify a different config file\n" | |
439 | " --scan -s : find mail-address/program in config file\n" | |
d013a55e | 440 | " --daemonise -f : Fork and continue in child, parent exits\n" |
b5e64645 | 441 | " --pid-file= -i : In daemon mode write pid to specified file instead of stdout\n" |
aa88f531 | 442 | " --oneshot -1 : Check for degraded arrays, then exit\n" |
98c6faba | 443 | " --test -t : Generate a TestMessage event against each array at startup\n" |
e0d19036 NB |
444 | ; |
445 | ||
dd0781e5 NB |
446 | char Help_grow[] = |
447 | "Usage: mdadm --grow device options\n" | |
448 | "\n" | |
449 | "This usage causes mdadm to attempt to reconfigure a running array.\n" | |
450 | "This is only possibly if the kernel being used supports a particular\n" | |
451 | "reconfiguration. This version only supports changing the number of\n" | |
452 | "devices in a RAID1, and changing the active size of all devices in\n" | |
453 | "a RAID1/4/5/6.\n" | |
454 | "\n" | |
891d2994 | 455 | "Options that are valid with the grow (-G --grow) mode are:\n" |
dd0781e5 NB |
456 | " --size= -z : Change the active size of devices in an array.\n" |
457 | " : This is useful if all devices have been replaced\n" | |
458 | " : with larger devices.\n" | |
459 | " --raid-disks= -n : Change the number of active devices in a RAID1\n" | |
460 | " : array.\n" | |
461 | ; | |
e0d19036 NB |
462 | |
463 | ||
464 | ||
465 | char Help_config[] = | |
466 | "The /etc/mdadm.conf config file:\n\n" | |
467 | " The config file contains, apart from blank lines and comment lines that\n" | |
468 | " start with a hash(#), four sorts of configuration lines: array lines, \n" | |
469 | " device lines, mailaddr lines and program lines.\n" | |
470 | " Each configuration line is constructed of a number of space separated\n" | |
471 | " words, and can be continued on subsequent physical lines by indenting\n" | |
472 | " those lines.\n" | |
473 | "\n" | |
474 | " A device line starts with the word 'device' and then has a number of words\n" | |
475 | " which identify devices. These words should be names of devices in the\n" | |
476 | " filesystem, and can contain wildcards. There can be multiple words or each\n" | |
477 | " device line, and multiple device lines. All devices so listed are checked\n" | |
478 | " for relevant super blocks when assembling arrays.\n" | |
479 | "\n" | |
480 | " An array line start with the word 'array'. This is followed by the name of\n" | |
481 | " the array device in the filesystem, e.g. '/dev/md2'. Subsequent words\n" | |
482 | " describe the identity of the array, used to recognise devices to include in the\n" | |
483 | " array. The identity can be given as a UUID with a word starting 'uuid=', or\n" | |
484 | " as a minor-number stored in the superblock using 'super-minor=', or as a list\n" | |
485 | " of devices. This is given as a comma separated list of names, possibly\n" | |
5787fa49 | 486 | " containing wildcards, preceded by 'devices='. If multiple critea are given,\n" |
e0d19036 NB |
487 | " than a device must match all of them to be considered.\n" |
488 | "\n" | |
489 | " A mailaddr line starts with the word 'mailaddr' and should contain exactly\n" | |
490 | " one Email address. 'mdadm --monitor --scan' will send alerts of failed drives\n" | |
491 | " to this Email address." | |
492 | "\n" | |
493 | " A program line starts with the word 'program' and should contain exactly\n" | |
494 | " one program name. 'mdadm --monitor --scan' will run this program when any\n" | |
495 | " event is detected.\n" | |
64c4757e NB |
496 | "\n" |
497 | ; | |
682c7051 NB |
498 | |
499 | ||
500 | /* name/number mappings */ | |
501 | ||
502 | mapping_t r5layout[] = { | |
cd29a5c8 NB |
503 | { "left-asymmetric", 0}, |
504 | { "right-asymmetric", 1}, | |
505 | { "left-symmetric", 2}, | |
506 | { "right-symmetric", 3}, | |
682c7051 NB |
507 | |
508 | { "default", 2}, | |
509 | { "la", 0}, | |
510 | { "ra", 1}, | |
511 | { "ls", 2}, | |
512 | { "rs", 3}, | |
513 | { NULL, 0} | |
514 | }; | |
515 | ||
516 | mapping_t pers[] = { | |
517 | { "linear", -1}, | |
518 | { "raid0", 0}, | |
519 | { "0", 0}, | |
520 | { "stripe", 0}, | |
521 | { "raid1", 1}, | |
522 | { "1", 1}, | |
523 | { "mirror", 1}, | |
524 | { "raid4", 4}, | |
525 | { "4", 4}, | |
526 | { "raid5", 5}, | |
527 | { "5", 5}, | |
e0d19036 NB |
528 | { "multipath", -4}, |
529 | { "mp", -4}, | |
98c6faba NB |
530 | { "raid6", 6}, |
531 | { "6", 6}, | |
e5329c37 NB |
532 | { "raid10", 10}, |
533 | { "10", 10}, | |
b5e64645 | 534 | { "faulty", -5}, |
682c7051 NB |
535 | { NULL, 0} |
536 | }; | |
e0d19036 NB |
537 | |
538 | ||
539 | mapping_t modes[] = { | |
540 | { "assemble", ASSEMBLE}, | |
541 | { "build", BUILD}, | |
542 | { "create", CREATE}, | |
543 | { "manage", MANAGE}, | |
544 | { "misc", MISC}, | |
545 | { "monitor", MONITOR}, | |
dd0781e5 | 546 | { "grow", GROW}, |
e0d19036 | 547 | }; |
b5e64645 NB |
548 | |
549 | mapping_t faultylayout[] = { | |
550 | { "write-transient", WriteTransient }, | |
551 | { "wt", WriteTransient }, | |
552 | { "read-transient", ReadTransient }, | |
553 | { "rt", ReadTransient }, | |
554 | { "write-persistent", WritePersistent }, | |
555 | { "wp", WritePersistent }, | |
556 | { "read-persistent", ReadPersistent }, | |
557 | { "rp", ReadPersistent }, | |
558 | { "write-all", WriteAll }, | |
559 | { "wa", WriteAll }, | |
560 | { "read-fixable", ReadFixable }, | |
561 | { "rf", ReadFixable }, | |
562 | ||
563 | { "clear", ClearErrors}, | |
564 | { "flush", ClearFaults}, | |
565 | { "none", ClearErrors}, | |
566 | { "default", ClearErrors}, | |
567 | { NULL, 0} | |
568 | }; |