xref: /freebsd/lib/libc/posix1e/acl_strip_np.3 (revision bdcbfde31e8e9b343f113a1956384bdf30d1ed62)
1.\"-
2.\" Copyright (c) 2008, 2009 Edward Tomasz Napierala
3.\"
4.\" This software was developed by Robert Watson for the TrustedBSD Project.
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 THE 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.Dd June 25, 2009
28.Dt ACL_STRIP_NP 3
29.Os
30.Sh NAME
31.Nm acl_strip_np
32.Nd strip extended entries from an ACL
33.Sh LIBRARY
34.Lb libc
35.Sh SYNOPSIS
36.In sys/types.h
37.In sys/acl.h
38.Ft acl_t
39.Fn acl_strip_np "const acl_t acl" "int recalculate_mask"
40.Sh DESCRIPTION
41The
42.Fn acl_strip_np
43function returns a pointer to a trivial ACL computed from the ACL pointed
44to by the argument
45.Va acl .
46.Pp
47This function may cause memory to be allocated.
48The caller should free any
49releasable memory, when the new ACL is no longer required, by calling
50.Xr acl_free 3
51with the
52.Va (void*)acl_t
53as an argument.
54.Pp
55Any existing ACL pointers that refer to the ACL referred to by
56.Va acl
57shall continue to refer to the ACL.
58.Sh RETURN VALUES
59Upon successful completion, this function shall return a pointer to the
60newly allocated ACL.
61Otherwise, a value of
62.Va (acl_t)NULL
63shall be returned, and
64.Va errno
65shall be set to indicate the error.
66.Sh ERRORS
67If any of the following conditions occur, the
68.Fn acl_init
69function shall return a value of
70.Va (acl_t)NULL
71and set
72.Va errno
73to the corresponding value:
74.Bl -tag -width Er
75.It Bq Er EINVAL
76Argument
77.Va acl
78does not point to a valid ACL.
79.It Bq Er ENOMEM
80The
81.Va acl_t
82to be returned requires more memory than is allowed by the hardware or
83system-imposed memory management constraints.
84.El
85.Sh SEE ALSO
86.Xr acl 3 ,
87.Xr acl_is_trivial_np 3 ,
88.Xr posix1e 3
89.Sh STANDARDS
90POSIX.1e is described in IEEE POSIX.1e draft 17.
91Discussion
92of the draft continues on the cross-platform POSIX.1e implementation
93mailing list.
94To join this list, see the
95.Fx
96POSIX.1e implementation
97page for more information.
98.Sh HISTORY
99POSIX.1e support was introduced in
100.Fx 4.0 .
101The
102.Fn acl_strip_np
103function was added in
104.Fx 8.0 .
105.Sh AUTHORS
106.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
107