lib/libc/posix1e/acl_add_flag_np.3

   1 .\"-
   2 .\" Copyright (c) 2008, 2009 Edward Tomasz Napierala
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd September 4, 2015
  28 .Dt ACL_ADD_FLAG_NP 3
  29 .Os
  30 .Sh NAME
  31 .Nm acl_add_flag_np
  32 .Nd add flags to a flagset
  33 .Sh LIBRARY
  34 .Lb libc
  35 .Sh SYNOPSIS
  36 .In sys/types.h
  37 .In sys/acl.h
  38 .Ft int
  39 .Fn acl_add_flag_np "acl_flagset_t flagset_d" "acl_flag_t flag"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn acl_add_flag_np
  43 function
  44 is a non-portable call that adds the NFSv4 ACL flags contained in
  45 .Fa flags
  46 to the flagset
  47 .Fa flagset_d .
  48 .Pp
  49 Note: it is not considered an error to attempt to add flags
  50 that already exist in the flagset.
  51 .Pp
  52 Valid values are:
  53 .Bl -column -offset 3n "ACL_ENTRY_NO_PROPAGATE_INHERIT"
  54 .It ACL_ENTRY_FILE_INHERIT Ta "Will be inherited by files."
  55 .It ACL_ENTRY_DIRECTORY_INHERIT Ta "Will be inherited by directories."
  56 .It ACL_ENTRY_NO_PROPAGATE_INHERIT Ta "Will not propagate."
  57 .It ACL_ENTRY_INHERIT_ONLY Ta "Inherit-only."
  58 .It ACL_ENTRY_INHERITED Ta "Inherited from parent"
  59 .El
  60 .Sh RETURN VALUES
  61 .Rv -std acl_add_flag_np
  62 .Sh ERRORS
  63 The
  64 .Fn acl_add_flag_np
  65 function fails if:
  66 .Bl -tag -width Er
  67 .It Bq Er EINVAL
  68 Argument
  69 .Fa flagset_d
  70 is not a valid descriptor for a flagset within an ACL entry.
  71 Argument
  72 .Fa flag
  73 does not contain a valid
  74 .Vt acl_flag_t
  75 value.
  76 .El
  77 .Sh SEE ALSO
  78 .Xr acl 3 ,
  79 .Xr acl_clear_flags_np 3 ,
  80 .Xr acl_delete_flag_np 3 ,
  81 .Xr acl_get_flagset_np 3 ,
  82 .Xr acl_set_flagset_np 3 ,
  83 .Xr posix1e 3
  84 .Sh STANDARDS
  85 POSIX.1e is described in IEEE POSIX.1e draft 17.
  86 .Sh HISTORY
  87 POSIX.1e support was introduced in
  88 .Fx 4.0 .
  89 The
  90 .Fn acl_add_flag_np
  91 function was added in
  92 .Fx 8.0 .
  93 .Sh AUTHORS
  94 The
  95 .Fn acl_add_flag_np
  96 function was written by
  97 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org .