BSD 4_3_Net_2 release
[unix-history] / usr / src / bin / chmod / chmod.1
index 97b15ae..2de3c01 100644 (file)
@@ -1,31 +1,48 @@
 .\" Copyright (c) 1989, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1989, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" This code is derived from software contributed to Berkeley by
+.\" the Institute of Electrical and Electronics Engineers, Inc.
 .\"
 .\"
-.\"     @(#)chmod.1    6.10 (Berkeley) 7/24/90
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
 .\"
 .\"
-.Dd July 24, 1990
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"    @(#)chmod.1     6.15 (Berkeley) 7/23/91
+.\"
+.Dd July 23, 1991
 .Dt CHMOD 1
 .Dt CHMOD 1
-.Os BSD 4.4
+.Os
 .Sh NAME
 .Nm chmod
 .Sh NAME
 .Nm chmod
-change file modes
+.Nd change file modes
 .Sh SYNOPSIS
 .Nm chmod
 .Sh SYNOPSIS
 .Nm chmod
-.Op Fl fR
+.Op Fl R
 .Ar mode
 .Ar file ...
 .Sh DESCRIPTION
 .Ar mode
 .Ar file ...
 .Sh DESCRIPTION
@@ -37,18 +54,14 @@ as specified by the
 operand.
 .Pp
 The options are as follows:
 operand.
 .Pp
 The options are as follows:
-.Tw Ds
-.Tp Fl f
-.Nm chmod
-will still exit 0 and not complain if it fails to change the mode
-on a file.
-.Tp Fl R
+.Bl -tag -width Ds
+.It Fl R
 Traverse a file hierarchy.
 For each file that is of type directory,
 .Nm chmod
 changes the mode of all files in the file hierarchy below it followed
 by the mode of the directory itself.
 Traverse a file hierarchy.
 For each file that is of type directory,
 .Nm chmod
 changes the mode of all files in the file hierarchy below it followed
 by the mode of the directory itself.
-.Tp
+.El
 .Pp
 Symbolic links are not indirected through, nor are their modes altered.
 .Pp
 .Pp
 Symbolic links are not indirected through, nor are their modes altered.
 .Pp
@@ -61,56 +74,41 @@ utility exits 0 on success, and >0 if an error occurs.
 .Sh MODES
 Modes may be absolute or symbolic.
 An absolute mode is an octal number constructed by
 .Sh MODES
 Modes may be absolute or symbolic.
 An absolute mode is an octal number constructed by
-.Cx Ar or
-.Cx 'ing
-.Cx
+.Ar or Ap ing
 the following values:
 the following values:
-.Df I
-.Dw Fl
-.Dp Li 4000
+.Pp
+.Bl -tag -width 6n -compact -offset indent
+.It Li 4000
 set-user-ID-on-execution
 set-user-ID-on-execution
-.Dp Li 2000
+.It Li 2000
 set-group-ID-on-execution
 set-group-ID-on-execution
-.Dp Li 1000
+.It Li 1000
 sticky bit, see chmod(2)
 sticky bit, see chmod(2)
-.Dp Li 0400
+.It Li 0400
 read by owner
 read by owner
-.Dp Li 0200
+.It Li 0200
 write by owner
 write by owner
-.Dp Li 0100
+.It Li 0100
 execute (or search for directories) by owner
 execute (or search for directories) by owner
-.Dp Li 0070
+.It Li 0070
 read, write, execute/search by group
 read, write, execute/search by group
-.Dp Li 0007
+.It Li 0007
 read, write, execute/search by others
 read, write, execute/search by others
-.Dp
-.De
+.El
 .Pp
 The read, write, and execute/search values for group and others
 are encoded as described for owner.
 .Pp
 The symbolic mode is described by the following grammar:
 .Pp
 The read, write, and execute/search values for group and others
 are encoded as described for owner.
 .Pp
 The symbolic mode is described by the following grammar:
-.Dp Li mode
-::= clause
-.Op  \&, clause
-...
-.Dp Li clause
-::=
-.Op  who ...
-.Op  action ...
-last_action
-.Dp Li action
-::= op perm ...
-.Dp Li last_action
-::= op
-.Op  perm ...
-.Dp Li who
-.Li ::= a | u | g | o
-.Dp Li op
-.Li ::= + |  - |  =
-.Dp Li perm
-.Li ::= r |  s |  t |  w |  X |  x
-.Dp
+.Bd -literal -offset indent
+mode         ::= clause [, clause ...]
+clause       ::= [who ...] [action ...] last_action
+action       ::= op [perm ...]
+last_action  ::= op [perm ...]
+who          ::= a | u | g | o
+op           ::= + | \- | =
+perm         ::= r | s | t | w | X | x | u | g | o
+.Ed
 .Pp
 The
 .Ar who
 .Pp
 The
 .Ar who
@@ -123,18 +121,19 @@ symbol ``a'' is equivalent to ``ugo''.
 The
 .Ar perm
 symbols represent the portions of the mode bits as follows:
 The
 .Ar perm
 symbols represent the portions of the mode bits as follows:
-.Dw Ds
-.Dp r
+.Pp
+.Bl -tag -width Ds -compact -offset indent
+.It r
 The read bits.
 The read bits.
-.Dp s
+.It s
 The set-user-ID-on-execution and set-group-ID-on-execution bits.
 The set-user-ID-on-execution and set-group-ID-on-execution bits.
