[apple/xnu.git] / bsd / man / man2 / chflags.2

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