2 .\" Copyright (c) 2000 Robert N. M. Watson
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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
26 .\" $FreeBSD: src/lib/libposix1e/acl_to_text.3,v 1.2.2.5 2001/12/20 16:27:06 ru Exp $
27 .\" $DragonFly: src/lib/libposix1e/acl_to_text.3,v 1.3 2004/03/11 13:28:52 hmp Exp $
34 .Nd convert an ACL to text
41 .Fn acl_to_text "acl_t acl" "ssize_t *len_p"
45 function translates the ACL pointed to by argument
47 into a NULL terminated character string. If the pointer
49 is not NULL, then the function shall return the length of the string (not
50 including the NULL terminator) in the location pointed to by
52 The format of the text string returned by
54 shall be the POSIX.1e long ACL form.
56 This function allocates any memory necessary to contain the string and
57 returns a pointer to the string. The caller should free any releasable
58 memory, when the new string is no longer required, by calling
63 .Sh IMPLEMENTATION NOTES
65 support for POSIX.1e interfaces and features is still under
66 development at this time.
68 Upon successful completion, the function shall return a pointer to the
69 long text form of an ACL. Otherwise, a value of
73 shall be set to indicate the error.
75 If any of the following conditions occur, the
77 function shall return a value of
81 to the corresponding value:
86 does not point to a valid ACL.
90 contains one or more improperly formed ACL entries, or for some other
91 reason cannot be translated into a text form of an ACL.
93 The character string to be returned requires more memory than is allowed
94 by the hardware or software-imposed memory management constraints.
102 POSIX.1e is described in IEEE POSIX.1e draft 17. Discussion
103 of the draft continues on the cross-platform POSIX.1e implementation
104 mailing list. To join this list, see the
106 POSIX.1e implementation
107 page for more information.
109 POSIX.1e support was introduced in
111 and development continues.
113 .An Robert N M Watson
115 These features are not yet fully implemented. In particular, the shipped
116 version of UFS/FFS does not support storage of additional security labels,
117 and so is unable to (easily) provide support for most of these features.
124 library calls to manage username and uid mapping, as well as the
126 library calls to manage groupname and gid mapping. These calls are not
127 thread safe, and so transitively, neither are
131 These functions may also interfere with stateful
132 calls associated with the