xref: /original-bsd/usr.bin/chflags/chflags.1 (revision e59fb703)
1.\" Copyright (c) 1989, 1990 The Regents of the University of California.
2.\" 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.\" %sccs.include.redist.roff%
8.\"
9.\"	@(#)chflags.1	5.1 (Berkeley) 12/12/91
10.\"
11.Dd
12.Dt CHFLAGS 1
13.Os
14.Sh NAME
15.Nm chflags
16.Nd change file flags
17.Sh SYNOPSIS
18.Nm chflags
19.Op Fl R
20.Ar flags
21.Ar file ...
22.Sh DESCRIPTION
23The
24.Nm chflags
25utility modifies the file flags of the listed files
26as specified by the
27.Ar flags
28operand.
29.Pp
30The options are as follows:
31.Bl -tag -width Ds
32.It Fl R
33Traverse a file hierarchy.
34For each file that is of type directory,
35.Nm chflags
36changes the flags of all files in the file hierarchy below it followed
37by the flags of the directory itself.
38.El
39.Pp
40Symbolic links are not indirected through, nor are their flags altered.
41.Pp
42Only the owner of a file or the super-user is permitted to change
43the low 16-bits in the flags of a file.
44Only the the super-user is permitted to change
45the high 16-bits in the flags of a file.
46.Pp
47The
48.Nm chflags
49utility exits 0 on success, and >0 if an error occurs.
50.Sh FLAGS
51Flags may be absolute or symbolic.
52An absolute flag is an octal number constructed by
53.Ar or'ing
54the following values:
55.Pp
56.Bl -tag -width 6n -compact -offset indent
57.It Li 1
58the file should never be dumped
59.El
60.Pp
61The symbolic flags is a comma separated list of keywords.
62The following keywords are defined:
63.Bd -literal -offset indent
64dump         cause the file to be dumped when it is next modified
65.Ed
66.Pp
67Putting the word ``no'' before an option causes it to be deleted.
68For example:
69.Bd -literal -offset indent
70nodump       the file should never be dumped
71.Ed
72.Sh SEE ALSO
73.Xr chflags 2 ,
74.Xr stat 2 ,
75.Xr fts 3
76