6324 Add an `ndp' tool for manipulating the neighbors table
[illumos-gate.git] / usr / src / man / man1m / mount_tmpfs.1m
bloba4f38d3b1ffcf0394bb3a76cf0a0fdb85430ff40
1 '\" te
2 .\"  Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH MOUNT_TMPFS 1M "Nov 24, 2003"
7 .SH NAME
8 mount_tmpfs \- mount tmpfs file systems
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBmount\fR [\fB-F\fR tmpfs] [\fB-o\fR \fIspecific_options\fR] [\fB-O\fR] \fIspecial\fR \fImount_point\fR
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 \fBtmpfs\fR is a memory based file system which uses kernel resources relating
19 to the \fBVM\fR system and page cache as a file system.
20 .sp
21 .LP
22 \fBmount\fR attaches a \fBtmpfs\fR file system to the file system hierarchy at
23 the pathname location \fImount_point\fR, which must already exist. If
24 \fImount_point\fR has any contents prior to the \fBmount\fR operation, these
25 remain hidden until the file system is once again unmounted. The attributes
26 (mode, owner, and group) of the root of the \fBtmpfs\fR filesystem are
27 inherited from the underlying \fImount_point\fR, provided that those attributes
28 are determinable. If not, the root's attributes are set to their default
29 values.
30 .sp
31 .LP
32 The \fIspecial\fR argument is usually specified as \fBswap\fR but is in fact
33 disregarded and assumed to be the virtual memory resources within the system.
34 .SH OPTIONS
35 .sp
36 .ne 2
37 .na
38 \fB\fB-o\fR \fIspecific_options\fR\fR
39 .ad
40 .RS 23n
41 Specify \fBtmpfs\fR file system specific options in a comma-separated list with
42 no intervening spaces. If invalid options are specified, a warning  message is
43 printed and the invalid options are ignored. The following options are
44 available:
45 .sp
46 .ne 2
47 .na
48 \fBsize=\fIsz\fR\fR
49 .ad
50 .RS 19n
51 The \fIsz\fR argument controls the size of this particular \fBtmpfs\fR file
52 system. If the argument is has a `k' suffix, the number will be interpreted as
53 a number of kilobytes. An `m' suffix will be interpreted as a number of
54 megabytes. No suffix is interpreted as bytes. In all cases, the actual size of
55 the file system is the number of bytes specified, rounded up to the physical
56 pagesize of the system.
57 .RE
59 .sp
60 .ne 2
61 .na
62 \fB\fBxattr\fR | \fBnoxattr\fR\fR
63 .ad
64 .RS 19n
65 Allow or disallow the creation and manipulation of extended attributes. The
66 default is \fBxattr\fR. See \fBfsattr\fR(5) for a description of extended
67 attributes.
68 .RE
70 .RE
72 .sp
73 .ne 2
74 .na
75 \fB\fB-O\fR\fR
76 .ad
77 .RS 23n
78 Overlay  mount. Allow the file system to be mounted over an existing mount
79 point, making the underlying file system inaccessible. If a mount is attempted
80 on a pre-existing mount point without setting this flag, the mount will fail,
81 producing the error\f(CWdevice busy\fR.
82 .RE
84 .SH FILES
85 .sp
86 .ne 2
87 .na
88 \fB\fB/etc/mnttab\fR\fR
89 .ad
90 .RS 15n
91 Table of mounted file systems
92 .RE
94 .SH SEE ALSO
95 .sp
96 .LP
97 \fBmount\fR(1M), \fBmkdir\fR(2), \fBmount\fR(2), \fBopen\fR(2),
98 \fBumount\fR(2), \fBmnttab\fR(4), \fBattributes\fR(5), \fBfsattr\fR(5),
99 \fBtmpfs\fR(7FS)
100 .SH NOTES
103 If the directory on which a file system is to be mounted is a symbolic link,
104 the file system is mounted on the directory to which the symbolic link refers,
105 rather than on top of the symbolic link itself.