xref: /freebsd/lib/libc/posix1e/acl_set_tag_type.3 (revision 315ee00f)
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 June 25, 2009
27.Dt ACL_SET_TAG_TYPE 3
28.Os
29.Sh NAME
30.Nm acl_set_tag_type
31.Nd set the tag type of an ACL entry
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_set_tag_type "acl_entry_t entry_d" "acl_tag_t tag_type"
39.Sh DESCRIPTION
40The
41.Fn acl_set_tag_type
42function
43is a POSIX.1e call that sets the ACL tag type of ACL entry
44.Fa entry_d
45to the value of
46.Fa tag_type .
47.Pp
48Valid values are:
49.Bl -column -offset 3n "ACL_OTHER_OBJ"
50.It ACL_USER_OBJ Ta "Permissions apply to file owner"
51.It ACL_USER Ta "Permissions apply to additional user specified by qualifier"
52.It ACL_GROUP_OBJ Ta "Permissions apply to file group"
53.It ACL_GROUP Ta "Permissions apply to additional group specified by qualifier"
54.It ACL_MASK Ta "Permissions specify mask"
55.It ACL_OTHER Ta Permissions apply to "other"
56.It ACL_OTHER_OBJ Ta "Same as ACL_OTHER"
57.It ACL_EVERYONE Ta Permissions apply to "everyone@"
58.El
59.Pp
60Calling
61.Fn acl_set_tag_type
62with
63.Fa tag_type
64equal to ACL_MASK, ACL_OTHER or ACL_OTHER_OBJ brands the ACL as POSIX.1e.
65Calling it with ACL_EVERYONE brands the ACL as NFSv4.
66.Sh RETURN VALUES
67.Rv -std acl_set_tag_type
68.Sh ERRORS
69The
70.Fn acl_set_tag_type
71function fails if:
72.Bl -tag -width Er
73.It Bq Er EINVAL
74Argument
75.Fa entry_d
76is not a valid descriptor for an ACL entry.
77Argument
78.Fa tag_type
79is not a valid ACL tag type.
80ACL is already branded differently.
81.El
82.Sh SEE ALSO
83.Xr acl 3 ,
84.Xr acl_get_brand_np 3 ,
85.Xr acl_get_tag_type 3 ,
86.Xr posix1e 3
87.Sh STANDARDS
88POSIX.1e is described in IEEE POSIX.1e draft 17.
89.Sh HISTORY
90POSIX.1e support was introduced in
91.Fx 4.0 .
92The
93.Fn acl_set_tag_type
94function was added in
95.Fx 5.0 .
96.Sh AUTHORS
97The
98.Fn acl_set_tag_type
99function was written by
100.An Chris D. Faulhaber Aq Mt jedgar@fxp.org .
101