xref: /netbsd-src/lib/libc/posix1e/acl_delete_entry.3 (revision 1b3734281f17fd86d3db0e29f84ea9985be6fe06)
1.\" $NetBSD: acl_delete_entry.3,v 1.2 2020/06/18 19:46:34 wiz Exp $
2.\"-
3.\" Copyright (c) 2001 Chris D. Faulhaber
4.\" 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.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" $FreeBSD: head/lib/libc/posix1e/acl_delete_entry.3 267774 2014-06-23 08:25:03Z bapt $
28.\"
29.Dd June 25, 2009
30.Dt ACL_DELETE_ENTRY 3
31.Os
32.Sh NAME
33.Nm acl_delete_entry ,
34.Nm acl_delete_entry_np
35.Nd delete an ACL entry from an ACL
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In sys/types.h
40.In sys/acl.h
41.Ft int
42.Fn acl_delete_entry "acl_t acl" "acl_entry_t entry_d"
43.Ft int
44.Fn acl_delete_entry_np "acl_t acl" "int index"
45.Sh DESCRIPTION
46The
47.Fn acl_delete_entry
48function
49is a POSIX.1e call that removes the ACL entry
50.Fa entry_d
51from ACL
52.Fa acl .
53The
54.Fn acl_delete_entry_np
55function is a non-portable version that removes the ACL entry
56at position
57.Fa index
58from ACL
59.Fa acl .
60Positions are numbered starting from zero, i.e. calling
61.Fn acl_delete_entry_np
62with
63.Fa index
64argument equal to zero will remove the first ACL entry.
65.Sh RETURN VALUES
66.Rv -std acl_delete_entry
67.Sh ERRORS
68The
69.Fn acl_delete_entry
70function fails if:
71.Bl -tag -width Er
72.It Bq Er EINVAL
73Argument
74.Fa acl
75does not point to a valid ACL.
76Argument
77.Fa entry_d
78is not a valid descriptor for an ACL entry in
79.Fa acl .
80Argument
81.Fa index
82is out of bounds.
83.El
84.Sh SEE ALSO
85.Xr acl 3 ,
86.Xr acl_copy_entry 3 ,
87.Xr acl_get_entry 3 ,
88.Xr posix1e 3
89.Sh STANDARDS
90POSIX.1e is described in IEEE POSIX.1e draft 17.
91.Sh HISTORY
92POSIX.1e support was introduced in
93.Fx 4.0 .
94The
95.Fn acl_delete_entry
96function was added in
97.Fx 5.0 .
98.Sh AUTHORS
99The
100.Fn acl_delete_entry
101function was written by
102.An Chris D. Faulhaber Aq Mt jedgar@fxp.org .
103