share/man/man5/nullfs.5

   1 .\"
   2 .\" Copyright (c) 2008 Daniel Gerzo
   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 .\"
  14 .\" THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd February 10, 2015
  28 .Dt NULLFS 5
  29 .Os
  30 .Sh NAME
  31 .Nm nullfs
  32 .Nd "null file system"
  33 .Sh SYNOPSIS
  34 To enable support for this driver,
  35 place the following line in the kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "options NULLFS"
  38 .Ed
  39 .Pp
  40 Alternatively, to load the driver as a
  41 module at boot time, place the following line in
  42 .Xr loader.conf 5 :
  43 .Bd -literal -offset indent
  44 nullfs_load="YES"
  45 .Ed
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 driver will permit the
  50 .Fx
  51 kernel to mount a loopback file system sub-tree.
  52 .Sh EXAMPLES
  53 To mount a
  54 .Nm
  55 file system:
  56 .Pp
  57 .Dl "mount_nullfs /usr/ports /home/devel/ports"
  58 .Sh SEE ALSO
  59 .Xr fstab 5 ,
  60 .Xr mount_nullfs 8
  61 .Sh HISTORY
  62 The
  63 .Nm
  64 layer first appeared in
  65 .Bx 4.4 .
  66 .Sh AUTHORS
  67 .An -nosplit
  68 The
  69 .Nm
  70 kernel implementation was written by
  71 .An John Heideman .
  72 .Pp
  73 This manual page was written by
  74 .An Daniel Gerzo Aq danger@FreeBSD.org .