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