NetBSD/lib/libp2k/p2k.3
pooka bdf6e0b034 Install rump libraries and utilities to the base system and remove the
private non-installed build infrastructure from sys/rump.

breakdown of commit:
  * install relevant headers into /usr/include/rump
  * build sys/rump/librump/rumpuser and sys/rump/librump/rumpkern
    from src/lib and install as librumpuser and librump, respectively
    + this retains the ability to test a librump build with just the
      kernel sources at hand
  * move sys/rump/fs/lib/libukfs and sys/rump/fs/lib/libp2k to src/lib
    for general consumption, they are not kernel-space dwellers anyway
  * build and install sys/rump/fs/lib/lib$fs as librumpfs_$fs
  * add chapter 3 manual pages for rump, rumpuser, ukfs and p2k
  * build and install userspace kernel file system daemons if MKPUFFS=yes
    is spexified
  * retire fsconsole for now, it will make a comeback with an actually
    implemented version shortly
2008-07-29 13:17:40 +00:00

76 lines
2.4 KiB
Groff

.\" $NetBSD: p2k.3,v 1.1 2008/07/29 13:17:40 pooka Exp $
.\"
.\" Copyright (c) 2008 Antti Kantee. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd July 28, 2008
.Dt P2K 3
.Os
.Sh NAME
.Nm p2k
.Nd puffs to kernel vfs translation library
.Sh LIBRARY
p2k Library (libp2k, \-lp2k)
.Sh SYNOPSIS
.In rump/p2k.h
.Ft int
.Fo p2k_run_fs
.Fa "const char *vfsname" "const char *devpath" "const char *mountpath"
.Fa "int mntflags" "void *arg" "size_t alen" "uint32_t puffs_flags"
.Fc
.Sh DESCRIPTION
The
.Nm
library translates the puffs protocol to the kernel vfs protocol and
back again.
It can therefore be used to mount and run kernel file system code as
a userspace daemon.
.Pp
Calling the library interface function mounts the file system and,
if succesful, starts handling requests.
The parameters are handled by
.Fn ukfs_mount
(see
.Xr ukfs 3 ) ,
with the exception that
.Fa mountpath
and
.Fa puffs_flags
are handled by
.Xr puffs 3 .
.Sh SEE ALSO
.Xr puffs 3 ,
.Xr rump 3 ,
.Xr ukfs 3 ,
.Xr rump_cd9660 8 ,
.Xr rump_efs 8 ,
.Xr rump_ext2fs 8 ,
.Xr rump_ffs 8 ,
.Xr rump_hfs 8 ,
.Xr rump_lfs 8 ,
.Xr rump_msdos 8 ,
.Xr rump_ntfs 8 ,
.Xr rump_syspuffs 8 ,
.Xr rump_tmpfs 8 ,
.Xr rump_udf 8