makerumpmanpages.sh revision 1.1 
1#!/bin/sh
2#
3#	$NetBSD: makerumpmanpages.sh,v 1.1 2008/08/06 20:15:30 pooka Exp $
4#
5
6IFS=' '
7MANTMPL=".\\\"	\$NetBSD\$"'
8.\"
9.\" Copyright (c) 2008 Antti Kantee.  All rights reserved.
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\"    notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\"    notice, this list of conditions and the following disclaimer in the
18.\"    documentation and/or other materials provided with the distribution.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.Dd August 6, 2008
33.Dt RUMP_XXXFSXXX 8
34.Os
35.Sh NAME
36.Nm rump_xxxfsxxx
37.Nd mount the xxxfsxxx file system using a userspace server
38.Sh SYNOPSIS
39.Cd "file-system PUFFS"
40.Pp
41.Nm
42.Op options
43.Ar special
44.Ar node
45.Sh DESCRIPTION
46The
47.Nm
48utility can be used to mount xxxfsxxx file systems.
49It uses
50.Xr rump 3
51and
52.Xr p2k 3
53to facilitate running the file system as a server in userspace.
54As opposed to
55.Xr mount_xxxfsxxx 8 ,
56.Nm
57does not use file system code within the kernel and therefore does
58not require kernel support except
59.Xr puffs 4 .
60Apart from a minor speed penalty (~10%), there is no difference to
61using the in-kernel code.
62.Pp
63It is recommended that untrusted file system images be mounted with
64.Nm
65instead of
66.Xr mount_xxxfsxxx 8 .
67Corrupt file system images commonly cause the file system
68to crash the entire kernel, but with
69.Nm
70only the userspace server process will dump core.
71.Pp
72Please see
73.Xr mount_xxxfsxxx 8
74for a full description of the available command line options.
75.Sh SEE ALSO
76.Xr p2k 3 ,
77.Xr puffs 3 ,
78.Xr rump 3 ,
79.Xr mount_xxxfsxxx 8
80.Sh HISTORY
81The
82.Nm
83utility first appeared in
84.Nx 5.0 .
85.Sh BUGS
86.Nm
87cannot be used via
88.Xr mount 8 .
89Instead,
90.Nm
91must be run directly.'
92
93# generate the manual pages
94#
95for x in rump_*
96do
97	fs=${x#rump_}
98
99	# syspuffs is special, it has a handwritten manpage
100	if [ "$fs" = "syspuffs" ]
101	then
102		continue
103	fi
104
105	fsc=`echo $fs | tr '[:lower:]' '[:upper:]'`
106	echo ${MANTMPL}�| sed "s/xxxfsxxx/$fs/g;s/XXXFSXXX/$fsc/g" > \
107	    rump_${fs}/rump_${fs}.8
108done
109