lib/libc/posix1e/cap_init.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$
  27 .\"
  28 .\" TrustedBSD Project - support for POSIX.1e process capabilities
  29 .\"
  30 .Dd April 1, 2000
  31 .Dt CAP_INIT 3
  32 .Os FreeBSD
  33 .Sh NAME
  34 .Nm cap_init
  35 .Nd Allocate and Initialize a Capability State in Working Storage
  36 .Sh SYNOPSIS
  37 .Fd #include <sys/types.h>
  38 .Fd #include <sys/capability.h>
  39 .Ft cap_t
  40 .Fn cap_init "void"
  41 .Sh DESCRIPTION
  42 The function
  43 .Fn cap_init
  44 shall create a capability state in working storage and return a pointer to
  45 the capability state.
  46 The initial value of all flags for all capabilities defined by the
  47 implementation shall be cleared.
  48 .Pp
  49 This function may cause memory to be allocated.
  50 The caller should free any releasable memory, when the capability state in
  51 working storage is no longer required, by calling
  52 .Fn cap_free
  53 with the cap_t as an argument.
  54 .Sh IMPLEMENTATION NOTES
  55 FreeBSD's support for POSIX.1e interfaces and features is still under
  56 development at this time.
  57 .Sh RETURN VALUES
  58 Upon successful completion, the
  59 .Fn cap_init
  60 function returns a non-NULL cap_t value.
  61 Otherwise, a value of
  62 .Va (cap_t)NULL
  63 shall be returned and
  64 .Va errno
  65 shall be set to indicate the error.
  66 .Sh ERRORS
  67 If any of the following conditions occur, the
  68 .Fn cap_dup
  69 function shall return
  70 .Va (cap_t)NULL
  71 and set
  72 .Va errno
  73 to the corresponding value:
  74 .Bl -tag -width Er
  75 .It Bq Er ENOMEM
  76 The capability state to be returned requires more memory than is allowed by
  77 the hardware or system-imposed memory management constraints.
  78 .El
  79 .Sh SEE ALSO
  80 .Xr cap 3 ,
  81 .Xr cap_free 3 ,
  82 .Xr posix1e 3
  83 .Sh STANDARDS
  84 POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
  85 of the draft continues on the cross-platform POSIX.1e implementation
  86 mailing list.  To join this list, see the
  87 .Fx
  88 POSIX.1e implementation
  89 page for more information.
  90 .Sh HISTORY
  91 Support for POSIX.1e Capabilities was developed as part of the TrustedBSD
  92 Project.
  93 POSIX.1e Capability support was introduced in
  94 .Fx 5.0 ,
  95 and development continues.
  96 .Sh AUTHORS
  97 .An Robert N M Watson