Improve descriptions for tmpfs mount options. The descriptions have

been mostly obtained from NetBSD mount_tmpfs(8) manual page.

Obtained from:	NetBSD
Discussed with:	delphij
This commit is contained in:
jh 2010-02-16 19:59:10 +00:00
parent 05a1bb0a4a
commit 5e778d8cbc

View File

@ -1,4 +1,4 @@
.\"
.\"-
.\" Copyright (c) 2007 Xin LI
.\" All rights reserved.
.\"
@ -22,9 +22,34 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\"-
.\" Copyright (c) 2005, 2006 The NetBSD Foundation, Inc.
.\" 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 SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``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 FOUNDATION OR CONTRIBUTORS
.\" 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
.Dd February 16, 2010
.Dt TMPFS 5
.Os
.Sh NAME
@ -59,17 +84,28 @@ mounting
file systems:
.Bl -tag -width indent
.It Cm gid
root group id.
Specifies the group ID of the root inode of the file system.
Defaults to the mount point's GID.
.It Cm uid
root user id.
Specifies the user ID of the root inode of the file system.
Defaults to the mount point's UID.
.It Cm mode
permissions in octal format.
Specifies the mode (in octal notation) of the root inode of the file system.
Defaults to the mount point's mode.
.It Cm inodes
maximum number of inodes.
Specifies the maximum number of nodes available to the file system.
If not specified, the file system chooses a reasonable maximum based on
the file system size, which can be limited with the
.Cm size
option.
.It Cm size
maximum size (in bytes) for the file system.
Specifies the total file system size in bytes.
If zero (the default) or a value larger than SIZE_MAX - PAGE_SIZE
is given, the available amount of memory (including
main memory and swap space) will be used.
.It Cm maxfilesize
maximum file size (in bytes).
Specifies the maximum file size in bytes.
Defaults to the maximum possible value.
.El
.Sh EXAMPLES
To mount a