lib/libc/posix1e/cap_free.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_FREE 3
  32 .Os
  33 .Sh NAME
  34 .Nm cap_free
  35 .Nd "release memory allocated to a capability state in working storage"
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .In sys/capability.h
  41 .Ft int
  42 .Fn cap_free "void *obj_d"
  43 .Sh DESCRIPTION
  44 The function
  45 .Fn cap_free
  46 shall free any releasable memory currently allocated to the capability
  47 state in working storage identified by
  48 .Va obj_d .
  49 The
  50 .Va obj_d
  51 argument may identify either a cap_t entity, or a char * entity allocated
  52 by the
  53 .Fn cap_to_text
  54 function.
  55 .Sh IMPLEMENTATION NOTES
  56 .Fx Ns 's
  57 support for POSIX.1e interfaces and features is still under
  58 development at this time.
  59 .Sh RETURN VALUES
  60 .Rv -std cap_free
  61 .Sh ERRORS
  62 If any of the following conditions occur, the
  63 .Fn cap_free
  64 function shall return -1 and set
  65 .Va errno
  66 to the corresponding value:
  67 .Bl -tag -width Er
  68 .It Bq Er EINVAL
  69 The value of the
  70 .Va cap_p
  71 argument does not refer to a capability state in the working storage.
  72 Search permission is denied for a component of the path prefix, or the
  73 .El
  74 .Sh SEE ALSO
  75 .Xr cap 3 ,
  76 .Xr cap_dup 3 ,
  77 .Xr cap_from_text 3 ,
  78 .Xr cap_get_fd 3 ,
  79 .Xr cap_get_file 3 ,
  80 .Xr cap_get_proc 3 ,
  81 .Xr cap_init 3 ,
  82 .Xr cap_to_text 3 ,
  83 .Xr posix1e 3
  84 .Sh STANDARDS
  85 POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
  86 of the draft continues on the cross-platform POSIX.1e implementation
  87 mailing list.  To join this list, see the
  88 .Fx
  89 POSIX.1e implementation
  90 page for more information.
  91 .Sh HISTORY
  92 Support for POSIX.1e Capabilities was developed as part of the TrustedBSD
  93 Project.
  94 POSIX.1e Capability support was introduced in
  95 .Fx 5.0 ,
  96 and development continues.
  97 .Sh AUTHORS
  98 .An Robert N M Watson