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