xref: /freebsd/share/man/man4/unionfs.4 (revision 5ad3b09f2fe91028d3ffccb80d128d3408ef74f8)
1*5ad3b09fSAlexander Ziaee.\"-
2*5ad3b09fSAlexander Ziaee.\" SPDX-License-Identifier: BSD-2-Clause
3*5ad3b09fSAlexander Ziaee.\"
41687d771SAlexander Ziaee.\" Copyright (c) 2020 Gordon Bergling
51687d771SAlexander Ziaee.\"
61687d771SAlexander Ziaee.\" Redistribution and use in source and binary forms, with or without
71687d771SAlexander Ziaee.\" modification, are permitted provided that the following conditions
81687d771SAlexander Ziaee.\" are met:
91687d771SAlexander Ziaee.\" 1. Redistributions of source code must retain the above copyright
101687d771SAlexander Ziaee.\"    notice, this list of conditions and the following disclaimer.
111687d771SAlexander Ziaee.\" 2. Redistributions in binary form must reproduce the above copyright
121687d771SAlexander Ziaee.\"    notice, this list of conditions and the following disclaimer in the
131687d771SAlexander Ziaee.\"    documentation and/or other materials provided with the distribution.
141687d771SAlexander Ziaee.\"
151687d771SAlexander Ziaee.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
161687d771SAlexander Ziaee.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
171687d771SAlexander Ziaee.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
181687d771SAlexander Ziaee.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
191687d771SAlexander Ziaee.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
201687d771SAlexander Ziaee.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
211687d771SAlexander Ziaee.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
221687d771SAlexander Ziaee.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
231687d771SAlexander Ziaee.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
241687d771SAlexander Ziaee.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
251687d771SAlexander Ziaee.\" SUCH DAMAGE.
261687d771SAlexander Ziaee.\"
271687d771SAlexander Ziaee.Dd April 27, 2020
281687d771SAlexander Ziaee.Dt UNIONFS 4
291687d771SAlexander Ziaee.Os
301687d771SAlexander Ziaee.Sh NAME
311687d771SAlexander Ziaee.Nm unionfs
32*5ad3b09fSAlexander Ziaee.Nd union mount file system
331687d771SAlexander Ziaee.Sh SYNOPSIS
341687d771SAlexander ZiaeeTo compile this driver into the kernel,
351687d771SAlexander Ziaeeplace the following lines in your
361687d771SAlexander Ziaeekernel configuration file:
371687d771SAlexander Ziaee.Bd -ragged -offset indent
381687d771SAlexander Ziaee.Cd "option UNIONFS"
391687d771SAlexander Ziaee.Ed
401687d771SAlexander Ziaee.Pp
411687d771SAlexander ZiaeeAlternatively, to load the driver as a
421687d771SAlexander Ziaeemodule at boot time, place the following line in
431687d771SAlexander Ziaee.Xr loader.conf 5 :
441687d771SAlexander Ziaee.Bd -literal -offset indent
451687d771SAlexander Ziaeeunionfs_load="YES"
461687d771SAlexander Ziaee.Ed
471687d771SAlexander Ziaee.Sh DESCRIPTION
481687d771SAlexander ZiaeeThe UNIONFS driver is an implementation of a stackable unification filesystem.
491687d771SAlexander Ziaee.Sh SEE ALSO
501687d771SAlexander Ziaee.Xr mount_unionfs 8
511687d771SAlexander Ziaee.Sh STANDARDS
521687d771SAlexander Ziaee.Rs
531687d771SAlexander Ziaee.%T Union mounts in 4.4BSD-Lite
541687d771SAlexander Ziaee.%A J. S. Pendry
551687d771SAlexander Ziaee.%A M. K. McKusick
561687d771SAlexander Ziaee.%R Proceedings of the USENIX Technical Conference on UNIX and Advanced Computing Systems
571687d771SAlexander Ziaee.%D December 1995
581687d771SAlexander Ziaee.Re
591687d771SAlexander Ziaee.Pp
601687d771SAlexander Ziaee.Rs
611687d771SAlexander Ziaee.%T Jails: Confining the omnipotent root
621687d771SAlexander Ziaee.%A P. H. Kamp
631687d771SAlexander Ziaee.%A R. N. M. Watson
641687d771SAlexander Ziaee.%R Proceedings of the Second International System Administration and Networking Conference (SANE2000)
651687d771SAlexander Ziaee.%D May 2000
661687d771SAlexander Ziaee.Re
671687d771SAlexander Ziaee.Sh HISTORY
681687d771SAlexander ZiaeeThe
691687d771SAlexander Ziaee.Nm
701687d771SAlexander Ziaeedevice driver first appeared in
711687d771SAlexander Ziaee.Fx 5.0 .
721687d771SAlexander Ziaee.Sh AUTHORS
731687d771SAlexander Ziaee.An -nosplit
741687d771SAlexander ZiaeeThe
751687d771SAlexander Ziaee.Nm
761687d771SAlexander Ziaeedevice driver was written by Jan-Simon Pendry for
771687d771SAlexander Ziaee.Bx 4.4
781687d771SAlexander Ziaeeand
791687d771SAlexander Ziaee.An Masanori OZAWA Aq Mt ozawa@ongs.co.jp
801687d771SAlexander Ziaeereimplemented the handling of the locking for
811687d771SAlexander Ziaee.Fx 7.0 .
821687d771SAlexander ZiaeeThe manual page was written by
831687d771SAlexander Ziaee.An Gordon Bergling Aq Mt gbe@FreeBSD.org .
841687d771SAlexander Ziaee.Sh BUGS
851687d771SAlexander ZiaeePlease see the
861687d771SAlexander Ziaee.Xr mount_unionfs 8
871687d771SAlexander Ziaeemanual page for a list of bugs regarding the
881687d771SAlexander Ziaee.Nm
891687d771SAlexander Ziaeefilesystem.
90