xref: /netbsd-src/usr.sbin/puffs/rump_ffs/rump_ffs.8 (revision 50728e7823a76d5bd1a7bfa3a4eac400269b1339)
1.\"	$NetBSD: rump_ffs.8,v 1.4 2008/10/16 10:32:29 pooka Exp $
2.\"
3.\"	WARNING: GENERATED FILE, DO NOT EDIT
4.\"	INSTEAD, EDIT makerumpmanpages.sh AND REGEN
5.\"
6.\" Copyright (c) 2008 Antti Kantee. All rights reserved.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\" notice, this list of conditions and the following disclaimer in the
15.\" documentation and/or other materials provided with the distribution.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.Dd August 6, 2008
30.Dt RUMP_FFS 8
31.Os
32.Sh NAME
33.Nm rump_ffs
34.Nd mount the ffs file system using a userspace server
35.Sh SYNOPSIS
36.Cd "file-system PUFFS"
37.Pp
38.Nm
39.Op options
40.Ar special
41.Ar node
42.Sh DESCRIPTION
43The
44.Nm
45utility can be used to mount ffs file systems.
46It uses
47.Xr rump 3
48and
49.Xr p2k 3
50to facilitate running the file system as a server in userspace.
51As opposed to
52.Xr mount_ffs 8 ,
53.Nm
54does not use file system code within the kernel and therefore does
55not require kernel support except
56.Xr puffs 4 .
57Apart from a minor speed penalty (starting from 10% and depending
58on the workload and file system in question), there is no difference
59to using in-kernel code.
60.Pp
61It is recommended that untrusted file system images be mounted with
62.Nm
63instead of
64.Xr mount_ffs 8 .
65Corrupt file system images commonly cause the file system
66to crash the entire kernel, but with
67.Nm
68only the userspace server process will dump core.
69.Pp
70Please see
71.Xr mount_ffs 8
72for a full description of the available command line options.
73.Sh SEE ALSO
74.Xr p2k 3 ,
75.Xr puffs 3 ,
76.Xr rump 3 ,
77.Xr mount_ffs 8
78.Sh HISTORY
79The
80.Nm
81utility first appeared in
82.Nx 5.0 .
83.Sh BUGS
84.Nm
85cannot be used via
86.Xr mount 8 .
87Instead,
88.Nm
89must be run directly.
90