lib/libc/posix1e/acl_set_entry_type_np.3

   1 .\"-
   2 .\" Copyright (c) 2008, 2009 Edward Tomasz Napierala
   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 THE VOICES IN HIS HEAD BE
  18 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24 .\" POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd June 25, 2009
  29 .Dt ACL_SET_ENTRY_TYPE_NP 3
  30 .Os
  31 .Sh NAME
  32 .Nm acl_set_entry_type_np
  33 .Nd set NFSv4 ACL entry type
  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_entry_type_np "acl_entry_t entry_d" "acl_entry_type_t entry_type"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn acl_set_entry_type_np
  44 function
  45 is a non-portable call that sets the type of the ACL entry
  46 .Fa entry_d
  47 to the value referred to by
  48 .Fa entry_type .
  49 .Pp
  50 Valid values are:
  51 .Pp
  52 .Bl -column -offset 3n "ACL_ENTRY_TYPE_ALLOW"
  53 .It ACL_ENTRY_TYPE_ALLOW        "allow" type entry
  54 .It ACL_ENTRY_TYPE_DENY         "deny" type entry
  55 .El
  56 .Pp
  57 This call brands the ACL as NFSv4.
  58 .Sh RETURN VALUES
  59 .Rv -std acl_set_entry_type_np
  60 .Sh ERRORS
  61 The
  62 .Fn acl_set_entry_type_np
  63 function fails if:
  64 .Bl -tag -width Er
  65 .It Bq Er EINVAL
  66 Argument
  67 .Fa entry_d
  68 is not a valid descriptor for an ACL entry.
  69 The value pointed to by
  70 .Fa entry_type
  71 is not valid.
  72 ACL is already branded as POSIX.1e.
  73 .It Bq Er ENOMEM
  74 The value to be returned requires more memory than is allowed
  75 by the hardware or system-imposed memory management constraints.
  76 .El
  77 .Sh SEE ALSO
  78 .Xr acl 3 ,
  79 .Xr acl_get_brand_np 3 ,
  80 .Xr acl_get_entry_type_np 3 ,
  81 .Xr posix1e 3
  82 .Sh STANDARDS
  83 POSIX.1e is described in IEEE POSIX.1e draft 17.
  84 .Sh HISTORY
  85 POSIX.1e support was introduced in
  86 .Fx 4.0 .
  87 The
  88 .Fn acl_get_entry_type_np
  89 function was added in
  90 .Fx 8.0 .
  91 .Sh AUTHORS
  92 The
  93 .Fn acl_get_entry_type_np
  94 function was written by
  95 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org .