xref: /netbsd/sbin/ccdconfig/ccd.conf.5 (revision 6550d01e)
1.\"	$NetBSD: ccd.conf.5,v 1.4 2005/05/17 11:46:15 grant Exp $
2.\"
3.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Grant Beattie.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. The name of the author may not be used to endorse or promote products
18.\"    derived from this software without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30.\" POSSIBILITY OF SUCH DAMAGE.
31.\"
32.Dd June 11, 2002
33.Dt CCD.CONF 5
34.Os
35.Sh NAME
36.Nm ccd.conf
37.Nd concatenated disk driver configuration file
38.Sh SYNOPSIS
39.Nm ccd.conf
40.Sh DESCRIPTION
41The
42.Nm
43file defines the configuration of concatenated disk devices, or ccds.
44It is used by
45.Xr ccdconfig 8
46when invoked with the
47.Fl C
48option and at system boot time.
49For more information about the concatenated disk driver, see
50.Xr ccd 4 .
51.Pp
52Each line of the configuration file contains arguments as per the
53.Fl c
54argument to
55.Xr ccdconfig 8 :
56.Pp
57.Bd -ragged -offset indent -compact
58.Ar ccd
59.Ar ileave
60.Op Ar flags
61.Ar dev
62.Op Ar ...
63.Ed
64.Pp
65.Bl -tag -width preserveX
66.It Ar ccd
67The name of the ccd.
68.It Ar ileave
69The interleave, expressed in units of
70.Dv DEV_BSIZE .
71.It Ar flags
72The flags for the device, which may be represented as a decimal number,
73a hexadecimal number, a comma-separated list of strings, or the word
74.Dq none .
75.It Ar dev Op Ar ...
76The component partitions to be concatenated, which should be of type
77.Dv FS_CCD .
78.El
79.Pp
80A
81.Sq #
82is a comment, and everything to end of line is ignored.
83A
84.Sq \e
85at the end of a line indicates that the next line should be concatenated
86with the current.
87A
88.Sq \e
89preceding any character (other than the end of line) prevents that
90character's special meaning from taking effect.
91.Sh FILES
92.Pa /etc/ccd.conf
93.Sh EXAMPLES
94An example
95.Pa /etc/ccd.conf :
96.Bd -literal -offset indent
97#
98# /etc/ccd.conf
99# Configuration file for concatenated disk devices
100#
101
102# ccd           ileave  flags   component devices
103ccd0            16      none    /dev/sd2e /dev/sd3e
104.Ed
105.Sh SEE ALSO
106.Xr ccd 4 ,
107.Xr ccdconfig 8
108.Sh HISTORY
109The
110.Nm
111configuration file first appeared in
112.Nx 1.1 .
113