1.\" $NetBSD: rump_ntfs.8,v 1.8 2009/02/15 18:01:26 pooka Exp $ 2.\" 3.\" WARNING: GENERATED FILE, DO NOT EDIT 4.\" INSTEAD, EDIT makerumpmanpages.sh AND REGEN 5.\" 6.\" Copyright (c) 2008 Antti Kantee. All rights reserved. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND 18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27.\" SUCH DAMAGE. 28.\" 29.Dd February 15, 2009 30.Dt RUMP_NTFS 8 31.Os 32.Sh NAME 33.Nm rump_ntfs 34.Nd mount the ntfs file system using a userspace server 35.Sh SYNOPSIS 36.Cd "file-system PUFFS" 37.Cd "pseudo-device putter" 38.Pp 39.Nm 40.Op options 41.Ar special 42.Ar node 43.Sh DESCRIPTION 44The 45.Nm 46utility can be used to mount ntfs file systems. 47It uses 48.Xr rump 3 49and 50.Xr p2k 3 51to facilitate running the file system as a server in userspace. 52As opposed to 53.Xr mount_ntfs 8 , 54.Nm 55does not use file system code within the kernel and therefore does 56not require kernel support except 57.Xr puffs 4 . 58Apart from a minor speed penalty (starting from 10% and depending 59on the workload and file system in question), there is no difference 60to using in-kernel code. 61.Pp 62In case mounting a file system image from a regular file, 63.Nm 64does not require the use of 65.Xr vnconfig 8 66unlike kernel file systems. 67Instead, the image path can be directly passed as the special file path. 68The exception is if the image contains a disklabel. 69In this case vnconfig is required to resolve the start offset for the 70correct partition within the image. 71.Pp 72It is recommended that untrusted file system images be mounted with 73.Nm 74instead of 75.Xr mount_ntfs 8 . 76Corrupt file system images commonly cause the file system 77to crash the entire kernel, but with 78.Nm 79only the userspace server process will dump core. 80.Pp 81To use 82.Nm 83via 84.Xr mount 8 , 85the flags 86.Fl o Ar rump 87and 88.Fl t Ar ntfs 89should be given. 90Similarly, 91.Nm 92is run instead of 93.Xr mount_ntfs 8 94if 95.Dq rump 96is added to the options field of 97.Xr fstab 5 . 98.Pp 99Please see 100.Xr mount_ntfs 8 101for a full description of the available command line options. 102.Sh SEE ALSO 103.Xr p2k 3 , 104.Xr puffs 3 , 105.Xr rump 3 , 106.Xr mount_ntfs 8 107.Sh HISTORY 108The 109.Nm 110utility first appeared in 111.Nx 5.0 . 112It is currently considered experimental. 113