sbin/mount_ntfs/mount_ntfs.8

   1 .\" $NetBSD: mount_ntfs.8,v 1.16 2004/04/23 02:58:27 simonb Exp $
   2 .\"
   3 .\" Copyright (c) 1993,1994 Christopher G. Demetriou
   4 .\" Copyright (c) 1999 Semen Ustimenko
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgment:
  17 .\"      This product includes software developed by Christopher G. Demetriou.
  18 .\" 3. The name of the author may not be used to endorse or promote products
  19 .\"    derived from this software without specific prior written permission
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  22 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  23 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  24 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  25 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  26 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 .\"
  32 .\"     Id: mount_ntfs.8,v 1.3 1999/05/04 11:34:33 jkoshy Exp
  33 .\"
  34 .Dd October 31, 2001
  35 .Dt MOUNT_NTFS 8
  36 .Os
  37 .Sh NAME
  38 .Nm mount_ntfs
  39 .Nd mount an NTFS file system
  40 .Sh SYNOPSIS
  41 .Nm mount_ntfs
  42 .Op Fl a
  43 .Op Fl i
  44 .Op Fl u Ar uid
  45 .Op Fl g Ar gid
  46 .Op Fl m Ar mask
  47 .Pa special
  48 .Pa node
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 command attaches the NTFS filesystem residing on the device
  53 .Pa special
  54 to the global filesystem namespace at the location
  55 indicated by
  56 .Pa node .
  57 Both
  58 .Ar special
  59 and
  60 .Ar node
  61 are converted to absolute paths before use.
  62 This command is normally executed by
  63 .Xr mount 8
  64 at boot time, but can be used by any user to mount an
  65 NTFS file system on any directory that they own (provided,
  66 of course, that they have appropriate access to the device that
  67 contains the file system).
  68 .Pp
  69 The supported NTFS versions include both NTFS4, as used by Microsoft
  70 Windows NT 4.0, and NTFS5, as used by Microsoft Windows 2000 and XP.
  71 .Pp
  72 The options are as follows:
  73 .Bl -tag -width Ds
  74 .It Fl a
  75 Force behaviour to return MS-DOS 8.3 names also on
  76 .Fn readdir .
  77 .It Fl i
  78 Make name lookup case insensitive for all names except POSIX names.
  79 .It Fl u Ar uid
  80 Set the owner of the files in the file system to
  81 .Ar uid .
  82 The default owner is the owner of the directory
  83 on which the file system is being mounted.
  84 .It Fl g Ar gid
  85 Set the group of the files in the file system to
  86 .Ar gid .
  87 The default group is the group of the directory
  88 on which the file system is being mounted.
  89 .It Fl m Ar mask
  90 Specify the maximum file permissions for files
  91 in the file system.
  92 .El
  93 .Sh FEATURES
  94 .Ss NTFS file attributes
  95 NTFS file attributes can be accessed in the following way:
  96 .Bd -literal -offset indent
  97 foo[[:ATTRTYPE]:ATTRNAME]
  98 .Ed
  99 .Pp
 100 .Sq ATTRTYPE
 101 is one of identifier listed in $AttrDef file of volume.
 102 Default is $DATA.
 103 .Sq ATTRNAME
 104 is an attribute name.
 105 Default is none.
 106 .Pp
 107 .Sy Examples :
 108 .Pp
 109 To get volume name (in Unicode):
 110 .Bd -literal -offset indent
 111 # cat /mnt/\\$Volume:\\$VOLUME_NAME
 112 .Ed
 113 .Pp
 114 To read directory raw data:
 115 .Bd -literal -offset indent
 116 # cat /mnt/foodir:\\$INDEX_ROOT:\\$I30
 117 .Ed
 118 .Ss Limited support for writing
 119 There is limited writing ability for files.
 120 Limitations:
 121 .Bl -bullet -compact
 122 .It
 123 file must be non-resident
 124 .It
 125 file must
 126 .Em not
 127 contain any holes (uninitialized areas)
 128 .It
 129 file can't be compressed
 130 .El
 131 .Pp
 132 Note that it's not currently possible to create or remove files
 133 on NTFS filesystems.
 134 .Pp
 135 .Sy Warning :
 136 do not mount NTFS filesystems read-write.
 137 The write support is not very useful and is not tested well.
 138 It's not safe to write to any file on NTFS; you might damage the filesystem.
 139 Unless you want to debug NTFS filesystem code, mount the NTFS filesystem
 140 read-only.
 141 .Sh SEE ALSO
 142 .Xr mount 2 ,
 143 .Xr unmount 2 ,
 144 .Xr fstab 5 ,
 145 .Xr disklabel 8 ,
 146 .Xr mbrlabel 8 ,
 147 .Xr mount 8
 148 .Sh HISTORY
 149 Support for NTFS first appeared in
 150 .Fx 3.0 .
 151 It was ported to
 152 .Nx
 153 and first appeared in
 154 .Nx 1.5 .
 155 .Sh AUTHORS
 156 NTFS kernel implementation,
 157 .Nm
 158 and this manual were originally written by
 159 .An Semen Ustimenko Aq semenu@FreeBSD.org .
 160 .Pp
 161 The
 162 .Nx
 163 port was done by
 164 .An Christos Zoulas
 165 .Aq christos@NetBSD.org
 166 and
 167 .An Jaromir Dolecek
 168 .Aq jdolecek@NetBSD.org .
 169 .Sh BUGS
 170 The write support should be enhanced to actually be able to change
 171 file size, and to create and remove files and directories.
 172 It's not very useful right now.
 173 .Pp
 174 If the attempt to mount NTFS gives you an error like this:
 175 .Bd -literal
 176 # mount -t ntfs /dev/wd0k /mnt
 177 mount_ntfs: /dev/wd0k on /mnt: Invalid argument
 178 .Ed
 179 .Pp
 180 make sure that appropriate partition has correct entry in the
 181 disk label, particularly that the partition offset is correct.
 182 If the NTFS partition is the first partition on the disk, the
 183 offset should be '63' on i386 (see
 184 .Xr disklabel 8 ) .
 185 .Xr mbrlabel 8
 186 could help you to set up the disk label correctly.
 187 .Pp
 188 If the NTFS partition is marked as
 189 .Ql dynamic
 190 under Microsoft Windows XP,
 191 it won't be possible to access it under
 192 .Nx
 193 anymore.