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 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_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 .Bl -column -offset 3n "ACL_ENTRY_TYPE_ALLOW"
  52 .It ACL_ENTRY_TYPE_ALLOW Ta "allow" type entry
  53 .It ACL_ENTRY_TYPE_DENY Ta "deny" type entry
  54 .El
  55 .Pp
  56 This call brands the ACL as NFSv4.
  57 .Sh RETURN VALUES
  58 .Rv -std acl_set_entry_type_np
  59 .Sh ERRORS
  60 The
  61 .Fn acl_set_entry_type_np
  62 function fails if:
  63 .Bl -tag -width Er
  64 .It Bq Er EINVAL
  65 Argument
  66 .Fa entry_d
  67 is not a valid descriptor for an ACL entry.
  68 The value pointed to by
  69 .Fa entry_type
  70 is not valid.
  71 ACL is already branded as POSIX.1e.
  72 .It Bq Er ENOMEM
  73 The value to be returned requires more memory than is allowed
  74 by the hardware or system-imposed memory management constraints.
  75 .El
  76 .Sh SEE ALSO
  77 .Xr acl 3 ,
  78 .Xr acl_get_brand_np 3 ,
  79 .Xr acl_get_entry_type_np 3 ,
  80 .Xr posix1e 3
  81 .Sh STANDARDS
  82 POSIX.1e is described in IEEE POSIX.1e draft 17.
  83 .Sh HISTORY
  84 POSIX.1e support was introduced in
  85 .Fx 4.0 .
  86 The
  87 .Fn acl_get_entry_type_np
  88 function was added in
  89 .Fx 8.0 .
  90 .Sh AUTHORS
  91 The
  92 .Fn acl_get_entry_type_np
  93 function was written by
  94 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org .