share/man/man5/tmpfs.5

   1 .\"
   2 .\" Copyright (c) 2007 Xin LI
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote products
  14 .\"    derived from this software without specific prior written permission
  15 .\"
  16 .\" THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man5/tmpfs.5,v 1.7 2010/01/29 15:11:50 jh Exp $
  28 .\"
  29 .Dd February 2, 2010
  30 .Dt TMPFS 5
  31 .Os
  32 .Sh NAME
  33 .Nm tmpfs
  34 .Nd "efficient memory file system"
  35 .Sh SYNOPSIS
  36 To compile this driver into the kernel,
  37 place the following line in your
  38 kernel configuration file:
  39 .Bd -ragged -offset indent
  40 .Cd "options TMPFS"
  41 .Ed
  42 .Pp
  43 Alternatively, to load the driver as a
  44 module at boot time, place the following line in
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 tmpfs_load="YES"
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 driver will permit the
  53 .Dx
  54 kernel to access
  55 .Tn tmpfs
  56 file systems.
  57 .Sh OPTIONS
  58 The following options are available when
  59 mounting
  60 .Nm
  61 file systems:
  62 .Bl -tag -width indent
  63 .It Cm gid
  64 root group id.
  65 .It Cm uid
  66 root user id.
  67 .It Cm mode
  68 permissions in octal format.
  69 .It Cm inodes
  70 maximum number of inodes.
  71 .It Cm size
  72 maximum size (in bytes) for the file system.
  73 .It Cm maxfilesize
  74 maximum file size (in bytes).
  75 .El
  76 .Sh EXAMPLES
  77 To mount a
  78 .Nm
  79 memory file system:
  80 .Pp
  81 .Dl "mount -t tmpfs tmpfs /tmp"
  82 .Sh SEE ALSO
  83 .Xr nmount 2 ,
  84 .Xr unmount 2 ,
  85 .Xr fstab 5 ,
  86 .Xr mount 8
  87 .Sh HISTORY
  88 The
  89 .Nm
  90 driver first appeared in
  91 .Dx 2.5.1 .
  92 .Sh AUTHORS
  93 .An -nosplit
  94 The
  95 .Nm
  96 kernel implementation was written by
  97 .An Julio M. Merino Vidal Aq jmmv@NetBSD.org
  98 as a Google SoC project.
  99 .Pp
 100 .An Rohit Jalan
 101 and others ported it from
 102 .Nx
 103 to
 104 .Fx .
 105 .Pp
 106 .An Naoya Sugioka
 107 and others ported it from
 108 .Nx
 109 to
 110 .Dx .
 111 .Pp
 112 This manual page was written by
 113 .An Xin LI Aq delphij@FreeBSD.org .
 114 .Sh BUGS
 115 The
 116 .Nm
 117 kernel implementation is currently considered as
 118 an experimental feature.
 119 Some file system mount
 120 time options are not well supported.