xref: /freebsd/bin/chflags/chflags.1 (revision 380a989b3223d455375b4fae70fd0b9bdd43bafb)
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.2 (Berkeley) 3/31/94
36.\"	$Id$
37.\"
38.Dd March 31, 1994
39.Dt CHFLAGS 1
40.Os
41.Sh NAME
42.Nm chflags
43.Nd change file flags
44.Sh SYNOPSIS
45.Nm chflags
46.Oo
47.Fl R
48.Op Fl H | Fl L | Fl P
49.Oc
50.Ar flags
51.Ar file ...
52.Sh DESCRIPTION
53The
54.Nm chflags
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 Ds
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
80Flags are a comma separated list of keywords.
81The following keywords are currently defined:
82.Bd -literal -offset indent compact
83arch	set the archived flag (super-user only)
84dump	set the dump flag
85sappnd	set the system append-only flag (super-user only)
86schg	set the system immutable flag (super-user only)
87sunlnk	set the system undeletable flag (super-user only)
88uappnd	set the user append-only flag (owner or super-user only)
89uchg	set the user immutable flag (owner or super-user only)
90uunlnk	set the user undeletable flag (owner or super-user only)
91archived, sappend, schange, simmutable, uappend, uchange, uimmutable,
92sunlink, uunlink
93	aliases for the above
94.Ed
95.Pp
96Putting the letters
97.Dq no
98before an option causes the flag to be turned off.
99For example:
100.Bd -literal -offset indent compact
101nodump	the file should never be dumped
102.Ed
103.Pp
104Symbolic links do not have flags, so unless the
105.Fl H
106or
107.Fl L
108option is set,
109.Nm chflags
110on a symbolic link always succeeds and has no effect.
111The
112.Fl H ,
113.Fl L
114and
115.Fl P
116options are ignored unless the
117.Fl R
118option is specified.
119In addition, these options override each other and the
120command's actions are determined by the last one specified.
121.Pp
122You can use "ls -lo" to see the flags of existing files.
123.Pp
124The
125.Nm chflags
126utility exits 0 on success, and >0 if an error occurs.
127.Sh SEE ALSO
128.Xr ls 1 ,
129.Xr chflags 2 ,
130.Xr stat 2 ,
131.Xr fts 3 ,
132.Xr symlink 7
133.Sh HISTORY
134The
135.Nm chflags
136command first appeared in
137.Bx 4.4 .
138