[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_int flags"
.Ft int
.Fn fchflags "int fd" "u_int 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_IMMUTABLEX" -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 UF_OPAQUE
The directory is opaque when viewed through a union stack.
.It UF_HIDDEN
The file or directory is not intended to be displayed to the user.
.It SF_ARCHIVED
The file has been archived.
.It SF_IMMUTABLE
The file may not be changed.
.It SF_APPEND
The file may only be appended to.
.It SF_DATALESS 
The file is a dataless placeholder.
The system will attempt to materialize it when accessed according to the dataless file materialization policy of the accessing thread or process.
See
.Xr getiopolicy_np 3 .
.El
.Pp
The
.Dq UF_IMMUTABLE ,
.Dq UF_APPEND ,
.Dq UF_OPAQUE ,
and
.Dq UF_HIDDEN
flags may be set or unset by either the owner of a file or the super-user.
.Pp
The
.Dq SF_ARCHIVED ,
.Dq SF_IMMUTABLE
and
.Dq SF_APPEND
flags may only be set or unset by the super-user.
.Pp
The
.Dq SF_DATALESS
flag is an internal flag and may not be set from user space.
.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 if:
.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.
.It Bq Er ENOTSUP
The operation isn't supported by the filesystem.
.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.
.It Bq Er ENOTSUP
The operation isn't supported by the filesystem.
.El
.Sh SEE ALSO
.Xr chflags 1 ,
.Xr fflagstostr 3 ,
.Xr lchflags 3 ,
.Xr strtofflags 3 ,
.Xr launchd 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
91447636	47	.Fn chflags "const char *path" "u_int flags"
9bccf70c	48	.Ft int
91447636	49	.Fn fchflags "int fd" "u_int flags"
9bccf70c A	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
2d21ac55	63	.Bl -tag -width "SF_IMMUTABLEX" -compact -offset indent
9bccf70c A	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.
2d21ac55 A	70	.It UF_OPAQUE
	71	The directory is opaque when viewed through a union stack.
	72	.It UF_HIDDEN
	73	The file or directory is not intended to be displayed to the user.
	74	.It SF_ARCHIVED
	75	The file has been archived.
9bccf70c A	76	.It SF_IMMUTABLE
	77	The file may not be changed.
	78	.It SF_APPEND
	79	The file may only be appended to.
f427ee49	80	.It SF_DATALESS
cb323159 A	81	The file is a dataless placeholder.
	82	The system will attempt to materialize it when accessed according to the dataless file materialization policy of the accessing thread or process.
	83	See
	84	.Xr getiopolicy_np 3 .
9bccf70c A	85	.El
	86	.Pp
	87	The
2d21ac55 A	88	.Dq UF_IMMUTABLE ,
	89	.Dq UF_APPEND ,
	90	.Dq UF_OPAQUE ,
9bccf70c	91	and
2d21ac55	92	.Dq UF_HIDDEN
9bccf70c A	93	flags may be set or unset by either the owner of a file or the super-user.
	94	.Pp
	95	The
2d21ac55	96	.Dq SF_ARCHIVED ,
9bccf70c A	97	.Dq SF_IMMUTABLE
	98	and
	99	.Dq SF_APPEND
	100	flags may only be set or unset by the super-user.
cb323159 A	101	.Pp
cb323159 A	102	The
f427ee49	103	.Dq SF_DATALESS
cb323159	104	flag is an internal flag and may not be set from user space.
9bccf70c A	105	.Sh RETURN VALUES
	106	Upon successful completion, a value of 0 is returned.
	107	Otherwise, -1 is returned and the global variable
	108	.Va errno
	109	is set to indicate the error.
	110	.Sh ERRORS
39037602	111	.Fn chflags
b0d623f7	112	will fail if:
9bccf70c A	113	.Bl -tag -width Er
	114	.It Bq Er ENOTDIR
	115	A component of the path prefix is not a directory.
	116	.It Bq Er ENAMETOOLONG
	117	A component of a pathname exceeded
	118	.Dv {NAME_MAX}
	119	characters, or an entire path name exceeded
	120	.Dv {PATH_MAX}
	121	characters.
	122	.It Bq Er ENOENT
	123	The named file does not exist.
	124	.It Bq Er EACCES
	125	Search permission is denied for a component of the path prefix.
	126	.It Bq Er ELOOP
	127	Too many symbolic links were encountered in translating the pathname.
	128	.It Bq Er EPERM
	129	The effective user ID does not match the owner of the file and
	130	the effective user ID is not the super-user.
	131	.It Bq Er EROFS
	132	The named file resides on a read-only file system.
	133	.It Bq Er EFAULT
	134	.Fa Path
	135	points outside the process's allocated address space.
	136	.It Bq Er EIO
	137	An
	138	.Tn I/O
	139	error occurred while reading from or writing to the file system.
b0d623f7 A	140	.It Bq Er ENOTSUP
b0d623f7 A	141	The operation isn't supported by the filesystem.
9bccf70c A	142	.El
9bccf70c A	143	.Pp
39037602	144	.Fn fchflags
9bccf70c A	145	will fail if:
	146	.Bl -tag -width Er
	147	.It Bq Er EBADF
	148	The descriptor is not valid.
	149	.It Bq Er EINVAL
55e303ae	150	.Fa fd
9bccf70c A	151	refers to a socket, not to a file.
	152	.It Bq Er EPERM
	153	The effective user ID does not match the owner of the file and
	154	the effective user ID is not the super-user.
	155	.It Bq Er EROFS
	156	The file resides on a read-only file system.
	157	.It Bq Er EIO
	158	An
	159	.Tn I/O
	160	error occurred while reading from or writing to the file system.
b0d623f7 A	161	.It Bq Er ENOTSUP
b0d623f7 A	162	The operation isn't supported by the filesystem.
9bccf70c A	163	.El
	164	.Sh SEE ALSO
	165	.Xr chflags 1 ,
2d21ac55	166	.Xr fflagstostr 3 ,
b0d623f7	167	.Xr lchflags 3 ,
2d21ac55	168	.Xr strtofflags 3 ,
3e170ce0	169	.Xr launchd 8
9bccf70c A	170	.Sh HISTORY
	171	The
	172	.Fn chflags
	173	and
	174	.Nm fchflags
	175	functions first appeared in 4.4BSD.