xref: /dragonfly/lib/libc/sys/chflags.2 (revision 333227be)
1.\" Copyright (c) 1989, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"	@(#)chflags.2	8.3 (Berkeley) 5/2/95
33.\" $FreeBSD: src/lib/libc/sys/chflags.2,v 1.11.2.7 2001/12/14 18:34:00 ru Exp $
34.\" $DragonFly: src/lib/libc/sys/chflags.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
35.\"
36.Dd May 2, 1995
37.Dt CHFLAGS 2
38.Os
39.Sh NAME
40.Nm chflags ,
41.Nm fchflags
42.Nd set file flags
43.Sh LIBRARY
44.Lb libc
45.Sh SYNOPSIS
46.In sys/stat.h
47.In unistd.h
48.Ft int
49.Fn chflags "const char *path"  "u_long flags"
50.Ft int
51.Fn fchflags "int fd" "u_long flags"
52.Sh DESCRIPTION
53The file whose name
54is given by
55.Fa path
56or referenced by the descriptor
57.Fa fd
58has its flags changed to
59.Fa flags .
60.Pp
61The flags specified are formed by
62.Em or Ns 'ing
63the following values
64.Pp
65.Bl -tag -width "SF_IMMUTABLE" -compact -offset indent
66.It UF_NODUMP
67Do not dump the file.
68.It UF_IMMUTABLE
69The file may not be changed.
70.It UF_APPEND
71The file may only be appended to.
72.It UF_NOUNLINK
73The file may not be renamed or deleted.
74.It UF_OPAQUE
75The directory is opaque when viewed through a union stack.
76.It SF_ARCHIVED
77The file may be archived.
78.It SF_IMMUTABLE
79The file may not be changed.
80.It SF_APPEND
81The file may only be appended to.
82.It SF_NOUNLINK
83The file may not be renamed or deleted.
84.El
85.Pp
86The
87.Dq UF_IMMUTABLE ,
88.Dq UF_APPEND ,
89.Dq UF_NOUNLINK ,
90.Dq UF_NODUMP ,
91and
92.Dq UF_OPAQUE
93flags may be set or unset by either the owner of a file or the super-user.
94.Pp
95The
96.Dq SF_IMMUTABLE ,
97.Dq SF_APPEND ,
98.Dq SF_NOUNLINK ,
99and
100.Dq SF_ARCHIVED
101flags may only be set or unset by the super-user.
102Attempts by the non-super-user to set the super-user only flags
103are silently ignored.
104These flags may be set at any time, but normally may only be unset when
105the system is in single-user mode.
106(See
107.Xr init 8
108for details.)
109.Sh RETURN VALUES
110.Rv -std
111.Sh ERRORS
112.Fn Chflags
113will fail if:
114.Bl -tag -width Er
115.It Bq Er ENOTDIR
116A component of the path prefix is not a directory.
117.It Bq Er ENAMETOOLONG
118A component of a pathname exceeded 255 characters,
119or an entire path name exceeded 1023 characters.
120.It Bq Er ENOENT
121The named file does not exist.
122.It Bq Er EACCES
123Search permission is denied for a component of the path prefix.
124.It Bq Er ELOOP
125Too many symbolic links were encountered in translating the pathname.
126.It Bq Er EPERM
127The effective user ID does not match the owner of the file and
128the effective user ID is not the super-user.
129.It Bq Er EROFS
130The named file resides on a read-only file system.
131.It Bq Er EFAULT
132.Fa Path
133points outside the process's allocated address space.
134.It Bq Er EIO
135An
136.Tn I/O
137error occurred while reading from or writing to the file system.
138.It Bq Er EOPNOTSUPP
139The underlying file system does not support file flags.
140.El
141.Pp
142.Fn Fchflags
143will fail if:
144.Bl -tag -width Er
145.It Bq Er EBADF
146The descriptor is not valid.
147.It Bq Er EINVAL
148.Fa fd
149refers to a socket, not to a file.
150.It Bq Er EPERM
151The effective user ID does not match the owner of the file and
152the effective user ID is not the super-user.
153.It Bq Er EROFS
154The file resides on a read-only file system.
155.It Bq Er EIO
156An
157.Tn I/O
158error occurred while reading from or writing to the file system.
159.It Bq Er EOPNOTSUPP
160The underlying file system does not support file flags.
161.El
162.Sh SEE ALSO
163.Xr chflags 1 ,
164.Xr fflagstostr 3 ,
165.Xr strtofflags 3 ,
166.Xr init 8 ,
167.Xr mount_union 8
168.Sh HISTORY
169The
170.Nm chflags
171and
172.Nm fchflags
173functions first appeared in
174.Bx 4.4 .
175