#include "mdadm.h"
-char Version[] = Name " - v1.0.0 - 10 May 2002\n";
+char Version[] = Name " - v1.6.0 - 4 June 2004\n";
/*
* File: ReadMe.c
*
*/
/*
- * mdadm has 6 major modes of operation:
+ * mdadm has 7 major modes of operation:
* 1/ Create
- * This mode is used to create a new array with a superbock
+ * This mode is used to create a new array with a superblock
* It can progress in several step create-add-add-run
* or it can all happen with one command
* 2/ Assemble
* This mode is used to assemble the parts of a previously created
* array into an active array. Components can be explicitly given
* or can be searched for. mdadm (optionally) check that the components
- * do form a bonafide array, and can, on request, fiddle superblock
+ * do form a bona-fide array, and can, on request, fiddle superblock
* version numbers so as to assemble a faulty array.
* 3/ Build
* This is for building legacy arrays without superblocks
* Also query will treat it as either
* 6/ Monitor
* This mode never exits but just monitors arrays and reports changes.
+ * 7/ Grow
+ * This mode allows for changing of key attributes of a raid array, such
+ * as size, number of devices, and possibly even layout.
+ * At the time if writing, there is only minimal support.
*/
-char short_options[]="-ABCDEFGQhVvbc:l:p:m:n:x:u:c:d:z:sarfRSow";
+char short_options[]="-ABCDEFGQhVvbc:l:p:m:n:x:u:c:d:z:U:sa::rfRSow1t";
struct option long_options[] = {
{"manage", 0, 0, '@'},
{"misc", 0, 0, '#'},
{"detail", 0, 0, 'D'},
{"examine", 0, 0, 'E'},
{"follow", 0, 0, 'F'},
- {"grow", 0, 0, 'G'}, /* not yet implemented */
+ {"grow", 0, 0, 'G'},
{"zero-superblock", 0, 0, 'K'}, /* deliberately no a short_option */
{"query", 0, 0, 'Q'},
/* after those will normally come the name of the md device */
{"help", 0, 0, 'h'},
+ {"help-options",0,0,'h'},
{"version", 0, 0, 'V'},
{"verbose", 0, 0, 'v'},
/* For create or build: */
{"chunk", 1, 0, 'c'},
{"rounding", 1, 0, 'c'}, /* for linear, chunk is really a rounding number */
- {"level", 1, 0, 'l'}, /* 0,1,4,5,linear */
- {"parity", 1, 0, 'p'}, /* {left,right}-{a,}symetric */
+ {"level", 1, 0, 'l'}, /* 0,1,4,5,6,linear */
+ {"parity", 1, 0, 'p'}, /* {left,right}-{a,}symmetric */
{"layout", 1, 0, 'p'},
{"raid-disks",1, 0, 'n'},
{"raid-devices",1, 0, 'n'},
{"spare-disks",1,0, 'x'},
{"spare-devices",1,0, 'x'},
- {"size" ,1, 0, 'z'},
+ {"size", 1, 0, 'z'},
+ {"auto", 2, 0, 'a'}, /* also for --assemble */
+ {"assume-clean",0,0, 3 },
/* For assemble */
{"uuid", 1, 0, 'u'},
{"config", 1, 0, 'c'},
{"scan", 0, 0, 's'},
{"force", 0, 0, 'f'},
+ {"update", 1, 0, 'U'},
/* Management */
{"add", 0, 0, 'a'},
{"remove", 0, 0, 'r'},
/* For Detail/Examine */
{"brief", 0, 0, 'b'},
+ {"sparc2.2", 0, 0, 22},
+ {"test", 0, 0, 't'},
/* For Follow/monitor */
{"mail", 1, 0, 'm'},
{"program", 1, 0, 'p'},
{"alert", 1, 0, 'p'},
{"delay", 1, 0, 'd'},
-
+ {"daemonise", 0, 0, 'f'},
+ {"daemonize", 0, 0, 'f'},
+ {"oneshot", 0, 0, '1'},
{0, 0, 0, 0}
};
" mdadm --misc options... devices\n"
" mdadm --monitor options...\n"
" mdadm device options...\n"
-" mdadm is used for building, manageing, and monitoring\n"
-" Linux md devices (aka RAID arrays)\n"
-" For detail help on the above major modes use --help after the mode\n"
+" mdadm is used for building, managing, and monitoring\n"
+" Linux md devices (aka RAID arrays)\n"
+" For detailed help on the above major modes use --help after the mode\n"
" e.g.\n"
" mdadm --assemble --help\n"
-"\n"
+" For general help on options use\n"
+" mdadm --help-options\n"
+;
+
+char OptionHelp[] =
"Any parameter that does not start with '-' is treated as a device name\n"
"The first such name is often the name of an md device. Subsequent\n"
"names are often names of component devices."
"\n"
"Some common options are:\n"
-" --help -h : This help message or, after above option,\n"
+" --help -h : General help message or, after above option,\n"
" mode specific help message\n"
+" --help-options : This help message\n"
" --version -V : Print version information for mdadm\n"
" --verbose -v : Be more verbose about what is happening\n"
" --brief -b : Be less verbose, more brief\n"
" --build -B : Build a legacy array\n"
" --create -C : Create a new array\n"
" --detail -D : Display details of an array\n"
-" --examine -E : Examine superblock on an array componenet\n"
+" --examine -E : Examine superblock on an array component\n"
" --monitor -F : monitor (follow) some arrays\n"
" --query -Q : Display general information about how a\n"
" device relates to the md driver\n"
"\n"
" For create or build:\n"
" --chunk= -c : chunk size of kibibytes\n"
-" --rounding= : rounding factor for linear array (==chunck size)\n"
-" --level= -l : raid level: 0,1,4,5,linear,mp. 0 or linear for build\n"
-" --paritiy= -p : raid5 parity algorith: {left,right}-{,a}symmetric\n"
+" --rounding= : rounding factor for linear array (==chunk size)\n"
+" --level= -l : raid level: 0,1,4,5,6,linear,mp. 0 or linear for build\n"
+" --parity= -p : raid5/6 parity algorithm: {left,right}-{,a}symmetric\n"
" --layout= : same as --parity\n"
" --raid-devices= -n : number of active devices in array\n"
" --spare-devices= -x: number of spares (eXtras) devices in initial array\n"
-" --size= -z : Size (in K) of each drive in RAID1/4/5 - optional\n"
+" --size= -z : Size (in K) of each drive in RAID1/4/5/6 - optional\n"
" --force -f : Honour devices as listed on command line. Don't\n"
" : insert a missing drive for RAID5.\n"
+" --auto(=p) -a : Automatically allocate new (partitioned) md array if needed.\n"
+" --assume-clean : Assume the array is already in-sync. This is dangerous.\n"
"\n"
" For assemble:\n"
" --uuid= -u : uuid of array to assemble. Devices which don't\n"
" --config= -c : config file\n"
" --scan -s : scan config file for missing information\n"
" --force -f : Assemble the array even if some superblocks appear out-of-date\n"
+" --update= -U : Update superblock: one of sparc2.2, super-minor or summaries\n"
+" --auto(=p) -a : Automatically allocate new (partitioned) md array if needed.\n"
"\n"
" For detail or examine:\n"
" --brief -b : Just print device name and UUID\n"
" --fail -f : mark subsequent devices a faulty\n"
" --set-faulty : same as --fail\n"
" --run -R : start a partially built array\n"
-" --stop -S : deactive array, releasing all resources\n"
+" --stop -S : deactivate array, releasing all resources\n"
" --readonly -o : mark array as readonly\n"
" --readwrite -w : mark array as readwrite\n"
" --zero-superblock : erase the MD superblock from a device.\n"
char Help_create[] =
"Usage: mdadm --create device -chunk=X --level=Y --raid-devices=Z devices\n"
"\n"
-" This usage will initialise a new md array and associate some\n"
-" devices with it. If enough devices are given to complete the array,\n"
-" the array will be activated. Otherwise it will be left inactive\n"
-" to be completed and activated by subsequent management commands.\n"
+" This usage will initialise a new md array, associate some\n"
+" devices with it, and activate the array. In order to create an\n"
+" array with some devices missing, use the special word 'missing' in\n"
+" place of the relevant device name.\n"
"\n"
-" As devices are added, they are checked to see if they already contain\n"
+" Before devices are added, they are checked to see if they already contain\n"
" raid superblocks or filesystems. They are also checked to see if\n"
" the variance in device size exceeds 1%.\n"
-" If any discrepancy is found, the array will not automatically\n"
-" be run, though the presence of a '--run' can override this\n"
+" If any discrepancy is found, the user will be prompted for confirmation\n"
+" before the array is created. The presence of a '--run' can override this\n"
" caution.\n"
"\n"
" If the --size option is given then only that many kilobytes of each\n"
"\n"
" Options that are valid with --create (-C) are:\n"
" --chunk= -c : chunk size of kibibytes\n"
-" --rounding= : rounding factor for linear array (==chunck size)\n"
-" --level= -l : raid level: 0,1,4,5,linear,multipath and synonyms\n"
-" --paritiy= -p : raid5 parity algorith: {left,right}-{,a}symmetric\n"
+" --rounding= : rounding factor for linear array (==chunk size)\n"
+" --level= -l : raid level: 0,1,4,5,6,linear,multipath and synonyms\n"
+" --parity= -p : raid5/6 parity algorithm: {left,right}-{,a}symmetric\n"
" --layout= : same as --parity\n"
" --raid-devices= -n : number of active devices in array\n"
" --spare-devices= -x: number of spares (eXtras) devices in initial array\n"
-" --size= -z : Size (in K) of each drive in RAID1/4/5 - optional\n"
+" --size= -z : Size (in K) of each drive in RAID1/4/5/6 - optional\n"
" --force -f : Honour devices as listed on command line. Don't\n"
" : insert a missing drive for RAID5.\n"
-" --run : insist of running the array even if not all\n"
+" --run -R : insist of running the array even if not all\n"
" : devices are present or some look odd.\n"
-" --readonly : start the array readonly - not supported yet.\n"
+" --readonly -o : start the array readonly - not supported yet.\n"
"\n"
;
" All devices must be listed and the array will be started once complete.\n"
" Options that are valid with --build (-B) are:\n"
" --chunk= -c : chunk size of kibibytes\n"
-" --rounding= : rounding factor for linear array (==chunck size)\n"
+" --rounding= : rounding factor for linear array (==chunk size)\n"
" --level= -l : 0, raid0, or linear\n"
" --raid-devices= -n : number of active devices in array\n"
;
" for a full array are present\n"
" --force -f : Assemble the array even if some superblocks appear\n"
" : out-of-date. This involves modifying the superblocks.\n"
+" --update= -U : Update superblock: one of sparc2.2, super-minor or summaries\n"
;
char Help_manage[] =
" --fail -f : mark subsequent devices a faulty\n"
" --set-faulty : same as --fail\n"
" --run -R : start a partially built array\n"
-" --stop -S : deactive array, releasing all resources\n"
+" --stop -S : deactivate array, releasing all resources\n"
" --readonly -o : mark array as readonly\n"
" --readwrite -w : mark array as readwrite\n"
;
" --query -Q : Display general information about how a\n"
" device relates to the md driver\n"
" --detail -D : Display details of an array\n"
-" --examine -E : Examine superblock on an array componenet\n"
+" --examine -E : Examine superblock on an array component\n"
" --zero-superblock : erase the MD superblock from a device.\n"
" --run -R : start a partially built array\n"
-" --stop -S : deactive array, releasing all resources\n"
+" --stop -S : deactivate array, releasing all resources\n"
" --readonly -o : mark array as readonly\n"
" --readwrite -w : mark array as readwrite\n"
+" --test -t : exit status 0 if ok, 1 if degrade, 2 if dead, 4 if missing\n"
;
char Help_monitor[] =
"If no mail address or program are specified, then mdadm reports all\n"
"state changes to stdout.\n"
"\n"
-"Options that are valid with the monitor (--F --follow) mode are:\n"
+"Options that are valid with the monitor (-F --follow) mode are:\n"
" --mail= -m : Address to mail alerts of failure to\n"
" --program= -p : Program to run when an event is detected\n"
" --alert= : same as --program\n"
" --delay= -d : seconds of delay between polling state. default=60\n"
" --config= -c : specify a different config file\n"
" --scan -s : find mail-address/program in config file\n"
+" --daemonise -f : Fork and continue in child, parent exits\n"
+" --oneshot -1 : Check for degraded arrays, then exit\n"
+" --test -t : Generate a TestMessage event against each array at startup\n"
;
+char Help_grow[] =
+"Usage: mdadm --grow device options\n"
+"\n"
+"This usage causes mdadm to attempt to reconfigure a running array.\n"
+"This is only possibly if the kernel being used supports a particular\n"
+"reconfiguration. This version only supports changing the number of\n"
+"devices in a RAID1, and changing the active size of all devices in\n"
+"a RAID1/4/5/6.\n"
+"\n"
+"Options that are valid with the grow (-F --grow) mode are:\n"
+" --size= -z : Change the active size of devices in an array.\n"
+" : This is useful if all devices have been replaced\n"
+" : with larger devices.\n"
+" --raid-disks= -n : Change the number of active devices in a RAID1\n"
+" : array.\n"
+;
" array. The identity can be given as a UUID with a word starting 'uuid=', or\n"
" as a minor-number stored in the superblock using 'super-minor=', or as a list\n"
" of devices. This is given as a comma separated list of names, possibly\n"
-" containing wildcards, preceeded by 'devices='. If multiple critea are given,\n"
+" containing wildcards, preceded by 'devices='. If multiple critea are given,\n"
" than a device must match all of them to be considered.\n"
"\n"
" A mailaddr line starts with the word 'mailaddr' and should contain exactly\n"
{ "5", 5},
{ "multipath", -4},
{ "mp", -4},
+ { "raid6", 6},
+ { "6", 6},
{ NULL, 0}
};
{ "manage", MANAGE},
{ "misc", MISC},
{ "monitor", MONITOR},
+ { "grow", GROW},
};
projects / thirdparty / mdadm.git / blobdiff