xref: /netbsd-src/usr.bin/chflags/chflags.1 (revision ae9172d6cd9432a6a1a56760d86b32c57a66c39c)
1.\"	$NetBSD: chflags.1,v 1.2 1994/11/14 20:27:22 jtc 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. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"	This product includes software developed by the University of
20.\"	California, Berkeley and its contributors.
21.\" 4. Neither the name of the University nor the names of its contributors
22.\"    may be used to endorse or promote products derived from this software
23.\"    without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35.\" SUCH DAMAGE.
36.\"
37.\"	@(#)chflags.1	8.2 (Berkeley) 3/31/94
38.\"
39.Dd March 31, 1994
40.Dt CHFLAGS 1
41.Os
42.Sh NAME
43.Nm chflags
44.Nd change file flags
45.Sh SYNOPSIS
46.Nm chflags
47.Oo
48.Fl R
49.Op Fl H | Fl L | Fl P
50.Oc
51.Ar flags
52.Ar file ...
53.Sh DESCRIPTION
54The
55.Nm chflags
56utility modifies the file flags of the listed files
57as specified by the
58.Ar flags
59operand.
60.Pp
61The options are as follows:
62.Bl -tag -width Ds
63.It Fl H
64If the
65.Fl R
66option is specified, symbolic links on the command line are followed.
67(Symbolic links encountered in the tree traversal are not followed.)
68.It Fl L
69If the
70.Fl R
71option is specified, all symbolic links are followed.
72.It Fl P
73If the
74.Fl R
75option is specified, no symbolic links are followed.
76.It Fl R
77Change the file flags for the file hierarchies rooted
78in the files instead of just the files themselves.
79.El
80.Pp
81Flags are a comma separated list of keywords.
82The following keywords are currently defined:
83.Bd -literal -offset indent compact
84.\"arch	nothing yet.
85dump	set the dump flag
86sappnd	set the system append-only flag (super-user only)
87schg	set the system immutable 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)
90.Ed
91.Pp
92Putting the letters
93.Dq no
94before an option causes the flag to be turned off.
95For example:
96.Bd -literal -offset indent compact
97nodump	the file should never be dumped
98.Ed
99.Pp
100Symbolic links do not have flags, so unless the
101.Fl H
102or
103.Fl L
104option is set,
105.Nm chflags
106on a symbolic link always succeeds and has no effect.
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.Nm chflags
120utility exits 0 on success, and >0 if an error occurs.
121.Sh SEE ALSO
122.Xr chflags 2 ,
123.Xr stat 2 ,
124.Xr fts 3 ,
125.Xr symlink 7
126