1.\"     $NetBSD: rump.3,v 1.12 2014/12/02 01:52:13 pooka Exp $
2.\"
3.\" Copyright (c) 2008-2011 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 December 1, 2014
27.Dt RUMP 3
28.Os
29.Sh NAME
30.Nm librump
31.Nd Rump kernel base
32.Sh LIBRARY
33rump kernel base (librump, \-lrump)
34.Sh SYNOPSIS
35.In rump/rump.h
36.In rump/rump_syscalls.h
37.Sh DESCRIPTION
38The base of a
39.Xr rumpkernel 7
40is provided by the
41.Nm
42library.
43In addition to fundamental routines such as kernel memory allocators
44and locking,
45.Nm
46provides system call wrappers.
47.Pp
48Like the
49.Xr rumpuser 3
50library,
51.Nm
52is a mandatory component and is present in every rump kernel.
53.Sh SEE ALSO
54.Xr rumpuser 3 ,
55.Xr rumpkernel 7
56