xref: /freebsd/lib/libc/posix1e/acl_dup.3 (revision a889d1fb766450bff9b27c3bccfe18fc39cd753d)
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 SYNOPSIS
35.Fd #include <sys/types.h>
36.Fd #include <sys/acl.h>
37.Ft acl_t
38.Fn acl_dup "acl_t acl"
39.Sh DESCRIPTION
40The
41.Fn acl_dup
42function returns a pointer to a copy of the ACL pointed to by the argument
43.Va acl .
44
45This function may cause memory to be allocated.  Teh caller should free any
46releaseable memory, when the new ACL is no longer required, by calling
47.Xr acl_free 3
48with the
49.Va (void*)acl_t
50as an argument.
51
52Any existing ACL pointers that refer to the ACL referred to by
53.Va acl
54shall continue to refer to the ACL.
55.Sh IMPLEMENTATION NOTES
56FreeBSD's support for POSIX.1e interfaces and features is still under
57development at this time.
58.Sh RETURN VALUES
59Upon successful completion, this function shall return a pointer to the
60duplicate ACL.  Otherwise, a value of
61.Va (acl_t)NULL
62shall be returned, and
63.Va errno
64shall be set to indicate the error.
65.Sh ERRORS
66If any of the following conditions occur, the
67.Fn acl_init
68function shall return a value of
69.Va (acl_t)NULL
70and set
71.Va errno
72to the corresponding value:
73.Bl -tag -width Er
74.It Bq Er EINVAL
75Argument
76.Va acl
77does not point to a valid ACL.
78.It Bq Er ENOMEM
79The
80.Va acl_t
81to be returned requires more memory than is allowed by the hardware or
82system-imposed memory management constraints.
83.El
84.Sh SEE ALSO
85.Xr acl 3 ,
86.Xr acl_free 3 ,
87.Xr acl_get 3 ,
88.Xr posix1e 3
89.Sh STANDARDS
90POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
91of the draft continues on the cross-platform POSIX.1e implementation
92mailing list.  To join this list, see the FreeBSD POSIX.1e implementation
93page for more information.
94.Sh HISTORY
95POSIX.1e support was introduced in FreeBSD 4.0, and development continues.
96.Sh AUTHORS
97Robert N M Watson
98.Sh BUGS
99These features are not yet fully implemented.  In particular, the shipped
100version of UFS/FFS does not support storage of additional security labels,
101and so is unable to (easily) provide support for most of these features.
102