share/man/man5/unionfs.5

   1 .\" Copyright (c) 2020 Gordon Bergling
   2 .\"
   3 .\" Redistribution and use in source and binary forms, with or without
   4 .\" modification, are permitted provided that the following conditions
   5 .\" are met:
   6 .\" 1. Redistributions of source code must retain the above copyright
   7 .\"    notice, this list of conditions and the following disclaimer.
   8 .\" 2. Redistributions in binary form must reproduce the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer in the
  10 .\"    documentation and/or other materials provided with the distribution.
  11 .\"
  12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  15 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  22 .\" SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD$
  25 .\"
  26 .Dd April 27, 2020
  27 .Dt UNIONFS 5
  28 .Os
  29 .Sh NAME
  30 .Nm unionfs
  31 .Nd "UNION FS"
  32 .Sh SYNOPSIS
  33 To compile this driver into the kernel,
  34 place the following lines in your
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "option UNIONFS"
  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 unionfs_load="YES"
  45 .Ed
  46 .Sh DESCRIPTION
  47 The UNIONFS driver is an implementation of a stackable unification filesystem.
  48 .Sh SEE ALSO
  49 .Xr mount_unionfs 8
  50 .Sh STANDARDS
  51 .Rs
  52 .%T Union mounts in 4.4BSD-Lite
  53 .%A J. S. Pendry
  54 .%A M. K. McKusick
  55 .%R Proceedings of the USENIX Technical Conference on UNIX and Advanced Computing Systems
  56 .%D December 1995
  57 .Re
  58 .Pp
  59 .Rs
  60 .%T Jails: Confining the omnipotent root
  61 .%A P. H. Kamp
  62 .%A R. N. M. Watson
  63 .%R Proceedings of the Second International System Administration and Networking Conference (SANE2000)
  64 .%D May 2000
  65 .Re
  66 .Sh HISTORY
  67 The
  68 .Nm
  69 device driver first appeared in
  70 .Fx 5.0 .
  71 .Sh AUTHORS
  72 The
  73 .Nm
  74 device driver was written by Jan-Simon Pendry for
  75 .Bx 4.4
  76 and
  77 .An Masanori OZAWA Aq Mt ozawa@ongs.co.jp
  78 reimplemented the handling of the locking for
  79 .Fx 7.0 .
  80 The manual page was written by
  81 .An Gordon Bergling Aq Mt gbergling@gmail.com .
  82 .Sh BUGS
  83 Please see the
  84 .Xr mount_unionfs 8
  85 manual page for a list of bugs regarding the
  86 .Nm
  87 filesystem.