xref: /freebsd/lib/libc/posix1e/acl_set.3 (revision 4b2eaea43fec8e8792be611dea204071a10b655a)
1.\"-
2.\" Copyright (c) 2000, 2002 Robert N. M. Watson
3.\" All rights reserved.
4.\"
5.\" This software was developed by Robert Watson for the TrustedBSD Project.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\" $FreeBSD$
29.\"
30.Dd December 29, 2002
31.Dt ACL_SET 3
32.Os
33.Sh NAME
34.Nm acl_set_fd ,
35.Nm acl_set_fd_np ,
36.Nm acl_set_file ,
37.Nm acl_set_link_np
38.Nd set an ACL for a file
39.Sh LIBRARY
40.Lb libc
41.Sh SYNOPSIS
42.In sys/types.h
43.In sys/acl.h
44.Ft int
45.Fn acl_set_fd "int fd" "acl_t acl"
46.Ft int
47.Fn acl_set_fd_np "int fd" "acl_t acl" "acl_type_t type"
48.Ft int
49.Fn acl_set_file "const char *path_p" "acl_type_t type" "acl_t acl"
50.Ft int
51.Fn acl_set_link_np "const char *path_p" "acl_type_t type" "acl_t acl"
52.Sh DESCRIPTION
53The
54.Fn acl_set_fd ,
55.Fn acl_set_fd_np ,
56.Fn acl_set_file ,
57and
58.Fn acl_set_link_np ,
59each associate an ACL with an object referred to by
60.Va fd
61or
62.Va path_p .
63.Fn acl_set_fd_np
64and
65.Fn acl_set_link_np
66are not POSIX.1e calls.
67.Fn acl_set_fd
68allows only the setting of ACLs of type ACL_TYPE_ACCESS
69where as
70.Fn acl_set_fd_np
71allows the setting of ACLs of any type.
72.Fn acl_set_link_np
73acts on a symlink rather than its target, if the target of the
74path is a symlink.
75.Sh IMPLEMENTATION NOTES
76.Fx Ns 's
77support for POSIX.1e interfaces and features is still under
78development at this time.
79.Sh RETURN VALUES
80.Rv -std
81.Sh ERRORS
82If any of the following conditions occur, these functions shall return
83-1 and set
84.Va errno
85to the corresponding value:
86.Bl -tag -width Er
87.It Bq Er EACCES
88Search permission is denied for a component of the path prefix, or the
89object exists and the process does not have appropriate access rights.
90.It Bq Er EBADF
91The
92.Va fd
93argument is not a valid file descriptor.
94.It Bq Er EINVAL
95Argument
96.Va acl
97does not point to a valid ACL for this object, or the ACL type
98specified in
99.Va type
100is invalid for this object, or both.
101.It Bq Er ENAMETOOLONG
102A component of a pathname exceeded 255 characters, or an
103entire path name exceeded 1023 characters.
104.It Bq Er ENOENT
105The named object does not exist, or the
106.Va path_p
107argument points to an empty string.
108.It Bq Er ENOMEM
109Insufficient memory available to fulfill request.
110.It Bq Er ENOSPC
111The directory or file system that would contain the new ACL cannot be
112extended, or the file system is out of file allocation resources.
113.It Bq Er EOPNOTSUPP
114The file system does not support ACL retrieval.
115.It Bq Er EROFS
116This function requires modification of a file system which is currently
117read-only.
118.El
119.Sh SEE ALSO
120.Xr acl 3 ,
121.Xr acl_delete 3 ,
122.Xr acl_get 3 ,
123.Xr acl_valid 3 ,
124.Xr posix1e 3
125.Sh STANDARDS
126POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
127of the draft continues on the cross-platform POSIX.1e implementation
128mailing list.  To join this list, see the
129.Fx
130POSIX.1e implementation
131page for more information.
132.Sh HISTORY
133POSIX.1e support was introduced in
134.Fx 4.0 ,
135and development continues.
136.Sh AUTHORS
137.An Robert N M Watson
138