makerumpmanpages.sh revision 1.5 
1#!/bin/sh
2#
3#	$NetBSD: makerumpmanpages.sh,v 1.5 2009/01/11 21:15:07 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 January 11, 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
67It is recommended that untrusted file system images be mounted with
68.Nm
69instead of
70.Xr mount_xxxfsxxx 8 .
71Corrupt file system images commonly cause the file system
72to crash the entire kernel, but with
73.Nm
74only the userspace server process will dump core.
75.Pp
76To use
77.Nm
78via
79.Xr mount 8 ,
80the flags
81.Fl "o rump"
82and
83.Fl "t xxxfsxxx"
84should be given.
85Similarly,
86.Nm
87is run instead of
88.Xr mount_xxxfsxxx 8
89if 
90.Dq rump
91is added to the options field of
92.Xr fstab 5 .
93.Pp
94Please see
95.Xr mount_xxxfsxxx 8
96for a full description of the available command line options.
97.Sh SEE ALSO
98.Xr p2k 3 ,
99.Xr puffs 3 ,
100.Xr rump 3 ,
101.Xr mount_xxxfsxxx 8
102.Sh HISTORY
103The
104.Nm
105utility first appeared in
106.Nx 5.0 .'
107
108# generate the manual pages
109#
110for x in rump_*
111do
112	fs=${x#rump_}
113
114	# syspuffs is special, it has a handwritten manpage
115	if [ "$fs" = "syspuffs" ]
116	then
117		continue
118	fi
119
120	fsc=`echo $fs | tr '[:lower:]' '[:upper:]'`
121	echo ${MANTMPL} | sed "s/xxxfsxxx/$fs/g;s/XXXFSXXX/$fsc/g" > \
122	    rump_${fs}/rump_${fs}.8
123done
124