32dfdf7695b6c7d39ee5dd0b48325bd7b13863a1
[dragonfly.git] / sbin / mount_umap / mount_umap.8
1 .\" Copyright (c) 1992, 1993, 1994
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\" All rights reserved.
4 .\"
5 .\" This code is derived from software donated to Berkeley by
6 .\" Jan-Simon Pendry and from John Heidemann of the UCLA Ficus project.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in the
15 .\"    documentation and/or other materials provided with the distribution.
16 .\" 3. All advertising materials mentioning features or use of this software
17 .\"    must display the following acknowledgement:
18 .\"     This product includes software developed by the University of
19 .\"     California, Berkeley and its contributors.
20 .\" 4. Neither the name of the University nor the names of its contributors
21 .\"    may be used to endorse or promote products derived from this software
22 .\"    without specific prior written permission.
23 .\"
24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .\" SUCH DAMAGE.
35 .\"
36 .\"     @(#)mount_umap.8        8.4 (Berkeley) 5/1/95
37 .\" $FreeBSD: src/sbin/mount_umap/mount_umap.8,v 1.10.2.3 2001/12/20 16:44:17 ru Exp $
38 .\" $DragonFly: src/sbin/mount_umap/Attic/mount_umap.8,v 1.3 2006/02/17 19:33:33 swildner Exp $
39 .\"
40 .Dd May 1, 1995
41 .Dt MOUNT_UMAP 8
42 .Os
43 .Sh NAME
44 .Nm mount_umap
45 .Nd sample file system layer
46 .Sh SYNOPSIS
47 .Nm
48 .Op Fl o Ar options
49 .Fl u Ar uid-mapfile
50 .Fl g Ar gid-mapfile
51 .Ar target
52 .Ar mount-point
53 .Sh DESCRIPTION
54 The
55 .Nm
56 command is used to mount a sub-tree of an existing file system
57 that uses a different set of uids and gids than the local system.
58 Such a file system could be mounted from a remote site via NFS or
59 it could be a file system on removable media brought from some
60 foreign location that uses a different password file.
61 .Pp
62 The
63 .Nm
64 command uses a set of files provided by the user to make correspondences
65 between uids and gids in the sub-tree's original environment and
66 some other set of ids in the local environment.  For instance, user
67 smith might have uid 1000 in the original environment, while having
68 uid 2000 in the local environment.  The
69 .Nm
70 command allows the subtree from smith's original environment to be
71 mapped in such a way that all files with owning uid 1000 look like
72 they are actually owned by uid 2000.
73 .Pp
74 The options are as follows:
75 .Bl -tag -width indent
76 .It Fl o
77 Options are specified with a
78 .Fl o
79 flag followed by a comma separated string of options.
80 See the
81 .Xr mount 8
82 man page for possible options and their meanings.
83 .It Ar target
84 Should be the current location of the sub-tree in the
85 local system's name space.
86 .It Ar mount-point
87 Should be a directory
88 where the mapped subtree is to be placed.
89 .It Fl u Ar uid-mapfile
90 .It Fl g Ar gid-mapfile
91 Describe the mappings to be made between identifiers.
92 Briefly, the format of these files is a count of the number of
93 mappings on the first line, with each subsequent line containing
94 a single mapping.  Each of these mappings consists of an id in
95 the local environment and the corresponding id from the original environment,
96 separated by white space.
97 .Ar Uid-mapfile
98 should contain all uid
99 mappings, and
100 .Ar gid-mapfile
101 should contain all gid mappings.
102 Any uids not mapped in
103 .Ar uid-mapfile
104 will be treated as user NOBODY,
105 and any gids not mapped in
106 .Ar gid-mapfile
107 will be treated as group
108 NULLGROUP.  At most 64 uids can be mapped for a given subtree, and
109 at most 16 groups can be mapped by a given subtree.
110 .El
111 .Pp
112 The mapfiles can be located anywhere in the file hierarchy, but they
113 must be owned by root, and they must be writable only by root.
114 .Nm Mount_umap
115 will refuse to map the sub-tree if the ownership or permissions on
116 these files are improper.  It will also balk if the count of mappings
117 in the first line of the map files is not correct.
118 .Pp
119 The layer created by the
120 .Nm
121 command is meant to serve as a simple example of file system layering.
122 It is not meant for production use.  The implementation is not very
123 sophisticated.
124 .Sh SEE ALSO
125 .Xr mount 8 ,
126 .Xr mount_null 8
127 .Sh HISTORY
128 The
129 .Nm
130 utility first appeared in
131 .Bx 4.4 .
132 .Sh BUGS
133 THIS FILESYSTEM TYPE IS NOT YET FULLY SUPPORTED (READ: IT DOESN'T WORK)
134 AND USING IT MAY, IN FACT, DESTROY DATA ON YOUR SYSTEM.  USE AT YOUR
135 OWN RISK.  BEWARE OF DOG.  SLIPPERY WHEN WET.
136 .Pp
137 This code also needs an owner in order to be less dangerous - serious
138 hackers can apply by sending mail to
139 .Aq hackers@FreeBSD.org
140 and announcing
141 their intent to take it over.