xref: /freebsd/sbin/ccdconfig/ccdconfig.8 (revision 9ad54eb7b35925afd76550bbee3929252f59ad3a)
1.\"	$NetBSD: ccdconfig.8,v 1.1.2.1 1995/11/11 02:43:33 thorpej Exp $
2.\"
3.\" Copyright (c) 1995 Jason R. Thorpe.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgment:
16.\"	This product includes software developed for the NetBSD Project
17.\"	by Jason R. Thorpe.
18.\" 4. The name of the author may not be used to endorse or promote products
19.\"    derived from this software without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31.\" SUCH DAMAGE.
32.\"
33.\"	$Id$
34.\"
35.Dd July 17, 1995
36.Dt CCDCONFIG 8
37.Os FreeBSD
38.Sh NAME
39.Nm ccdconfig
40.Nd configuration utility for the concatenated disk driver
41.Sh SYNOPSIS
42.Nm ccdconfig
43.Op Fl cv
44.Ar ccd
45.Ar ileave
46.Op Ar flags
47.Ar dev
48.Op Ar
49.Nm ccdconfig
50.Fl C
51.Op Fl v
52.Op Fl f Ar config_file
53.Nm ccdconfig
54.Fl u
55.Op Fl v
56.Ar ccd
57.Op Ar
58.Nm ccdconfig
59.Fl U
60.Op Fl v
61.Op Fl f Ar config_file
62.Nm ccdconfig
63.Fl g
64.Op Fl M Ar core
65.Op Fl N Ar system
66.Oo
67.Ar ccd Oo ...
68.Oc
69.Oc
70.Sh DESCRIPTION
71.Nm Ccdconfig
72is used to dynamically configure and unconfigure concatenated disk
73devices, or ccds.  For more information about the ccd, see
74.Xr ccd 4 .
75.Pp
76The options are as follows:
77.Bl -tag -width indent
78.It Fl c
79Configure a ccd.  This is the default behavior of
80.Nm Ns .
81.It Fl C
82Configure all ccd devices listed in the ccd configuration file.
83.It Fl f Ar config_file
84When configuring or unconfiguring all devices, read the file
85.Pa config_file
86instead of the default
87.Pa /etc/ccd.conf .
88.It Fl g
89Dump the current ccd configuration in a format suitable for use as the
90ccd configuration file.  If no arguments are specified, every configured
91ccd is dumped.  Otherwise, the configuration of each listed ccd is dumped.
92.It Fl M Ar core
93Extract values associated with the name list from
94.Pa core
95instead of the default
96.Pa /dev/mem .
97.It Fl N Ar system
98Use
99.Ar system
100as the kernel instead of the running kernel (as determined from
101.Xr getbootfile 3 ).
102.It Fl u
103Unconfigure a ccd.
104.It Fl U
105Unconfigure all ccd devices listed the ccd configuration file.
106.It Fl v
107Cause
108.Nm
109to be verbose.
110.El
111.Pp
112A ccd is described on the command line and in the ccd configuration
113file by the name of the ccd, the interleave factor, the ccd configuration
114flags, and a list of one or more devices.  The flags may be represented
115as a decimal number, a hexadecimal number, a comma-separated list
116of strings, or the word
117.Dq none .
118The flags are as follows:
119.Bd -unfilled -offset indent
120CCDF_SWAP		0x01		Interleave should be dmmax
121CCDF_UNIFORM	0x02		Use uniform interleave
122CCDF_MIRROR	0x04		Support mirroring
123CCDF_PARITY	0x08		Support parity (not implemented yet)
124.Ed
125.Pp
126The format in the
127configuration file appears exactly as if it were entered on the command line.
128Note that on the command line and in the configuration file, the
129.Pa flags
130argument is optional.
131.Bd -unfilled -offset indent
132#
133# /etc/ccd.conf
134# Configuration file for concatenated disk devices
135#
136.Pp
137# ccd           ileave  flags   component devices
138ccd0            16      none    /dev/sd2e /dev/sd3e
139.Ed
140.Pp
141.Sh EXAMPLE
142The following command, executed from the command line, would configure ccd0
143with 4 components (/dev/sd2e, /dev/sd3e, /dev/sd4e, /dev/sd5e), and an
144interleave factor of 32 blocks.
145.Bd -unfilled -offset indent
146# ccdconfig ccd0 32 0 /dev/sd2e /dev/sd3e /dev/sd4e /dev/sd5e
147.Ed
148.Pp
149.Sh FILES
150.Bl -tag -width /etc/ccd.conf -compact
151.It Pa /etc/ccd.conf
152default ccd configuration file
153.El
154.Sh SEE ALSO
155.Xr ccd 4 ,
156.Xr rc 8
157.Sh HISTORY
158The
159.Nm
160command first appeared in
161.Nx 1.0a .
162