xref: /freebsd/lib/libc/posix1e/acl_clear_perms.3 (revision d37eb51047221dc3322b34db1038ff3aa533883f)
1.\"-
2.\" Copyright (c) 2001 Chris D. Faulhaber
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 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 March 10, 2001
27.Dt ACL_CLEAR_PERMS 3
28.Os
29.Sh NAME
30.Nm acl_clear_perms
31.Nd clear permissions from a permission set
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_clear_perms "acl_permset_t permset_d"
39.Sh DESCRIPTION
40The
41.Fn acl_clear_perms
42function
43is a POSIX.1e call that clears all permissions from permissions set
44.Fa permset_d .
45.Sh RETURN VALUES
46.Rv -std acl_clear_perms
47.Sh ERRORS
48The
49.Fn acl_clear_perms
50function fails if:
51.Bl -tag -width Er
52.It Bq Er EINVAL
53Argument
54.Fa permset_d
55is not a valid descriptor for a permission set.
56.El
57.Sh SEE ALSO
58.Xr acl 3 ,
59.Xr acl_add_perm 3 ,
60.Xr acl_delete_perm 3 ,
61.Xr acl_get_permset 3 ,
62.Xr acl_set_permset 3 ,
63.Xr posix1e 3
64.Sh STANDARDS
65POSIX.1e is described in IEEE POSIX.1e draft 17.
66.Sh HISTORY
67POSIX.1e support was introduced in
68.Fx 4.0 .
69The
70.Fn acl_clear_perms
71function was added in
72.Fx 5.0 .
73.Sh AUTHORS
74The
75.Fn acl_clear_perms
76function was written by
77.An Chris D. Faulhaber Aq Mt jedgar@fxp.org .
78