lib/libposix1e/acl_set.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_set.3,v 1.2.2.5 2002/01/09 13:34:56 ru Exp $
  27 .\"
  28 .Dd January 28, 2000
  29 .Dt ACL_SET 3
  30 .Os
  31 .Sh NAME
  32 .Nm acl_set_fd ,
  33 .Nm acl_set_fd_np ,
  34 .Nm acl_set_file
  35 .Nd set an ACL for a file
  36 .Sh LIBRARY
  37 .Lb libposix1e
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .In sys/acl.h
  41 .Ft int
  42 .Fn acl_set_file "const char *path_p" "acl_type_t type" "acl_t acl"
  43 .Ft int
  44 .Fn acl_set_fd "int fd" "acl_t acl"
  45 .Ft int
  46 .Fn acl_set_fd_np "int fd" "acl_t acl" "acl_type_t type"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn acl_set_file ,
  50 .Fn acl_set_fd ,
  51 and
  52 .Fn acl_set_fd_np
  53 each associate an ACL with an object referred to by
  54 .Va fd
  55 or
  56 .Va path_p .
  57 All except
  58 .Fn acl_set_fd_np
  59 are POSIX.1e calls--
  60 .Fn acl_set_fd
  61 allows only the setting of ACLs of type ACL_TYPE_ACCESS
  62 where as
  63 .Fn acl_set_fd_np
  64 allows the setting of ACLs of any type.
  65 .Sh IMPLEMENTATION NOTES
  66 .Fx Ns 's
  67 support for POSIX.1e interfaces and features is still under
  68 development at this time.
  69 .Sh RETURN VALUES
  70 .Rv -std
  71 .Sh ERRORS
  72 If any of the following conditions occur, these functions shall return
  73 -1 and set
  74 .Va errno
  75 to the corresponding value:
  76 .Bl -tag -width Er
  77 .It Bq Er EACCES
  78 Search permission is denied for a component of the path prefix, or the
  79 object exists and the process does not have appropriate access rights.
  80 .It Bq Er EBADF
  81 The
  82 .Va fd
  83 argument is not a valid file descriptor.
  84 .It Bq Er EINVAL
  85 Argument
  86 .Va acl
  87 does not point to a valid ACL for this object, or the ACL type
  88 specified in
  89 .Va type
  90 is invalid for this object, or both.
  91 .It Bq Er ENAMETOOLONG
  92 A component of a pathname exceeded 255 characters, or an
  93 entire path name exceeded 1023 characters.
  94 .It Bq Er ENOENT
  95 The named object does not exist, or the
  96 .Va path_p
  97 argument points to an empty string.
  98 .It Bq Er ENOMEM
  99 Insufficient memory available to fulfill request.
 100 .It Bq Er ENOSPC
 101 The directory or file system that would contain the new ACL cannot be
 102 extended, or the file system is out of file allocation resources.
 103 .It Bq Er EOPNOTSUPP
 104 The file system does not support ACL retrieval.
 105 .It Bq Er EROFS
 106 This function requires modification of a file system which is currently
 107 read-only.
 108 .El
 109 .Sh SEE ALSO
 110 .Xr acl 3 ,
 111 .Xr acl_delete 3 ,
 112 .Xr acl_get 3 ,
 113 .Xr acl_valid 3 ,
 114 .Xr posix1e 3
 115 .Sh STANDARDS
 116 POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
 117 of the draft continues on the cross-platform POSIX.1e implementation
 118 mailing list.  To join this list, see the
 119 .Fx
 120 POSIX.1e implementation
 121 page for more information.
 122 .Sh HISTORY
 123 POSIX.1e support was introduced in
 124 .Fx 4.0 ,
 125 and development continues.
 126 .Sh AUTHORS
 127 .An Robert N M Watson
 128 .Sh BUGS
 129 These features are not yet fully implemented.  In particular, the shipped
 130 version of UFS/FFS does not support storage of additional security labels,
 131 and so is unable to (easily) provide support for most of these features.