lib/libposix1e/cap_clear.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_CLEAR 3
  32 .Os FreeBSD 5.0
  33 .Sh NAME
  34 .Nm cap_clear
  35 .Nd Initialize a Capability State in Working Store
  36 .Sh SYNOPSIS
  37 .Fd #include <sys/types.h>
  38 .Fd #include <sys/capability.h>
  39 .Ft int
  40 .Fn cap_clear "cap_t cap_p"
  41 .Sh DESCRIPTION
  42 The function
  43 .Fn cap_clear
  44 shall initialize the capability state in working storage identified by
  45 .Ar cap_p
  46 so that all capability flags for all capabilities defined in the
  47 implementation shall be cleared.
  48 .Sh IMPLEMENTATION NOTES
  49 FreeBSD's support for POSIX.1e interfaces and features is still under
  50 development at this time.
  51 .Sh RETURN VALUES
  52 Upon successful completion, the function shall return a value of zero.
  53 Otherwise, a value of -1 shall be returned and
  54 .Va errno
  55 shall be set to indicate the error.
  56 .Sh ERRORS
  57 If any of the following conditions occur, the
  58 .Fn cap_clear
  59 function shall return -1 and set
  60 .Va errno
  61 to the corresponding value:
  62 .Bl -tag -width Er
  63 .It Bq Er EINVAL
  64 The value of the
  65 .Va cap_p
  66 argument does not refer to a capability state in the working storage.
  67 Search permission is denied for a component of the path prefix, or the
  68 .El
  69 .Sh SEE ALSO
  70 .Xr cap 3 ,
  71 .Xr cap_init 3 ,
  72 .Xr cap_set_flag 3 ,
  73 .Xr posix1e 3
  74 .Sh STANDARDS
  75 POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
  76 of the draft continues on the cross-platform POSIX.1e implementation
  77 mailing list.  To join this list, see the
  78 .Fx
  79 POSIX.1e implementation
  80 page for more information.
  81 .Sh HISTORY
  82 Support for POSIX.1e Capabilities was developed as part of the TrustedBSD
  83 Project.
  84 POSIX.1e Capability support was introduced in
  85 .Fx 5.0 ,
  86 and development continues.
  87 .Sh AUTHORS
  88 .An Robert N M Watson
  89 .Sh BUGS
  90 These features are not yet fully implemented.