sys/rump/librump/rumpuser/rumpuser.3

   1 .\"     $NetBSD$
   2 .\"
   3 .\" Copyright (c) 2008 Antti Kantee.  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 .Dd July 28, 2008
  27 .Dt RUMPUSER 3
  28 .Os
  29 .Sh NAME
  30 .Nm rumpuser
  31 .Nd rump user namespace helper routines
  32 .Sh LIBRARY
  33 rump User Library (librumpuser, \-lrumpuser)
  34 .Sh SYNOPSIS
  35 .In rump/rumpuser.h
  36 .Sh DESCRIPTION
  37 .Nm
  38 is a user namespace helper library for runnable userspace meta programs.
  39 From rump emulation code compiled with
  40 .Dv -D_KERNEL
  41 is it not possible to directly call routines such as system calls
  42 for reading and writing files or devices.
  43 This is where
  44 .Nm
  45 comes into play by providing a bridge between the two namespaces.
  46 Another example of its services is a way to call pthread routines,
  47 used for emulating kernel threads and synchronization mechanisms
  48 in rump.
  49 .Sh SEE ALSO
  50 .Xr rump 3