xref: /freebsd/bin/chflags/chflags.1 (revision 17d6c636720d00f77e5d098daf4c278f89d84f7b)
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$
37.\"
38.Dd May 2, 1995
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
53The
54.Nm
55utility modifies the file flags of the listed files
56as specified by the
57.Ar flags
58operand.
59.Pp
60The options are as follows:
61.Bl -tag -width indent
62.It Fl H
63If the
64.Fl R
65option 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
68If the
69.Fl R
70option is specified, all symbolic links are followed.
71.It Fl P
72If the
73.Fl R
74option is specified, no symbolic links are followed.
75This is the default.
76.It Fl R
77Change the file flags for the file hierarchies rooted
78in the files instead of just the files themselves.
79.El
80.Pp
81The flags are specified as an octal number or a comma separated list
82of keywords.
83The following keywords are currently defined:
84.Pp
85.Bl -tag -offset indent -width "opaque" -compact
86.It Ar arch
87set the archived flag (super-user only)
88.It Ar opaque
89set the opaque flag (owner or super-user only)
90.It Ar nodump
91set the nodump flag (owner or super-user only)
92.It Ar sappnd
93set the system append-only flag (super-user only)
94.It Ar schg
95set the system immutable flag (super-user only)
96.It Ar sunlnk
97set the system undeletable flag (super-user only)
98.It Ar uappnd
99set the user append-only flag (owner or super-user only)
100.It Ar uchg
101set the user immutable flag (owner or super-user only)
102.It Ar uunlnk
103set 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
108aliases for the above
109.El
110.Pp
111Putting the letters
112.Dq Ar no
113before an option causes the flag to be turned off.
114For example:
115.Bl -tag -offset indent -width "nouchg"
116.It Ar nouchg
117the immutable bit should be cleared
118.El
119.Pp
120Symbolic links do not have flags, so unless the
121.Fl H
122or
123.Fl L
124option is set,
125.Nm
126on a symbolic link always succeeds and has no effect.
127The
128.Fl H ,
129.Fl L
130and
131.Fl P
132options are ignored unless the
133.Fl R
134option is specified.
135In addition, these options override each other and the
136command's actions are determined by the last one specified.
137.Pp
138You can use "ls -lo" to see the flags of existing files.
139.Sh DIAGNOSTICS
140.Ex -std
141.Sh SEE ALSO
142.Xr ls 1 ,
143.Xr chflags 2 ,
144.Xr stat 2 ,
145.Xr fts 3 ,
146.Xr symlink 7
147.Sh HISTORY
148The
149.Nm
150command first appeared in
151.Bx 4.4 .
152