Sync usage with man page.
[netbsd-mini2440.git] / share / man / man4 / altmem.4
blobfef067ed32677a6f23adadb22d7563026eeceaf6
1 .\"     $NetBSD: altmem.4,v 1.2 2009/03/12 08:55:14 wiz Exp $
2 .\"
3 .\" Copyright (c) 2009 Jared D. McNeill <jmcneill@invisible.ca>
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. Neither the name of the author nor the names of any
12 .\"    contributors may be used to endorse or promote products derived
13 .\"    from this software without specific prior written permission.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS
16 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 .\" POSSIBILITY OF SUCH DAMAGE.
26 .\"
27 .Dd March 11, 2009
28 .Dt ALTMEM 4
29 .Os
30 .Sh NAME
31 .Nm altmem
32 .Nd Alternative memory disk driver
33 .Sh SYNOPSIS
34 .Cd "altmem* at altmemdev?"
35 .Sh DESCRIPTION
36 The
37 .Nm
38 driver enables use of physical memory that is normally inaccessible by the
39 machine-dependent
40 .Xr pmap 9
41 as a swap device.
42 .Pp
43 When an alternative memory disk device is present, this device is generally
44 preferred to hard disk-based swap space.
45 See the
46 .Xr swapctl 8
47 and
48 .Xr fstab 5
49 man pages for instructions on how to assign priorities to swap devices.
50 .Sh FILES
51 .Bl -tag -width /dev/raltmemXX -compact
52 .It Pa "/dev/altmem??"
53 block mode alternative memory disk devices.
54 .It Pa "/dev/raltmem??"
55 raw mode alternative memory disk devices.
56 .El
57 .Sh SEE ALSO
58 .Xr md 4 ,
59 .Xr fstab 5 ,
60 .Xr swapctl 8
61 .Sh HISTORY
62 The
63 .Nm
64 device driver appeared in
65 .Nx 6.0 .
66 .Sh AUTHORS
67 .An Jared D. McNeill Aq jmcneill@NetBSD.org