xref: /netbsd-src/usr.bin/chflags/chflags.1 (revision c2f76ff004a2cb67efe5b12d97bd3ef7fe89e18d)
1.\"	$NetBSD: chflags.1,v 1.21 2010/05/14 16:48:02 joerg Exp $
2.\"
3.\" Copyright (c) 1989, 1990, 1993, 1994
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" the Institute of Electrical and Electronics Engineers, Inc.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. Neither the name of the University nor the names of its contributors
18.\"    may be used to endorse or promote products derived from this software
19.\"    without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31.\" SUCH DAMAGE.
32.\"
33.\"	@(#)chflags.1	8.4 (Berkeley) 5/2/95
34.\"
35.Dd May 14, 2010
36.Dt CHFLAGS 1
37.Os
38.Sh NAME
39.Nm chflags
40.Nd change file flags
41.Sh SYNOPSIS
42.Nm
43.Oo
44.Fl R
45.Op Fl H | Fl L | Fl P
46.Oc
47.Op Fl h
48.Ar flags
49.Ar
50.Sh DESCRIPTION
51The
52.Nm
53utility modifies the file flags of the listed files
54as specified by the
55.Ar flags
56operand.
57.Pp
58The options are as follows:
59.Bl -tag -width Ds
60.It Fl H
61If the
62.Fl R
63option is specified, symbolic links on the command line are followed.
64(Symbolic links encountered in the tree traversal are not followed.)
65.It Fl L
66If the
67.Fl R
68option is specified, all symbolic links are followed.
69.It Fl P
70If the
71.Fl R
72option is specified, no symbolic links are followed.
73.It Fl R
74Change the file flags for the file hierarchies rooted
75in the
76.Ar files
77instead of just the
78.Ar files
79themselves.
80.It Fl h
81If the
82.Ar file
83or a file encountered during directory traversal is a symbolic link,
84the file flags of the link itself is changed.
85.El
86.Pp
87Flags are a comma separated list of keywords.
88The following keywords are currently defined:
89.Bl -column -offset indent "Keyword   " "system append-only" "Permission"
90.It Sy Keyword Ta Sy Flag Ta Sy Permission
91.It Em arch Ta archived Ta super-user only
92.It Em opaque Ta opaque Ta owner or super-user
93.It Em nodump Ta nodump Ta owner or super-user
94.It Em sappnd Ta system append-only Ta super-user only
95.It Em schg Ta system immutable Ta super-user only
96.It Em uappnd Ta user append-only Ta owner or super-user
97.It Em uchg Ta user immutable Ta owner or super-user
98.El
99.Pp
100Putting the letters
101.Dq no
102before an option causes the flag to be turned off.
103For example:
104.Pp
105.Bl -tag -offset indent -width ".Em nouchg"
106.It Em nouchg
107the immutable bit should be cleared
108.El
109.Pp
110The
111.Fl H ,
112.Fl L
113and
114.Fl P
115options are ignored unless the
116.Fl R
117option is specified.
118In addition, these options override each other and the
119command's actions are determined by the last one specified.
120.Pp
121The
122.Fl o
123option
124of
125.Xr ls 1
126is used to display the flags.
127.Pp
128The
129.Nm
130utility exits 0 on success, and \*[Gt]0 if an error occurs.
131.Pp
132The kernel does not allow the flags on block and character
133devices to be changed except by the super-user.
134.Sh SEE ALSO
135.Xr ls 1 ,
136.Xr chflags 2 ,
137.Xr lchflags 2 ,
138.Xr stat 2 ,
139.Xr fts 3 ,
140.Xr symlink 7 ,
141.Xr dump 8 ,
142.Xr init 8
143