Changeset View
Changeset View
Standalone View
Standalone View
lib/libc/posix1e/acl_from_mode_np.3
- This file was added.
.\"- | |||||||||
.\" Copyright (c) 2021 Gleb Popov | |||||||||
.\" All rights reserved. | |||||||||
.\" | |||||||||
.\" Redistribution and use in source and binary forms, with or without | |||||||||
.\" modification, are permitted provided that the following conditions | |||||||||
.\" are met: | |||||||||
.\" 1. Redistributions of source code must retain the above copyright | |||||||||
.\" notice, this list of conditions and the following disclaimer. | |||||||||
.\" 2. Redistributions in binary form must reproduce the above copyright | |||||||||
.\" notice, this list of conditions and the following disclaimer in the | |||||||||
.\" documentation and/or other materials provided with the distribution. | |||||||||
.\" | |||||||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | |||||||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |||||||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |||||||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | |||||||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |||||||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |||||||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |||||||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |||||||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |||||||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |||||||||
.\" SUCH DAMAGE. | |||||||||
.\" | |||||||||
.Dd January 20, 2021 | |||||||||
.Dt ACL_FROM_MODE_NP 3 | |||||||||
.Os | |||||||||
.Sh NAME | |||||||||
.Nm acl_from_mode_np | |||||||||
.Nd create an ACL from status information | |||||||||
.Sh LIBRARY | |||||||||
.Lb libc | |||||||||
.Sh SYNOPSIS | |||||||||
.In sys/types.h | |||||||||
.In sys/acl.h | |||||||||
.Ft acl_t | |||||||||
.Fn acl_from_mode_np "const mode_t mode" | |||||||||
.Sh DESCRIPTION | |||||||||
The | |||||||||
.Fn acl_from_mode_np | |||||||||
function is a non-portable call that converts the permissions set referred to by | |||||||||
.Va mode | |||||||||
into the corresponding minimal ACL structure, appropriate for applying to | |||||||||
files or manipulating. | |||||||||
.Pp | |||||||||
This function causes memory to be allocated. | |||||||||
The caller should free any | |||||||||
free-able memory, when the new ACL is no longer required, by calling | |||||||||
.Xr acl_free 3 | |||||||||
with the | |||||||||
.Va (void *)acl_t | |||||||||
debdrup: I think it's better to stick with terminology that relates to the VM subsystem here? The dash… | |||||||||
as an argument. | |||||||||
.Sh RETURN VALUES | |||||||||
Upon successful completion, the function returns a pointer to the | |||||||||
internal representation of the ACL in working storage. | |||||||||
Otherwise, a value | |||||||||
of | |||||||||
Done Inline Actions
'shall return' makes it sounds like a spec is being quoted, and that the implementation doesn't follow this - I assume that's not the intention? debdrup: 'shall return' makes it sounds like a spec is being quoted, and that the implementation doesn't… | |||||||||
Done Inline ActionsThat's right - there is no spec as these functions are non-standard. arrowd: That's right - there is no spec as these functions are non-standard. | |||||||||
.Va (acl_t)NULL | |||||||||
is returned, and | |||||||||
.Va errno | |||||||||
is set to indicate the error. | |||||||||
.Sh ERRORS | |||||||||
Done Inline Actions
Same as above. debdrup: Same as above. | |||||||||
If any of the following conditions occur, the | |||||||||
.Fn acl_from_mode_np | |||||||||
Done Inline Actions
Same as above. debdrup: Same as above. | |||||||||
function returns a value of | |||||||||
.Va (acl_t)NULL | |||||||||
and set | |||||||||
.Va errno | |||||||||
Done Inline Actions
Same as above. debdrup: Same as above. | |||||||||
to the corresponding value: | |||||||||
.Bl -tag -width Er | |||||||||
.It Bq Er ENOMEM | |||||||||
The ACL working storage requires more memory than is allowed by the | |||||||||
hardware or system-imposed memory management constraints. | |||||||||
.El | |||||||||
.Sh SEE ALSO | |||||||||
.Xr acl 3 , | |||||||||
.Xr acl_free 3 , | |||||||||
.Xr acl_from_text 3 , | |||||||||
.Xr posix1e 3 | |||||||||
.Sh STANDARDS | |||||||||
POSIX.1e is described in IEEE POSIX.1e draft 17. | |||||||||
Discussion | |||||||||
of the draft continues on the cross-platform POSIX.1e implementation | |||||||||
mailing list. | |||||||||
To join this list, see the | |||||||||
.Fx | |||||||||
POSIX.1e implementation | |||||||||
page for more information. | |||||||||
.Sh HISTORY | |||||||||
POSIX.1e support was introduced in | |||||||||
.Fx 4.0 , | |||||||||
and development continues. | |||||||||
.Sh AUTHORS | |||||||||
.An Gleb Popov |
I think it's better to stick with terminology that relates to the VM subsystem here? The dash is optional, but I think it looks better with it.