Initial import from FreeBSD RELENG_4:
[dragonfly.git] / 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: src/sbin/mount_ntfs/mount_ntfs.8,v 1.6.2.9 2003/02/24 00:56:42 trhodes Exp $
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 uid
44 .Op Fl g Ar gid
45 .Op Fl m Ar mask
46 .Op Fl W Ar u2wtable
47 .Pa special
48 .Pa node
49 .Sh DESCRIPTION
50 The
51 .Nm
52 utility attaches the NTFS file system residing on the device
53 .Pa special
54 to the global file system namespace at the location
55 indicated by
56 .Pa node .
57 This command is normally executed by
58 .Xr mount 8
59 at boot time, but can be used by any user to mount an
60 NTFS file system on any directory that they own (provided,
61 of course, that they have appropriate access to the device that
62 contains the file system).
63 .Pp
64 The options are as follows:
65 .Bl -tag -width Ds
66 .It Fl a
67 Force behaviour to return MS-DOS 8.3 names also on
68 .Fn readdir .
69 .It Fl i
70 Make name lookup case insensitive for all names except POSIX names.
71 .It Fl u Ar uid
72 Set the owner of the files in the file system to
73 .Ar uid .
74 The default owner is the owner of the directory
75 on which the file system is being mounted.
76 .It Fl g Ar gid
77 Set the group of the files in the file system to
78 .Ar gid .
79 The default group is the group of the directory
80 on which the file system is being mounted.
81 .It Fl m Ar mask
82 Specify the maximum file permissions for files
83 in the file system.
84 .It Fl W Ar u2wtable
85 Specify
86 .Ux
87 to
88 .Tn Unicode
89 translation table.
90 See
91 .Xr mount_msdos 8
92 for the description of this option.
93 .El
94 .Sh FEATURES
95 NTFS file attributes are accessed in following way:
96 .Bd -literal -offset indent
97 foo[[:ATTRTYPE]:ATTRNAME]
98 .Ed
99 .Pp
100 .Sq ATTRTYPE
101 is one of the identifiers listed in $AttrDef file of
102 volume.
103 Default is $DATA.
104 .Sq ATTRNAME
105 is an attribute name.
106 Default is none.
107 .Sh EXAMPLES
108 To mount an ntfs volume located in
109 .Pa /dev/ad1s1 :
110 .Bd -literal -offset indent
111 # mount_ntfs /dev/ad1s1 /mnt
112 .Ed
113 .Pp
114 To get the volume name (in Unicode):
115 .Bd -literal -offset indent
116 # cat /mnt/\\$Volume:\\$VOLUME_NAME
117 .Ed
118 .Pp
119 To read directory raw data:
120 .Bd -literal -offset indent
121 # cat /mnt/foodir:\\$INDEX_ROOT:\\$I30
122 .Ed
123 .Sh WRITING
124 There is limited writing ability.
125 Limitations: file must be nonresident
126 and must not contain any sparces (uninitialized areas); compressed
127 files are also not supported.
128 .Sh SEE ALSO
129 .Xr mount 2 ,
130 .Xr unmount 2 ,
131 .Xr fstab 5 ,
132 .Xr mount 8 ,
133 .Xr mount_msdos 8
134 .Sh CAVEATS
135 This utility is primarily used for read access to an NTFS volume.
136 See the
137 .Sx WRITING
138 section for details about writing to an NTFS volume.
139 .Sh HISTORY
140 The
141 .Nm
142 utility first appeared in
143 .Fx 3.0 .
144 .Sh AUTHORS
145 The NTFS kernel implementation,
146 .Nm
147 utility, and manual were written by
148 .An Semen Ustimenko Aq semenu@FreeBSD.org .