xref: /freebsd/bin/chflags/chflags.1 (revision c68159a6d8eede11766cf13896d0f7670dbd51aa)
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.
75.It Fl R
76Change the file flags for the file hierarchies rooted
77in the files instead of just the files themselves.
78.El
79.Pp
80The flags are specified as an octal number or a comma separated list
81of keywords.
82The following keywords are currently defined:
83.Pp
84.Bl -tag -offset indent -width "opaque" -compact
85.It Ar arch
86set the archived flag (super-user only)
87.It Ar opaque
88set the opaque flag (owner or super-user only)
89.It Ar nodump
90set the nodump flag (owner or super-user only)
91.It Ar sappnd
92set the system append-only flag (super-user only)
93.It Ar schg
94set the system immutable flag (super-user only)
95.It Ar sunlnk
96set the system undeletable flag (super-user only)
97.It Ar uappnd
98set the user append-only flag (owner or super-user only)
99.It Ar uchg
100set the user immutable flag (owner or super-user only)
101.It Ar uunlnk
102set the user undeletable flag (owner or super-user only)
103.It Ar archived , sappend , schange , Xo
104.Ar simmutable , uappend , uchange , uimmutable ,
105.Ar sunlink , uunlink
106.Xc
107aliases for the above
108.El
109.Pp
110Putting the letters
111.Dq Ar no
112before an option causes the flag to be turned off.
113For example:
114.Bl -tag -offset indent -width "nouchg"
115.It Ar nouchg
116the immutable bit should be cleared
117.El
118.Pp
119Symbolic links do not have flags, so unless the
120.Fl H
121or
122.Fl L
123option is set,
124.Nm
125on a symbolic link always succeeds and has no effect.
126The
127.Fl H ,
128.Fl L
129and
130.Fl P
131options are ignored unless the
132.Fl R
133option is specified.
134In addition, these options override each other and the
135command's actions are determined by the last one specified.
136.Pp
137You can use "ls -lo" to see the flags of existing files.
138.Sh DIAGNOSTICS
139The
140.Nm
141utility exits 0 on success, and >0 if an error occurs.
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