lib/libc/sys/caps_sys_client.2

   1 .\"
   2 .\" Copyright (c) 2006 The DragonFly Project.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\"
   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
  12 .\"    the documentation and/or other materials provided with the
  13 .\"    distribution.
  14 .\" 3. Neither the name of The DragonFly Project nor the names of its
  15 .\"    contributors may be used to endorse or promote products derived
  16 .\"    from this software without specific, prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  22 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  23 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  26 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  28 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $DragonFly: src/lib/libc/sys/caps_sys_client.2,v 1.2 2006/03/02 19:27:35 swildner Exp $
  32 .\"
  33 .Dd February 28, 2006
  34 .Dt CAPS_SYS_CLIENT 2
  35 .Os
  36 .Sh NAME
  37 .Nm caps_sys_client
  38 .Nd create a CAPS IPC client
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In sys/caps.h
  43 .Ft int
  44 .Fo caps_sys_client
  45 .Fa "const char *name"
  46 .Fa "uid_t uid"
  47 .Fa "gid_t gid"
  48 .Fa "int upcid"
  49 .Fa "int flags"
  50 .Fc
  51 .Sh DESCRIPTION
  52 Create an IPC client connected to the service specified by the
  53 .Fa name
  54 argument.
  55 Either
  56 .Fa uid
  57 or
  58 .Fa gid
  59 can be -1 (thereby indicating a wildcard),
  60 but not both.
  61 Programs connecting to a
  62 .Em generic
  63 service typically first try
  64 .Fn getuid
  65 and -1, then try -1 and
  66 .Fn getgid ,
  67 then try 0 and 0.
  68 The
  69 .Fa upcid
  70 argument can either be an upcall or a kqueue identifier.
  71 .Sh RETURN VALUES
  72 On success, this function returns a port identifier.
  73 On failure, -1 is returned and
  74 .Va errno
  75 is set to indicate the error.
  76 .Sh ERRORS
  77 This function will fail if:
  78 .Bl -tag -width ".Bq Er EOPNOTSUPP"
  79 .It Bq Er EOPNOTSUPP
  80 The CAPS system has not been enabled with
  81 .Va kern.caps_enabled .
  82 .It Bq Er EINVAL
  83 An invalid argument was specified.
  84 .El
  85 .Sh SEE ALSO
  86 .Xr caps_sys_service 2
  87 .Sh HISTORY
  88 The
  89 .Fn caps_sys_client
  90 function call first appeared in
  91 .Dx 1.0 .
  92 .Sh AUTHORS
  93 .An -nosplit
  94 CAPS IPC was written by
  95 .An Matthew Dillon .
  96 This man page was written by
  97 .An Sascha Wildner .
  98 .Sh BUGS
  99 Support for the
 100 .Fa upcid
 101 argument is currently not implemented.