lib/libposix1e/acl_dup.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_dup.3,v 1.2.2.5 2001/12/20 16:27:06 ru Exp $
  27 .\" $DragonFly: src/lib/libposix1e/acl_dup.3,v 1.3 2004/03/11 12:28:52 hmp Exp $
  28 .\"
  29 .Dd January 28, 2000
  30 .Dt ACL_DUP 3
  31 .Os
  32 .Sh NAME
  33 .Nm acl_dup
  34 .Nd duplicate an ACL
  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_dup "acl_t acl"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn acl_dup
  45 function returns a pointer to a copy of the ACL pointed to by the argument
  46 .Va acl .
  47 .Pp
  48 This function may cause memory to be allocated.  The caller should free any
  49 releasable memory, when the new ACL is no longer required, by calling
  50 .Xr acl_free 3
  51 with the
  52 .Va (void*)acl_t
  53 as an argument.
  54 .Pp
  55 Any existing ACL pointers that refer to the ACL referred to by
  56 .Va acl
  57 shall continue to refer to the ACL.
  58 .Sh IMPLEMENTATION NOTES
  59 .Dx Ns 's
  60 support for POSIX.1e interfaces and features is still under
  61 development at this time.
  62 .Sh RETURN VALUES
  63 Upon successful completion, this function shall return a pointer to the
  64 duplicate ACL.  Otherwise, a value of
  65 .Va (acl_t)NULL
  66 shall be returned, and
  67 .Va errno
  68 shall be set to indicate the error.
  69 .Sh ERRORS
  70 If any of the following conditions occur, the
  71 .Fn acl_init
  72 function shall return a value of
  73 .Va (acl_t)NULL
  74 and set
  75 .Va errno
  76 to the corresponding value:
  77 .Bl -tag -width Er
  78 .It Bq Er EINVAL
  79 Argument
  80 .Va acl
  81 does not point to a valid ACL.
  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 acl_get 3 ,
  92 .Xr posix1e 3
  93 .Sh STANDARDS
  94 POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
  95 of the draft continues on the cross-platform POSIX.1e implementation
  96 mailing list.  To join this list, see the
  97 .Fx
  98 POSIX.1e implementation
  99 page for more information.
 100 .Sh HISTORY
 101 POSIX.1e support was introduced in
 102 .Fx 4.0 ,
 103 and development continues.
 104 .Sh AUTHORS
 105 .An Robert N M Watson
 106 .Sh BUGS
 107 These features are not yet fully implemented.  In particular, the shipped
 108 version of UFS/FFS does not support storage of additional security labels,
 109 and so is unable to (easily) provide support for most of these features.