-.Dp t
+.It t
 The sticky bit.
 The sticky bit.
-.Dp w
+.It w
 The write bits.
 The write bits.
-.Dp x
+.It x
 The execute/search bits.
 The execute/search bits.
-.Dp X
+.It X
 The execute/search bits if the file is a directory or any of the
 execute/search bits are set in the original (unmodified) mode.
 Operations with the
 The execute/search bits if the file is a directory or any of the
 execute/search bits are set in the original (unmodified) mode.
 Operations with the
@@ -142,13 +141,13 @@ Operations with the
 symbol ``X'' are only meaningful in conjunction with the
 .Ar op
 symbol ``+'', and it is ignored in all other cases.
 symbol ``X'' are only meaningful in conjunction with the
 .Ar op
 symbol ``+'', and it is ignored in all other cases.
-.Dp
+.El
 .Pp
 The
 .Ar op
 symbols represent the operation performed, as follows:
 .Pp
 The
 .Ar op
 symbols represent the operation performed, as follows:
-.Tw Ds
-.Tp \&+
+.Bl -tag -width 4n
+.It +
 If no value is supplied for
 .Ar perm ,
 the ``+'' operation has no effect.
 If no value is supplied for
 .Ar perm ,
 the ``+'' operation has no effect.
@@ -163,10 +162,10 @@ Otherwise, the mode bits represented by the specified
 and
 .Ar perm
 values are set.
 and
 .Ar perm
 values are set.
-.Tp \&-
+.It \&\-
 If no value is supplied for
 .Ar perm ,
 If no value is supplied for
 .Ar perm ,
-the ``-'' operation has no effect.
+the ``\-'' operation has no effect.
 If no value is supplied for
 .Ar who ,
 the mode bits represented by
 If no value is supplied for
 .Ar who ,
 the mode bits represented by
@@ -177,7 +176,7 @@ Otherwise, the mode bits represented by the specified
 and
 .Ar perm
 values are cleared.
 and
 .Ar perm
 values are cleared.
-.Tp \&=
+.It =
 The mode bits specified by the
 .Ar who
 value are cleared, or, if no who value is specified, the owner, group
 The mode bits specified by the
 .Ar who
 value are cleared, or, if no who value is specified, the owner, group
@@ -193,7 +192,7 @@ Otherwise, the mode bits represented by the specified
 and
 .Ar perm
 values are set.
 and
 .Ar perm
 values are set.
-.Tp
+.El
 .Pp
 Each
 .Ar clause
 .Pp
 Each
 .Ar clause
@@ -206,22 +205,32 @@ Operations upon the other permissions only (specified by the symbol
 .Ar perm
 symbols ``s'' or ``t'', are ignored.
 .Sh EXAMPLES
 .Ar perm
 symbols ``s'' or ``t'', are ignored.
 .Sh EXAMPLES
-.Tw Ar
-.Tp ``644''
+.Bl -tag -width "u=rwx,go=u-w" -compact
+.It Li 644
 make a file readable by anyone and writable by the owner only.
 make a file readable by anyone and writable by the owner only.
-.Tp ``go-w''
+.Pp
+.It Li go-w
 deny write permission to group and others.
 deny write permission to group and others.
-.Tp ``=rw,+X''
+.Pp
+.It Li =rw,+X
 set the read and write permissions to the usual defaults, but
 retain any execute permissions that are currently set.
 set the read and write permissions to the usual defaults, but
 retain any execute permissions that are currently set.
-.Tp ``+X''
+.Pp
+.It Li +X
 make a directory or file searchable/executable by everyone if it is
 already searchable/executable by anyone.
 make a directory or file searchable/executable by everyone if it is
 already searchable/executable by anyone.
-.Tp ``755'' or ``u=rwx,go=rx''
+.Pp
+.It Li 755
+.It Li u=rwx,go=rx
+.It Li u=rwx,go=u-w
 make a file readable/executable by everyone and writeable by the owner only.
 make a file readable/executable by everyone and writeable by the owner only.
-.Tp ``go=''
+.Pp
+.It Li go=
 clear all mode bits for group and others.
 clear all mode bits for group and others.
-.Tp
+.Pp
+.It Li g=u-w
+set the group bits equal to the user bits, but clear the group write bit.
+.El
 .Sh BUGS
 There's no
 .Ar perm
 .Sh BUGS
 There's no
 .Ar perm
@@ -229,15 +238,21 @@ option for the naughty bits.
 .Sh SEE ALSO
 .Xr install 1 ,
 .Xr chmod 2 ,
 .Sh SEE ALSO
 .Xr install 1 ,
 .Xr chmod 2 ,
-.Xr fts 2 ,
 .Xr stat 2 ,
 .Xr umask 2 ,
 .Xr stat 2 ,
 .Xr umask 2 ,
+.Xr fts 3 ,
 .Xr setmode 3 ,
 .Xr chown 8
 .Sh STANDARDS
 The
 .Nm chmod
 .Xr setmode 3 ,
 .Xr chown 8
 .Sh STANDARDS
 The
 .Nm chmod
-utility is expected to be POSIX 1003.2 compatible with the exception
+utility is expected to be
+.St -p1003.2
+compatible with the exception
 of the
 .Ar perm
 of the
 .Ar perm
-symbols ``t'' and ``X'' which are not included in that standard.
+symbols
+.Dq t
+and
+.Dq X
+which are not included in that standard.