xref: /freebsd/lib/libc/posix1e/acl_is_trivial_np.3 (revision 7ef62cebc2f965b0f640263e179276928885e33d)
1.\"-
2.\" Copyright (c) 2008, 2009 Edward Tomasz Napierala
3.\"
4.\" This software was developed by Robert Watson for the TrustedBSD Project.
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$
28.\"
29.Dd June 19, 2023
30.Dt ACL_IS_TRIVIAL_NP 3
31.Os
32.Sh NAME
33.Nm acl_is_trivial_np
34.Nd determine whether ACL is trivial
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_is_trivial_np "const acl_t aclp" "int *trivialp"
42.Sh DESCRIPTION
43The
44.Fn acl_is_trivial_np
45function determines whether the ACL pointed to by the argument
46.Va acl
47is trivial.
48Upon successful completion, the location referred to by the argument
49.Fa trivialp
50will be set to 1, if the ACL
51.Fa aclp
52points to is trivial, or 0 if it's not.
53.Pp
54ACL is trivial if it can be fully expressed as a file mode without losing
55any access rules.
56For POSIX.1e ACLs, ACL is trivial if it has the three required entries,
57one for owner, one for owning group, and one for other.
58For NFSv4 ACLs, ACL is trivial if it is identical to the ACL generated by
59.Xr acl_strip_np 3 .
60Files that have non-trivial ACL have a plus sign appended after mode bits
61in "ls -l" output.
62.Sh RETURN VALUES
63.Rv -std acl_is_trivial_np
64.Sh SEE ALSO
65.Xr acl 3 ,
66.Xr acl_strip_np 3 ,
67.Xr posix1e 3
68.Sh STANDARDS
69POSIX.1e is described in IEEE POSIX.1e draft 17.
70Discussion
71of the draft continues on the cross-platform POSIX.1e implementation
72mailing list.
73To join this list, see the
74.Fx
75POSIX.1e implementation
76page for more information.
77.Sh HISTORY
78POSIX.1e support was introduced in
79.Fx 4.0 .
80The
81.Fn acl_is_trivial_np
82function was added in
83.Fx 8.0 .
84.Sh AUTHORS
85.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
86