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