X-Git-Url: http://git.ipfire.org/?a=blobdiff_plain;f=ReadMe.c;h=ca2bc77ded9501dfd81e7678c3a7a218dc8f8b06;hb=e7bb5d23a9b29ae6f316fe3ce8970301e1bc0d4d;hp=687752bc69443a22a097587ae8a2f8dc8e843940;hpb=b5e64645037e99b5f05c9499b27b422ae60d23a9;p=thirdparty%2Fmdadm.git diff --git a/ReadMe.c b/ReadMe.c index 687752bc..ca2bc77d 100644 --- a/ReadMe.c +++ b/ReadMe.c @@ -1,7 +1,7 @@ /* * mdadm - manage Linux "md" devices aka RAID arrays. * - * Copyright (C) 2001-2002 Neil Brown + * Copyright (C) 2001-2006 Neil Brown * * * This program is free software; you can redistribute it and/or modify @@ -29,7 +29,8 @@ #include "mdadm.h" -char Version[] = Name " - v1.8.0 - 01 November 2004\n"; +char Version[] = Name " - v2.4.1 - 4 April 2006\n"; + /* * File: ReadMe.c * @@ -90,7 +91,9 @@ char Version[] = Name " - v1.8.0 - 01 November 2004\n"; * At the time if writing, there is only minimal support. */ -char short_options[]="-ABCDEFGQhVvbc:i:l:p:m:n:x:u:c:d:z:U:sa::rfRSow1t"; +char short_options[]="-ABCDEFGQhVXvqbc:i:l:p:m:n:x:u:c:d:z:U:sarfRSow1tye:"; +char short_bitmap_auto_options[]="-ABCDEFGQhVXvqb:c:i:l:p:m:n:x:u:c:d:z:U:sa:rfRSow1tye:"; + struct option long_options[] = { {"manage", 0, 0, '@'}, {"misc", 0, 0, '#'}, @@ -103,6 +106,7 @@ struct option long_options[] = { {"grow", 0, 0, 'G'}, {"zero-superblock", 0, 0, 'K'}, /* deliberately no a short_option */ {"query", 0, 0, 'Q'}, + {"examine-bitmap", 0, 0, 'X'}, /* synonyms */ {"monitor", 0, 0, 'F'}, @@ -112,6 +116,7 @@ struct option long_options[] = { {"help-options",0,0,'h'}, {"version", 0, 0, 'V'}, {"verbose", 0, 0, 'v'}, + {"quiet", 0, 0, 'q'}, /* For create or build: */ {"chunk", 1, 0, 'c'}, @@ -124,16 +129,25 @@ struct option long_options[] = { {"spare-disks",1,0, 'x'}, {"spare-devices",1,0, 'x'}, {"size", 1, 0, 'z'}, - {"auto", 2, 0, 'a'}, /* also for --assemble */ - {"assume-clean",0,0, 3 }, + {"auto", 1, 0, 'a'}, /* also for --assemble */ + {"assume-clean",0,0, AssumeClean }, + {"metadata", 1, 0, 'e'}, /* superblock format */ + {"bitmap", 1, 0, 'b'}, + {"bitmap-chunk", 1, 0, BitmapChunk}, + {"write-behind", 2, 0, WriteBehind}, + {"write-mostly",0, 0, 'W'}, + {"re-add", 0, 0, ReAdd}, + {"homehost", 1, 0, HomeHost}, /* For assemble */ {"uuid", 1, 0, 'u'}, {"super-minor",1,0, 'm'}, + {"name", 1, 0, 'N'}, {"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'}, @@ -143,10 +157,11 @@ struct option long_options[] = { {"stop", 0, 0, 'S'}, {"readonly", 0, 0, 'o'}, {"readwrite", 0, 0, 'w'}, + {"no-degraded",0,0, NoDegraded }, /* For Detail/Examine */ {"brief", 0, 0, 'b'}, - {"sparc2.2", 0, 0, 22}, + {"sparc2.2", 0, 0, Sparc22}, {"test", 0, 0, 't'}, /* For Follow/monitor */ @@ -158,6 +173,8 @@ struct option long_options[] = { {"daemonize", 0, 0, 'f'}, {"oneshot", 0, 0, '1'}, {"pid-file", 1, 0, 'i'}, + /* For Grow */ + {"backup-file", 1,0, BackupFile}, {0, 0, 0, 0} }; @@ -168,15 +185,27 @@ char Usage[] = ; char Help[] = +"mdadm is used for building, managing, and monitoring\n" +"Linux md devices (aka RAID arrays)\n" "Usage: mdadm --create device options...\n" +" Create a new array from unused devices.\n" " mdadm --assemble device options...\n" +" Assemble a previously created array.\n" " mdadm --build device options...\n" +" Create or assemble an array without metadata.\n" " mdadm --manage device options...\n" +" make changes to an existing array.\n" " mdadm --misc options... devices\n" +" report on or modify various md related devices.\n" " mdadm --monitor options...\n" +" Monitor one or more array for significant changes.\n" " mdadm device options...\n" -" mdadm is used for building, managing, and monitoring\n" -" Linux md devices (aka RAID arrays)\n" +" Shorthand for --manage.\n" +"Any parameter that does not start with '-' is treated as a device name\n" +"or, for --examine-bitmap, a file name.\n" +"The first such name is often the name of an md device. Subsequent\n" +"names are often names of component devices.\n" +"\n" " For detailed help on the above major modes use --help after the mode\n" " e.g.\n" " mdadm --assemble --help\n" @@ -186,8 +215,9 @@ char Help[] = char OptionHelp[] = "Any parameter that does not start with '-' is treated as a device name\n" +"or, for --examine-bitmap, a file name.\n" "The first such name is often the name of an md device. Subsequent\n" -"names are often names of component devices." +"names are often names of component devices.\n" "\n" "Some common options are:\n" " --help -h : General help message or, after above option,\n" @@ -195,14 +225,16 @@ char OptionHelp[] = " --help-options : This help message\n" " --version -V : Print version information for mdadm\n" " --verbose -v : Be more verbose about what is happening\n" +" --quiet -q : Don't print un-necessary messages\n" " --brief -b : Be less verbose, more brief\n" " --force -f : Override normal checks and be more forceful\n" "\n" " --assemble -A : Assemble an array\n" -" --build -B : Build a legacy array\n" +" --build -B : Build an array without metadata\n" " --create -C : Create a new array\n" " --detail -D : Display details of an array\n" " --examine -E : Examine superblock on an array component\n" +" --examine-bitmap -X: Display the detail of a bitmap file\n" " --monitor -F : monitor (follow) some arrays\n" " --query -Q : Display general information about how a\n" " device relates to the md driver\n" @@ -210,6 +242,7 @@ char OptionHelp[] = /* "\n" " For create or build:\n" +" --bitmap= -b : File to store bitmap in - may pre-exist for --build\n" " --chunk= -c : chunk size of kibibytes\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" @@ -222,17 +255,24 @@ char OptionHelp[] = " : 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" +" --bitmap-chunk= : chunksize of bitmap in bitmap file (Kilobytes)\n" +" --delay= -d : seconds between bitmap updates\n" +" --write-behind= : number of simultaneous write-behind requests to allow (requires bitmap)\n" +" --name= -N : Textual name for array - max 32 characters\n" "\n" " For assemble:\n" +" --bitmap= -b : File to find bitmap information in\n" " --uuid= -u : uuid of array to assemble. Devices which don't\n" " have this uuid are excluded\n" " --super-minor= -m : minor number to look for in super-block when\n" " choosing devices to use.\n" +" --name= -N : Array name to look for in super-block.\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" +" --no-degraded : Do not start any degraded arrays - default unless --scan.\n" "\n" " For detail or examine:\n" " --brief -b : Just print device name and UUID\n" @@ -278,6 +318,7 @@ char Help_create[] = " other levels.\n" "\n" " Options that are valid with --create (-C) are:\n" +" --bitmap= : Create a bitmap for the array with the given filename\n" " --chunk= -c : chunk size of kibibytes\n" " --rounding= : rounding factor for linear array (==chunk size)\n" " --level= -l : raid level: 0,1,4,5,6,linear,multipath and synonyms\n" @@ -291,6 +332,9 @@ char Help_create[] = " --run -R : insist of running the array even if not all\n" " : devices are present or some look odd.\n" " --readonly -o : start the array readonly - not supported yet.\n" +" --name= -N : Textual name for array - max 32 characters\n" +" --bitmap-chunk= : bitmap chunksize in Kilobytes.\n" +" --delay= -d : bitmap update delay in seconds.\n" "\n" ; @@ -306,10 +350,13 @@ char Help_build[] = " The level may only be 0, raid0, or linear.\n" " All devices must be listed and the array will be started once complete.\n" " Options that are valid with --build (-B) are:\n" +" --bitmap= : file to store/find bitmap information in.\n" " --chunk= -c : chunk size of kibibytes\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" +" --raid-devices= -n : number of active devices in array\n" +" --bitmap-chunk= : bitmap chunksize in Kilobytes.\n" +" --delay= -d : bitmap update delay in seconds.\n" ; char Help_assemble[] = @@ -344,11 +391,21 @@ char Help_assemble[] = " Those devices are md devices that are to be assembled. Their identity\n" " and components are determined from the config file.\n" "\n" +" If mdadm can not find all of the components for an array, it will assemble\n" +" it but not activate it unless --run or --scan is given. To preserve this\n" +" behaviour even with --scan, add --no-degraded. Note that \"all of the\n" +" components\" means as many as were present the last time the array was running\n" +" as recorded in the superblock. If the array was already degraded, and\n" +" the missing device is not a new problem, it will still be assembled. It\n" +" is only newly missing devices that cause the array not to be started.\n" +"\n" "Options that are valid with --assemble (-A) are:\n" +" --bitmap= : bitmap file to use wit the array\n" " --uuid= -u : uuid of array to assemble. Devices which don't\n" " have this uuid are excluded\n" " --super-minor= -m : minor number to look for in super-block when\n" " choosing devices to use.\n" +" --name= -N : Array name to look for in super-block.\n" " --config= -c : config file\n" " --scan -s : scan config file for missing information\n" " --run -R : Try to start the array even if not enough devices\n" @@ -356,6 +413,7 @@ char Help_assemble[] = " --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" +" --no-degraded : Assemble but do not start degraded arrays.\n" ; char Help_manage[] = @@ -391,6 +449,7 @@ char Help_misc[] = " device relates to the md driver\n" " --detail -D : Display details of an array\n" " --examine -E : Examine superblock on an array component\n" +" --examine-bitmap -X: Display contents of a bitmap file\n" " --zero-superblock : erase the MD superblock from a device.\n" " --run -R : start a partially built array\n" " --stop -S : deactivate array, releasing all resources\n" @@ -433,7 +492,7 @@ char Help_grow[] = "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" +"Options that are valid with the grow (-G --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"