lib/libc/posix1e/acl_dup.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$
  29 .\"
  30 .Dd January 28, 2000
  31 .Dt ACL_DUP 3
  32 .Os
  33 .Sh NAME
  34 .Nm acl_dup
  35 .Nd duplicate an ACL
  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_dup "acl_t acl"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn acl_dup
  46 function returns a pointer to a copy of the ACL pointed to by the argument
  47 .Va acl .
  48 .Pp
  49 This function may cause memory to be allocated.
  50 The caller should free any
  51 releasable memory, when the new ACL is no longer required, by calling
  52 .Xr acl_free 3
  53 with the
  54 .Va (void*)acl_t
  55 as an argument.
  56 .Pp
  57 Any existing ACL pointers that refer to the ACL referred to by
  58 .Va acl
  59 shall continue to refer to the ACL.
  60 .Sh IMPLEMENTATION NOTES
  61 .Fx 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 duplicate ACL.
  67 Otherwise, a value of
  68 .Va (acl_t)NULL
  69 shall be returned, and
  70 .Va errno
  71 shall be set to indicate the error.
  72 .Sh ERRORS
  73 If any of the following conditions occur, the
  74 .Fn acl_init
  75 function shall return a value of
  76 .Va (acl_t)NULL
  77 and set
  78 .Va errno
  79 to the corresponding value:
  80 .Bl -tag -width Er
  81 .It Bq Er EINVAL
  82 Argument
  83 .Va acl
  84 does not point to a valid ACL.
  85 .It Bq Er ENOMEM
  86 The
  87 .Va acl_t
  88 to be returned requires more memory than is allowed by the hardware or
  89 system-imposed memory management constraints.
  90 .El
  91 .Sh SEE ALSO
  92 .Xr acl 3 ,
  93 .Xr acl_free 3 ,
  94 .Xr acl_get 3 ,
  95 .Xr posix1e 3
  96 .Sh STANDARDS
  97 POSIX.1e is described in IEEE POSIX.1e draft 17.
  98 Discussion
  99 of the draft continues on the cross-platform POSIX.1e implementation
 100 mailing list.
 101 To join this list, see the
 102 .Fx
 103 POSIX.1e implementation
 104 page for more information.
 105 .Sh HISTORY
 106 POSIX.1e support was introduced in
 107 .Fx 4.0 ,
 108 and development continues.
 109 .Sh AUTHORS
 110 .An Robert N M Watson