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