X-Git-Url: http://git.ipfire.org/?p=thirdparty%2Fmdadm.git;a=blobdiff_plain;f=mdadm.man;fp=mdctl.man;h=b12de9529d34c885f47f64d595f436a2140e3ef4;hp=682bc828d1edb63edd8a0e3722fc957cc0d08107;hb=9a9dab3670110c2db7fe6f716977b72adedbf855;hpb=cd29a5c835c11cbcedc10487677eac6a946ad61b diff --git a/mdctl.man b/mdadm.man similarity index 88% rename from mdctl.man rename to mdadm.man index 682bc828..b12de952 100644 --- a/mdctl.man +++ b/mdadm.man @@ -1,13 +1,13 @@ -mdctl(8) mdctl(8) +mdadm(8) mdadm(8) NNAAMMEE - mdctl - manage MD devices _a_k_a Linux Software Raid. + mdadm - manage MD devices _a_k_a Linux Software Raid. SSYYNNOOPPSSIISS - mmddccttll _[_m_o_d_e_] _<_r_a_i_d_d_e_v_i_c_e_> _[_o_p_t_i_o_n_s_] _<_s_u_b_d_e_v_i_c_e_s_> + mmddaaddmm _[_m_o_d_e_] _<_r_a_i_d_d_e_v_i_c_e_> _[_o_p_t_i_o_n_s_] _<_s_u_b_d_e_v_i_c_e_s_> DDEESSCCRRIIPPTTIIOONN @@ -25,34 +25,34 @@ DDEESSCCRRIIPPTTIIOONN ing), RRAAIIDD11 (mirroring), RRAAIIDD44 and RRAAIIDD55.. Recent kernels (2002) also support a mode known as MMUULLTTII-- - PPAATTHH. mmddccttll does not support MULTIPATH as yet. + PPAATTHH. mmddaaddmm does not support MULTIPATH as yet. - mmddccttll is a program that can be used to create and manage + mmddaaddmm is a program that can be used to create and manage MD devices. As such it provides a similar set of func- tionality to the rraaiiddttoooollss packages. The key differences - between mmddccttll and rraaiiddttoooollss are: + between mmddaaddmm and rraaiiddttoooollss are: - +o mmddccttll is a single program and not a collection of pro- + +o mmddaaddmm is a single program and not a collection of pro- grams. - +o mmddccttll can perform (almost) all of its functions with- - out having a configuration file. Also mdctl helps + +o mmddaaddmm can perform (almost) all of its functions with- + out having a configuration file. Also mdadm helps with management of the configuration file. - +o mmddccttll can provide information about your arrays + +o mmddaaddmm can provide information about your arrays (through Detail and Examine) that rraaiiddttoooollss cannot. - +o rraaiiddttoooollss can manage MULTIPATH devices which mmddccttll + +o rraaiiddttoooollss can manage MULTIPATH devices which mmddaaddmm cannot yet manage. MMOODDEESS - mdctl has 7 major modes of operation: + mdadm has 7 major modes of operation: AAsssseemmbbllee Assemble the parts of a previously created array into an active array. Components can be explicitly - given or can be searched for. mmddccttll checks that + given or can be searched for. mmddaaddmm checks that the components do form a bona fide array, and can, on request, fiddle superblock information so as to assemble a faulty array. @@ -76,7 +76,7 @@ MMOODDEESS This mode can also be used to examine a large num- ber of devices and to print out a summary of the arrays found in a format suitable for the - mmddccttll..ccoonnff configuration file. + mmddaaddmm..ccoonnff configuration file. FFoollllooww oorr MMoonniittoorr @@ -122,7 +122,7 @@ OOPPTTIIOONNSS --VV, ----vveerrssiioonn - Print version information for mdctl. + Print version information for mdadm. --vv, ----vveerrbboossee @@ -197,7 +197,7 @@ FFoorr aasssseemmbbllee:: --cc, ----ccoonnffiigg== - config file. Default is //eettcc//mmddccttll..ccoonnff. + config file. Default is //eettcc//mmddaaddmm..ccoonnff. --ss, ----ssccaann @@ -254,19 +254,19 @@ GGeenneerraall mmaannaaggeemmeenntt AASSSSEEMMBBLLYY MMOODDEE - Usage: mmddccttll ----aasssseemmbbllee _d_e_v_i_c_e _o_p_t_i_o_n_s_._._. + Usage: mmddaaddmm ----aasssseemmbbllee _d_e_v_i_c_e _o_p_t_i_o_n_s_._._. - Usage: mmddccttll ----aasssseemmbbllee ----ssccaann _o_p_t_i_o_n_s_._._. + Usage: mmddaaddmm ----aasssseemmbbllee ----ssccaann _o_p_t_i_o_n_s_._._. This usage assembles one or more raid arrays from pre- - existing components. For each array, mdctl needs to know + existing components. For each array, mdadm needs to know the md device, the identity of the array, and a number of sub devices. These can be found in a number of ways. The md device is either given before ----ssccaann or is found from the config file. In the latter case, multiple md - devices can be started with a single mdctl command. + devices can be started with a single mdadm command. The identity can be given with the ----uuuuiidd option, with the ----ssuuppeerr--mmiinnoorr option, can be found in in the config file, @@ -280,7 +280,7 @@ AASSSSEEMMBBLLYY MMOODDEE The config file is only used if explicitly named with ----ccoonnffiigg or requested with ----ssccaann.. In the later case, - //eettcc//mmddccttll..ccoonnff is used. + //eettcc//mmddaaddmm..ccoonnff is used. If ----ssccaann is not given, then the config file will only be used to find the identity of md arrays. @@ -295,7 +295,7 @@ AASSSSEEMMBBLLYY MMOODDEE BBUUIILLDD MMOODDEE - Usage: mmddccttll ----bbuuiilldd _d_e_v_i_c_e ----cchhuunnkk==_X ----lleevveell==_Y ----rraaiidd-- + Usage: mmddaaddmm ----bbuuiilldd _d_e_v_i_c_e ----cchhuunnkk==_X ----lleevveell==_Y ----rraaiidd-- ddiisskkss==_Z _d_e_v_i_c_e_s @@ -312,7 +312,7 @@ BBUUIILLDD MMOODDEE CCRREEAATTEE MMOODDEE - Usage: mmddccttll ----ccrreeaattee _d_e_v_i_c_e ----cchhuunnkk==_X ----lleevveell==_Y + Usage: mmddaaddmm ----ccrreeaattee _d_e_v_i_c_e ----cchhuunnkk==_X ----lleevveell==_Y ----rraaiidd--ddiisskkss==_Z _d_e_v_i_c_e_s @@ -340,21 +340,21 @@ CCRREEAATTEE MMOODDEE DDEETTAAIILL MMOODDEE - Usage: mmddccttll ----ddeettaaiill [----bbrriieeff] _d_e_v_i_c_e _._._. + Usage: mmddaaddmm ----ddeettaaiill [----bbrriieeff] _d_e_v_i_c_e _._._. This usage sill print out the details of the given array including a list of component devices. To determine names - for the devices, mmddccttll searches //ddeevv for device files with + for the devices, mmddaaddmm searches //ddeevv for device files with the right major and minor numbers. - With ----bbrriieeff mmddccttll prints a single line that identifies + With ----bbrriieeff mmddaaddmm prints a single line that identifies the level, number of disks, and UUID of the array. This - line is suitable for inclusion in //eettcc//mmddccttll..ccoonnff. + line is suitable for inclusion in //eettcc//mmddaaddmm..ccoonnff. EEXXAAMMIINNEE MMOODDEE - Usage: mmddccttll ----eexxaammiinnee [----ssccaann] [----bbrriieeff] _d_e_v_i_c_e _._._. + Usage: mmddaaddmm ----eexxaammiinnee [----ssccaann] [----bbrriieeff] _d_e_v_i_c_e _._._. This usage will examine some block devices to see if that have a valid RAID superblock on them. The information in @@ -365,14 +365,14 @@ EEXXAAMMIINNEE MMOODDEE tion file are checked. ----ssccaann implies ----bbrriieeff but this implication can be countered by specifying ----vveerrbboossee. - With ----bbrriieeff mmddccttll will output an config file entry of + With ----bbrriieeff mmddaaddmm will output an config file entry of each distinct array that was found. This entry will list the UUID, the raid level, and a list of the individual devices on which a superblock for that array was found. This output will by syntactically suitable for inclusion in the configuration file, but should NNOOTT be used blindly. Often the array description that you want in the configu- - ration file is much less specific than that given by mmddccttll + ration file is much less specific than that given by mmddaaddmm --BBss. For example, you normally do not want to list the devices, particularly if they are SCSI devices. @@ -382,10 +382,10 @@ FFIILLEESS //pprroocc//mmddssttaatt If you're using the //pprroocc filesystem, //pprroocc//mmddssttaatt gives you informations about md devices status. This file is - not currently used by mmddccttll. + not currently used by mmddaaddmm. - //eettcc//mmddccttll..ccoonnff + //eettcc//mmddaaddmm..ccoonnff The config file is line oriented with, as usual, blank lines and lines beginning with a hash (or pound sign or sharp or number sign, whichever you like to call it) @@ -403,7 +403,7 @@ FFIILLEESS The DEVICE lines usually come first. All remaining words on the line are treated as names of devices, possibly con- taining wild cards (see _g_l_o_b(7)). These list all the - devices that mmddccttll is allowed to scan when looking for + devices that mmddaaddmm is allowed to scan when looking for devices with RAID superblocks. Each line can contain mul- tiple device names, and there can be multiple DEVICE lines. For example: @@ -439,12 +439,12 @@ FFIILLEESS lleevveell== The value is a raid level. This is normally used to identify an array, but is supported so that the - output of mmddccttll ----eexxaammiinnee ----ssccaann can be use + output of mmddaaddmm ----eexxaammiinnee ----ssccaann can be use directly in the configuration file. ddiisskkss== The value is the number of disks in a complete active array. As with lleevveell== this is mainly for - compatibility with the output of mmddccttll ----eexxaammiinnee + compatibility with the output of mmddaaddmm ----eexxaammiinnee ----ssccaann. @@ -473,4 +473,4 @@ SSEEEE AALLSSOO - mdctl(8) + mdadm(8)