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. 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 .\"     @(#)chmod.1     8.4 (Berkeley) 3/31/94
  36 .\" $FreeBSD: src/bin/chmod/chmod.1,v 1.17.2.16 2003/02/24 03:01:00 trhodes Exp $
  37 .\"
  38 .Dd March 31, 1994
  39 .Dt CHMOD 1
  40 .Os
  41 .Sh NAME
  42 .Nm chmod
  43 .Nd change file modes
  44 .Sh SYNOPSIS
  45 .Nm
  46 .Op Fl fhv
  47 .Op Fl R Op Fl H | L | P
  48 .Ar mode
  49 .Ar
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 utility modifies the file mode bits of the listed files
  54 as specified by the
  55 .Ar mode
  56 operand.
  57 .Pp
  58 The options are as follows:
  59 .Bl -tag -width indent
  60 .It Fl f
  61 Do not display a diagnostic message if
  62 .Nm
  63 could not modify the mode for
  64 .Va file ,
  65 nor modify the exit status to reflect such failures.
  66 .It Fl H
  67 If the
  68 .Fl R
  69 option is specified, symbolic links on the command line are followed.
  70 (Symbolic links encountered in the tree traversal are not followed by
  71 default.)
  72 .It Fl h
  73 If the file is a symbolic link, change the mode of the link itself
  74 rather than the file that the link points to.
  75 .It Fl L
  76 If the
  77 .Fl R
  78 option is specified, all symbolic links are followed.
  79 .It Fl P
  80 If the
  81 .Fl R
  82 option is specified, no symbolic links are followed.
  83 This is the default.
  84 .It Fl R
  85 Change the modes of the file hierarchies rooted in the files
  86 instead of just the files themselves.
  87 .It Fl v
  88 Cause
  89 .Nm
  90 to be verbose, showing filenames as the mode is modified.
  91 .El
  92 .Pp
  93 The
  94 .Fl H ,
  95 .Fl L
  96 and
  97 .Fl P
  98 options are ignored unless the
  99 .Fl R
 100 option is specified.
 101 In addition, these options override each other and the
 102 command's actions are determined by the last one specified.
 103 .Pp
 104 Only the owner of a file or the super-user is permitted to change
 105 the mode of a file.
 106 .Sh DIAGNOSTICS
 107 .Ex -std
 108 .Sh MODES
 109 Modes may be absolute or symbolic.
 110 An absolute mode is an octal number constructed from the sum of
 111 one or more of the following values:
 112 .Pp
 113 .Bl -tag -width 6n -compact -offset indent
 114 .It Li 4000
 115 (the setuid bit).
 116 Executable files with this bit set
 117 will run with effective uid set to the uid of the file owner.
 118 Directories with this bit set will force all files and
 119 sub-directories created in them to be owned by the directory owner
 120 and not by the uid of the creating process, if the underlying file
 121 system supports this feature: see
 122 .Xr chmod 2
 123 and the
 124 .Cm suiddir
 125 option to
 126 .Xr mount 8 .
 127 .It Li 2000
 128 (the setgid bit).
 129 Executable files with this bit set
 130 will run with effective gid set to the gid of the file owner.
 131 .It Li 1000
 132 (the sticky bit).
 133 See
 134 .Xr chmod 2
 135 and
 136 .Xr sticky 8 .
 137 .It Li 0400
 138 Allow read by owner.
 139 .It Li 0200
 140 Allow write by owner.
 141 .It Li 0100
 142 For files, allow execution by owner.
 143 For directories, allow the owner to
 144 search in the directory.
 145 .It Li 0040
 146 Allow read by group members.
 147 .It Li 0020
 148 Allow write by group members.
 149 .It Li 0010
 150 For files, allow execution by group members.
 151 For directories, allow
 152 group members to search in the directory.
 153 .It Li 0004
 154 Allow read by others.
 155 .It Li 0002
 156 Allow write by others.
 157 .It Li 0001
 158 For files, allow execution by others.
 159 For directories allow others to
 160 search in the directory.
 161 .El
 162 .Pp
 163 For example, the absolute mode that permits read, write and execute by
 164 the owner, read and execute by group members, read and execute by
 165 others, and no set-uid or set-gid behaviour is 755
 166 (400+200+100+040+010+004+001).
 167 .Pp
 168 The symbolic mode is described by the following grammar:
 169 .Bd -literal -offset indent
 170 mode         ::= clause [, clause ...]
 171 clause       ::= [who ...] [action ...] action
 172 action       ::= op [perm ...]
 173 who          ::= a | u | g | o
 174 op           ::= + | \- | =
 175 perm         ::= r | s | t | w | x | X | u | g | o
 176 .Ed
 177 .Pp
 178 The
 179 .Ar who
 180 symbols ``u'', ``g'', and ``o'' specify the user, group, and other parts
 181 of the mode bits, respectively.
 182 The
 183 .Ar who
 184 symbol ``a'' is equivalent to ``ugo''.
 185 .Pp
 186 The
 187 .Ar perm
 188 symbols represent the portions of the mode bits as follows:
 189 .Pp
 190 .Bl -tag -width Ds -compact -offset indent
 191 .It r
 192 The read bits.
 193 .It s
 194 The set-user-ID-on-execution and set-group-ID-on-execution bits.
 195 .It t
 196 The sticky bit.
 197 .It w
 198 The write bits.
 199 .It x
 200 The execute/search bits.
 201 .It X
 202 The execute/search bits if the file is a directory or any of the
 203 execute/search bits are set in the original (unmodified) mode.
 204 Operations with the
 205 .Ar perm
 206 symbol ``X'' are only meaningful in conjunction with the
 207 .Ar op
 208 symbol ``+'', and are ignored in all other cases.
 209 .It u
 210 The user permission bits in the original mode of the file.
 211 .It g
 212 The group permission bits in the original mode of the file.
 213 .It o
 214 The other permission bits in the original mode of the file.
 215 .El
 216 .Pp
 217 The
 218 .Ar op
 219 symbols represent the operation performed, as follows:
 220 .Bl -tag -width 4n
 221 .It +
 222 If no value is supplied for
 223 .Ar perm ,
 224 the ``+'' operation has no effect.
 225 If no value is supplied for
 226 .Ar who ,
 227 each permission bit specified in
 228 .Ar perm ,
 229 for which the corresponding bit in the file mode creation mask
 230 is clear, is set.
 231 Otherwise, the mode bits represented by the specified
 232 .Ar who
 233 and
 234 .Ar perm
 235 values are set.
 236 .It \&\-
 237 If no value is supplied for
 238 .Ar perm ,
 239 the ``\-'' operation has no effect.
 240 If no value is supplied for
 241 .Ar who ,
 242 each permission bit specified in
 243 .Ar perm ,
 244 for which the corresponding bit in the file mode creation mask
 245 is clear, is cleared.
 246 Otherwise, the mode bits represented by the specified
 247 .Ar who
 248 and
 249 .Ar perm
 250 values are cleared.
 251 .It =
 252 The mode bits specified by the
 253 .Ar who
 254 value are cleared, or, if no who value is specified, the owner, group
 255 and other mode bits are cleared.
 256 Then, if no value is supplied for
 257 .Ar who ,
 258 each permission bit specified in
 259 .Ar perm ,
 260 for which the corresponding bit in the file mode creation mask
 261 is clear, is set.
 262 Otherwise, the mode bits represented by the specified
 263 .Ar who
 264 and
 265 .Ar perm
 266 values are set.
 267 .El
 268 .Pp
 269 Each
 270 .Ar clause
 271 specifies one or more operations to be performed on the mode
 272 bits, and each operation is applied to the mode bits in the
 273 order specified.
 274 .Pp
 275 Operations upon the other permissions only (specified by the symbol
 276 ``o'' by itself), in combination with the
 277 .Ar perm
 278 symbols ``s'' or ``t'', are ignored.
 279 .Sh EXAMPLES
 280 .Bl -tag -width "u=rwx,go=u-w" -compact
 281 .It Li 644
 282 make a file readable by anyone and writable by the owner only.
 283 .Pp
 284 .It Li go-w
 285 deny write permission to group and others.
 286 .Pp
 287 .It Li =rw,+X
 288 set the read and write permissions to the usual defaults, but
 289 retain any execute permissions that are currently set.
 290 .Pp
 291 .It Li +X
 292 make a directory or file searchable/executable by everyone if it is
 293 already searchable/executable by anyone.
 294 .Pp
 295 .It Li 755
 296 .It Li u=rwx,go=rx
 297 .It Li u=rwx,go=u-w
 298 make a file readable/executable by everyone and writable by the owner only.
 299 .Pp
 300 .It Li go=
 301 clear all mode bits for group and others.
 302 .Pp
 303 .It Li g=u-w
 304 set the group bits equal to the user bits, but clear the group write bit.
 305 .El
 306 .Sh BUGS
 307 There's no
 308 .Ar perm
 309 option for the naughty bits.
 310 .Sh COMPATIBILITY
 311 The
 312 .Fl v
 313 option is non-standard and its use in scripts is not recommended.
 314 .Sh SEE ALSO
 315 .Xr chflags 1 ,
 316 .Xr install 1 ,
 317 .Xr chmod 2 ,
 318 .Xr stat 2 ,
 319 .Xr umask 2 ,
 320 .Xr fts 3 ,
 321 .Xr setmode 3 ,
 322 .Xr symlink 7 ,
 323 .Xr chown 8 ,
 324 .Xr mount 8 ,
 325 .Xr sticky 8
 326 .Sh STANDARDS
 327 The
 328 .Nm
 329 utility is expected to be
 330 .St -p1003.2
 331 compatible with the exception of the
 332 .Ar perm
 333 symbol
 334 .Dq t
 335 which is not included in that standard.
 336 .Sh HISTORY
 337 A
 338 .Nm
 339 command appeared in
 340 .At v1 .