xref: /netbsd-src/usr.sbin/puffs/rump_nfs/rump_nfs.8 (revision 876775fb1a93bf99312e75f3b3ad9bf1afc1b0b2)
1.\"	$NetBSD: rump_nfs.8,v 1.11 2011/07/24 09:00:07 uch Exp $
2.\"
3.\"	WARNING: GENERATED FILE, DO NOT EDIT
4.\"	INSTEAD, EDIT makerumpmanpages.sh AND REGEN
5.\"	from: NetBSD: makerumpmanpages.sh,v 1.12 2010/11/22 07:56:31 pooka Exp
6.\"
7.\" Copyright (c) 2008-2010 Antti Kantee. All rights reserved.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\" notice, this list of conditions and the following disclaimer in the
16.\" documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.Dd November 21, 2010
31.Dt RUMP_NFS 8
32.Os
33.Sh NAME
34.Nm rump_nfs
35.Nd mount a nfs share with a userspace server
36.Sh SYNOPSIS
37.Cd "file-system PUFFS"
38.Cd "pseudo-device putter"
39.Pp
40.Nm
41.Op options
42.Ar share
43.Ar mountpoint
44.Sh DESCRIPTION
45.Em NOTE!
46This manual page describes features specific to the
47.Xr rump 3
48file server.
49Please see
50.Xr mount_nfs 8
51for a full description of the available command line options.
52.Pp
53The
54.Nm
55utility can be used to mount nfs file systems.
56It uses
57.Xr rump 3
58and
59.Xr p2k 3
60to facilitate running the file system as a server in userspace.
61As opposed to
62.Xr mount_nfs 8 ,
63.Nm
64does not use file system code within the kernel and therefore does
65not require kernel support except
66.Xr puffs 4 .
67Apart from a minor speed penalty there is no downside with respect to
68in-kernel code.
69.Pp
70Even though the
71.Nm
72file system client runs within a virtual rump kernel in userspace,
73it uses host network services
74.Pq by means of Dq rump sockin .
75This means that regardless of whether using
76.Nm
77or
78.Xr mount_nfs 8 ,
79the same network configurations will be used.
80Currently,
81.Dq sockin
82supports IPv4.
83.Pp
84To use
85.Nm
86via
87.Xr mount 8 ,
88the flags
89.Fl o Ar rump
90and
91.Fl t Ar nfs
92should be given.
93Similarly,
94.Nm
95is used instead of
96.Xr mount_nfs 8
97if
98.Dq rump
99is added to the options field of
100.Xr fstab 5 .
101.Sh SEE ALSO
102.Xr p2k 3 ,
103.Xr puffs 3 ,
104.Xr rump 3 ,
105.Xr mount_nfs 8
106.Sh HISTORY
107The
108.Nm
109utility first appeared in
110.Nx 5.0 .
111