1 '\" te
   2 .\"  Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved
   3 .\"  Copyright (c) 2011, Joyent, Inc.  All Rights Reserved
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH MOUNT_TMPFS 1M "Dec 2, 2011"
   8 .SH NAME
   9 mount_tmpfs \- mount tmpfs file systems
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBmount\fR [\fB-F\fR tmpfs] [\fB-o\fR \fIspecific_options\fR] [\fB-O\fR] \fIspecial\fR \fImount_point\fR
  14 .fi
  15 
  16 .SH DESCRIPTION
  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 .ne 2
  36 .na
  37 \fB\fB-o\fR \fIspecific_options\fR\fR
  38 .ad
  39 .RS 23n
  40 Specify \fBtmpfs\fR file system specific options in a comma-separated list with
  41 no intervening spaces. If invalid options are specified, a warning  message is
  42 printed and the invalid options are ignored. The following options are
  43 available:
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fBremount\fR\fR
  48 .ad
  49 .sp .6
  50 .RS 19n
  51 Remounts a file system with a new size. A size not explicitly
  52 set with \fBremount\fR reverts to no limit.
  53 .RE
  54 
  55 .sp
  56 .ne 2
  57 .na
  58 \fBsize=\fIsz\fR\fR
  59 .ad
  60 .RS 19n
  61 The \fIsz\fR argument controls the size of this particular \fBtmpfs\fR file
  62 system. If the argument is has a `k' suffix, the number will be interpreted as
  63 a number of kilobytes. An `m' suffix will be interpreted as a number of
  64 megabytes. No suffix is interpreted as bytes. In all cases, the actual size of
  65 the file system is the number of bytes specified, rounded up to the physical
  66 pagesize of the system.
  67 .RE
  68 
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBxattr\fR | \fBnoxattr\fR\fR
  73 .ad
  74 .RS 19n
  75 Allow or disallow the creation and manipulation of extended attributes. The
  76 default is \fBxattr\fR. See \fBfsattr\fR(5) for a description of extended
  77 attributes.
  78 .RE
  79 
  80 .RE
  81 
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fB-O\fR\fR
  86 .ad
  87 .RS 23n
  88 Overlay  mount. Allow the file system to be mounted over an existing mount
  89 point, making the underlying file system inaccessible. If a mount is attempted
  90 on a pre-existing mount point without setting this flag, the mount will fail,
  91 producing the error\f(CWdevice busy\fR.
  92 .RE
  93 
  94 .SH FILES
  95 .ne 2
  96 .na
  97 \fB\fB/etc/mnttab\fR\fR
  98 .ad
  99 .RS 15n
 100 Table of mounted file systems
 101 .RE
 102 
 103 .SH SEE ALSO
 104 .LP
 105 \fBmount\fR(1M), \fBmkdir\fR(2), \fBmount\fR(2), \fBopen\fR(2),
 106 \fBumount\fR(2), \fBmnttab\fR(4), \fBattributes\fR(5), \fBfsattr\fR(5),
 107 \fBtmpfs\fR(7FS)
 108 .SH NOTES
 109 .LP
 110 If the directory on which a file system is to be mounted is a symbolic link,
 111 the file system is mounted on the directory to which the symbolic link refers,
 112 rather than on top of the symbolic link itself.