makerumpmanpages.sh revision 1.10 
1#!/bin/sh
2#
3#	$NetBSD: makerumpmanpages.sh,v 1.10 2010/11/21 19:29:01 pooka Exp $
4#
5
6IFS=' '
7MANTMPL=".\\\"	\$NetBSD\$"'
8.\"
9.\"	WARNING: GENERATED FILE, DO NOT EDIT
10.\"	INSTEAD, EDIT makerumpmanpages.sh AND REGEN
11.\"
12.\" Copyright (c) 2008-2010 Antti Kantee.  All rights reserved.
13.\"
14.\" Redistribution and use in source and binary forms, with or without
15.\" modification, are permitted provided that the following conditions
16.\" are met:
17.\" 1. Redistributions of source code must retain the above copyright
18.\"    notice, this list of conditions and the following disclaimer.
19.\" 2. Redistributions in binary form must reproduce the above copyright
20.\"    notice, this list of conditions and the following disclaimer in the
21.\"    documentation and/or other materials provided with the distribution.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.Dd November 21, 2010
36.Dt RUMP_XXXFSXXX 8
37.Os
38.Sh NAME
39.Nm rump_xxxfsxxx
40.Nd mount the xxxfsxxx file system using a userspace server
41.Sh SYNOPSIS
42.Cd "file-system PUFFS"
43.Cd "pseudo-device putter"
44.Pp
45.Nm
46.Op options
47.Ar image
48.Ar mountpoint
49.Sh DESCRIPTION
50.Em NOTE!
51This manual page has been generated from a common source shared between all
52.Xr rump 3
53file servers.
54Some parts of this manual page may not apply to this particular server.
55After reading this manual page, you may want to verify the details from
56.Xr mount_xxxfsxxx 8 .
57.Pp
58The
59.Nm
60utility can be used to mount xxxfsxxx file systems.
61It uses
62.Xr rump 3
63and
64.Xr p2k 3
65to facilitate running the file system as a server in userspace.
66As opposed to
67.Xr mount_xxxfsxxx 8 ,
68.Nm
69does not use file system code within the kernel and therefore does
70not require kernel support except
71.Xr puffs 4 .
72Apart from a minor speed penalty there is no downside with respect to
73in-kernel code.
74.Pp
75.Nm
76does not require using
77.Xr vnconfig 8
78for mounts from regular files and the file path can be passed
79directly as the
80.Ar image
81parameter.
82In fact, the use of
83.Xr vnconfig 8
84is discouraged, since it is unable to properly deal with images on
85sparse files.
86.Pp
87In case the image contains multiple partitions, the desired partition
88must be indicated by appending the token
89.Dq %DISKLABEL:p%
90to the
91.Ar image
92path.
93The letter
94.Dq p
95specifies the partition as obtained via
96.Xr disklabel 8 .
97For example, to mount partition
98.Dq e
99from image
100.Pa /tmp/wd0.img ,
101use
102.Dq /tmp/wd0.img%DISKLABEL:e% .
103.Pp
104It is recommended that untrusted file system images be mounted with
105.Nm
106instead of
107.Xr mount_xxxfsxxx 8 .
108Corrupt file system images commonly cause the file system
109to crash the entire kernel, but with
110.Nm
111only the userspace server process will dump core.
112.Pp
113To use
114.Nm
115via
116.Xr mount 8 ,
117the flags
118.Fl o Ar rump
119and
120.Fl t Ar xxxfsxxx
121should be given.
122Similarly,
123.Nm
124is run instead of
125.Xr mount_xxxfsxxx 8
126if
127.Dq rump
128is added to the options field of
129.Xr fstab 5 .
130.Pp
131Please see
132.Xr mount_xxxfsxxx 8
133for a full description of the available command line options.
134.Sh SEE ALSO
135.Xr p2k 3 ,
136.Xr puffs 3 ,
137.Xr rump 3 ,
138.Xr mount_xxxfsxxx 8
139.Sh HISTORY
140The
141.Nm
142utility first appeared in
143.Nx 5.0 .'
144
145# generate the manual pages
146#
147for x in rump_*
148do
149	fs=${x#rump_}
150
151	# syspuffs is special, it has a handwritten manpage
152	if [ "$fs" = "syspuffs" ]
153	then
154		continue
155	fi
156
157	fsc=`echo $fs | tr '[:lower:]' '[:upper:]'`
158	echo ${MANTMPL} | sed "s/xxxfsxxx/$fs/g;s/XXXFSXXX/$fsc/g" > \
159	    rump_${fs}/rump_${fs}.8
160done
161