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