Patrick Welche <prlw1@cam.ac.uk>
[netbsd-mini2440.git] / usr.sbin / mdconfig / mdconfig.8
blobde4587ea75cb8c8a654d602865ec1b2861d6d324
1 .\"
2 .\"     $NetBSD: mdconfig.8,v 1.8 2002/01/19 03:27:06 wiz Exp $
3 .\"
4 .\" Copyright (c) 1995 Gordon W. Ross
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. The name of the author may not be used to endorse or promote products
16 .\"    derived from this software without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 .\"
29 .Dd July 8, 1993
30 .Dt MDCONFIG 8
31 .Os
32 .Sh NAME
33 .Nm mdconfig
34 .Nd configure MEMORY disks
35 .Sh SYNOPSIS
36 .Nm
37 .Ar special_file
38 .Ar 512-byte-blocks
39 .Sh DESCRIPTION
40 The
41 .Nm
42 command configures memory disk devices.
43 It will associate the special file
44 .Ar special_file
45 with a range of user-virtual memory allocated by the
46 .Nm
47 process itself.  The
48 .Nm
49 command should be run in the background.
50 If successful, the command will not return.
51 Otherwise, an error message will be printed.
52 .Pp
53 To "unconfigure" the memory disk, just kill the background
54 .Nm
55 process started earlier.
56 .Sh FILES
57 .Bl -tag -width /etc/rmd?? -compact
58 .It Pa /dev/rmd??
59 .It Pa /dev/md??
60 .El
61 .Sh EXAMPLES
62 .Dl mdconfig /dev/md0c 2048 \*[Am]
63 .Pp
64 Configures the memory disk
65 .Pa md0c
66 with one megabyte of user-space memory.
67 .Sh SEE ALSO
68 .Xr mount 8 ,
69 .Xr swapon 8 ,
70 .Xr umount 8
71 .Sh BUGS
72 The special device will become inoperative if the
73 .Nm
74 process is killed while the special device is open.