[thirdparty/mdadm.git] / mdadm.conf.5

.TH MDADM.CONF 5
.SH NAME
mdadm.conf \- configuration for management of Software Raid with mdadm
.SH SYNOPSIS
/etc/mdadm.conf
.SH DESCRIPTION
.PP
.B mdadm
is a tools for creating an managing RAID devices using the
.B md
driver in Linux.
.PP
Some common tasks, such as assembling all arrays, can be simplified
by describing the devices and array in this configuations file.

.SS SYNTAX
The file should be seen as a collection of words separated by white
space (space, tab, or newline).
Any word that being with a hash sign (#) starts a comment and that
word together with the remainder of the line are ignored.

Any line that start with white space (space or tab) is treated as
though it were a continuation of the previous line.

Empty lines are ignored, but otherwise each (non continuation) line
must start with a keyword as listed below.  The key words are case
insensitve and can be abbreviated to 3 characters.

The keywords are:
.TP
.B DEVICE
A
.B device
line lists the devices (whole devices or partitions) that might contain
a component of an MD array.  When looking for the components of an
array,
.B mdadm
will scan these devices and no others.

The
.B device
line may contain a number of different devices (separated by spaces)
and each device name can contain wild cards as defined by
.BR glob (7).

Also, there may be several device lines present in the file.

.TP
.B ARRAY

.SH SEE ALSO
mdadm (8),
md (4).
Commit	Line	Data
56eb10c0 NB	1	.TH MDADM.CONF 5
	2	.SH NAME
	3	mdadm.conf \- configuration for management of Software Raid with mdadm
	4	.SH SYNOPSIS
	5	/etc/mdadm.conf
	6	.SH DESCRIPTION
	7	.PP
	8	.B mdadm
	9	is a tools for creating an managing RAID devices using the
	10	.B md
	11	driver in Linux.
	12	.PP
	13	Some common tasks, such as assembling all arrays, can be simplified
	14	by describing the devices and array in this configuations file.
	15
	16	.SS SYNTAX
	17	The file should be seen as a collection of words separated by white
	18	space (space, tab, or newline).
	19	Any word that being with a hash sign (#) starts a comment and that
	20	word together with the remainder of the line are ignored.
	21
	22	Any line that start with white space (space or tab) is treated as
	23	though it were a continuation of the previous line.
	24
	25	Empty lines are ignored, but otherwise each (non continuation) line
	26	must start with a keyword as listed below. The key words are case
	27	insensitve and can be abbreviated to 3 characters.
	28
	29	The keywords are:
	30	.TP
	31	.B DEVICE
	32	A
	33	.B device
	34	line lists the devices (whole devices or partitions) that might contain
	35	a component of an MD array. When looking for the components of an
	36	array,
	37	.B mdadm
	38	will scan these devices and no others.
	39
	40	The
	41	.B device
	42	line may contain a number of different devices (separated by spaces)
	43	and each device name can contain wild cards as defined by
	44	.BR glob (7).
	45
	46	Also, there may be several device lines present in the file.
	47
	48	.TP
	49	.B ARRAY
	50
	51	.SH SEE ALSO
	52	mdadm (8),
	53	md (4).
	54