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