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 January 3, 1999
  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 .It Fl C Ar charset
  86 Specify local
  87 .Ar charset
  88 to convert Unicode file names.
  89 Currently only reading is supported, thus the file system is to be
  90 mounted read-only.
  91 .It Fl W Ar u2wtable
  92 Specify
  93 .Ux
  94 to
  95 .Tn Unicode
  96 translation table.
  97 See
  98 .Xr mount_msdosfs 8
  99 for the description of this option.
 100 .Bf Em
 101 This option is preserved for backward compatibility purpose only,
 102 and will be removed in the future.
 103 Please do not use this option.
 104 .Ef
 105 .El
 106 .Sh FEATURES
 107 NTFS file attributes are accessed in following way:
 108 .Bd -literal -offset indent
 109 foo[[:ATTRTYPE]:ATTRNAME]
 110 .Ed
 111 .Pp
 112 .Sq ATTRTYPE
 113 is one of the identifiers listed in $AttrDef file of
 114 volume.
 115 Default is $DATA.
 116 .Sq ATTRNAME
 117 is an attribute name.
 118 Default is none.
 119 .Sh EXAMPLES
 120 To mount an NTFS volume located in
 121 .Pa /dev/ad1s1 :
 122 .Pp
 123 .Dl "mount_ntfs /dev/ad1s1 /mnt"
 124 .Pp
 125 To get the volume name (in Unicode):
 126 .Pp
 127 .Dl "cat /mnt/\e$Volume:\e$VOLUME_NAME"
 128 .Pp
 129 To read directory raw data:
 130 .Pp
 131 .Dl "cat /mnt/foodir:\e$INDEX_ROOT:\e$I30"
 132 .Pp
 133 To mount a Japanese NTFS volume located in
 134 .Pa /dev/ad0s1 :
 135 .Pp
 136 .Dl "mount_ntfs -C eucJP /dev/ad0s1 /mnt"
 137 .Sh WRITING
 138 There is limited writing ability.
 139 Limitations: file must be nonresident
 140 and must not contain any sparces (uninitialized areas); compressed
 141 files are also not supported.
 142 The file name must not contain multibyte characters.
 143 .Sh SEE ALSO
 144 .Xr mount 2 ,
 145 .Xr unmount 2 ,
 146 .Xr fstab 5 ,
 147 .Xr mount 8 ,
 148 .Xr mount_msdosfs 8
 149 .Sh CAVEATS
 150 This utility is primarily used for read access to an NTFS volume.
 151 See the
 152 .Sx WRITING
 153 section for details about writing to an NTFS volume.
 154 .Sh HISTORY
 155 The
 156 .Nm
 157 utility first appeared in
 158 .Fx 3.0 .
 159 .Pp
 160 The Unicode conversion routine was added by
 161 .An Ryuichiro Imura Aq imura@ryu16.org
 162 in 2003.
 163 .Sh AUTHORS
 164 The NTFS kernel implementation,
 165 .Nm
 166 utility, and manual were written by
 167 .An Semen Ustimenko Aq semenu@FreeBSD.org .