xref: /netbsd-src/usr.sbin/puffs/rump_udf/rump_udf.8 (revision 6c43668aa241f78f126ea64331e78427d593aaf4)
1.\"	$NetBSD: rump_udf.8,v 1.9 2010/03/31 14:49:47 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 March 31, 2010
30.Dt RUMP_UDF 8
31.Os
32.Sh NAME
33.Nm rump_udf
34.Nd mount the udf file system using a userspace server
35.Sh SYNOPSIS
36.Cd "file-system PUFFS"
37.Cd "pseudo-device putter"
38.Pp
39.Nm
40.Op options
41.Ar special
42.Ar node
43.Sh DESCRIPTION
44.Em NOTE!
45This manual page has been generated from a common source shared between all
46.Xr rump 3
47file servers.
48Some parts of this manual page may not apply to this particular server.
49After reading this manual page, you may want to verify the details from
50.Xr mount_udf 8 .
51.Pp
52The
53.Nm
54utility can be used to mount udf file systems.
55It uses
56.Xr rump 3
57and
58.Xr p2k 3
59to facilitate running the file system as a server in userspace.
60As opposed to
61.Xr mount_udf 8 ,
62.Nm
63does not use file system code within the kernel and therefore does
64not require kernel support except
65.Xr puffs 4 .
66Apart from a minor speed penalty (starting from 10% and depending
67on the workload and file system in question), there is no difference
68to using in-kernel code.
69.Pp
70In case mounting a file system image from a regular file,
71.Nm
72does not require the use of
73.Xr vnconfig 8
74unlike kernel file systems.
75Instead, the image path can be directly passed as the special file path.
76The exception is if the image contains a disklabel.
77In this case vnconfig is required to resolve the start offset for the
78correct partition within the image.
79.Pp
80It is recommended that untrusted file system images be mounted with
81.Nm
82instead of
83.Xr mount_udf 8 .
84Corrupt file system images commonly cause the file system
85to crash the entire kernel, but with
86.Nm
87only the userspace server process will dump core.
88.Pp
89To use
90.Nm
91via
92.Xr mount 8 ,
93the flags
94.Fl o Ar rump
95and
96.Fl t Ar udf
97should be given.
98Similarly,
99.Nm
100is run instead of
101.Xr mount_udf 8
102if
103.Dq rump
104is added to the options field of
105.Xr fstab 5 .
106.Pp
107Please see
108.Xr mount_udf 8
109for a full description of the available command line options.
110.Sh SEE ALSO
111.Xr p2k 3 ,
112.Xr puffs 3 ,
113.Xr rump 3 ,
114.Xr mount_udf 8
115.Sh HISTORY
116The
117.Nm
118utility first appeared in
119.Nx 5.0 .
120It is currently considered experimental.
121