xref: /freebsd/sbin/mdconfig/mdconfig.8 (revision 3ff369fed2a08f32dda232c10470b949bef9489f)
1.\" Copyright (c) 1993 University of Utah.
2.\" Copyright (c) 1980, 1989, 1991, 1993
3.\"	The Regents of the University of California.  All rights reserved.
4.\" Copyright (c) 2000
5.\"	Poul-Henning Kamp  All rights reserved.
6.\"
7.\" This code is derived from software contributed to Berkeley by
8.\" the Systems Programming Group of the University of Utah Computer
9.\" Science Department.
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\"    notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\"    notice, this list of conditions and the following disclaimer in the
18.\"    documentation and/or other materials provided with the distribution.
19.\" 3. All advertising materials mentioning features or use of this software
20.\"    must display the following acknowledgement:
21.\"	This product includes software developed by the University of
22.\"	California, Berkeley and its contributors.
23.\" 4. Neither the name of the University nor the names of its contributors
24.\"    may be used to endorse or promote products derived from this software
25.\"    without specific prior written permission.
26.\"
27.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37.\" SUCH DAMAGE.
38.\"
39.\"     @(#)vnconfig.8	8.1 (Berkeley) 6/5/93
40.\" from: src/usr.sbin/vnconfig/vnconfig.8,v 1.19 2000/12/27 15:30:29
41.\"
42.\" $FreeBSD$
43.\"
44.Dd December 31, 2000
45.Dt MDCONFIG 8
46.Os
47.Sh NAME
48.Nm mdconfig
49.Nd configure and enable memory disks
50.Sh SYNOPSIS
51.Nm
52.Fl a
53.Fl t Ar type
54.Oo
55.Fl o
56.Oo Cm no Oc Ns Ar option
57.Oc
58.Op Fl s Ar size
59.Op Fl f Ar file
60.Op Fl u Ar unit
61.Nm
62.Fl d
63.Fl u Ar unit
64.Nm
65.Fl l
66.Op Fl u Ar unit
67.Sh DESCRIPTION
68The
69.Nm
70command configures and enables
71.Xr md 4
72devices.
73.Pp
74Options indicate an action to be performed:
75.Bl -tag -width indent
76.It Fl a
77Attach a memory disk.
78This will configure and attach a memory disk with the
79parameters specified and attach it to the system.
80.It Fl d
81Detach a memory disk from the system and release all resources.
82.It Fl t Ar type
83Select the type of the memory disk.
84.Bl -tag -width "preload"
85.It Cm malloc
86Storage for this type of memory disk is allocated with
87.Xr malloc 9 .
88This limits the size to the malloc bucket limit in the kernel.
89.It Cm vnode
90A file specified with
91.Fl f Ar file
92becomes the backingstore for this memory disk.
93.It Cm swap
94swapspace is used to back this memory disk.
95.El
96.It Fl f Ar file
97Filename to use for the vnode type memory disk.
98.It Fl l
99List information about configured
100.Xr md 4
101devices.  If the
102.Fl u
103option is used in conjuction with this, the output is limited to
104information on the specified device.
105.It Fl s Ar size
106Size of the memory disk.
107.Ar Size
108is the number of 512 bytes sectors unless suffixed with a
109.Cm k , m ,
110or
111.Cm g
112which
113denotes kilobyte, megabyte and gigabyte respectively.
114.It Fl o Oo Cm no Oc Ns Ar option
115Set or reset options.
116.Bl -tag -width indent
117.It Oo Cm no Oc Ns Cm reserve
118Allocate and reserve all needed storage from the start, rather than as needed.
119.It Oo Cm no Oc Ns Cm cluster
120Enable clustering on this disk.
121.It Oo Cm no Oc Ns Cm compress
122Enable/Disable compression features to reduce memory usage.
123.It Oo Cm no Oc Ns Cm force
124Disable/Enable extra sanity checks to prevent the user from doing something
125that might adversely affect the system.
126.It Oo Cm no Oc Ns Cm readonly
127Enable/Disable readonly mode.
128.El
129.It Fl u Ar unit
130Request a specific unit number for the
131.Xr md 4
132device instead of automatic allocation.
133.El
134.Sh EXAMPLES
135To create a 4 megabyte
136.Xr malloc 9
137backed memory disk.
138The name of the allocated unit will be output on stdout like
139.Dq Li md3 :
140.Pp
141.Dl mdconfig -a -t malloc -s 4m
142.Pp
143To create a disk named
144.Pa /dev/md4
145with
146.Pa /tmp/boot.flp
147as backing:
148.Pp
149.Dl mdconfig -a -t vnode -f /tmp/boot.flp -u 4
150.Pp
151To detach and free all resources used by
152.Pa /dev/md4 :
153.Pp
154.Dl mdconfig -d -u 4
155.Pp
156To create and mount a 128MByte swap backed filesystem on
157.Pa /tmp :
158.Bd -literal -offset indent
159mdconfig -a -t swap -s 128M -u 10
160disklabel -r -w md10 auto
161newfs /dev/md10c
162tunefs -n enable /dev/md10c
163mount /dev/md10c /tmp
164chmod 1777 /tmp
165.Ed
166.Sh SEE ALSO
167.Xr md 4 ,
168.Xr disklabel 8 ,
169.Xr fdisk 8 ,
170.Xr malloc 9
171.Sh HISTORY
172The
173.Nm
174first appeared in
175.Fx 5.0
176as a cleaner replacement for the
177.Xr vn 4
178and
179.Xr vnconfig 8
180combo.
181.Sh AUTHORS
182The
183.Nm
184program was written by
185.An Poul-Henning Kamp
186.Aq phk@FreeBSD.org .
187