sbin/mount_tmpfs/mount_tmpfs.8

   1 .\"     $NetBSD: mount_tmpfs.8,v 1.14 2008/04/30 13:10:53 martin Exp $
   2 .\"
   3 .\" Copyright (c) 2005, 2006 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Julio M. Merino Vidal, developed as part of Google's Summer of Code
   8 .\" 2005 program.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29 .\" POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .Dd February 13, 2008
  32 .Dt MOUNT_TMPFS 8
  33 .Os
  34 .Sh NAME
  35 .Nm mount_tmpfs
  36 .Nd mount an efficient memory file system
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl g Ar group
  40 .Op Fl m Ar mode
  41 .Op Fl n Ar nodes
  42 .Op Fl o Ar options
  43 .Op Fl s Ar size
  44 .Op Fl u Ar user
  45 .Ar tmpfs
  46 .Ar mount_point
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 command attaches an instance of the efficient memory file system to the
  51 global file system namespace.
  52 The
  53 .Ar tmpfs
  54 parameter only exists for compatibility with the other mount commands and
  55 is ignored.
  56 The directory specified by
  57 .Ar mount_point
  58 is converted to an absolute path before use and its attributes (owner,
  59 group and mode) are inherited unless explicitly overriden by the options
  60 described below.
  61 .Pp
  62 The following options are supported:
  63 .Bl -tag -width XoXoptions
  64 .It Fl g Ar group
  65 Specifies the group name or GID of the root inode of the file system.
  66 Defaults to the mount point's GID.
  67 .It Fl m Ar mode
  68 Specifies the mode (in octal notation) of the root inode of the file system.
  69 Defaults to the mount point's mode.
  70 .It Fl n Ar nodes
  71 Specifies the maximum number of nodes available to the file system.
  72 If not specified, the file system chooses a reasonable maximum given its
  73 size at mount time, which can be limited with
  74 .Fl s .
  75 .It Fl o Ar options
  76 Options are specified with a
  77 .Fl o
  78 flag followed by a comma-separated string of options.
  79 See the
  80 .Xr mount 8
  81 man page for possible options and their meanings.
  82 .It Fl s Ar size
  83 Specifies the total file system size in bytes.
  84 If zero is given (the default), the available amount of memory (including
  85 main memory and swap space) will be used.
  86 Note that four megabytes are always reserved for the system and cannot
  87 be assigned to the file system.
  88 .It Fl u Ar user
  89 Specifies the user name or UID of the root inode of the file system.
  90 Defaults to the mount point's UID.
  91 .El
  92 .Pp
  93 Every option that accepts a numerical value as its argument can take a
  94 trailing
  95 .Sq b
  96 to indicate bytes (the default), a trailing
  97 .Sq k
  98 to indicate kilobytes, a trailing
  99 .Sq M
 100 to indicate megabytes or a trailing
 101 .Sq G
 102 to indicate gigabytes.
 103 Note that both lowercase and uppercase forms of these letters are allowed.
 104 .Sh EXAMPLES
 105 The following command mounts a tmpfs instance over the
 106 .Pa /tmp
 107 directory, inheriting its owner, group and mode settings:
 108 .Pp
 109 .Ic "mount -t tmpfs tmpfs /tmp"
 110 .Pp
 111 The following command mounts a tmpfs instance over the
 112 .Pa /mnt
 113 directory, setting a 20 megabytes limit in space, owned by the
 114 .Sq joe
 115 user and belonging to the
 116 .Sq users
 117 group, with a restricted 0700 mode:
 118 .Pp
 119 .Ic "mount -t tmpfs -o -s20M -o -ujoe -o -gusers -o -m0700 tmpfs /mnt"
 120 .Pp
 121 See
 122 .Pa /usr/share/examples/fstab/fstab.ramdisk
 123 for some examples on how to add tmpfs entries to
 124 .Pa /etc/fstab .
 125 .Sh SEE ALSO
 126 .Xr fstab 5 ,
 127 .Xr mount 8
 128 .Sh HISTORY
 129 The
 130 .Nm
 131 utility first appeared in
 132 .Nx 4.0 .
 133 .Sh BUGS
 134 File system meta-data is not pageable.
 135 If there is not enough main memory to hold this information, the system may
 136 become unstable or very unresponsive because it will not be able to allocate
 137 required memory.
 138 A malicious user could trigger this condition if he could create lots of
 139 files inside a size-unbounded tmpfs file system.
 140 Limiting the number of nodes per file system
 141 .Pq Fl n
 142 will prevent this; the default value for this setting is also often adjusted
 143 to an adequate value to resolve this.