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$
  28 .\"
  29 .Dd June 18, 2007
  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 .Fx
  54 kernel to access
  55 .Tn tmpfs
  56 file systems.
  57 .Sh EXAMPLES
  58 To mount a
  59 .Nm
  60 memory file system:
  61 .Pp
  62 .Dl "mount -t tmpfs tmpfs /tmp"
  63 .Sh SEE ALSO
  64 .Xr nmount 2 ,
  65 .Xr unmount 2 ,
  66 .Xr fstab 5 ,
  67 .Xr mount 8
  68 .Sh HISTORY
  69 The
  70 .Nm
  71 driver first appeared in
  72 .Fx 7.0 .
  73 .Sh AUTHORS
  74 .An -nosplit
  75 The
  76 .Nm
  77 kernel implementation was written by
  78 .An Julio M. Merino Vidal Aq jmmv@NetBSD.org
  79 as a Google SoC project.
  80 .Pp
  81 .An Rohit Jalan
  82 and others ported it from
  83 .Nx
  84 to
  85 .Fx .
  86 .Pp
  87 This manual page was written by
  88 .An Xin LI Aq delphij@FreeBSD.org .
  89 .Sh BUGS
  90 The
  91 .Nm
  92 kernel implementation is currently considered as
  93 an experimental feature.
  94 Some file system mount
  95 time options are not well supported.