Initial import from FreeBSD RELENG_4:
[games.git] / lib / libposix1e / acl_delete.3
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: src/lib/libposix1e/acl_delete.3,v 1.2.2.5 2001/12/20 16:27:06 ru Exp $
27 .\"
28 .Dd January 28, 2000
29 .Dt ACL_DELETE 3
30 .Os
31 .Sh NAME
32 .Nm acl_delete_def_file ,
33 .Nm acl_delete_fd_np ,
34 .Nm acl_delete_file_np
35 .Nd delete an ACL from a file
36 .Sh LIBRARY
37 .Lb libposix1e
38 .Sh SYNOPSIS
39 .In sys/types.h
40 .In sys/acl.h
41 .Ft int
42 .Fn acl_delete_def_file "const char *path_p"
43 .Ft int
44 .Fn acl_delete_file_np "const char *path_p" "acl_type_t type"
45 .Ft int
46 .Fn acl_delete_fd_np "int filedes" "acl_type_t type"
47 .Sh DESCRIPTION
48 The
49 .Fn acl_delete_def_file ,
50 .Fn acl_delete_file_np ,
51 and
52 .Fn acl_delete_fd_np
53 each allow the deletion of an ACL from a file.
54 .Fn acl_delete_def_file
55 is a POSIX.1e call that deletes the default ACL from a file (normally a
56 directory) by name; the other two calls are non-portable extensions that
57 allow deleting of arbitrary ACL types from a file/directory by either path
58 name, or by file descriptor.
59 .Sh IMPLEMENTATION NOTES
60 .Fx Ns 's
61 support for POSIX.1e interfaces and features is still under
62 development at this time.
63 .Sh RETURN VALUES
64 .Rv -std
65 .Sh ERRORS
66 If any of the following conditions occur, these functions shall return -1
67 and set
68 .Va errno
69 to the corresponding value:
70 .Bl -tag -width Er
71 .It Bq Er EACCES
72 Search permission is denied for a component of the path prefix, or the
73 object exists and the process does not have appropriate access rights.
74 .It Bq Er EBADF
75 The
76 .Va fd
77 argument is not a valid file descriptor.
78 .It Bq Er EINVAL
79 The ACL type passed is invalid for this file object.
80 .It Bq Er ENAMETOOLONG
81 A component of a pathname exceeded 255 characters, or an
82 entire path name exceeded 1023 characters.
83 .It Bq Er ENOENT
84 The named object does not exist, or the
85 .Va path_p
86 argument points to an empty string.
87 .It Bq Er ENOMEM
88 Insufficient memory available to fulfill request.
89 .It Bq Er ENOTDIR
90 A component of the path prefix is not a directory.
91 .Pp
92 Argument
93 .Va path_p
94 must be a directory, and is not.
95 .It Bq Er EOPNOTSUPP
96 The file system does not support ACL deletion.
97 .It Bq Er EPERM
98 The process does not have appropriate privilege to perform the operation
99 to delete an ACL.
100 .It Bq Er EROFS
101 The file system is read-only.
102 .El
103 .Sh SEE ALSO
104 .Xr acl 3 ,
105 .Xr acl_get 3 ,
106 .Xr acl_set 3 ,
107 .Xr posix1e 3
108 .Sh STANDARDS
109 POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
110 of the draft continues on the cross-platform POSIX.1e implementation
111 mailing list.  To join this list, see the
112 .Fx
113 POSIX.1e implementation
114 page for more information.
115 .Sh HISTORY
116 POSIX.1e support was introduced in
117 .Fx 4.0 ,
118 and development continues.
119 .Sh AUTHORS
120 .An Robert N M Watson
121 .Sh BUGS
122 These features are not yet fully implemented.  In particular, the shipped
123 version of UFS/FFS does not support storage of additional security labels,
124 and so is unable to (easily) provide support for most of these features.