sbin/mount_ntfs/mount_ntfs.8

   1 .\"
   2 .\" Copyright (c) 1993,1994 Christopher G. Demetriou
   3 .\" Copyright (c) 1999 Semen Ustimenko
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgment:
  16 .\"      This product includes software developed by Christopher G. Demetriou.
  17 .\" 3. The name of the author may not be used to endorse or promote products
  18 .\"    derived from this software without specific prior written permission
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  21 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  22 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  23 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  24 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  25 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  29 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd November 17, 2007
  34 .Dt MOUNT_NTFS 8
  35 .Os
  36 .Sh NAME
  37 .Nm mount_ntfs
  38 .Nd mount an NTFS file system
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl a
  42 .Op Fl i
  43 .Op Fl u Ar user
  44 .Op Fl g Ar group
  45 .Op Fl m Ar mask
  46 .Op Fl C Ar charset
  47 .Op Fl W Ar u2wtable
  48 .Pa special
  49 .Pa node
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 utility attaches the NTFS file system residing on the device
  54 .Pa special
  55 to the global file system namespace at the location
  56 indicated by
  57 .Pa node .
  58 This command is normally executed by
  59 .Xr mount 8
  60 at boot time, but can be used by any user to mount an
  61 NTFS file system on any directory that they own (provided,
  62 of course, that they have appropriate access to the device that
  63 contains the file system).
  64 .Pp
  65 The options are as follows:
  66 .Bl -tag -width Ds
  67 .It Fl a
  68 Force behaviour to return MS-DOS 8.3 names also on
  69 .Fn readdir .
  70 .It Fl i
  71 Make name lookup case insensitive for all names except POSIX names.
  72 .It Fl u Ar user
  73 Set the owner of the files in the file system to
  74 .Ar user .
  75 The default owner is the owner of the directory
  76 on which the file system is being mounted.
  77 .It Fl g Ar group
  78 Set the group of the files in the file system to
  79 .Ar group .
  80 The default group is the group of the directory
  81 on which the file system is being mounted.
  82 .It Fl m Ar mask
  83 Specify the maximum file permissions for files
  84 in the file system.
  85 Only the nine low-order bits of
  86 .Ar mask
  87 are used.
  88 .It Fl C Ar charset
  89 Specify local
  90 .Ar charset
  91 to convert Unicode file names.
  92 Currently only reading is supported, thus the file system is to be
  93 mounted read-only.
  94 .It Fl W Ar u2wtable
  95 Specify
  96 .Ux
  97 to
  98 .Tn Unicode
  99 translation table.
 100 See
 101 .Xr mount_msdosfs 8
 102 for the description of this option.
 103 .Bf Em
 104 This option is preserved for backward compatibility purpose only,
 105 and will be removed in the future.
 106 Please do not use this option.
 107 .Ef
 108 .El
 109 .Sh FEATURES
 110 NTFS file attributes are accessed in following way:
 111 .Bd -literal -offset indent
 112 foo[[:ATTRTYPE]:ATTRNAME]
 113 .Ed
 114 .Pp
 115 .Sq ATTRTYPE
 116 is one of the identifiers listed in $AttrDef file of
 117 volume.
 118 Default is $DATA.
 119 .Sq ATTRNAME
 120 is an attribute name.
 121 Default is none.
 122 .Sh EXAMPLES
 123 To mount an NTFS volume located in
 124 .Pa /dev/ad1s1 :
 125 .Pp
 126 .Dl "mount_ntfs /dev/ad1s1 /mnt"
 127 .Pp
 128 To get the volume name (in Unicode):
 129 .Pp
 130 .Dl "cat /mnt/\e$Volume:\e$VOLUME_NAME"
 131 .Pp
 132 To read directory raw data:
 133 .Pp
 134 .Dl "cat /mnt/foodir:\e$INDEX_ROOT:\e$I30"
 135 .Pp
 136 To mount a Japanese NTFS volume located in
 137 .Pa /dev/ad0s1 :
 138 .Pp
 139 .Dl "mount_ntfs -C eucJP /dev/ad0s1 /mnt"
 140 .Sh WRITING
 141 There is limited writing ability.
 142 Limitations: file must be nonresident
 143 and must not contain any sparces (uninitialized areas); compressed
 144 files are also not supported.
 145 The file name must not contain multibyte characters.
 146 .Sh SEE ALSO
 147 .Xr mount 2 ,
 148 .Xr unmount 2 ,
 149 .Xr fstab 5 ,
 150 .Xr mount 8 ,
 151 .Xr mount_msdosfs 8
 152 .Sh HISTORY
 153 The
 154 .Nm
 155 utility first appeared in
 156 .Fx 3.0 .
 157 .Pp
 158 The Unicode conversion routine was added by
 159 .An Ryuichiro Imura Aq imura@ryu16.org
 160 in 2003.
 161 .Sh AUTHORS
 162 The NTFS kernel implementation,
 163 .Nm
 164 utility, and manual were written by
 165 .An Semen Ustimenko Aq semenu@FreeBSD.org .
 166 .Sh CAVEATS
 167 This utility is primarily used for read access to an NTFS volume.
 168 See the
 169 .Sx WRITING
 170 section for details about writing to an NTFS volume.
 171 .Pp
 172 For a full read-write NTFS support consider sysutils/fusefs-ntfs
 173 port/package.