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