xref: /netbsd-src/usr.bin/chflags/chflags.1 (revision abb0f93cd77b67f080613360c65701f85e5f5cfe)
1.\"	$NetBSD: chflags.1,v 1.18 2009/06/29 03:49:41 dholland 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 2, 1995
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.Bd -literal -offset indent -compact
90arch	set the archived flag (super-user only)
91opaque	set the opaque flag (owner or super-user only)
92nodump	set the nodump flag (owner or super-user only)
93sappnd	set the system append-only flag (super-user only)
94schg	set the system immutable flag (super-user only)
95uappnd	set the user append-only flag (owner or super-user only)
96uchg	set the user immutable flag (owner or super-user only)
97.Ed
98.Pp
99Putting the letters
100.Dq no
101before an option causes the flag to be turned off.
102For example:
103.Bd -literal -offset indent -compact
104nouchg	the immutable bit should be cleared
105.Ed
106.Pp
107The
108.Fl H ,
109.Fl L
110and
111.Fl P
112options are ignored unless the
113.Fl R
114option is specified.
115In addition, these options override each other and the
116command's actions are determined by the last one specified.
117.Pp
118The
119.Fl o
120option
121of
122.Xr ls 1
123is used to display the flags.
124.Pp
125The
126.Nm
127utility exits 0 on success, and \*[Gt]0 if an error occurs.
128.Pp
129The kernel does not allow the flags on block and character
130devices to be changed except by the super-user.
131.Sh SEE ALSO
132.Xr ls 1 ,
133.Xr chflags 2 ,
134.Xr lchflags 2 ,
135.Xr stat 2 ,
136.Xr fts 3 ,
137.Xr symlink 7 ,
138.Xr dump 8 ,
139.Xr init 8
140