2 .\" Copyright (c) 2000, 2002 Robert N. M. Watson
3 .\" All rights reserved.
5 .\" This software was developed by Robert Watson for the TrustedBSD Project.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
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.
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
35 .Nd convert an ACL to text
42 .Fn acl_to_text "acl_t acl" "ssize_t *len_p"
46 function translates the ACL pointed to by argument
48 into a NULL terminated character string.
51 is not NULL, then the function shall return the length of the string (not
52 including the NULL terminator) in the location pointed to by
54 The format of the text string returned by
56 shall be the POSIX.1e long ACL form.
58 This function allocates any memory necessary to contain the string and
59 returns a pointer to the string.
60 The caller should free any releasable
61 memory, when the new string is no longer required, by calling
66 .Sh IMPLEMENTATION NOTES
68 support for POSIX.1e interfaces and features is still under
69 development at this time.
71 Upon successful completion, the function shall return a pointer to the
72 long text form of an ACL.
77 shall be set to indicate the error.
79 If any of the following conditions occur, the
81 function shall return a value of
85 to the corresponding value:
90 does not point to a valid ACL.
94 contains one or more improperly formed ACL entries, or for some other
95 reason cannot be translated into a text form of an ACL.
97 The character string to be returned requires more memory than is allowed
98 by the hardware or software-imposed memory management constraints.
103 .Xr acl_from_text 3 ,
106 POSIX.1e is described in IEEE POSIX.1e draft 17.
108 of the draft continues on the cross-platform POSIX.1e implementation
110 To join this list, see the
112 POSIX.1e implementation
113 page for more information.
115 POSIX.1e support was introduced in
117 and development continues.
119 .An Robert N M Watson
128 library calls to manage username and uid mapping, as well as the
130 library calls to manage groupname and gid mapping.
132 thread safe, and so transitively, neither are
136 These functions may also interfere with stateful
137 calls associated with the