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