]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - lib/libc/posix1e/acl_cmp_np.3
zfs: merge openzfs/zfs@cb01da680
[FreeBSD/FreeBSD.git] / lib / libc / posix1e / acl_cmp_np.3
1 .\"-
2 .\" Copyright (c) 2021 Gleb Popov
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 .Dd January 20, 2021
27 .Dt ACL_CMP_NP 3
28 .Os
29 .Sh NAME
30 .Nm acl_cmp
31 .Nd compare between two ACLs
32 .Sh LIBRARY
33 .Lb libc
34 .Sh SYNOPSIS
35 .In sys/types.h
36 .In sys/acl.h
37 .Ft int
38 .Fn acl_cmp_np "acl_t acl1" "acl_t acl2"
39 .Sh DESCRIPTION
40 The
41 .Fn acl_cmp_np
42 function is a non-portable call that checks if ACLs pointed to by
43 .Va acl1
44 and
45 .Va acl2
46 are equivalent.
47 The two ACLs are considered equal when they contain the same
48 entries with matching tag types, qualifiers and permissions.
49 .Sh RETURN VALUES
50 Upon successful completion, this function returns 0 if the given ACLs are
51 equivalent and 1 if they differ.
52 Otherwise, the value -1 is returned, and
53 .Va errno
54 indicates the error.
55 .Sh ERRORS
56 If any of the following conditions occur, the
57 .Fn acl_cmp_np
58 function shall return a value of
59 .Va -1
60 and set
61 .Va errno
62 to the corresponding value:
63 .Bl -tag -width Er
64 .It Bq Er EINVAL
65 Either first or second argument does not point to a valid ACL.
66 .Sh SEE ALSO
67 .Xr acl 3 ,
68 .Xr posix1e 3
69 .Sh STANDARDS
70 POSIX.1e is described in IEEE POSIX.1e draft 17.
71 Discussion
72 of the draft continues on the cross-platform POSIX.1e implementation
73 mailing list.
74 To join this list, see the
75 .Fx
76 POSIX.1e implementation
77 page for more information.
78 .Sh HISTORY
79 POSIX.1e support was introduced in
80 .Fx 4.0 ,
81 and development continues.
82 .Sh AUTHORS
83 .An Gleb Popov