bin/chmod/chmod.1

   1 .\"     $NetBSD: chmod.1,v 1.26 2016/08/11 00:10:42 sevan Exp $
   2 .\"
   3 .\" Copyright (c) 1989, 1990, 1993, 1994
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" the Institute of Electrical and Electronics Engineers, Inc.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .\"     @(#)chmod.1     8.4 (Berkeley) 3/31/94
  34 .\"
  35 .Dd August 11, 2016
  36 .Dt CHMOD 1
  37 .Os
  38 .Sh NAME
  39 .Nm chmod
  40 .Nd change file modes
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Oo
  44 .Fl R
  45 .Op Fl H | Fl L | Fl P
  46 .Oc
  47 .Op Fl fh
  48 .Ar mode
  49 .Ar
  50 .Nm
  51 .Oo
  52 .Fl R
  53 .Op Fl H | Fl L | Fl P
  54 .Oc
  55 .Op Fl fh
  56 .Fl Fl reference=rfile
  57 .Ar
  58 .Sh DESCRIPTION
  59 The
  60 .Nm
  61 utility modifies the file mode bits of the listed files
  62 as specified by the
  63 .Ar mode
  64 operand, or
  65 copied from a reference
  66 .Ar rfile ,
  67 as specified with the
  68 .Fl Fl reference
  69 argument.
  70 .Pp
  71 The options are as follows:
  72 .Bl -tag -width Ds
  73 .It Fl H
  74 If the
  75 .Fl R
  76 option is specified, symbolic links on the command line are followed.
  77 (Symbolic links encountered in the tree traversal are not followed.)
  78 .It Fl L
  79 If the
  80 .Fl R
  81 option is specified, all symbolic links are followed.
  82 .It Fl P
  83 If the
  84 .Fl R
  85 option is specified, no symbolic links are followed.
  86 .It Fl R
  87 Change the modes of the file hierarchies rooted in the files
  88 instead of just the files themselves.
  89 .It Fl f
  90 Do not display a diagnostic message or modify the exit status if
  91 .Nm
  92 fails to change the mode of a file.
  93 .It Fl h
  94 If
  95 .Ar file
  96 is symbolic link, the mode of the link is changed.
  97 .El
  98 .Pp
  99 The
 100 .Fl H ,
 101 .Fl L
 102 and
 103 .Fl P
 104 options are ignored unless the
 105 .Fl R
 106 option is specified.
 107 In addition, these options override each other and the
 108 command's actions are determined by the last one specified.
 109 The default is as if the
 110 .Fl P
 111 option had been specified.
 112 .Pp
 113 Only the owner of a file or the super-user is permitted to change
 114 the mode of a file.
 115 .Sh EXIT STATUS
 116 The
 117 .Nm
 118 utility exits 0 on success, and \*[Gt]0 if an error occurs.
 119 .Sh MODES
 120 Modes may be absolute or symbolic.
 121 An absolute mode is an octal number constructed by
 122 .Em or Ap ing
 123 the following values:
 124 .Pp
 125 .Bl -tag -width 6n -compact -offset indent
 126 .It Li 4000
 127 set-user-ID-on-execution
 128 .It Li 2000
 129 set-group-ID-on-execution
 130 .It Li 1000
 131 sticky bit, see
 132 .Xr chmod 2
 133 .It Li 0400
 134 read by owner
 135 .It Li 0200
 136 write by owner
 137 .It Li 0100
 138 execute (or search for directories) by owner
 139 .It Li 0070
 140 read, write, execute/search by group
 141 .It Li 0007
 142 read, write, execute/search by others
 143 .El
 144 .Pp
 145 The read, write, and execute/search values for group and others
 146 are encoded as described for owner.
 147 .Pp
 148 The symbolic mode is described by the following grammar:
 149 .Bd -literal -offset indent
 150 mode         ::= clause [, clause ...]
 151 clause       ::= [who ...] [action ...] last_action
 152 action       ::= op [perm ...]
 153 last_action  ::= op [perm ...]
 154 who          ::= a | u | g | o
 155 op           ::= + | \- | =
 156 perm         ::= r | s | t | w | x | X | u | g | o
 157 .Ed
 158 .Pp
 159 The
 160 .Ar who
 161 symbols ``u'', ``g'', and ``o'' specify the user, group, and other parts
 162 of the mode bits, respectively.
 163 The
 164 .Ar who
 165 symbol ``a'' is equivalent to ``ugo''.
 166 .Pp
 167 The
 168 .Ar perm
 169 symbols represent the portions of the mode bits as follows:
 170 .Pp
 171 .Bl -tag -width Ds -compact -offset indent
 172 .It r
 173 The read bits.
 174 .It s
 175 The set-user-ID-on-execution and set-group-ID-on-execution bits.
 176 .It t
 177 The sticky bit.
 178 .It w
 179 The write bits.
 180 .It x
 181 The execute/search bits.
 182 .It X
 183 The execute/search bits if the file is a directory or any of the
 184 execute/search bits are set in the original (unmodified) mode.
 185 Operations with the
 186 .Ar perm
 187 symbol ``X'' are only meaningful in conjunction with the
 188 .Ar op
 189 symbol ``+'', and are ignored in all other cases.
 190 .It u
 191 The user permission bits in the mode of the original file.
 192 .It g
 193 The group permission bits in the mode of the original file.
 194 .It o
 195 The other permission bits in the mode of the original file.
 196 .El
 197 .Pp
 198 The
 199 .Ar op
 200 symbols represent the operation performed, as follows:
 201 .Bl -tag -width 4n
 202 .It +
 203 If no value is supplied for
 204 .Ar perm ,
 205 the ``+'' operation has no effect.
 206 If no value is supplied for
 207 .Ar who ,
 208 each permission bit specified in
 209 .Ar perm ,
 210 for which the corresponding bit in the file mode creation mask
 211 is clear, is set.
 212 Otherwise, the mode bits represented by the specified
 213 .Ar who
 214 and
 215 .Ar perm
 216 values are set.
 217 .It \&\-
 218 If no value is supplied for
 219 .Ar perm ,
 220 the ``\-'' operation has no effect.
 221 If no value is supplied for
 222 .Ar who ,
 223 each permission bit specified in
 224 .Ar perm ,
 225 for which the corresponding bit in the file mode creation mask
 226 is clear, is cleared.
 227 Otherwise, the mode bits represented by the specified
 228 .Ar who
 229 and
 230 .Ar perm
 231 values are cleared.
 232 .It =
 233 The mode bits specified by the
 234 .Ar who
 235 value are cleared, or, if no who value is specified, the owner, group
 236 and other mode bits are cleared.
 237 Then, if no value is supplied for
 238 .Ar who ,
 239 each permission bit specified in
 240 .Ar perm ,
 241 for which the corresponding bit in the file mode creation mask
 242 is clear, is set.
 243 Otherwise, the mode bits represented by the specified
 244 .Ar who
 245 and
 246 .Ar perm
 247 values are set.
 248 .El
 249 .Pp
 250 Each
 251 .Ar clause
 252 specifies one or more operations to be performed on the mode
 253 bits, and each operation is applied to the mode bits in the
 254 order specified.
 255 .Pp
 256 Operations upon the other permissions only (specified by the symbol
 257 ``o'' by itself), in combination with the
 258 .Ar perm
 259 symbols ``s'' or ``t'', are ignored.
 260 .Sh EXAMPLES
 261 .Bl -tag -width "u=rwx,go=u-w" -compact
 262 .It Li 644
 263 make a file readable by anyone and writable by the owner only.
 264 .Pp
 265 .It Li go-w
 266 deny write permission to group and others.
 267 .Pp
 268 .It Li =rw,+X
 269 set the read and write permissions to the usual defaults, but
 270 retain any execute permissions that are currently set.
 271 .Pp
 272 .It Li +X
 273 make a directory or file searchable/executable by everyone if it is
 274 already searchable/executable by anyone.
 275 .Pp
 276 .It Li 755
 277 .It Li u=rwx,go=rx
 278 .It Li u=rwx,go=u-w
 279 make a file readable/executable by everyone and writable by the owner only.
 280 .Pp
 281 .It Li go=
 282 clear all mode bits for group and others.
 283 .Pp
 284 .It Li g=u-w
 285 set the group bits equal to the user bits, but clear the group write bit.
 286 .El
 287 .Sh SEE ALSO
 288 .Xr chflags 1 ,
 289 .Xr install 1 ,
 290 .Xr chmod 2 ,
 291 .Xr stat 2 ,
 292 .Xr umask 2 ,
 293 .Xr fts 3 ,
 294 .Xr setmode 3 ,
 295 .Xr symlink 7 ,
 296 .Xr chown 8
 297 .Sh STANDARDS
 298 The
 299 .Nm
 300 utility is expected to be
 301 .St -p1003.2-92
 302 compatible with the exception of the
 303 .Ar perm
 304 symbol
 305 .Dq t
 306 which is not included in that standard.
 307 .Sh HISTORY
 308 A
 309 .Nm
 310 utility appeared in
 311 .At v1 .
 312 .Sh BUGS
 313 There's no
 314 .Ar perm
 315 option for the naughty bits.