posix1e/acl_from_text.3

   1 .\"-
   2 .\" Copyright (c) 2000, 2002 Robert N. M. Watson
   3 .\" All rights reserved.
   4 .\"
   5 .\" This software was developed by Robert Watson for the TrustedBSD Project.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  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.
  15 .\"
  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
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD: src/lib/libc/posix1e/acl_from_text.3,v 1.15 2002/12/29 20:52:42 rwatson Exp $
  29 .\"
  30 .Dd January 28, 2000
  31 .Dt ACL_FROM_TEXT 3
  32 .Os
  33 .Sh NAME
  34 .Nm acl_from_text
  35 .Nd create an ACL from text
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .In sys/acl.h
  41 .Ft acl_t
  42 .Fn acl_from_text "const char *buf_p"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn acl_from_text
  46 function converts the text form of an ACL referred to by
  47 .Va buf_p
  48 into the internal working structure for ACLs, appropriate for applying to
  49 files or manipulating.
  50 .Pp
  51 This function may cause memory to be allocated.  The caller should free any
  52 releasable memory, when the new ACL is no longer required, by calling
  53 .Xr acl_free 3
  54 with the
  55 .Va (void *)acl_t
  56 as an argument.
  57 .Sh IMPLEMENTATION NOTES
  58 The ACL_TYPE_EXTENDE text format differs from the POSIX.1e format, and this
  59 function will not translate between formats.
  60 .Sh RETURN VALUES
  61 Upon successful completion, the function shall return a pointer to the
  62 internal representation of the ACL in working storage.  Otherwise, a value
  63 of
  64 .Va (acl_t)NULL
  65 shall be returned, and
  66 .Va errno
  67 shall be set to indicate the error.
  68 .Sh ERRORS
  69 If any of the following conditions occur, the
  70 .Fn acl_from_text
  71 function shall return a value of
  72 .Va (acl_t)NULL
  73 and set
  74 .Va errno
  75 to the corresponding value:
  76 .Bl -tag -width Er
  77 .It Bq Er EINVAL
  78 Argument
  79 .Va buf_p
  80 cannot be translated into an ACL.
  81 .It Bq Er ENOMEM
  82 The ACL working storage requires more memory than is allowed by the
  83 hardware or system-imposed memory management constraints.
  84 .El
  85 .Sh SEE ALSO
  86 .Xr acl 3 ,
  87 .Xr acl_free 3 ,
  88 .Xr acl_get 3 ,
  89 .Xr acl_to_text 3 ,
  90 .Xr posix1e 3
  91 .Sh STANDARDS
  92 POSIX.1e is described in IEEE POSIX.1e draft 17.
  93 .Sh AUTHORS
  94 .An Michael Smith
  95 .An Robert N M Watson