xref: /netbsd-src/usr.sbin/puffs/rump_syspuffs/rump_syspuffs.8 (revision 7788a0781fe6ff2cce37368b4578a7ade0850cb1)
1.\"	$NetBSD: rump_syspuffs.8,v 1.4 2012/11/14 23:11:27 njoly Exp $
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 June 9, 2009
27.Dt RUMP_SYSPUFFS 8
28.Os
29.Sh NAME
30.Nm rump_syspuffs
31.Nd mount a puffs file server with a userspace puffs loop
32.Sh SYNOPSIS
33.Cd "file-system PUFFS"
34.Cd "pseudo-device putter"
35.Pp
36.Nm
37.Ar "file_server"
38.Ar arguments
39.Sh DESCRIPTION
40The
41.Nm
42utility can be used to mount any
43.Xr puffs 3
44file server so that the requests are passed through the kernel
45puffs code in userspace as well.
46Therefore the approximate callgraph looks a little like the following,
47where k and u denote code running in the kernel space and userspace,
48respectively:
49puffs vfs (k) \(-> libpuffs (u) \(-> p2k (u) \(-> puffs vfs (u) \(->
50libpuffs (u) \(-> file server (u).
51The response path is the same, but in reverse.
52.Pp
53In its current state,
54.Nm
55is most useful as a proof of concept for file system distribution
56and for developing and debugging the kernel portion of puffs.
57.Sh EXAMPLES
58Mount a file system with sshfs:
59.Dl rump_syspuffs mount_psshfs server.address /mnt
60.Pp
61Mount an ntfs file system using ntfs-3g (from pkgsrc/filesystems/fuse-ntfs-3g),
62set the default uid to 1323:
63.Dl rump_syspuffs ntfs-3g -o uid=1323 /path/to/filesystem /mnt
64.Sh SEE ALSO
65.Xr p2k 3 ,
66.Xr puffs 3 ,
67.Xr rump 3 ,
68.Xr puffs 4
69.Sh HISTORY
70The
71.Nm
72debugging utility first appeared in
73.Nx 5.0 .
74