xref: /freebsd/bin/chflags/chflags.1 (revision 6fd05b64b5b65dd4ba9b86482a0634a5f0b96c29)
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.\" 4. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\"	@(#)chflags.1	8.4 (Berkeley) 5/2/95
32.\" $FreeBSD$
33.\"
34.Dd March 24, 2003
35.Dt CHFLAGS 1
36.Os
37.Sh NAME
38.Nm chflags
39.Nd change file flags
40.Sh SYNOPSIS
41.Nm
42.Oo
43.Fl R
44.Op Fl H | Fl L | Fl P
45.Oc
46.Ar flags
47.Ar
48.Sh DESCRIPTION
49The
50.Nm
51utility modifies the file flags of the listed files
52as specified by the
53.Ar flags
54operand.
55.Pp
56The options are as follows:
57.Bl -tag -width indent
58.It Fl H
59If the
60.Fl R
61option is specified, symbolic links on the command line are followed.
62(Symbolic links encountered in the tree traversal are not followed.)
63.It Fl L
64If the
65.Fl R
66option is specified, all symbolic links are followed.
67.It Fl P
68If the
69.Fl R
70option is specified, no symbolic links are followed.
71This is the default.
72.It Fl R
73Change the file flags for the file hierarchies rooted
74in the files instead of just the files themselves.
75.El
76.Pp
77The flags are specified as an octal number or a comma separated list
78of keywords.
79The following keywords are currently defined:
80.Pp
81.Bl -tag -offset indent -width "opaque" -compact
82.It Ar arch
83set the archived flag (super-user only)
84.It Ar opaque
85set the opaque flag (owner or super-user only)
86.It Ar nodump
87set the nodump flag (owner or super-user only)
88.It Ar sappnd
89set the system append-only flag (super-user only)
90.It Ar schg
91set the system immutable flag (super-user only)
92.It Ar sunlnk
93set the system undeletable flag (super-user only)
94.It Ar uappnd
95set the user append-only flag (owner or super-user only)
96.It Ar uchg
97set the user immutable flag (owner or super-user only)
98.It Ar uunlnk
99set the user undeletable flag (owner or super-user only)
100.It Ar archived , sappend , schange , Xo
101.Ar simmutable , uappend , uchange , uimmutable ,
102.Ar sunlink , uunlink
103.Xc
104aliases for the above
105.El
106.Pp
107Putting the letters
108.Dq Ar no
109before or removing the letters
110.Dq Ar no
111from a keyword causes the flag to be cleared.
112For example:
113.Pp
114.Bl -tag -offset indent -width "nouchg" -compact
115.It Ar nouchg
116clear the user immutable flag (owner or super-user only)
117.It Ar dump
118clear the nodump flag (owner or super-user only)
119.El
120.Pp
121Symbolic links do not have flags, so unless the
122.Fl H
123or
124.Fl L
125option is set,
126.Nm
127on a symbolic link always succeeds and has no effect.
128The
129.Fl H ,
130.Fl L
131and
132.Fl P
133options are ignored unless the
134.Fl R
135option is specified.
136In addition, these options override each other and the
137command's actions are determined by the last one specified.
138.Pp
139You can use "ls -lo" to see the flags of existing files.
140.Sh DIAGNOSTICS
141.Ex -std
142.Sh SEE ALSO
143.Xr ls 1 ,
144.Xr chflags 2 ,
145.Xr stat 2 ,
146.Xr fts 3 ,
147.Xr symlink 7
148.Sh HISTORY
149The
150.Nm
151command first appeared in
152.Bx 4.4 .
153