1.\"	$NetBSD: rump_ext2fs.8,v 1.12 2010/11/22 07:56:55 pooka 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_EXT2FS 8
32.Os
33.Sh NAME
34.Nm rump_ext2fs
35.Nd mount a ext2fs image 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 image
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_ext2fs 8
51for a full description of the available command line options.
52.Pp
53The
54.Nm
55utility can be used to mount ext2fs 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_ext2fs 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
70.Nm
71does not require using
72.Xr vnconfig 8
73for mounts from regular files and the file path can be passed
74directly as the
75.Ar image
76parameter.
77In fact, the use of
78.Xr vnconfig 8
79is discouraged, since it is unable to properly deal with images on
80sparse files.
81.Pp
82In case the image contains multiple partitions, the desired partition
83must be indicated by appending the token
84.Dq %DISKLABEL:p%
85to the
86.Ar image
87path.
88The letter
89.Dq p
90specifies the partition as obtained via
91.Xr disklabel 8 .
92For example, to mount partition
93.Dq e
94from image
95.Pa /tmp/wd0.img ,
96use
97.Dq /tmp/wd0.img%DISKLABEL:e% .
98.Pp
99It is recommended that untrusted file system images be mounted with
100.Nm
101instead of
102.Xr mount_ext2fs 8 .
103Corrupt file system images commonly cause the file system
104to crash the entire kernel, but with
105.Nm
106only the userspace server process will dump core.
107.Pp
108To use
109.Nm
110via
111.Xr mount 8 ,
112the flags
113.Fl o Ar rump
114and
115.Fl t Ar ext2fs
116should be given.
117Similarly,
118.Nm
119is used instead of
120.Xr mount_ext2fs 8
121if
122.Dq rump
123is added to the options field of
124.Xr fstab 5 .
125.Sh SEE ALSO
126.Xr p2k 3 ,
127.Xr puffs 3 ,
128.Xr rump 3 ,
129.Xr mount_ext2fs 8
130.Sh HISTORY
131The
132.Nm
133utility first appeared in
134.Nx 5.0 .
135