xref: /freebsd/sbin/mdconfig/mdconfig.8 (revision f9218d3d4fd34f082473b3a021c6d4d109fb47cf)
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 S Ar sectorsize
61.Op Fl u Ar unit
62.Nm
63.Fl d
64.Fl u Ar unit
65.Nm
66.Fl l
67.Op Fl u Ar unit
68.Sh DESCRIPTION
69The
70.Nm
71utility configures and enables
72.Xr md 4
73devices.
74.Pp
75Options indicate an action to be performed:
76.Bl -tag -width indent
77.It Fl a
78Attach a memory disk.
79This will configure and attach a memory disk with the
80parameters specified and attach it to the system.
81.It Fl d
82Detach a memory disk from the system and release all resources.
83.It Fl t Ar type
84Select the type of the memory disk.
85.Bl -tag -width "preload"
86.It Cm malloc
87Storage for this type of memory disk is allocated with
88.Xr malloc 9 .
89This limits the size to the malloc bucket limit in the kernel.
90.It Cm vnode
91A file specified with
92.Fl f Ar file
93becomes the backingstore for this memory disk.
94.It Cm swap
95swapspace is used to back this memory disk.
96.El
97.It Fl f Ar file
98Filename to use for the vnode type memory disk.
99.It Fl l
100List information about configured
101.Xr md 4
102devices.  If the
103.Fl u
104option is used in conjuction with this, the output is limited to
105information on the specified device.
106.It Fl s Ar size
107Size of the memory disk.
108.Ar Size
109is the number of 512 bytes sectors unless suffixed with a
110.Cm k , m ,
111or
112.Cm g
113which
114denotes kilobyte, megabyte and gigabyte respectively.
115.It Fl S Ar sectorsize
116Sectorsize to use for malloc backed device.
117.It Fl o Oo Cm no Oc Ns Ar option
118Set or reset options.
119.Bl -tag -width indent
120.It Oo Cm no Oc Ns Cm reserve
121Allocate and reserve all needed storage from the start, rather than as needed.
122.It Oo Cm no Oc Ns Cm cluster
123Enable clustering on this disk.
124.It Oo Cm no Oc Ns Cm compress
125Enable/Disable compression features to reduce memory usage.
126.It Oo Cm no Oc Ns Cm force
127Disable/Enable extra sanity checks to prevent the user from doing something
128that might adversely affect the system.
129.It Oo Cm no Oc Ns Cm readonly
130Enable/Disable readonly mode.
131.El
132.It Fl u Ar unit
133Request a specific unit number for the
134.Xr md 4
135device instead of automatic allocation.
136.El
137.Sh EXAMPLES
138To create a 4 megabyte
139.Xr malloc 9
140backed memory disk.
141The name of the allocated unit will be output on stdout like
142.Dq Li md3 :
143.Pp
144.Dl mdconfig -a -t malloc -s 4m
145.Pp
146To create a disk named
147.Pa /dev/md4
148with
149.Pa /tmp/boot.flp
150as backing:
151.Pp
152.Dl mdconfig -a -t vnode -f /tmp/boot.flp -u 4
153.Pp
154To detach and free all resources used by
155.Pa /dev/md4 :
156.Pp
157.Dl mdconfig -d -u 4
158.Pp
159To create and mount a 128MByte swap backed file system on
160.Pa /tmp :
161.Bd -literal -offset indent
162mdconfig -a -t swap -s 128M -u 10
163newfs -U /dev/md10
164mount /dev/md10 /tmp
165chmod 1777 /tmp
166.Ed
167.Sh SEE ALSO
168.Xr md 4 ,
169.Xr disklabel 8 ,
170.Xr fdisk 8 ,
171.Xr malloc 9
172.Sh HISTORY
173The
174.Nm
175utility first appeared in
176.Fx 5.0
177as a cleaner replacement for the
178.Xr vn 4
179and
180.Xr vnconfig 8
181combo.
182.Sh AUTHORS
183The
184.Nm
185utility was written by
186.An Poul-Henning Kamp
187.Aq phk@FreeBSD.org .
188