xref: /freebsd/sbin/ccdconfig/ccdconfig.8 (revision ac8ef3378960b5b91a3a75f94e247717a4554f0b)
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 acknowledgement:
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.Dd July 17, 1995
34.Dt CCDCONFIG 8
35.Os FreeBSD
36.Sh NAME
37.Nm ccdconfig
38.Nd configuration utility for the concatenated disk driver
39.Sh SYNOPSIS
40.Nm ccdconfig
41.Op Fl cv
42.Ar ccd
43.Ar ileave
44.Op Ar flags
45.Ar dev
46.Op Ar ...
47.Nm ccdconfig
48.Fl C
49.Op Fl v
50.Op Fl f Ar config_file
51.Nm ccdconfig
52.Fl u
53.Op Fl v
54.Ar ccd
55.Op Ar ...
56.Nm ccdconfig
57.Fl U
58.Op Fl v
59.Op Fl f Ar config_file
60.Nm ccdconfig
61.Fl g
62.Op Fl M Ar core
63.Op Fl N Ar system
64.Oo
65.Ar ccd Oo ...
66.Oc
67.Oc
68.Sh DESCRIPTION
69.Nm Ccdconfig
70is used to dynamically configure and unconfigure concatenated disk
71devices, or ccds.  For more information about the ccd, see
72.Xr ccd 4 .
73.Pp
74The options are as follows:
75.Bl -tag -width indent
76.It Fl c
77Configure a ccd.  This is the default behavior of
78.Nm ccdconfig .
79.It Fl C
80Configure all ccd devices listed in the ccd configuration file.
81.It Fl f Ar config_file
82When configuring or unconfiguring all devices, read the file
83.Pa config_file
84instead of the default
85.Pa /etc/ccd.conf .
86.It Fl g
87Dump the current ccd configuration in a format suitable for use as the
88ccd configuration file.  If no arguments are specified, every configured
89ccd is dumped.  Otherwise, the configuration of each listed ccd is dumped.
90.It Fl M Ar core
91Extract values associated with the name list from
92.Pa core
93instead of the default
94.Pa /dev/mem .
95.It Fl N Ar system
96Use
97.Ar system
98as the kernel instead of the running kernel (as determined from
99.Xr getbootfile 3 ).
100.It Fl u
101Unconfigure a ccd.
102.It Fl U
103Unconfigure all ccd devices listed the ccd configuration file.
104.It Fl v
105Causes
106.Nm ccdconfig
107to be verbose.
108.El
109.Pp
110A ccd is described on the command line and in the ccd configuration
111file by the name of the ccd, the interleave factor, the ccd configuration
112flags, and a list of one or more devices.  The flags may be represented
113as a decimal number, a hexadecimal number, a comma-separated list
114of strings, or the word
115.Dq none .
116The flags are as follows:
117.Bd -unfilled -offset indent
118CCDF_SWAP		0x01		Interleave should be dmmax
119CCDF_UNIFORM	0x02		Use uniform interleave
120CCDF_MIRROR	0x04		Support mirroring
121CCDF_PARITY	0x08		Support parity (not implemented yet)
122.Ed
123.Pp
124The format in the
125configuration file appears exactly as if it were entered on the command line.
126Note that on the command line and in the configuration file, the
127.Pa flags
128argument is optional.
129.Bd -unfilled -offset indent
130#
131# /etc/ccd.conf
132# Configuration file for concatenated disk devices
133#
134.Pp
135# ccd           ileave  flags   component devices
136ccd0            16      none    /dev/sd2e /dev/sd3e
137.Ed
138.Pp
139.Sh EXAMPLE
140The following command, executed from the command line, would configure ccd0
141with 4 components (/dev/sd2e, /dev/sd3e, /dev/sd4e, /dev/sd5e), and an
142interleave factor of 32 blocks.
143.Bd -unfilled -offset indent
144# ccdconfig ccd0 32 0 /dev/sd2e /dev/sd3e /dev/sd4e /dev/sd5e
145.Ed
146.Pp
147.Sh FILES
148/etc/ccd.conf - default ccd configuration file.
149.Sh SEE ALSO
150.Xr ccd 4 ,
151.Xr rc 8 .
152.Sh HISTORY
153The
154.Nm ccdconfig
155command first appeared in
156.Nx 1.0a .
157