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