posix1e/acl_set.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: src/lib/libc/posix1e/acl_set.3,v 1.16 2003/02/23 01:44:59 ru Exp $
  29 .\"
  30 .Dd December 29, 2002
  31 .Dt ACL_SET 3
  32 .Os
  33 .Sh NAME
  34 .Nm acl_set_fd ,
  35 .Nm acl_set_fd_np ,
  36 .Nm acl_set_file ,
  37 .Nm acl_set_link_np
  38 .Nd set an ACL for a file
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In sys/types.h
  43 .In sys/acl.h
  44 .Ft int
  45 .Fn acl_set_fd "int fd" "acl_t acl"
  46 .Ft int
  47 .Fn acl_set_fd_np "int fd" "acl_t acl" "acl_type_t type"
  48 .Ft int
  49 .Fn acl_set_file "const char *path_p" "acl_type_t type" "acl_t acl"
  50 .Ft int
  51 .Fn acl_set_link_np "const char *path_p" "acl_type_t type" "acl_t acl"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn acl_set_fd ,
  55 .Fn acl_set_fd_np ,
  56 .Fn acl_set_file ,
  57 and
  58 .Fn acl_set_link_np
  59 each associate an ACL with an object referred to by
  60 .Va fd
  61 or
  62 .Va path_p .
  63 The
  64 .Fn acl_set_fd_np
  65 and
  66 .Fn acl_set_link_np
  67 functions are not POSIX.1e calls.
  68 The
  69 .Fn acl_set_fd
  70 function allows only the setting of ACLs of type ACL_TYPE_EXTENDED
  71 where as
  72 .Fn acl_set_fd_np
  73 allows the setting of ACLs of any type.
  74 The
  75 .Fn acl_set_link_np
  76 function acts on a symlink rather than its target, if the target of the
  77 path is a symlink.
  78 .Sh RETURN VALUES
  79 .Rv -std
  80 .Sh ERRORS
  81 If any of the following conditions occur, these functions shall return
  82 -1 and set
  83 .Va errno
  84 to the corresponding value:
  85 .Bl -tag -width Er
  86 .It Bq Er EACCES
  87 Search permission is denied for a component of the path prefix, or the
  88 object exists and the process does not have appropriate access rights.
  89 .It Bq Er EBADF
  90 The
  91 .Va fd
  92 argument is not a valid file descriptor.
  93 .It Bq Er EINVAL
  94 Argument
  95 .Va acl
  96 does not point to a valid ACL for this object, or the ACL type
  97 specified in
  98 .Va type
  99 is invalid for this object, or both.
 100 .It Bq Er ENAMETOOLONG
 101 A component of a pathname exceeded 255 characters, or an
 102 entire path name exceeded 1023 characters.
 103 .It Bq Er ENOENT
 104 The named object does not exist, or the
 105 .Va path_p
 106 argument points to an empty string.
 107 .It Bq Er ENOMEM
 108 Insufficient memory available to fulfill request.
 109 .It Bq Er ENOSPC
 110 The directory or file system that would contain the new ACL cannot be
 111 extended, or the file system is out of file allocation resources.
 112 .It Bq Er EOPNOTSUPP
 113 The file system does not support ACL retrieval.
 114 .It Bq Er EROFS
 115 This function requires modification of a file system which is currently
 116 read-only.
 117 .El
 118 .Sh SEE ALSO
 119 .Xr acl 3 ,
 120 .Xr acl_delete 3 ,
 121 .Xr acl_get 3 ,
 122 .Xr acl_valid 3 ,
 123 .Xr posix1e 3
 124 .Sh STANDARDS
 125 POSIX.1e is described in IEEE POSIX.1e draft 17.
 126 .Sh AUTHORS
 127 .An Michael Smith
 128 .An Robert N M Watson