xref: /netbsd-src/usr.bin/chflags/chflags.1 (revision 274254cdae52594c1aa480a736aef78313d15c9c)
1.\"	$NetBSD: chflags.1,v 1.17 2003/08/07 11:13:16 agc 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 files instead of just the files themselves.
76.It Fl h
77If the
78.Ar file
79or a file encountered during directory traversal is a symbolic link,
80the file flags of the link itself is changed.
81.El
82.Pp
83Flags are a comma separated list of keywords.
84The following keywords are currently defined:
85.Bd -literal -offset indent -compact
86arch	set the archived flag (super-user only)
87opaque	set the opaque flag (owner or super-user only)
88nodump	set the nodump flag (owner or super-user only)
89sappnd	set the system append-only flag (super-user only)
90schg	set the system immutable flag (super-user only)
91uappnd	set the user append-only flag (owner or super-user only)
92uchg	set the user immutable flag (owner or super-user only)
93.Ed
94.Pp
95Putting the letters
96.Dq no
97before an option causes the flag to be turned off.
98For example:
99.Bd -literal -offset indent -compact
100nouchg	the immutable bit should be cleared
101.Ed
102.Pp
103The
104.Fl H ,
105.Fl L
106and
107.Fl P
108options are ignored unless the
109.Fl R
110option is specified.
111In addition, these options override each other and the
112command's actions are determined by the last one specified.
113.Pp
114The
115.Fl o
116option
117of
118.Xr ls 1
119is used to display the flags.
120.Pp
121The
122.Nm
123utility exits 0 on success, and \*[Gt]0 if an error occurs.
124.Pp
125The kernel does not allow the flags on block and character
126devices to be changed except by the super-user.
127.Sh SEE ALSO
128.Xr ls 1 ,
129.Xr chflags 2 ,
130.Xr lchflags 2 ,
131.Xr stat 2 ,
132.Xr fts 3 ,
133.Xr symlink 7 ,
134.Xr dump 8 ,
135.Xr init 8
136