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