sbin/mount_unionfs/mount_unionfs.8

   1 .\" Copyright (c) 1994
   2 .\" The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software donated to Berkeley by
   5 .\" Jan-Simon Pendry.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 4. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     @(#)mount_union.8       8.6 (Berkeley) 3/27/94
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd March 27, 1994
  35 .Dt MOUNT_UNIONFS 8
  36 .Os
  37 .Sh NAME
  38 .Nm mount_unionfs
  39 .Nd mount union file systems
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl br
  43 .Op Fl o Ar options
  44 .Ar directory
  45 .Ar uniondir
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility attaches
  50 .Ar directory
  51 above
  52 .Ar uniondir
  53 in such a way that the contents of both directory trees remain visible.
  54 By default,
  55 .Ar directory
  56 becomes the
  57 .Em upper
  58 layer and
  59 .Ar uniondir
  60 becomes the
  61 .Em lower
  62 layer.
  63 .Pp
  64 The options are as follows:
  65 .Bl -tag -width indent
  66 .It Fl b
  67 Invert the default position, so that
  68 .Ar directory
  69 becomes the lower layer and
  70 .Ar uniondir
  71 becomes the upper layer.
  72 However,
  73 .Ar uniondir
  74 remains the mount point.
  75 .It Fl o
  76 Options are specified with a
  77 .Fl o
  78 flag followed by a comma separated string of options.
  79 See the
  80 .Xr mount 8
  81 man page for possible options and their meanings.
  82 .It Fl r
  83 Hide the lower layer completely in the same way as mounting with
  84 .Xr mount_nullfs 8 .
  85 .El
  86 .Pp
  87 To enforce file system security, the user mounting the file system
  88 must be superuser or else have write permission on the mounted-on
  89 directory.
  90 In addition, the
  91 .Va vfs.usermount
  92 .Xr sysctl 8
  93 variable must be set to 1 to permit file system mounting by ordinary users.
  94 .Pp
  95 Filenames are looked up in the upper layer and then in the
  96 lower layer.
  97 If a directory is found in the lower layer, and there is no entry
  98 in the upper layer, then a
  99 .Em shadow
 100 directory will be created in the upper layer.
 101 It will be owned by the user who originally did the union mount,
 102 with mode
 103 .Dq rwxrwxrwx
 104 (0777) modified by the umask in effect at that time.
 105 .Pp
 106 If a file exists in the upper layer then there is no way to access
 107 a file with the same name in the lower layer.
 108 If necessary, a combination of loopback and union mounts can be made
 109 which will still allow the lower files to be accessed by a different
 110 pathname.
 111 .Pp
 112 Except in the case of a directory,
 113 access to an object is granted via the normal file system access checks.
 114 For directories, the current user must have access to both the upper
 115 and lower directories (should they both exist).
 116 .Pp
 117 Requests to create or modify objects in
 118 .Ar uniondir
 119 are passed to the upper layer with the exception of a few special cases.
 120 An attempt to open for writing a file which exists in the lower layer
 121 causes a copy of the
 122 .Em entire
 123 file to be made to the upper layer, and then for the upper layer copy
 124 to be opened.
 125 Similarly, an attempt to truncate a lower layer file to zero length
 126 causes an empty file to be created in the upper layer.
 127 Any other operation which would ultimately require modification to
 128 the lower layer fails with
 129 .Er EROFS .
 130 .Pp
 131 The union file system manipulates the namespace, rather than
 132 individual file systems.
 133 The union operation applies recursively down the directory tree
 134 now rooted at
 135 .Ar uniondir .
 136 Thus any file systems which are mounted under
 137 .Ar uniondir
 138 will take part in the union operation.
 139 This differs from the
 140 .Em union
 141 option to
 142 .Xr mount 8
 143 which only applies the union operation to the mount point itself,
 144 and then only for lookups.
 145 .Sh EXAMPLES
 146 The commands
 147 .Bd -literal -offset indent
 148 mount -t cd9660 -o ro /dev/cd0a /usr/src
 149 mount -t unionfs /var/obj /usr/src
 150 .Ed
 151 .Pp
 152 mount the CD-ROM drive
 153 .Pa /dev/cd0a
 154 on
 155 .Pa /usr/src
 156 and then attaches
 157 .Pa /var/obj
 158 on top.
 159 For most purposes the effect of this is to make the
 160 source tree appear writable
 161 even though it is stored on a CD-ROM.
 162 .Pp
 163 The command
 164 .Bd -literal -offset indent
 165 mount -t unionfs -o -b /sys $HOME/sys
 166 .Ed
 167 .Pp
 168 attaches the system source tree below the
 169 .Pa sys
 170 directory in the user's home directory.
 171 This allows individual users to make private changes
 172 to the source, and build new kernels, without those
 173 changes becoming visible to other users.
 174 Note that the files in the lower layer remain
 175 accessible via
 176 .Pa /sys .
 177 .Sh SEE ALSO
 178 .Xr intro 2 ,
 179 .Xr mount 2 ,
 180 .Xr unmount 2 ,
 181 .Xr fstab 5 ,
 182 .Xr mount 8 ,
 183 .Xr mount_nullfs 8
 184 .Sh HISTORY
 185 The
 186 .Nm
 187 utility first appeared in
 188 .Bx 4.4 .
 189 It first worked in
 190 .Fx Ns -(fill this in) .
 191 .Sh BUGS
 192 THIS FILE SYSTEM TYPE IS NOT YET FULLY SUPPORTED (READ: IT DOESN'T WORK)
 193 AND USING IT MAY, IN FACT, DESTROY DATA ON YOUR SYSTEM.
 194 USE AT YOUR
 195 OWN RISK.
 196 BEWARE OF DOG.
 197 SLIPPERY WHEN WET.
 198 .Pp
 199 This code also needs an owner in order to be less dangerous - serious
 200 hackers can apply by sending mail to
 201 .Aq hackers@FreeBSD.org
 202 and announcing
 203 their intent to take it over.
 204 .Pp
 205 Without whiteout support from the file system backing the upper layer,
 206 there is no way that delete and rename operations on lower layer
 207 objects can be done.
 208 .Er EROFS
 209 is returned for this kind of operations along with any others
 210 which would make modifications to the lower layer, such as
 211 .Xr chmod 1 .
 212 .Pp
 213 Running
 214 .Xr find 1
 215 over a union tree has the side-effect of creating
 216 a tree of shadow directories in the upper layer.