puffs/rump_hfs/rump_hfs.8

rump_hfs.8 revision 1.9  $NetBSD: rump_hfs.8,v 1.9 2010/03/31 14:49:46 pooka Exp $

 WARNING: GENERATED FILE, DO NOT EDIT
 INSTEAD, EDIT makerumpmanpages.sh AND REGEN

 Copyright (c) 2008 Antti Kantee. All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
 notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the
 documentation and/or other materials provided with the distribution.

 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGE.

.Dd March 31, 2010
.Dt RUMP_HFS 8
.Os
.Sh NAME
.Nm rump_hfs
.Nd mount the hfs file system using a userspace server
.Sh SYNOPSIS
.Cd "file-system PUFFS"
.Cd "pseudo-device putter"
p
.Nm
.Op options
.Ar special
.Ar node
.Sh DESCRIPTION
.Em NOTE!
This manual page has been generated from a common source shared between all
.Xr rump 3
file servers.
Some parts of this manual page may not apply to this particular server.
After reading this manual page, you may want to verify the details from
.Xr mount_hfs 8 .
p
The
.Nm
utility can be used to mount hfs file systems.
It uses
.Xr rump 3
and
.Xr p2k 3
to facilitate running the file system as a server in userspace.
As opposed to
.Xr mount_hfs 8 ,
.Nm
does not use file system code within the kernel and therefore does
not require kernel support except
.Xr puffs 4 .
Apart from a minor speed penalty (starting from 10% and depending
on the workload and file system in question), there is no difference
to using in-kernel code.
p
In case mounting a file system image from a regular file,
.Nm
does not require the use of
.Xr vnconfig 8
unlike kernel file systems.
Instead, the image path can be directly passed as the special file path.
The exception is if the image contains a disklabel.
In this case vnconfig is required to resolve the start offset for the
correct partition within the image.
p
It is recommended that untrusted file system images be mounted with
.Nm
instead of
.Xr mount_hfs 8 .
Corrupt file system images commonly cause the file system
to crash the entire kernel, but with
.Nm
only the userspace server process will dump core.
p
To use
.Nm
via
.Xr mount 8 ,
the flags
.Fl o Ar rump
and
.Fl t Ar hfs
should be given.
Similarly,
.Nm
is run instead of
.Xr mount_hfs 8
if
.Dq rump
is added to the options field of
.Xr fstab 5 .
p
Please see
.Xr mount_hfs 8
for a full description of the available command line options.
.Sh SEE ALSO
.Xr p2k 3 ,
.Xr puffs 3 ,
.Xr rump 3 ,
.Xr mount_hfs 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Nx 5.0 .
It is currently considered experimental.