lib/libposix1e/acl_init.3

   1 .\"-
   2 .\" Copyright (c) 2000 Robert N. M. Watson
   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 THE 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: src/lib/libposix1e/acl_init.3,v 1.2.2.5 2001/12/20 16:27:06 ru Exp $
  27 .\" $DragonFly: src/lib/libposix1e/acl_init.3,v 1.3 2004/03/11 12:28:52 hmp Exp $
  28 .\"
  29 .Dd January 28, 2000
  30 .Dt ACL_INIT 3
  31 .Os
  32 .Sh NAME
  33 .Nm acl_init
  34 .Nd initialize ACL working storage
  35 .Sh LIBRARY
  36 .Lb libposix1e
  37 .Sh SYNOPSIS
  38 .In sys/types.h
  39 .In sys/acl.h
  40 .Ft acl_t
  41 .Fn acl_init "int count"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn acl_init
  45 function allocates and initializes the working storage for an ACL of at
  46 least
  47 .Va count
  48 ACL entries.  A pointer to the working storage is returned.  The working
  49 storage allocated to contain the ACL is freed by a call to
  50 .Xr acl_free 3 .
  51 When the area is first allocated, it shall contain an ACL that contains
  52 no ACL entries.
  53 .Pp
  54 This function may cause memory to be allocated.  The caller should free any
  55 releasable memory, when the new ACL is no longer required, by calling
  56 .Xr acl_free 3
  57 with the
  58 .Va (void*)acl_t
  59 as an argument.
  60 .Sh IMPLEMENTATION NOTES
  61 .Dx Ns 's
  62 support for POSIX.1e interfaces and features is still under
  63 development at this time.
  64 .Sh RETURN VALUES
  65 Upon successful completion, this function shall return a pointer to the
  66 working storage.  Otherwise, a value of
  67 .Va (acl_t)NULL
  68 shall be returned, and
  69 .Va errno
  70 shall be set to indicate the error.
  71 .Sh ERRORS
  72 If any of the following conditions occur, the
  73 .Fn acl_init
  74 function shall return a value of
  75 .Va (acl_t)NULL
  76 and set
  77 .Va errno
  78 to the corresponding value:
  79 .Bl -tag -width Er
  80 .It Bq Er EINVAL
  81 The value of count is less than zero.
  82 .It Bq Er ENOMEM
  83 The
  84 .Va acl_t
  85 to be returned requires more memory than is allowed by the hardware or
  86 system-imposed memory management constraints.
  87 .El
  88 .Sh SEE ALSO
  89 .Xr acl 3 ,
  90 .Xr acl_free 3 ,
  91 .Xr posix1e 3
  92 .Sh STANDARDS
  93 POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
  94 of the draft continues on the cross-platform POSIX.1e implementation
  95 mailing list.  To join this list, see the
  96 .Fx
  97 POSIX.1e implementation
  98 page for more information.
  99 .Sh HISTORY
 100 POSIX.1e support was introduced in
 101 .Fx 4.0 ,
 102 and development continues.
 103 .Sh AUTHORS
 104 .An Robert N M Watson
 105 .Sh BUGS
 106 These features are not yet fully implemented.  In particular, the shipped
 107 version of UFS/FFS does not support storage of additional security labels,
 108 and so is unable to (easily) provide support for most of these features.