Add chmod from 4.4BSD-Lite Release 2
[bobcat.git] / usr / src / bin / chmod / chmod.1
1 .\" Copyright (c) 1989, 1990, 1993, 1994
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" the Institute of Electrical and Electronics Engineers, Inc.
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. 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 .\"     @(#)chmod.1     8.4 (Berkeley) 3/31/94
32 .\"
33 .Dd March 31, 1994
34 .Dt CHMOD 1
35 .Os
36 .Sh NAME
37 .Nm chmod
38 .Nd change file modes
39 .Sh SYNOPSIS
40 .Nm chmod
41 .Oo
42 .Fl R
43 .Op Fl H | Fl L | Fl P
44 .Oc
45 .Ar mode
46 .Ar file ...
47 .Sh DESCRIPTION
48 The
49 .Nm chmod
50 utility modifies the file mode bits of the listed files
51 as specified by the
52 .Ar mode
53 operand.
54 .Pp
55 The options are as follows:
56 .Bl -tag -width Ds
57 .It Fl H
58 If the
59 .Fl R
60 option is specified, symbolic links on the command line are followed.
61 (Symbolic links encountered in the tree traversal are not followed.)
62 .It Fl L
63 If the
64 .Fl R
65 option is specified, all symbolic links are followed.
66 .It Fl P
67 If the
68 .Fl R
69 option is specified, no symbolic links are followed.
70 .It Fl R
71 Change the modes of the file hierarchies rooted in the files
72 instead of just the files themselves.
73 .El
74 .Pp
75 Symbolic links do not have modes, so unless the
76 .Fl H
77 or
78 .Fl L
79 option is set,
80 .Nm chmod
81 on a symbolic link always succeeds and has no effect.
82 The
83 .Fl H ,
84 .Fl L
85 and
86 .Fl P
87 options are ignored unless the
88 .Fl R
89 option is specified.
90 In addition, these options override each other and the
91 command's actions are determined by the last one specified.
92 .Pp
93 Only the owner of a file or the super-user is permitted to change
94 the mode of a file.
95 .Pp
96 The
97 .Nm chmod
98 utility exits 0 on success, and >0 if an error occurs.
99 .Sh MODES
100 Modes may be absolute or symbolic.
101 An absolute mode is an octal number constructed by
102 .Ar or-ing
103 the following values:
104 .Pp
105 .Bl -tag -width 6n -compact -offset indent
106 .It Li 4000
107 set-user-ID-on-execution
108 .It Li 2000
109 set-group-ID-on-execution
110 .It Li 1000
111 sticky bit, see chmod(2)
112 .It Li 0400
113 read by owner
114 .It Li 0200
115 write by owner
116 .It Li 0100
117 execute (or search for directories) by owner
118 .It Li 0070
119 read, write, execute/search by group
120 .It Li 0007
121 read, write, execute/search by others
122 .El
123 .Pp
124 The read, write, and execute/search values for group and others
125 are encoded as described for owner.
126 .Pp
127 The symbolic mode is described by the following grammar:
128 .Bd -literal -offset indent
129 mode         ::= clause [, clause ...]
130 clause       ::= [who ...] [action ...] last_action
131 action       ::= op [perm ...]
132 last_action  ::= op [perm ...]
133 who          ::= a | u | g | o
134 op           ::= + | \- | =
135 perm         ::= r | s | t | w | x | X | u | g | o
136 .Ed
137 .Pp
138 The
139 .Ar who
140 symbols ``u'', ``g'', and ``o'' specify the user, group, and other parts
141 of the mode bits, respectively.
142 The
143 .Ar who
144 symbol ``a'' is equivalent to ``ugo''.
145 .Pp
146 .ne 1i
147 The
148 .Ar perm
149 symbols represent the portions of the mode bits as follows:
150 .Pp
151 .Bl -tag -width Ds -compact -offset indent
152 .It r
153 The read bits.
154 .It s
155 The set-user-ID-on-execution and set-group-ID-on-execution bits.
156 .It t
157 The sticky bit.
158 .It w
159 The write bits.
160 .It x
161 The execute/search bits.
162 .It X
163 The execute/search bits if the file is a directory or any of the
164 execute/search bits are set in the original (unmodified) mode.
165 Operations with the
166 .Ar perm
167 symbol ``X'' are only meaningful in conjunction with the
168 .Ar op
169 symbol ``+'', and are ignored in all other cases.
170 .It u
171 The user permission bits in the mode of the original file.
172 .It g
173 The group permission bits in the mode of the original file.
174 .It o
175 The other permission bits in the mode of the original file.
176 .El
177 .Pp
178 The
179 .Ar op
180 symbols represent the operation performed, as follows:
181 .Bl -tag -width 4n
182 .It +
183 If no value is supplied for
184 .Ar perm ,
185 the ``+'' operation has no effect.
186 If no value is supplied for
187 .Ar who ,
188 each permission bit specified in
189 .Ar perm ,
190 for which the corresponding bit in the file mode creation mask
191 is clear, is set.
192 Otherwise, the mode bits represented by the specified
193 .Ar who
194 and
195 .Ar perm
196 values are set.
197 .It \&\-
198 If no value is supplied for
199 .Ar perm ,
200 the ``\-'' operation has no effect.
201 If no value is supplied for
202 .Ar who ,
203 each permission bit specified in
204 .Ar perm ,
205 for which the corresponding bit in the file mode creation mask
206 is clear, is cleared.
207 Otherwise, the mode bits represented by the specified
208 .Ar who
209 and
210 .Ar perm
211 values are cleared.
212 .It =
213 The mode bits specified by the
214 .Ar who
215 value are cleared, or, if no who value is specified, the owner, group
216 and other mode bits are cleared.
217 Then, if no value is supplied for
218 .Ar who ,
219 each permission bit specified in
220 .Ar perm ,
221 for which the corresponding bit in the file mode creation mask
222 is clear, is set.
223 Otherwise, the mode bits represented by the specified
224 .Ar who
225 and
226 .Ar perm
227 values are set.
228 .El
229 .Pp
230 Each
231 .Ar clause
232 specifies one or more operations to be performed on the mode
233 bits, and each operation is applied to the mode bits in the
234 order specified.
235 .Pp
236 Operations upon the other permissions only (specified by the symbol
237 ``o'' by itself), in combination with the
238 .Ar perm
239 symbols ``s'' or ``t'', are ignored.
240 .Sh EXAMPLES
241 .Bl -tag -width "u=rwx,go=u-w" -compact
242 .It Li 644
243 make a file readable by anyone and writable by the owner only.
244 .Pp
245 .It Li go-w
246 deny write permission to group and others.
247 .Pp
248 .It Li =rw,+X
249 set the read and write permissions to the usual defaults, but
250 retain any execute permissions that are currently set.
251 .Pp
252 .It Li +X
253 make a directory or file searchable/executable by everyone if it is
254 already searchable/executable by anyone.
255 .Pp
256 .It Li 755
257 .It Li u=rwx,go=rx
258 .It Li u=rwx,go=u-w
259 make a file readable/executable by everyone and writable by the owner only.
260 .Pp
261 .It Li go=
262 clear all mode bits for group and others.
263 .Pp
264 .It Li g=u-w
265 set the group bits equal to the user bits, but clear the group write bit.
266 .El
267 .Sh BUGS
268 There's no
269 .Ar perm
270 option for the naughty bits.
271 .Sh SEE ALSO
272 .Xr install 1 ,
273 .Xr chmod 2 ,
274 .Xr stat 2 ,
275 .Xr umask 2 ,
276 .Xr fts 3 ,
277 .Xr setmode 3 ,
278 .Xr symlink 7 ,
279 .Xr chown 8
280 .Sh STANDARDS
281 The
282 .Nm chmod
283 utility is expected to be POSIX 1003.2
284 compatible with the exception of the
285 .Ar perm
286 symbols
287 .Dq t
288 and
289 .Dq X
290 which are not included in that standard.