lib/libc/posix1e/acl_add_flag_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 September 4, 2015
  29 .Dt ACL_ADD_FLAG_NP 3
  30 .Os
  31 .Sh NAME
  32 .Nm acl_add_flag_np
  33 .Nd add flags to a flagset
  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_add_flag_np "acl_flagset_t flagset_d" "acl_flag_t flag"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn acl_add_flag_np
  44 function
  45 is a non-portable call that adds the NFSv4 ACL flags contained in
  46 .Fa flags
  47 to the flagset
  48 .Fa flagset_d .
  49 .Pp
  50 Note: it is not considered an error to attempt to add flags
  51 that already exist in the flagset.
  52 .Pp
  53 Valid values are:
  54 .Bl -column -offset 3n "ACL_ENTRY_NO_PROPAGATE_INHERIT"
  55 .It ACL_ENTRY_FILE_INHERIT Ta "Will be inherited by files."
  56 .It ACL_ENTRY_DIRECTORY_INHERIT Ta "Will be inherited by directories."
  57 .It ACL_ENTRY_NO_PROPAGATE_INHERIT Ta "Will not propagate."
  58 .It ACL_ENTRY_INHERIT_ONLY Ta "Inherit-only."
  59 .It ACL_ENTRY_INHERITED Ta "Inherited from parent"
  60 .El
  61 .Sh RETURN VALUES
  62 .Rv -std acl_add_flag_np
  63 .Sh ERRORS
  64 The
  65 .Fn acl_add_flag_np
  66 function fails if:
  67 .Bl -tag -width Er
  68 .It Bq Er EINVAL
  69 Argument
  70 .Fa flagset_d
  71 is not a valid descriptor for a flagset within an ACL entry.
  72 Argument
  73 .Fa flag
  74 does not contain a valid
  75 .Vt acl_flag_t
  76 value.
  77 .El
  78 .Sh SEE ALSO
  79 .Xr acl 3 ,
  80 .Xr acl_clear_flags_np 3 ,
  81 .Xr acl_delete_flag_np 3 ,
  82 .Xr acl_get_flagset_np 3 ,
  83 .Xr acl_set_flagset_np 3 ,
  84 .Xr posix1e 3
  85 .Sh STANDARDS
  86 POSIX.1e is described in IEEE POSIX.1e draft 17.
  87 .Sh HISTORY
  88 POSIX.1e support was introduced in
  89 .Fx 4.0 .
  90 The
  91 .Fn acl_add_flag_np
  92 function was added in
  93 .Fx 8.0 .
  94 .Sh AUTHORS
  95 The
  96 .Fn acl_add_flag_np
  97 function was written by
  98 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org .