xref: /dflybsd-src/share/man/man5/tmpfs.5 (revision 7a2de9a42eb7af2d2c40f327e088e6c88489241a)
1*7a2de9a4SMatthew Dillon.\"
2*7a2de9a4SMatthew Dillon.\" Copyright (c) 2007 Xin LI
3*7a2de9a4SMatthew Dillon.\" All rights reserved.
4*7a2de9a4SMatthew Dillon.\"
5*7a2de9a4SMatthew Dillon.\" Redistribution and use in source and binary forms, with or without
6*7a2de9a4SMatthew Dillon.\" modification, are permitted provided that the following conditions
7*7a2de9a4SMatthew Dillon.\" are met:
8*7a2de9a4SMatthew Dillon.\" 1. Redistributions of source code must retain the above copyright
9*7a2de9a4SMatthew Dillon.\"    notice, this list of conditions and the following disclaimer.
10*7a2de9a4SMatthew Dillon.\" 2. Redistributions in binary form must reproduce the above copyright
11*7a2de9a4SMatthew Dillon.\"    notice, this list of conditions and the following disclaimer in the
12*7a2de9a4SMatthew Dillon.\"    documentation and/or other materials provided with the distribution.
13*7a2de9a4SMatthew Dillon.\" 3. The name of the author may not be used to endorse or promote products
14*7a2de9a4SMatthew Dillon.\"    derived from this software without specific prior written permission
15*7a2de9a4SMatthew Dillon.\"
16*7a2de9a4SMatthew Dillon.\" THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17*7a2de9a4SMatthew Dillon.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18*7a2de9a4SMatthew Dillon.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19*7a2de9a4SMatthew Dillon.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20*7a2de9a4SMatthew Dillon.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21*7a2de9a4SMatthew Dillon.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22*7a2de9a4SMatthew Dillon.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23*7a2de9a4SMatthew Dillon.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24*7a2de9a4SMatthew Dillon.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25*7a2de9a4SMatthew Dillon.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26*7a2de9a4SMatthew Dillon.\"
27*7a2de9a4SMatthew Dillon.\" $FreeBSD: src/share/man/man5/tmpfs.5,v 1.7 2010/01/29 15:11:50 jh Exp $
28*7a2de9a4SMatthew Dillon.\"
29*7a2de9a4SMatthew Dillon.Dd February 2, 2010
30*7a2de9a4SMatthew Dillon.Dt TMPFS 5
31*7a2de9a4SMatthew Dillon.Os
32*7a2de9a4SMatthew Dillon.Sh NAME
33*7a2de9a4SMatthew Dillon.Nm tmpfs
34*7a2de9a4SMatthew Dillon.Nd "efficient memory file system"
35*7a2de9a4SMatthew Dillon.Sh SYNOPSIS
36*7a2de9a4SMatthew DillonTo compile this driver into the kernel,
37*7a2de9a4SMatthew Dillonplace the following line in your
38*7a2de9a4SMatthew Dillonkernel configuration file:
39*7a2de9a4SMatthew Dillon.Bd -ragged -offset indent
40*7a2de9a4SMatthew Dillon.Cd "options TMPFS"
41*7a2de9a4SMatthew Dillon.Ed
42*7a2de9a4SMatthew Dillon.Pp
43*7a2de9a4SMatthew DillonAlternatively, to load the driver as a
44*7a2de9a4SMatthew Dillonmodule at boot time, place the following line in
45*7a2de9a4SMatthew Dillon.Xr loader.conf 5 :
46*7a2de9a4SMatthew Dillon.Bd -literal -offset indent
47*7a2de9a4SMatthew Dillontmpfs_load="YES"
48*7a2de9a4SMatthew Dillon.Ed
49*7a2de9a4SMatthew Dillon.Sh DESCRIPTION
50*7a2de9a4SMatthew DillonThe
51*7a2de9a4SMatthew Dillon.Nm
52*7a2de9a4SMatthew Dillondriver will permit the
53*7a2de9a4SMatthew Dillon.Dx
54*7a2de9a4SMatthew Dillonkernel to access
55*7a2de9a4SMatthew Dillon.Tn tmpfs
56*7a2de9a4SMatthew Dillonfile systems.
57*7a2de9a4SMatthew Dillon.Sh OPTIONS
58*7a2de9a4SMatthew DillonThe following options are available when
59*7a2de9a4SMatthew Dillonmounting
60*7a2de9a4SMatthew Dillon.Nm
61*7a2de9a4SMatthew Dillonfile systems:
62*7a2de9a4SMatthew Dillon.Bl -tag -width indent
63*7a2de9a4SMatthew Dillon.It Cm gid
64*7a2de9a4SMatthew Dillonroot group id.
65*7a2de9a4SMatthew Dillon.It Cm uid
66*7a2de9a4SMatthew Dillonroot user id.
67*7a2de9a4SMatthew Dillon.It Cm mode
68*7a2de9a4SMatthew Dillonpermissions in octal format.
69*7a2de9a4SMatthew Dillon.It Cm inodes
70*7a2de9a4SMatthew Dillonmaximum number of inodes.
71*7a2de9a4SMatthew Dillon.It Cm size
72*7a2de9a4SMatthew Dillonmaximum size (in bytes) for the file system.
73*7a2de9a4SMatthew Dillon.It Cm maxfilesize
74*7a2de9a4SMatthew Dillonmaximum file size (in bytes).
75*7a2de9a4SMatthew Dillon.El
76*7a2de9a4SMatthew Dillon.Sh EXAMPLES
77*7a2de9a4SMatthew DillonTo mount a
78*7a2de9a4SMatthew Dillon.Nm
79*7a2de9a4SMatthew Dillonmemory file system:
80*7a2de9a4SMatthew Dillon.Pp
81*7a2de9a4SMatthew Dillon.Dl "mount -t tmpfs tmpfs /tmp"
82*7a2de9a4SMatthew Dillon.Sh SEE ALSO
83*7a2de9a4SMatthew Dillon.Xr nmount 2 ,
84*7a2de9a4SMatthew Dillon.Xr unmount 2 ,
85*7a2de9a4SMatthew Dillon.Xr fstab 5 ,
86*7a2de9a4SMatthew Dillon.Xr mount 8
87*7a2de9a4SMatthew Dillon.Sh HISTORY
88*7a2de9a4SMatthew DillonThe
89*7a2de9a4SMatthew Dillon.Nm
90*7a2de9a4SMatthew Dillondriver first appeared in
91*7a2de9a4SMatthew Dillon.Dx 2.5.1 .
92*7a2de9a4SMatthew Dillon.Sh AUTHORS
93*7a2de9a4SMatthew Dillon.An -nosplit
94*7a2de9a4SMatthew DillonThe
95*7a2de9a4SMatthew Dillon.Nm
96*7a2de9a4SMatthew Dillonkernel implementation was written by
97*7a2de9a4SMatthew Dillon.An Julio M. Merino Vidal Aq jmmv@NetBSD.org
98*7a2de9a4SMatthew Dillonas a Google SoC project.
99*7a2de9a4SMatthew Dillon.Pp
100*7a2de9a4SMatthew Dillon.An Rohit Jalan
101*7a2de9a4SMatthew Dillonand others ported it from
102*7a2de9a4SMatthew Dillon.Nx
103*7a2de9a4SMatthew Dillonto
104*7a2de9a4SMatthew Dillon.Fx .
105*7a2de9a4SMatthew Dillon.Pp
106*7a2de9a4SMatthew Dillon.An Naoya Sugioka
107*7a2de9a4SMatthew Dillonand others ported it from
108*7a2de9a4SMatthew Dillon.Nx
109*7a2de9a4SMatthew Dillonto
110*7a2de9a4SMatthew Dillon.Dx .
111*7a2de9a4SMatthew Dillon.Pp
112*7a2de9a4SMatthew DillonThis manual page was written by
113*7a2de9a4SMatthew Dillon.An Xin LI Aq delphij@FreeBSD.org .
114*7a2de9a4SMatthew Dillon.Sh BUGS
115*7a2de9a4SMatthew DillonThe
116*7a2de9a4SMatthew Dillon.Nm
117*7a2de9a4SMatthew Dillonkernel implementation is currently considered as
118*7a2de9a4SMatthew Dillonan experimental feature.
119*7a2de9a4SMatthew DillonSome file system mount
120*7a2de9a4SMatthew Dillontime options are not well supported.
121