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