xref: /freebsd/lib/libc/posix1e/acl_dup.3 (revision b601c69bdbe8755d26570261d7fd4c02ee4eff74)
1.\"-
2.\" Copyright (c) 2000 Robert N. M. Watson
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 THE 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.\"       $FreeBSD$
27.\"
28.Dd January 28, 2000
29.Dt ACL_DUP 3
30.Os FreeBSD 4.0
31.Sh NAME
32.Nm acl_dup
33.Nd duplicate an ACL
34.Sh LIBRARY
35.Lb libposix1e
36.Sh SYNOPSIS
37.Fd #include <sys/types.h>
38.Fd #include <sys/acl.h>
39.Ft acl_t
40.Fn acl_dup "acl_t acl"
41.Sh DESCRIPTION
42The
43.Fn acl_dup
44function returns a pointer to a copy of the ACL pointed to by the argument
45.Va acl .
46
47This function may cause memory to be allocated.  The caller should free any
48releasable memory, when the new ACL is no longer required, by calling
49.Xr acl_free 3
50with the
51.Va (void*)acl_t
52as an argument.
53
54Any existing ACL pointers that refer to the ACL referred to by
55.Va acl
56shall continue to refer to the ACL.
57.Sh IMPLEMENTATION NOTES
58FreeBSD's support for POSIX.1e interfaces and features is still under
59development at this time.
60.Sh RETURN VALUES
61Upon successful completion, this function shall return a pointer to the
62duplicate ACL.  Otherwise, a value of
63.Va (acl_t)NULL
64shall be returned, and
65.Va errno
66shall be set to indicate the error.
67.Sh ERRORS
68If any of the following conditions occur, the
69.Fn acl_init
70function shall return a value of
71.Va (acl_t)NULL
72and set
73.Va errno
74to the corresponding value:
75.Bl -tag -width Er
76.It Bq Er EINVAL
77Argument
78.Va acl
79does not point to a valid ACL.
80.It Bq Er ENOMEM
81The
82.Va acl_t
83to be returned requires more memory than is allowed by the hardware or
84system-imposed memory management constraints.
85.El
86.Sh SEE ALSO
87.Xr acl 3 ,
88.Xr acl_free 3 ,
89.Xr acl_get 3 ,
90.Xr posix1e 3
91.Sh STANDARDS
92POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
93of the draft continues on the cross-platform POSIX.1e implementation
94mailing list.  To 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 ,
101and development continues.
102.Sh AUTHORS
103.An Robert N M Watson
104.Sh BUGS
105These features are not yet fully implemented.
106