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
36 .Nd convert an ACL to text
43 .Fn acl_to_text "acl_t acl" "ssize_t *len_p"
45 .Fn acl_to_text_np "acl_t acl" "ssize_t *len_p" "int flags"
51 functions translate the ACL pointed to by argument
53 into a NULL terminated character string.
56 is not NULL, then the function shall return the length of the string (not
57 including the NULL terminator) in the location pointed to by
59 If the ACL is POSIX.1e, the format of the text string returned by
61 shall be the POSIX.1e long ACL form. If the ACL is NFSv4, the format
62 of the text string shall be the compact form, unless the
66 The flags specified are formed by
69 .Bl -column -offset 3n "ACL_TEXT_NUMERIC_IDS"
70 .It ACL_TEXT_VERBOSE Ta "Format ACL using verbose form"
71 .It ACL_TEXT_NUMERIC_IDS Ta "Do not resolve IDs into user or group names"
72 .It ACL_TEXT_APPEND_ID Ta "In addition to user and group names, append numeric IDs"
75 This function allocates any memory necessary to contain the string and
76 returns a pointer to the string.
77 The caller should free any releasable
78 memory, when the new string is no longer required, by calling
83 .Sh IMPLEMENTATION NOTES
85 support for POSIX.1e interfaces and features is still under
86 development at this time.
88 Upon successful completion, the function shall return a pointer to the
89 long text form of an ACL.
94 shall be set to indicate the error.
96 If any of the following conditions occur, the
98 function shall return a value of
102 to the corresponding value:
107 does not point to a valid ACL.
111 contains one or more improperly formed ACL entries, or for some other
112 reason cannot be translated into a text form of an ACL.
114 The character string to be returned requires more memory than is allowed
115 by the hardware or software-imposed memory management constraints.
120 .Xr acl_from_text 3 ,
123 POSIX.1e is described in IEEE POSIX.1e draft 17.
125 of the draft continues on the cross-platform POSIX.1e implementation
127 To join this list, see the
129 POSIX.1e implementation
130 page for more information.
132 POSIX.1e support was introduced in
134 and development continues.
136 .An Robert N M Watson
145 library calls to manage username and uid mapping, as well as the
147 library calls to manage groupname and gid mapping.
149 thread safe, and so transitively, neither are
153 These functions may also interfere with stateful
154 calls associated with the