lib/libc/posix1e/acl_set_tag_type.3

   1 .\"-
   2 .\" Copyright (c) 2001 Chris D. Faulhaber
   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 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$
  27 .\"
  28 .Dd June 25, 2009
  29 .Dt ACL_SET_TAG_TYPE 3
  30 .Os
  31 .Sh NAME
  32 .Nm acl_set_tag_type
  33 .Nd set the tag type of an ACL entry
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In sys/acl.h
  39 .Ft int
  40 .Fn acl_set_tag_type "acl_entry_t entry_d" "acl_tag_t tag_type"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn acl_set_tag_type
  44 function
  45 is a POSIX.1e call that sets the ACL tag type of ACL entry
  46 .Fa entry_d
  47 to the value of
  48 .Fa tag_type .
  49 .Pp
  50 Valid values are:
  51 .Bl -column -offset 3n "ACL_OTHER_OBJ"
  52 .It ACL_USER_OBJ Ta "Permissions apply to file owner"
  53 .It ACL_USER Ta "Permissions apply to additional user specified by qualifier"
  54 .It ACL_GROUP_OBJ Ta "Permissions apply to file group"
  55 .It ACL_GROUP Ta "Permissions apply to additional group specified by qualifier"
  56 .It ACL_MASK Ta "Permissions specify mask"
  57 .It ACL_OTHER Ta Permissions apply to "other"
  58 .It ACL_OTHER_OBJ Ta "Same as ACL_OTHER"
  59 .It ACL_EVERYONE Ta Permissions apply to "everyone@"
  60 .El
  61 .Pp
  62 Calling
  63 .Fn acl_set_tag_type
  64 with
  65 .Fa tag_type
  66 equal to ACL_MASK, ACL_OTHER or ACL_OTHER_OBJ brands the ACL as POSIX.1e.
  67 Calling it with ACL_EVERYONE brands the ACL as NFSv4.
  68 .Sh RETURN VALUES
  69 .Rv -std acl_set_tag_type
  70 .Sh ERRORS
  71 The
  72 .Fn acl_set_tag_type
  73 function fails if:
  74 .Bl -tag -width Er
  75 .It Bq Er EINVAL
  76 Argument
  77 .Fa entry_d
  78 is not a valid descriptor for an ACL entry.
  79 Argument
  80 .Fa tag_type
  81 is not a valid ACL tag type.
  82 ACL is already branded differently.
  83 .El
  84 .Sh SEE ALSO
  85 .Xr acl 3 ,
  86 .Xr acl_get_brand_np 3 ,
  87 .Xr acl_get_tag_type 3 ,
  88 .Xr posix1e 3
  89 .Sh STANDARDS
  90 POSIX.1e is described in IEEE POSIX.1e draft 17.
  91 .Sh HISTORY
  92 POSIX.1e support was introduced in
  93 .Fx 4.0 .
  94 The
  95 .Fn acl_set_tag_type
  96 function was added in
  97 .Fx 5.0 .
  98 .Sh AUTHORS
  99 The
 100 .Fn acl_set_tag_type
 101 function was written by
 102 .An Chris D. Faulhaber Aq jedgar@fxp.org .