lib/libc/posix1e/acl_create_entry.3

   1 .\"-
   2 .\" Copyright (c) 2001 Chris D. Faulhaber
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   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.
  13 .\"
  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 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
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd June 25, 2009
  29 .Dt ACL_CREATE_ENTRY 3
  30 .Os
  31 .Sh NAME
  32 .Nm acl_create_entry
  33 .Nm acl_create_entry_np
  34 .Nd create a new ACL entry
  35 .Sh LIBRARY
  36 .Lb libc
  37 .Sh SYNOPSIS
  38 .In sys/types.h
  39 .In sys/acl.h
  40 .Ft int
  41 .Fn acl_create_entry "acl_t *acl_p" "acl_entry_t *entry_p"
  42 .Ft int
  43 .Fn acl_create_entry_np "acl_t *acl_p" "acl_entry_t *entry_p" "int index"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn acl_create_entry
  47 function
  48 is a POSIX.1e call that creates a new ACL entry in the ACL
  49 pointed to by
  50 .Fa acl_p .
  51 The
  52 .Fn acl_create_entry_np
  53 function is a non-portable version that creates the ACL entry
  54 at position
  55 .Fa index .
  56 Positions are numbered starting from zero, i.e. calling
  57 .Fn acl_create_entry_np
  58 with
  59 .Fa index
  60 argument equal to zero will prepend the entry to the ACL.
  61 .Sh RETURN VALUES
  62 .Rv -std acl_create_entry
  63 .Sh ERRORS
  64 The
  65 .Fn acl_create_entry
  66 function fails if:
  67 .Bl -tag -width Er
  68 .It Bq Er EINVAL
  69 Argument
  70 .Fa acl_p
  71 does not point to a pointer to a valid ACL.
  72 Argument
  73 .Fa index
  74 is out of bounds.
  75 .It Bq Er ENOMEM
  76 The ACL working storage requires more memory than is
  77 allowed by the hardware or system-imposed memory
  78 management constraints.
  79 .El
  80 .Sh SEE ALSO
  81 .Xr acl 3 ,
  82 .Xr acl_delete_entry 3 ,
  83 .Xr acl_get_entry 3 ,
  84 .Xr posix1e 3
  85 .Sh STANDARDS
  86 POSIX.1e is described in IEEE POSIX.1e draft 17.
  87 .Sh HISTORY
  88 POSIX.1e support was introduced in
  89 .Fx 4.0 .
  90 The
  91 .Fn acl_create_entry
  92 function was added in
  93 .Fx 5.0 .
  94 .Sh AUTHORS
  95 The
  96 .Fn acl_create_entry
  97 function was written by
  98 .An Chris D. Faulhaber Aq jedgar@fxp.org .