xref: /freebsd/lib/libc/posix1e/acl_create_entry.3 (revision f5463265955b829775bbb32e1fd0bc11dafc36ce)
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_CREATE_ENTRY 3
28.Os
29.Sh NAME
30.Nm acl_create_entry ,
31.Nm acl_create_entry_np
32.Nd create a new ACL entry
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_create_entry "acl_t *acl_p" "acl_entry_t *entry_p"
40.Ft int
41.Fn acl_create_entry_np "acl_t *acl_p" "acl_entry_t *entry_p" "int index"
42.Sh DESCRIPTION
43The
44.Fn acl_create_entry
45function
46is a POSIX.1e call that creates a new ACL entry in the ACL
47pointed to by
48.Fa acl_p .
49The
50.Fn acl_create_entry_np
51function is a non-portable version that creates the ACL entry
52at position
53.Fa index .
54Positions are numbered starting from zero, i.e. calling
55.Fn acl_create_entry_np
56with
57.Fa index
58argument equal to zero will prepend the entry to the ACL.
59.Sh RETURN VALUES
60.Rv -std acl_create_entry
61.Sh ERRORS
62The
63.Fn acl_create_entry
64function fails if:
65.Bl -tag -width Er
66.It Bq Er EINVAL
67Argument
68.Fa acl_p
69does not point to a pointer to a valid ACL.
70Argument
71.Fa index
72is out of bounds.
73.It Bq Er ENOMEM
74The ACL working storage requires more memory than is
75allowed by the hardware or system-imposed memory
76management constraints.
77.El
78.Sh SEE ALSO
79.Xr acl 3 ,
80.Xr acl_delete_entry 3 ,
81.Xr acl_get_entry 3 ,
82.Xr posix1e 3
83.Sh STANDARDS
84POSIX.1e is described in IEEE POSIX.1e draft 17.
85.Sh HISTORY
86POSIX.1e support was introduced in
87.Fx 4.0 .
88The
89.Fn acl_create_entry
90function was added in
91.Fx 5.0 .
92.Sh AUTHORS
93The
94.Fn acl_create_entry
95function was written by
96.An Chris D. Faulhaber Aq Mt jedgar@fxp.org .
97