diff options
author | rwatson <rwatson@FreeBSD.org> | 2000-06-04 21:15:16 +0000 |
---|---|---|
committer | rwatson <rwatson@FreeBSD.org> | 2000-06-04 21:15:16 +0000 |
commit | 9f516a06e7c6f525411dce748e4dafa561368c02 (patch) | |
tree | 980a9470e933ccb2a79e7e1d8a8f646fb1c4973d /lib/libc/posix1e/cap_init.3 | |
parent | a88c20a2394d023b211e87002e1c7fd00d8442ef (diff) | |
download | FreeBSD-src-9f516a06e7c6f525411dce748e4dafa561368c02.zip FreeBSD-src-9f516a06e7c6f525411dce748e4dafa561368c02.tar.gz |
o Introduce man pages for POSIX.1e capability API
- cap.3 describing library interface
- cap_*.3 describing specific API calls
APIs to follow relatively soon, code to follow later.
Obtained from: TrustedBSD Project
Diffstat (limited to 'lib/libc/posix1e/cap_init.3')
-rw-r--r-- | lib/libc/posix1e/cap_init.3 | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/lib/libc/posix1e/cap_init.3 b/lib/libc/posix1e/cap_init.3 new file mode 100644 index 0000000..2f8633c --- /dev/null +++ b/lib/libc/posix1e/cap_init.3 @@ -0,0 +1,99 @@ +.\"- +.\" Copyright (c) 2000 Robert N. M. Watson +.\" 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. +.\" +.\" $FreeBSD$ +.\" +.\" TrustedBSD Project - support for POSIX.1e process capabilities +.\" +.Dd April 1, 2000 +.Dt CAP_INIT 3 +.Os FreeBSD 5.0 +.Sh NAME +.Nm cap_init +.Nd Allocate and Initialize a Capability State in Working Storage +.Sh SYNOPSIS +.Fd #include <sys/types.h> +.Fd #include <sys/capability.h> +.Ft cap_t +.Fn cap_init "void" +.Sh DESCRIPTION +The function +.Fn cap_init +shall create a capability state in working storage and return a pointer to +the capability state. +The initial value of all flags for all capabilities defined by the +implementation shall be cleared. +.Pp +This function may cause memory to be allocated. +The caller should free any releasable memory, when the capability state in +working storage is no longer required, by calling +.Vn cap_free +with the cap_t as an argument. +.Sh IMPLEMENTATION NOTES +FreeBSD's support for POSIX.1e interfaces and features is still under +development at this time. +.Sh RETURN VALUES +Upon successful completion, the +.Fn cap_init +function returns a non-NULL cap_t value. +Otherwise, a value of +.Va (cap_t)NULL +shall be returned and +.Va errno +shall be set to indicate the error. +.Sh ERRORS +If any of the following conditions occur, the +.Fn cap_dup +function shall return +.Va (cap_t)NULL +and set +.Va errno +to the corresponding value: +.Bl -tag -width Er +.It Bq Er ENOMEM +The capability state to be returned requires more memory than is allowed by +the hardware or system-imposed memory management constraints. +.El +.Sh SEE ALSO +.Xr cap 3 , +.Xr cap_free 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 +Support for POSIX.1e Capabilities was developed as part of the TrustedBSD +Project. +POSIX.1e Capability support was introduced in +.Fx 5.0 , +and development continues. +.Sh AUTHORS +.An Robert N M Watson +.Sh BUGS +These features are not yet fully implemented. |