Git init
[framework/base/acl.git] / man / man3 / acl_clear_perms.3
1 .\" Access Control Lists manual pages
2 .\"
3 .\" (C) 2002 Andreas Gruenbacher, <a.gruenbacher@bestbits.at>
4 .\"
5 .\" This is free documentation; you can redistribute it and/or
6 .\" modify it under the terms of the GNU General Public License as
7 .\" published by the Free Software Foundation; either version 2 of
8 .\" the License, or (at your option) any later version.
9 .\"
10 .\" The GNU General Public License's references to "object code"
11 .\" and "executables" are to be interpreted as the output of any
12 .\" document formatting or typesetting system, including
13 .\" intermediate and printed output.
14 .\"
15 .\" This manual is distributed in the hope that it will be useful,
16 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 .\" GNU General Public License for more details.
19 .\"
20 .\" You should have received a copy of the GNU General Public
21 .\" License along with this manual.  If not, see
22 .\" <http://www.gnu.org/licenses/>.
23 .\"
24 .Dd March 23, 2002
25 .Dt ACL_CLEAR_PERMS 3
26 .Os "Linux ACL"
27 .Sh NAME
28 .Nm acl_clear_perms
29 .Nd clear all permissions from an ACL permission set
30 .Sh LIBRARY
31 Linux Access Control Lists library (libacl, \-lacl).
32 .Sh SYNOPSIS
33 .In sys/types.h
34 .In sys/acl.h
35 .Ft int
36 .Fn acl_clear_perms "acl_permset_t permset_d"
37 .Sh DESCRIPTION
38 The
39 .Fn acl_clear_perms
40 function clears all permissions from the permission set referred to by the argument
41 .Va permset_d .
42 .Pp
43 Any existing descriptors that refer to
44 .Va permset_d
45 shall continue to refer to that permission set.
46 .Sh RETURN VALUE
47 .Rv -std acl_clear_perms
48 .Sh ERRORS
49 If any of the following conditions occur, the
50 .Fn acl_clear_perms
51 function returns
52 .Li -1
53 and sets
54 .Va errno
55 to the corresponding value:
56 .Bl -tag -width Er
57 .It Bq Er EINVAL
58 The argument
59 .Va permset_d
60 is not a valid descriptor for a permission set within an ACL entry.
61 .El
62 .Sh STANDARDS
63 IEEE Std 1003.1e draft 17 (\(lqPOSIX.1e\(rq, abandoned)
64 .Sh SEE ALSO
65 .Xr acl_add_perm 3 ,
66 .Xr acl_delete_perm 3 ,
67 .Xr acl_get_perm 3 ,
68 .Xr acl_get_permset 3 ,
69 .Xr acl_set_permset 3 ,
70 .Xr acl 5
71 .Sh AUTHOR
72 Derived from the FreeBSD manual pages written by
73 .An "Robert N M Watson" Aq rwatson@FreeBSD.org ,
74 and adapted for Linux by
75 .An "Andreas Gruenbacher" Aq a.gruenbacher@bestbits.at .