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