acl_to_text(3) — Linux manual page


ACL_FROM_TEXT(3)      BSD Library Functions Manual      ACL_FROM_TEXT(3)

NAME         top

     acl_to_text — convert an ACL to text

LIBRARY         top

     Linux Access Control Lists library (libacl, -lacl).

SYNOPSIS         top

     #include <sys/types.h>
     #include <sys/acl.h>

     char *
     acl_to_text(acl_t acl, ssize_t *len_p);

DESCRIPTION         top

     The acl_to_text() function translates the ACL pointed to by the
     argument acl into a NULL terminated character string.  If the
     pointer len_p is not NULL, then the function returns the length of
     the string (not including the NULL terminator) in the location
     pointed to by len_p.  The format of the text string returned by
     acl_to_text() is the long text form defined in acl(5).  The ACL
     referred to by acl is not changed.

     This function allocates any memory necessary to contain the string
     and returns a pointer to the string.  The caller should free any
     releasable memory, when the new string is no longer required, by
     calling acl_free(3) with the (void*)char returned by acl_to_text()
     as an argument.

RETURN VALUE         top

     On success, this function returns a pointer to the long text form
     of the ACL.  On error, a value of (char *)NULL is returned, and
     errno is set appropriately.

ERRORS         top

     If any of the following conditions occur, the acl_to_text()
     function returns a value of (char *)NULL and sets errno to the
     corresponding value:

     [EINVAL]           The argument acl is not a valid pointer to an

                        The ACL referenced by acl contains one or more
                        improperly formed ACL entries, or for some other
                        reason cannot be translated into a text form of
                        an ACL.

     [ENOMEM]           The character string to be returned requires
                        more memory than is allowed by the hardware or
                        system-imposed memory management constraints.

STANDARDS         top

     IEEE Std 1003.1e draft 17 (“POSIX.1e”, abandoned)

SEE ALSO         top

     acl_free(3), acl_to_any_text(3), acl(5)

AUTHOR         top

     Derived from the FreeBSD manual pages written by Robert N M Watson
     <>, and adapted for Linux by Andreas Gruenbacher

COLOPHON         top

     This page is part of the acl (manipulating access control lists)
     project.  Information about the project can be found at  If you have a bug report
     for this manual page, see
     ⟨⟩.  This page was
     obtained from the project's upstream Git repository
     ⟨git://⟩ on 2021-08-27.  (At that
     time, the date of the most recent commit that was found in the
     repository was 2021-03-16.)  If you discover any rendering problems
     in this HTML version of the page, or you believe there is a better
     or more up-to-date source for the page, or you have corrections or
     improvements to the information in this COLOPHON (which is not part
     of the original manual page), send a mail to

Linux ACL                    March 23, 2002                    Linux ACL