2 .\" Copyright (c) 2007 Xin LI
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 .\" Copyright (c) 2005, 2006 The NetBSD Foundation, Inc.
27 .\" All rights reserved.
29 .\" Redistribution and use in source and binary forms, with or without
30 .\" modification, are permitted provided that the following conditions
32 .\" 1. Redistributions of source code must retain the above copyright
33 .\" notice, this list of conditions and the following disclaimer.
34 .\" 2. Redistributions in binary form must reproduce the above copyright
35 .\" notice, this list of conditions and the following disclaimer in the
36 .\" documentation and/or other materials provided with the distribution.
38 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
39 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
40 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
42 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
43 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
44 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
45 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
46 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
47 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
48 .\" POSSIBILITY OF SUCH DAMAGE.
57 .Nd "efficient memory file system"
59 To compile this driver into the kernel,
60 place the following line in your
61 kernel configuration file:
62 .Bd -ragged -offset indent
66 Alternatively, to load the driver as a
67 module at boot time, place the following line in
69 .Bd -literal -offset indent
75 driver will permit the
81 The following options are available when
85 .Bl -tag -width indent
87 Specifies the group ID of the root inode of the file system.
88 Defaults to the mount point's GID.
90 Specifies the user ID of the root inode of the file system.
91 Defaults to the mount point's UID.
93 Specifies the mode (in octal notation) of the root inode of the file system.
94 Defaults to the mount point's mode.
96 Specifies the maximum number of nodes available to the file system.
97 If not specified, the file system chooses a reasonable maximum based on
98 the file system size, which can be limited with the
102 Specifies the total file system size in bytes.
103 If zero (the default) or a value larger than SIZE_MAX - PAGE_SIZE
104 is given, the available amount of memory (including
105 main memory and swap space) will be used.
107 Specifies the maximum file size in bytes.
108 Defaults to the maximum possible value.
115 .Dl "mount -t tmpfs tmpfs /tmp"
125 driver first appeared in
131 kernel implementation was written by
132 .An Julio M. Merino Vidal Aq jmmv@NetBSD.org
133 as a Google SoC project.
136 and others ported it from
141 This manual page was written by
142 .An Xin LI Aq delphij@FreeBSD.org .
146 kernel implementation is currently considered as
147 an experimental feature.
148 Some file system mount
149 time options are not well supported.