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