share/man/man3sec/acl_get.3sec

   1 '\" te
   2 .\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH ACL_GET 3SEC "April 9, 2016"
   7 .SH NAME
   8 acl_get, facl_get, acl_set, facl_set \- get or set a file's Access Control List
   9 (ACL)
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lsec\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <sys/acl.h>
  15
  16 \fBint *\fR\fBacl_get\fR(\fBconst char *\fR\fIpath\fR, \fBint\fR \fIflag\fR, \fBacl_t **\fR\fIaclp\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint *\fR\fBfacl_get\fR(\fBint\fR \fIfd\fR, \fBint\fR \fIflag\fR, \fBacl_t **\fR\fIaclp\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBint\fR \fBacl_set\fR(\fBconst char *\fR\fIpath\fR, \fBacl_t *\fR\fIaclp\fR);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBint\fR \fBfacl_set\fR(\fBint\fR \fIfd\fR, \fBacl_t *\fR\fIaclp\fR);
  32 .fi
  33
  34 .SH DESCRIPTION
  35 .LP
  36 The \fBacl_get()\fR and \fBfacl_get()\fR functions retrieve an Access Control
  37 List (ACL) of a file whose name is given by \fIpath\fR or referenced by the
  38 open file descriptor \fIfd\fR. The \fIflag\fR argument specifies whether a
  39 trivial ACL should be retrieved. When the \fIflag\fR argument is
  40 \fBACL_NO_TRIVIAL\fR, only ACLs that are not trivial will be retrieved. The ACL
  41 is returned in the \fIaclp\fR argument.
  42 .sp
  43 .LP
  44 The \fBacl_set()\fR and \fBfacl_set()\fR functions are used for setting an ACL
  45 of a file whose name is given by \fIpath\fR or referenced by the open file
  46 descriptor \fIfd\fR. The \fIaclp\fR argument specifies the ACL to set.
  47 .sp
  48 .LP
  49 The \fBacl_get()\fR and \fBacl_set()\fR functions support multiple types of
  50 ACLs.  When possible, the \fBacl_set()\fR function translates an ACL to the
  51 target file's style of ACL. Currently this is only possible when translating
  52 from a POSIX-draft ACL such as on UFS to a file system that supports NFSv4 ACL
  53 semantics such as ZFS or NFSv4.
  54 .SH RETURN VALUES
  55 .LP
  56 Upon successful completion, \fBacl_get()\fR and \fBfacl_get()\fR return 0 and
  57 \fIaclp\fR is non-\fINULL\fR. The \fIaclp\fR argument can be \fINULL\fR after
  58 successful completion if the file had a trivial ACL and the \fIflag\fR argument
  59 was \fBACL_NO_TRIVIAL\fR. Otherwise, -1 is returned and \fBerrno\fR is set to
  60 indicate the error.
  61 .sp
  62 .LP
  63 Upon successful completion, \fBacl_set()\fR and \fBfacl_set()\fR return 0.
  64 Otherwise, -1 is returned and \fBerrno\fR is set to indicate the error.
  65 .SH ERRORS
  66 .LP
  67 These functions will fail if:
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBEACCES\fR\fR
  72 .ad
  73 .RS 11n
  74 The caller does not have access to a component of \fIpath\fR.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBEIO\fR\fR
  81 .ad
  82 .RS 11n
  83 A disk I/O error has occurred while retrieving the ACL.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBENOENT\fR\fR
  90 .ad
  91 .RS 11n
  92 A component of the \fIpath\fR does not exist.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBENOSYS\fR\fR
  99 .ad
 100 .RS 11n
 101 The file system does not support ACLs.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBENOTSUP\fR\fR
 108 .ad
 109 .RS 11n
 110 The ACL supplied could not be translated to an NFSv4 ACL.
 111 .RE
 112
 113 .SH ATTRIBUTES
 114 .LP
 115 See \fBattributes\fR(5) for descriptions of the following attributes:
 116 .sp
 117
 118 .sp
 119 .TS
 120 box;
 121 c | c
 122 l | l .
 123 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 124 _
 125 Interface Stability     Evolving
 126 _
 127 MT-Level        MT-Safe
 128 .TE
 129
 130 .SH SEE ALSO
 131 .LP
 132 \fBchmod\fR(1), \fBacl\fR(2), \fBacl\fR(5), \fBattributes\fR(5)