Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / usr.bin / chflags / chflags.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 .\"     @(#)chflags.1   8.4 (Berkeley) 5/2/95
36 .\" $FreeBSD: src/usr.bin/chflags/chflags.1,v 1.9.2.6 2003/04/08 19:16:16 johan Exp $
37 .\" $DragonFly: src/usr.bin/chflags/chflags.1,v 1.2 2003/06/17 04:29:25 dillon Exp $
38 .\"
39 .Dd Apr 8, 2003
40 .Dt CHFLAGS 1
41 .Os
42 .Sh NAME
43 .Nm chflags
44 .Nd change file flags
45 .Sh SYNOPSIS
46 .Nm
47 .Oo
48 .Fl R
49 .Op Fl H | Fl L | Fl P
50 .Oc
51 .Ar flags
52 .Ar
53 .Sh DESCRIPTION
54 The
55 .Nm
56 utility modifies the file flags of the listed files
57 as specified by the
58 .Ar flags
59 operand.
60 .Pp
61 The options are as follows:
62 .Bl -tag -width indent
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.)
68 .It Fl L
69 If the
70 .Fl R
71 option is specified, all symbolic links are followed.
72 .It Fl P
73 If the
74 .Fl R
75 option is specified, no symbolic links are followed.
76 This is the default.
77 .It Fl R
78 Change the file flags for the file hierarchies rooted
79 in the files instead of just the files themselves.
80 .El
81 .Pp
82 The flags are specified as an octal number or a comma separated list
83 of keywords.
84 The following keywords are currently defined:
85 .Pp
86 .Bl -tag -offset indent -width "opaque" -compact
87 .It Ar arch
88 set the archived flag (super-user only)
89 .It Ar opaque
90 set the opaque flag (owner or super-user only)
91 .It Ar nodump
92 set the nodump flag (owner or super-user only)
93 .It Ar sappnd
94 set the system append-only flag (super-user only)
95 .It Ar schg
96 set the system immutable flag (super-user only)
97 .It Ar sunlnk
98 set the system undeletable flag (super-user only)
99 .It Ar uappnd
100 set the user append-only flag (owner or super-user only)
101 .It Ar uchg
102 set the user immutable flag (owner or super-user only)
103 .It Ar uunlnk
104 set the user undeletable flag (owner or super-user only)
105 .It Ar archived , sappend , schange , Xo
106 .Ar simmutable , uappend , uchange , uimmutable ,
107 .Ar sunlink , uunlink
108 .Xc
109 aliases for the above
110 .El
111 .Pp
112 Putting the letters
113 .Dq Ar no
114 before or removing the letters
115 .Dq Ar no
116 from a keyword causes the flag to be cleared.
117 For example:
118 .Pp
119 .Bl -tag -offset indent -width "nouchg" -compact
120 .It Ar nouchg
121 clear the user immutable flag (owner or super-user only)
122 .It Ar dump
123 clear the nodump flag (owner or super-user only)
124 .El
125 .Pp
126 Symbolic links do not have flags, so unless the
127 .Fl H
128 or
129 .Fl L
130 option is set,
131 .Nm
132 on a symbolic link always succeeds and has no effect.
133 The
134 .Fl H ,
135 .Fl L
136 and
137 .Fl P
138 options are ignored unless the
139 .Fl R
140 option is specified.
141 In addition, these options override each other and the
142 command's actions are determined by the last one specified.
143 .Pp
144 You can use "ls -lo" to see the flags of existing files.
145 .Sh DIAGNOSTICS
146 .Ex -std
147 .Sh SEE ALSO
148 .Xr ls 1 ,
149 .Xr chflags 2 ,
150 .Xr stat 2 ,
151 .Xr fts 3 ,
152 .Xr symlink 7
153 .Sh HISTORY
154 The
155 .Nm
156 command first appeared in
157 .Bx 4.4 .