bin/chmod/chmod.1

   1 .\"-
   2 .\" Copyright (c) 1989, 1990, 1993, 1994
   3 .\"     The Regents of the University of California.  All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to Berkeley by
   6 .\" the Institute of Electrical and Electronics Engineers, Inc.
   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 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)chmod.1     8.4 (Berkeley) 3/31/94
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd January 26, 2009
  36 .Dt CHMOD 1
  37 .Os
  38 .Sh NAME
  39 .Nm chmod
  40 .Nd change file modes
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl fhv
  44 .Op Fl R Op Fl H | L | P
  45 .Ar mode
  46 .Ar
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  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 indent
  57 .It Fl f
  58 Do not display a diagnostic message if
  59 .Nm
  60 could not modify the mode for
  61 .Va file ,
  62 nor modify the exit status to reflect such failures.
  63 .It Fl H
  64 If the
  65 .Fl R
  66 option is specified, symbolic links on the command line are followed.
  67 (Symbolic links encountered in the tree traversal are not followed by
  68 default.)
  69 .It Fl h
  70 If the file is a symbolic link, change the mode of the link itself
  71 rather than the file that the link points to.
  72 .It Fl L
  73 If the
  74 .Fl R
  75 option is specified, all symbolic links are followed.
  76 .It Fl P
  77 If the
  78 .Fl R
  79 option is specified, no symbolic links are followed.
  80 This is the default.
  81 .It Fl R
  82 Change the modes of the file hierarchies rooted in the files
  83 instead of just the files themselves.
  84 .It Fl v
  85 Cause
  86 .Nm
  87 to be verbose, showing filenames as the mode is modified.
  88 If the
  89 .Fl v
  90 flag is specified more than once, the old and new modes of the file
  91 will also be printed, in both octal and symbolic notation.
  92 .El
  93 .Pp
  94 The
  95 .Fl H ,
  96 .Fl L
  97 and
  98 .Fl P
  99 options are ignored unless the
 100 .Fl R
 101 option is specified.
 102 In addition, these options override each other and the
 103 command's actions are determined by the last one specified.
 104 .Pp
 105 Only the owner of a file or the super-user is permitted to change
 106 the mode of a file.
 107 .Sh EXIT STATUS
 108 .Ex -std
 109 .Sh MODES
 110 Modes may be absolute or symbolic.
 111 An absolute mode is an octal number constructed from the sum of
 112 one or more of the following values:
 113 .Pp
 114 .Bl -tag -width 6n -compact -offset indent
 115 .It Li 4000
 116 (the setuid bit).
 117 Executable files with this bit set
 118 will run with effective uid set to the uid of the file owner.
 119 Directories with this bit set will force all files and
 120 sub-directories created in them to be owned by the directory owner
 121 and not by the uid of the creating process, if the underlying file
 122 system supports this feature: see
 123 .Xr chmod 2
 124 and the
 125 .Cm suiddir
 126 option to
 127 .Xr mount 8 .
 128 .It Li 2000
 129 (the setgid bit).
 130 Executable files with this bit set
 131 will run with effective gid set to the gid of the file owner.
 132 .It Li 1000
 133 (the sticky bit).
 134 See
 135 .Xr chmod 2
 136 and
 137 .Xr sticky 7 .
 138 .It Li 0400
 139 Allow read by owner.
 140 .It Li 0200
 141 Allow write by owner.
 142 .It Li 0100
 143 For files, allow execution by owner.
 144 For directories, allow the owner to
 145 search in the directory.
 146 .It Li 0040
 147 Allow read by group members.
 148 .It Li 0020
 149 Allow write by group members.
 150 .It Li 0010
 151 For files, allow execution by group members.
 152 For directories, allow
 153 group members to search in the directory.
 154 .It Li 0004
 155 Allow read by others.
 156 .It Li 0002
 157 Allow write by others.
 158 .It Li 0001
 159 For files, allow execution by others.
 160 For directories allow others to
 161 search in the directory.
 162 .El
 163 .Pp
 164 For example, the absolute mode that permits read, write and execute by
 165 the owner, read and execute by group members, read and execute by
 166 others, and no set-uid or set-gid behaviour is 755
 167 (400+200+100+040+010+004+001).
 168 .Pp
 169 The symbolic mode is described by the following grammar:
 170 .Bd -literal -offset indent
 171 mode         ::= clause [, clause ...]
 172 clause       ::= [who ...] [action ...] action
 173 action       ::= op [perm ...]
 174 who          ::= a | u | g | o
 175 op           ::= + | \- | =
 176 perm         ::= r | s | t | w | x | X | u | g | o
 177 .Ed
 178 .Pp
 179 The
 180 .Ar who
 181 symbols ``u'', ``g'', and ``o'' specify the user, group, and other parts
 182 of the mode bits, respectively.
 183 The
 184 .Ar who
 185 symbol ``a'' is equivalent to ``ugo''.
 186 .Pp
 187 The
 188 .Ar perm
 189 symbols represent the portions of the mode bits as follows:
 190 .Pp
 191 .Bl -tag -width Ds -compact -offset indent
 192 .It r
 193 The read bits.
 194 .It s
 195 The set-user-ID-on-execution and set-group-ID-on-execution bits.
 196 .It t
 197 The sticky bit.
 198 .It w
 199 The write bits.
 200 .It x
 201 The execute/search bits.
 202 .It X
 203 The execute/search bits if the file is a directory or any of the
 204 execute/search bits are set in the original (unmodified) mode.
 205 Operations with the
 206 .Ar perm
 207 symbol ``X'' are only meaningful in conjunction with the
 208 .Ar op
 209 symbol ``+'', and are ignored in all other cases.
 210 .It u
 211 The user permission bits in the original mode of the file.
 212 .It g
 213 The group permission bits in the original mode of the file.
 214 .It o
 215 The other permission bits in the original mode of the file.
 216 .El
 217 .Pp
 218 The
 219 .Ar op
 220 symbols represent the operation performed, as follows:
 221 .Bl -tag -width 4n
 222 .It +
 223 If no value is supplied for
 224 .Ar perm ,
 225 the ``+'' operation has no effect.
 226 If no value is supplied for
 227 .Ar who ,
 228 each permission bit specified in
 229 .Ar perm ,
 230 for which the corresponding bit in the file mode creation mask
 231 (see
 232 .Xr umask 2 )
 233 is clear, is set.
 234 Otherwise, the mode bits represented by the specified
 235 .Ar who
 236 and
 237 .Ar perm
 238 values are set.
 239 .It \&\-
 240 If no value is supplied for
 241 .Ar perm ,
 242 the ``\-'' operation has no effect.
 243 If no value is supplied for
 244 .Ar who ,
 245 each permission bit specified in
 246 .Ar perm ,
 247 for which the corresponding bit in the file mode creation mask
 248 is clear, is cleared.
 249 Otherwise, the mode bits represented by the specified
 250 .Ar who
 251 and
 252 .Ar perm
 253 values are cleared.
 254 .It =
 255 The mode bits specified by the
 256 .Ar who
 257 value are cleared, or, if no
 258 .Ar who
 259 value is specified, the owner, group
 260 and other mode bits are cleared.
 261 Then, if no value is supplied for
 262 .Ar who ,
 263 each permission bit specified in
 264 .Ar perm ,
 265 for which the corresponding bit in the file mode creation mask
 266 is clear, is set.
 267 Otherwise, the mode bits represented by the specified
 268 .Ar who
 269 and
 270 .Ar perm
 271 values are set.
 272 .El
 273 .Pp
 274 Each
 275 .Ar clause
 276 specifies one or more operations to be performed on the mode
 277 bits, and each operation is applied to the mode bits in the
 278 order specified.
 279 .Pp
 280 Operations upon the other permissions only (specified by the symbol
 281 ``o'' by itself), in combination with the
 282 .Ar perm
 283 symbols ``s'' or ``t'', are ignored.
 284 .Pp
 285 The ``w'' permission on directories will permit file creation, relocation,
 286 and copy into that directory.
 287 Files created within the directory itself will inherit its group ID.
 288 .Sh EXAMPLES
 289 .Bl -tag -width "u=rwx,go=u-w" -compact
 290 .It Li 644
 291 make a file readable by anyone and writable by the owner only.
 292 .Pp
 293 .It Li go-w
 294 deny write permission to group and others.
 295 .Pp
 296 .It Li =rw,+X
 297 set the read and write permissions to the usual defaults, but
 298 retain any execute permissions that are currently set.
 299 .Pp
 300 .It Li +X
 301 make a directory or file searchable/executable by everyone if it is
 302 already searchable/executable by anyone.
 303 .Pp
 304 .It Li 755
 305 .It Li u=rwx,go=rx
 306 .It Li u=rwx,go=u-w
 307 make a file readable/executable by everyone and writable by the owner only.
 308 .Pp
 309 .It Li go=
 310 clear all mode bits for group and others.
 311 .Pp
 312 .It Li g=u-w
 313 set the group bits equal to the user bits, but clear the group write bit.
 314 .El
 315 .Sh COMPATIBILITY
 316 The
 317 .Fl v
 318 option is non-standard and its use in scripts is not recommended.
 319 .Sh SEE ALSO
 320 .Xr chflags 1 ,
 321 .Xr install 1 ,
 322 .Xr setfacl 1 ,
 323 .Xr chmod 2 ,
 324 .Xr stat 2 ,
 325 .Xr umask 2 ,
 326 .Xr fts 3 ,
 327 .Xr setmode 3 ,
 328 .Xr sticky 7 ,
 329 .Xr symlink 7 ,
 330 .Xr chown 8 ,
 331 .Xr mount 8
 332 .Sh STANDARDS
 333 The
 334 .Nm
 335 utility is expected to be
 336 .St -p1003.2
 337 compatible with the exception of the
 338 .Ar perm
 339 symbol
 340 .Dq t
 341 which is not included in that standard.
 342 .Sh HISTORY
 343 A
 344 .Nm
 345 command appeared in
 346 .At v1 .
 347 .Sh BUGS
 348 There is no
 349 .Ar perm
 350 option for the naughty bits of a horse.