[apple/libc.git] / posix1e / acl_delete.3

.\"-
.\" Copyright (c) 2000, 2002 Robert N. M. Watson
.\" All rights reserved.
.\"
.\" This software was developed by Robert Watson for the TrustedBSD Project.
.\"
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
.\"
.\" $FreeBSD: src/lib/libc/posix1e/acl_delete.3,v 1.16 2003/02/23 01:44:37 ru Exp $
.\"
.Dd December 29, 2002
.Dt ACL_DELETE 3
.Os
.Sh NAME
.Nm acl_delete_fd_np ,
.Nm acl_delete_file_np
.Nm acl_delete_link_np
.Nd delete an ACL from a file
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In sys/types.h
.In sys/acl.h
.Ft int
.Fn acl_delete_fd_np "int filedes" "acl_type_t type"
.Ft int
.Fn acl_delete_file_np "const char *path_p" "acl_type_t type"
.Ft int
.Fn acl_delete_link_np "const char *path_p" "acl_type_t type"
.Sh DESCRIPTION
The
.Fn acl_delete_fd_np ,
.Fn acl_delete_file_np ,
and
.Fn acl_delete_link_np
each allow the deletion of an ACL from a file.
These functions are non-portable extensions
that permit the deletion of arbitrary ACL types from a file/directory
either by path name or file descriptor.
The
.Fn _file
variations follow a symlink if it occurs in the last segment of the
path name; the
.Fn _link
variations operate on the symlink itself.
.Sh RETURN VALUES
.Rv -std
.Sh ERRORS
If any of the following conditions occur, these functions shall return -1
and set
.Va errno
to the corresponding value:
.Bl -tag -width Er
.It Bq Er EACCES
Search permission is denied for a component of the path prefix, or the
object exists and the process does not have appropriate access rights.
.It Bq Er EBADF
The
.Va fd
argument is not a valid file descriptor.
.It Bq Er EINVAL
The ACL type passed is invalid for this file object.
.It Bq Er ENAMETOOLONG
A component of a pathname exceeded 255 characters, or an
entire path name exceeded 1023 characters.
.It Bq Er ENOENT
The named object does not exist, or the
.Va path_p
argument points to an empty string.
.It Bq Er ENOMEM
Insufficient memory available to fulfill request.
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.Pp
Argument
.Va path_p
must be a directory, and is not.
.It Bq Er EOPNOTSUPP
The file system does not support ACL deletion.
.It Bq Er EPERM
The process does not have appropriate privilege to perform the operation
to delete an ACL.
.It Bq Er EROFS
The file system is read-only.
.El
.Sh SEE ALSO
.Xr acl 3 ,
.Xr acl_get 3 ,
.Xr acl_set 3 ,
.Xr posix1e 3
.Sh STANDARDS
POSIX.1e is described in IEEE POSIX.1e draft 17.
.Sh AUTHORS
.An Michael Smith
.An Robert N M Watson
Commit	Line	Data
3d9156a7 A	1	.\"-
	2	.\" Copyright (c) 2000, 2002 Robert N. M. Watson
	3	.\" All rights reserved.
	4	.\"
	5	.\" This software was developed by Robert Watson for the TrustedBSD Project.
	6	.\"
	7	.\" Redistribution and use in source and binary forms, with or without
	8	.\" modification, are permitted provided that the following conditions
	9	.\" are met:
	10	.\" 1. Redistributions of source code must retain the above copyright
	11	.\" notice, this list of conditions and the following disclaimer.
	12	.\" 2. Redistributions in binary form must reproduce the above copyright
	13	.\" notice, this list of conditions and the following disclaimer in the
	14	.\" documentation and/or other materials provided with the distribution.
	15	.\"
	16	.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
	17	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	18	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	19	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
	20	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	21	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	22	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	23	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	24	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	25	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	26	.\" SUCH DAMAGE.
	27	.\"
	28	.\" $FreeBSD: src/lib/libc/posix1e/acl_delete.3,v 1.16 2003/02/23 01:44:37 ru Exp $
	29	.\"
	30	.Dd December 29, 2002
	31	.Dt ACL_DELETE 3
	32	.Os
	33	.Sh NAME
	34	.Nm acl_delete_fd_np ,
	35	.Nm acl_delete_file_np
	36	.Nm acl_delete_link_np
	37	.Nd delete an ACL from a file
	38	.Sh LIBRARY
	39	.Lb libc
	40	.Sh SYNOPSIS
	41	.In sys/types.h
	42	.In sys/acl.h
	43	.Ft int
	44	.Fn acl_delete_fd_np "int filedes" "acl_type_t type"
	45	.Ft int
	46	.Fn acl_delete_file_np "const char *path_p" "acl_type_t type"
	47	.Ft int
	48	.Fn acl_delete_link_np "const char *path_p" "acl_type_t type"
	49	.Sh DESCRIPTION
	50	The
	51	.Fn acl_delete_fd_np ,
	52	.Fn acl_delete_file_np ,
	53	and
	54	.Fn acl_delete_link_np
	55	each allow the deletion of an ACL from a file.
	56	These functions are non-portable extensions
	57	that permit the deletion of arbitrary ACL types from a file/directory
	58	either by path name or file descriptor.
	59	The
	60	.Fn _file
	61	variations follow a symlink if it occurs in the last segment of the
	62	path name; the
	63	.Fn _link
	64	variations operate on the symlink itself.
65	.Sh RETURN VALUES
66	.Rv -std
67	.Sh ERRORS
68	If any of the following conditions occur, these functions shall return -1
69	and set
70	.Va errno
71	to the corresponding value:
72	.Bl -tag -width Er
73	.It Bq Er EACCES
74	Search permission is denied for a component of the path prefix, or the
75	object exists and the process does not have appropriate access rights.
76	.It Bq Er EBADF
77	The
78	.Va fd
79	argument is not a valid file descriptor.
80	.It Bq Er EINVAL
81	The ACL type passed is invalid for this file object.
82	.It Bq Er ENAMETOOLONG
83	A component of a pathname exceeded 255 characters, or an
84	entire path name exceeded 1023 characters.
85	.It Bq Er ENOENT
86	The named object does not exist, or the
87	.Va path_p
88	argument points to an empty string.
89	.It Bq Er ENOMEM
90	Insufficient memory available to fulfill request.
91	.It Bq Er ENOTDIR
92	A component of the path prefix is not a directory.
93	.Pp
94	Argument
95	.Va path_p
96	must be a directory, and is not.
97	.It Bq Er EOPNOTSUPP
98	The file system does not support ACL deletion.
99	.It Bq Er EPERM
100	The process does not have appropriate privilege to perform the operation
101	to delete an ACL.
102	.It Bq Er EROFS
103	The file system is read-only.
104	.El
105	.Sh SEE ALSO
106	.Xr acl 3 ,
107	.Xr acl_get 3 ,
108	.Xr acl_set 3 ,
109	.Xr posix1e 3
110	.Sh STANDARDS
111	POSIX.1e is described in IEEE POSIX.1e draft 17.
112	.Sh AUTHORS
113	.An Michael Smith
114	.An Robert N M Watson