lib/libc/sys/caps_sys_service.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_service.2,v 1.1 2006/02/28 22:40:49 swildner Exp $
  32 .\"
  33 .Dd February 28, 2006
  34 .Dt CAPS_SYS_SERVICE 2
  35 .Os
  36 .Sh NAME
  37 .Nm caps_sys_service
  38 .Nd create a CAPS IPC service
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In sys/caps.h
  43 .Ft int
  44 .Fo caps_sys_service
  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 service using the specified
  53 .Fa name ,
  54 .Fa uid ,
  55 .Fa gid ,
  56 and
  57 .Fa flags .
  58 Either
  59 .Fa uid
  60 or
  61 .Fa gid
  62 can be -1
  63 .Pq "thereby indicating a wildcard" ,
  64 but not both.
  65 The
  66 .Fa upcid
  67 argument can either be an upcall or a kqueue identifier.
  68 .Sh RETURN VALUES
  69 On success, this function returns a port identifier.
  70 On failure, -1 is returned and
  71 .Va errno
  72 is set to indicate the error.
  73 .Sh ERRORS
  74 This function will fail if:
  75 .Bl -tag -width ".Bq Er EOPNOTSUPP"
  76 .It Bq Er EOPNOTSUPP
  77 The CAPS system has not been enabled with
  78 .Va kern.caps_enabled .
  79 .It Bq Er EINVAL
  80 An invalid argument was specified.
  81 .El
  82 .Sh SEE ALSO
  83 .Xr caps_sys_client 2
  84 .Sh HISTORY
  85 The
  86 .Fn caps_sys_service
  87 function call first appeared in
  88 .Dx 1.0 .
  89 .Sh AUTHORS
  90 .An -nosplit
  91 CAPS IPC was written by
  92 .An Matthew Dillon .
  93 This man page was written by
  94 .An Sascha Wildner .
  95 .Sh BUGS
  96 Support for the
  97 .Fa upcid
  98 argument is currently not implemented.