freebsd-dev/share/man/man5/tmpfs.5

.\"
.\" Copyright (c) 2007 Xin LI
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd January 29, 2010
.Dt TMPFS 5
.Os
.Sh NAME
.Nm tmpfs
.Nd "efficient memory file system"
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following line in your
kernel configuration file:
.Bd -ragged -offset indent
.Cd "options TMPFS"
.Ed
.Pp
Alternatively, to load the driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
tmpfs_load="YES"
.Ed
.Sh DESCRIPTION
The
.Nm
driver will permit the
.Fx
kernel to access
.Tn tmpfs
file systems.
.Sh OPTIONS
The following options are available when
mounting
.Nm
file systems:
.Bl -tag -width indent
.It Cm gid
root group id.
.It Cm uid
root user id.
.It Cm mode
permissions in octal format.
.It Cm inodes
maximum number of inodes.
.It Cm size
maximum size (in bytes) for the file system.
.It Cm maxfilesize
maximum file size (in bytes).
.El
.Sh EXAMPLES
To mount a
.Nm
memory file system:
.Pp
.Dl "mount -t tmpfs tmpfs /tmp"
.Sh SEE ALSO
.Xr nmount 2 ,
.Xr unmount 2 ,
.Xr fstab 5 ,
.Xr mount 8
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 7.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
kernel implementation was written by
.An Julio M. Merino Vidal Aq jmmv@NetBSD.org
as a Google SoC project.
.Pp
.An Rohit Jalan
and others ported it from
.Nx
to
.Fx .
.Pp
This manual page was written by
.An Xin LI Aq delphij@FreeBSD.org .
.Sh BUGS
The
.Nm
kernel implementation is currently considered as
an experimental feature.
Some file system mount
time options are not well supported.
Add a manual page for tmpfs(5). 2007-06-16 02:35:29 +00:00			`.\"`
			`.\" Copyright (c) 2007 Xin LI`
			`.\" All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
			`.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES`
			`.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.`
			`.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,`
			`.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT`
			`.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,`
			`.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY`
			`.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT`
			`.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF`
			`.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.`
			`.\"`
			`.\" $FreeBSD$`
			`.\"`
Bump .Dd for r203164. Approved by: trasz (mentor) 2010-01-29 15:11:50 +00:00			`.Dd January 29, 2010`
Add a manual page for tmpfs(5). 2007-06-16 02:35:29 +00:00			`.Dt TMPFS 5`
			`.Os`
			`.Sh NAME`
			`.Nm tmpfs`
Complete SYNOPSIS and some cleanup. 2007-06-18 18:58:15 +00:00			`.Nd "efficient memory file system"`
Add a manual page for tmpfs(5). 2007-06-16 02:35:29 +00:00			`.Sh SYNOPSIS`
Complete SYNOPSIS and some cleanup. 2007-06-18 18:58:15 +00:00			`To compile this driver into the kernel,`
			`place the following line in your`
			`kernel configuration file:`
			`.Bd -ragged -offset indent`
			`.Cd "options TMPFS"`
			`.Ed`
			`.Pp`
			`Alternatively, to load the driver as a`
			`module at boot time, place the following line in`
			`.Xr loader.conf 5 :`
			`.Bd -literal -offset indent`
			`tmpfs_load="YES"`
			`.Ed`
Add a manual page for tmpfs(5). 2007-06-16 02:35:29 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
			`driver will permit the`
			`.Fx`
			`kernel to access`
			`.Tn tmpfs`
			`file systems.`
Document more tmpfs mount options that are already available. PR: 124488 Submitted by: gahr 2008-06-12 18:49:24 +00:00			`.Sh OPTIONS`
			`The following options are available when`
			`mounting`
			`.Nm`
			`file systems:`
			`.Bl -tag -width indent`
			`.It Cm gid`
			`root group id.`
			`.It Cm uid`
			`root user id.`
			`.It Cm mode`
			`permissions in octal format.`
			`.It Cm inodes`
			`maximum number of inodes.`
			`.It Cm size`
			`maximum size (in bytes) for the file system.`
Add "maxfilesize" mount option for tmpfs to allow specifying the maximum file size limit. Default is UINT64_MAX when the option is not specified. It was useless to set the limit to the total amount of memory and swap in the system. Use tmpfs_mem_info() rather than get_swpgtotal() in tmpfs_mount() to check if there is enough memory available. Remove now unused get_swpgtotal(). Reviewed by: Gleb Kurtsou Approved by: trasz (mentor) 2010-01-29 12:09:14 +00:00			`.It Cm maxfilesize`
			`maximum file size (in bytes).`
Add a missing .El. Founded by: make manlint 2009-08-25 01:04:15 +00:00			`.El`
Add a manual page for tmpfs(5). 2007-06-16 02:35:29 +00:00			`.Sh EXAMPLES`
			`To mount a`
			`.Nm`
			`memory file system:`
			`.Pp`
			`.Dl "mount -t tmpfs tmpfs /tmp"`
			`.Sh SEE ALSO`
			`.Xr nmount 2 ,`
			`.Xr unmount 2 ,`
			`.Xr fstab 5 ,`
			`.Xr mount 8`
			`.Sh HISTORY`
			`The`
			`.Nm`
			`driver first appeared in`
			`.Fx 7.0 .`
			`.Sh AUTHORS`
			`.An -nosplit`
			`The`
			`.Nm`
			`kernel implementation was written by`
			`.An Julio M. Merino Vidal Aq jmmv@NetBSD.org`
			`as a Google SoC project.`
			`.Pp`
			`.An Rohit Jalan`
			`and others ported it from`
			`.Nx`
			`to`
			`.Fx .`
			`.Pp`
			`This manual page was written by`
			`.An Xin LI Aq delphij@FreeBSD.org .`
			`.Sh BUGS`
			`The`
			`.Nm`
			`kernel implementation is currently considered as`
Complete SYNOPSIS and some cleanup. 2007-06-18 18:58:15 +00:00			`an experimental feature.`
			`Some file system mount`
Add a manual page for tmpfs(5). 2007-06-16 02:35:29 +00:00			`time options are not well supported.`