makerumpmanpages.sh revision 1.7 
1#!/bin/sh
2#
3#	$NetBSD: makerumpmanpages.sh,v 1.7 2009/02/10 15:04:35 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 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 February 10, 2009
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.Pp
44.Nm
45.Op options
46.Ar special
47.Ar node
48.Sh DESCRIPTION
49The
50.Nm
51utility can be used to mount xxxfsxxx file systems.
52It uses
53.Xr rump 3
54and
55.Xr p2k 3
56to facilitate running the file system as a server in userspace.
57As opposed to
58.Xr mount_xxxfsxxx 8 ,
59.Nm
60does not use file system code within the kernel and therefore does
61not require kernel support except
62.Xr puffs 4 .
63Apart from a minor speed penalty (starting from 10% and depending
64on the workload and file system in question), there is no difference
65to using in-kernel code.
66.Pp
67In case mounting a file system image from a regular file,
68.Nm
69does not require the use of
70.Xr vnconfig 8
71unlike kernel file systems.
72Instead, the image path can be directly passed as the special file path.
73The exception is if the image contains a disklabel.
74In this case vnconfig is required to resolve the start offset for the
75correct partition within the image.
76.Pp
77It is recommended that untrusted file system images be mounted with
78.Nm
79instead of
80.Xr mount_xxxfsxxx 8 .
81Corrupt file system images commonly cause the file system
82to crash the entire kernel, but with
83.Nm
84only the userspace server process will dump core.
85.Pp
86To use
87.Nm
88via
89.Xr mount 8 ,
90the flags
91.Fl o Ar rump
92and
93.Fl t Ar xxxfsxxx
94should be given.
95Similarly,
96.Nm
97is run instead of
98.Xr mount_xxxfsxxx 8
99if
100.Dq rump
101is added to the options field of
102.Xr fstab 5 .
103.Pp
104Please see
105.Xr mount_xxxfsxxx 8
106for a full description of the available command line options.
107.Sh SEE ALSO
108.Xr p2k 3 ,
109.Xr puffs 3 ,
110.Xr rump 3 ,
111.Xr mount_xxxfsxxx 8
112.Sh HISTORY
113The
114.Nm
115utility first appeared in
116.Nx 5.0 .'
117
118# generate the manual pages
119#
120for x in rump_*
121do
122	fs=${x#rump_}
123
124	# syspuffs is special, it has a handwritten manpage
125	if [ "$fs" = "syspuffs" ]
126	then
127		continue
128	fi
129
130	fsc=`echo $fs | tr '[:lower:]' '[:upper:]'`
131	echo ${MANTMPL} | sed "s/xxxfsxxx/$fs/g;s/XXXFSXXX/$fsc/g" > \
132	    rump_${fs}/rump_${fs}.8
133done
134