xref: /freebsd/lib/libc/posix1e/acl_set.3 (revision ed403116940cbbd5dad8a3d1c3aa0e1e9771a4e9)
1.\"-
2.\" Copyright (c) 2000 Robert N. M. Watson
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.\" $FreeBSD$
27.\"
28.Dd January 28, 2000
29.Dt ACL_SET 3
30.Os FreeBSD
31.Sh NAME
32.Nm acl_set_fd ,
33.Nm acl_set_fd_np ,
34.Nm acl_set_file
35.Nd get an ACL for a file
36.Sh LIBRARY
37.Lb libposix1e
38.Sh SYNOPSIS
39.Fd #include <sys/types.h>
40.Fd #include <sys/acl.h>
41.Ft int
42.Fn acl_set_file "const char *path_p" "acl_type_t type" "acl_t acl"
43.Ft int
44.Fn acl_set_fd "int fd" "acl_t acl"
45.Ft int
46.Fn acl_set_fd_np "int fd" "acl_t acl" "acl_type_t type"
47.Sh DESCRIPTION
48The
49.Fn acl_set_file ,
50.Fn acl_set_fd ,
51and
52.Fn acl_set_fd_np
53each associate an ACL with an object referred to by
54.Va fd
55or
56.Va path_p .
57All except
58.Fn acl_set_fd_np
59are POSIX.1e calls--
60.Fn acl_set_fd
61allows only the setting of ACLs of type ACL_TYPE_ACCESS
62where as
63.Fn acl_set_fd_np
64allows the setting of ACLs of any type.
65.Sh IMPLEMENTATION NOTES
66.Fx Ns 's
67support for POSIX.1e interfaces and features is still under
68development at this time.
69.Sh RETURN VALUES
70Upon successful completion, the function shall return a value of zero.
71Otherwise, a value of -1 shall be returned and
72.Va errno
73shall be set to indicate the error.
74.Sh ERRORS
75If any of the following conditions occur, these functions shall return
76-1 and set
77.Va errno
78to the corresponding value:
79.Bl -tag -width Er
80.It Bq Er EACCES
81Search permission is denied for a component of the path prefix, or the
82object exists and the process does not have appropriate access rights.
83.It Bq Er EBADF
84The
85.Va fd
86argument is not a valid file descriptor.
87.It Bq Er EINVAL
88Argument
89.Va acl
90does not point to a valid ACL for this object, or the ACL type
91specified in
92.Va type
93is invalid for this object, or both.
94.It Bq Er ENAMETOOLONG
95A component of a pathname exceeded 255 characters, or an
96entire path name exceeded 1023 characters.
97.It Bq Er ENOENT
98The named object does not exist, or the
99.Va path_p
100argument points to an empty string.
101.It Bq Er ENOMEM
102Insufficient memory available to fulfill request.
103.It Bq Er ENOSPC
104The directory or file system that would contain the new ACL cannot be
105extended, or the file system is out of file allocation resources.
106.It Bq Er EOPNOTSUPP
107The file system does not support ACL retrieval.
108.It Bq Er EROFS
109This function requires modification of a file system which is currently
110read-only.
111.El
112.Sh SEE ALSO
113.Xr acl 3 ,
114.Xr acl_delete 3 ,
115.Xr acl_get 3 ,
116.Xr acl_valid 3 ,
117.Xr posix1e 3
118.Sh STANDARDS
119POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
120of the draft continues on the cross-platform POSIX.1e implementation
121mailing list.  To join this list, see the
122.Fx
123POSIX.1e implementation
124page for more information.
125.Sh HISTORY
126POSIX.1e support was introduced in
127.Fx 4.0 ,
128and development continues.
129.Sh AUTHORS
130.An Robert N M Watson
131.Sh BUGS
132These features are not yet fully implemented.
133