/*
- * mdctl - manage Linux "md" devices aka RAID arrays.
+ * mdadm - manage Linux "md" devices aka RAID arrays.
*
- * Copyright (C) 2001 Neil Brown <neilb@cse.unsw.edu.au>
+ * Copyright (C) 2001-2002 Neil Brown <neilb@cse.unsw.edu.au>
*
*
* This program is free software; you can redistribute it and/or modify
* Australia
*/
-#include "mdctl.h"
+#include "mdadm.h"
-char Version[] = Name " - v0.5 - 23 August 2001\n";
+char Version[] = Name " - v0.7.2 - 21 March 2002\n";
/*
* File: ReadMe.c
*
* This file contains general comments about the implementation
- * and the various usage messages that can be displayed by mdctl
+ * and the various usage messages that can be displayed by mdadm
*
- * mdctl is a single program that can be used to control Linux md devices.
+ * mdadm is a single program that can be used to control Linux md devices.
* It is intended to provide all the functionality of the mdtools and
* raidtools but with a very different interface.
- * mdctl can perform all functions without a configuration file.
+ * mdadm can perform all functions without a configuration file.
* There is the option of using a configuration file, but not in the same
* way that raidtools uses one
* raidtools uses a configuration file to describe how to create a RAID
* file for such things as stopping a raid array which needs to know
* nothing about the array.
*
- * The configuration file that can be used by mdctl lists two
+ * The configuration file that can be used by mdadm lists two
* different things:
* 1/ a mapping from uuid to md device to identify which arrays are
* expect and what names (numbers) they should be given
*/
/*
- * mdctl has 4 major modes of operation:
+ * mdadm has 4 major modes of operation:
* 1/ Create
* This mode is used to create a new array with a superbock
* It can progress in several step create-add-add-run
* 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. mdctl (optionally) check that the components
+ * or can be searched for. mdadm (optionally) check that the components
* do form a bonafide array, and can, on request, fiddle superblock
* version numbers so as to assemble a faulty array.
* 3/ Build
* command, subsequent Manage commands can finish the job.
*/
-char short_options[]="-ABCDEFhVvc:l:p:m:n:x:u:c:d:z:sarfRSow";
+char short_options[]="-ABCDEFhVvbc:l:p:m:n:x:u:c:d:z:sarfRSow";
struct option long_options[] = {
{"manage", 0, 0, '@'},
{"assemble", 0, 0, 'A'},
{"detail", 0, 0, 'D'},
{"examine", 0, 0, 'E'},
{"follow", 0, 0, 'F'},
+ {"grow", 0, 0, 'G'}, /* not yet implemented */
+ {"zero-superblock", 0, 0, 'H'},
/* synonyms */
{"monitor", 0, 0, 'F'},
{"readonly", 0, 0, 'o'},
{"readwrite", 0, 0, 'w'},
+ /* For Detail/Examine */
+ {"brief", 0, 0, 'b'},
+
/* For Follow/monitor */
{"mail", 1, 0, 'm'},
{"program", 1, 0, 'p'},
};
char Usage[] =
-"Usage: mdctl --help\n"
+"Usage: mdadm --help\n"
" for help\n"
;
char Help[] =
-"Usage: mdctl --create device options...\n"
-" mdctl --assemble device options...\n"
-" mdctl --build device options...\n"
-" mdctl --detail device\n"
-" mdctl --examine device\n"
-" mdctl --follow options...\n"
-" mdctl device options...\n"
-" mdctl is used for controlling Linux md devices (aka RAID arrays)\n"
+"Usage: mdadm --create device options...\n"
+" mdadm --assemble device options...\n"
+" mdadm --build device options...\n"
+" mdadm --detail device\n"
+" mdadm --examine device\n"
+" mdadm --follow options...\n"
+" mdadm device options...\n"
+" mdadm is used for controlling Linux md devices (aka RAID arrays)\n"
" For detail help on major modes use, e.g.\n"
-" mdctl --assemble --help\n"
+" mdadm --assemble --help\n"
"\n"
"Any parameter that does not start with '-' is treated as a device name\n"
"The first such name is normally the name of an md device. Subsequent\n"
"\n"
" --help -h : This help message or, after above option,\n"
" mode specific help message\n"
-" --version -V : Print version information for mdctl\n"
+" --version -V : Print version information for mdadm\n"
" --verbose -v : Be more verbose about what is happening\n"
"\n"
" For create or build:\n"
" --paritiy= -p : raid5 parity algorith: {left,right}-{,a}symmetric\n"
" --layout= : same as --parity\n"
" --raid-disks= -n : number of active devices in array\n"
-" --spare-disks= -x : number of spares (eXtras) to allow space for\n"
+" --spare-disks= -x : number of spares (eXtras) devices in initial array\n"
" --size= -z : Size (in K) of each drive in RAID1/4/5 - optional\n"
" --force -f : Honour devices as listed on command line. Don't\n"
" : insert a missing drive for RAID5.\n"
" --scan -s : scan config file for missing information\n"
" --force -f : Assemble the array even if some superblocks appear out-of-date\n"
"\n"
+" For detail or examine:\n"
+" --brief -b : Just print device name and UUID\n"
+"\n"
" For follow/monitor:\n"
" --mail= -m : Address to mail alerts of failure to\n"
" --program= -p : Program to run when an event is detected\n"
" --stop -S : deactive 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: mdctl --create device -chunk=X --level=Y --raid-disks=Z devices\n"
+"Usage: mdadm --create device -chunk=X --level=Y --raid-disks=Z devices\n"
"\n"
" This usage will initialise a new md array and possibly associate some\n"
" devices with it. If enough devices are given to complete the array,\n"
;
char Help_build[] =
-"Usage: mdctl --build device -chunk=X --level=Y --raid-disks=Z devices\n"
+"Usage: mdadm --build device -chunk=X --level=Y --raid-disks=Z devices\n"
"\n"
" This usage is similar to --create. The difference is that it creates\n"
" a legacy array with a superblock. With these arrays there is no\n"
;
char Help_assemble[] =
-"Usage: mdctl --assemble device options...\n"
-" mdctl --assemble --scan options...\n"
+"Usage: mdadm --assemble device options...\n"
+" mdadm --assemble --scan options...\n"
"\n"
"This usage assembles one or more raid arrays from pre-existing\n"
"components.\n"
-"For each array, mdctl needs to know the md device, the identify of\n"
+"For each array, mdadm needs to know the md device, the identify of\n"
"the array, and a number of sub devices. These can be found in a number\n"
"of ways.\n"
"\n"
/* name/number mappings */
mapping_t r5layout[] = {
- { "left_asymmetric", 0},
- { "right_asymmetric", 1},
- { "left_symmetric", 2},
- { "right_symmetric", 3},
+ { "left-asymmetric", 0},
+ { "right-asymmetric", 1},
+ { "left-symmetric", 2},
+ { "right-symmetric", 3},
{ "default", 2},
{ "la", 0},
projects / thirdparty / mdadm.git / blobdiff