108 lines
3.6 KiB
Groff
108 lines
3.6 KiB
Groff
.\"-
|
|
.\" 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$
|
|
.\"
|
|
.Dd September 18, 2000
|
|
.Dt CAP_FROM_TEXT 3
|
|
.Os FreeBSD
|
|
.Sh NAME
|
|
.Nm cap_from_text
|
|
.Nd Convert Text to a Capability State in Working Store
|
|
.Sh LIBRARY
|
|
.Lb libposix1e
|
|
.Sh SYNOPSIS
|
|
.Fd #include <sys/types.h>
|
|
.Fd #include <sys/capability.h>
|
|
.Ft cap_t
|
|
.Fn cap_from_text "const char *buf_p"
|
|
.Sh DESCRIPTION
|
|
This function allocates and initializes a capability state in working
|
|
storage.
|
|
It then sets the contents of this newly created capability state to the
|
|
state represented by the human-readable, null terminated character string
|
|
pointed to by
|
|
.Va buf_p .
|
|
.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
|
|
.Xr cap_free 3
|
|
with the
|
|
.Va (void *)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 function returns a pointer to the
|
|
internal representation of the capability in working storage.
|
|
Otherwise, a value of
|
|
.Va (cap_t)NULL
|
|
is returned, and
|
|
.Va errno
|
|
is set to indicate the error.
|
|
.Sh ERRORS
|
|
If any of the following conditions occur, the
|
|
.Fn cap_from_text
|
|
function shall return a value of
|
|
.Va (cap_t)NULL
|
|
and set
|
|
.Va errno
|
|
to the corresponding value:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EINVAL
|
|
The
|
|
.Va buf_p
|
|
argument does not refer to a character string, the string pointed to by
|
|
.Va buf_p
|
|
is not parseable by the function, the text string contains a
|
|
capability name or a flag character that the implementation does not
|
|
recognize as valid.
|
|
.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 cap_init 3 ,
|
|
.Xr cap_set_flag 3 ,
|
|
.Xr cap_to_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 Robert N M Watson
|