Sync in Copyright notice change from FreeBSD.
[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 .\" $DragonFly: src/sbin/mount_ntfs/mount_ntfs.8,v 1.2 2003/06/17 04:27:33 dillon Exp $
33 .\"
34 .Dd January 3, 1999
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
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 .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 uid
73 Set the owner of the files in the file system to
74 .Ar uid .
75 The default owner is the owner of the directory
76 on which the file system is being mounted.
77 .It Fl g Ar gid
78 Set the group of the files in the file system to
79 .Ar gid .
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 W Ar u2wtable
86 Specify
87 .Ux
88 to
89 .Tn Unicode
90 translation table.
91 See
92 .Xr mount_msdos 8
93 for the description of this option.
94 .El
95 .Sh FEATURES
96 NTFS file attributes are accessed in following way:
97 .Bd -literal -offset indent
98 foo[[:ATTRTYPE]:ATTRNAME]
99 .Ed
100 .Pp
101 .Sq ATTRTYPE
102 is one of the identifiers listed in $AttrDef file of
103 volume.
104 Default is $DATA.
105 .Sq ATTRNAME
106 is an attribute name.
107 Default is none.
108 .Sh EXAMPLES
109 To mount an ntfs volume located in
110 .Pa /dev/ad1s1 :
111 .Bd -literal -offset indent
112 # mount_ntfs /dev/ad1s1 /mnt
113 .Ed
114 .Pp
115 To get the volume name (in Unicode):
116 .Bd -literal -offset indent
117 # cat /mnt/\\$Volume:\\$VOLUME_NAME
118 .Ed
119 .Pp
120 To read directory raw data:
121 .Bd -literal -offset indent
122 # cat /mnt/foodir:\\$INDEX_ROOT:\\$I30
123 .Ed
124 .Sh WRITING
125 There is limited writing ability.
126 Limitations: file must be nonresident
127 and must not contain any sparces (uninitialized areas); compressed
128 files are also not supported.
129 .Sh SEE ALSO
130 .Xr mount 2 ,
131 .Xr unmount 2 ,
132 .Xr fstab 5 ,
133 .Xr mount 8 ,
134 .Xr mount_msdos 8
135 .Sh CAVEATS
136 This utility is primarily used for read access to an NTFS volume.
137 See the
138 .Sx WRITING
139 section for details about writing to an NTFS volume.
140 .Sh HISTORY
141 The
142 .Nm
143 utility first appeared in
144 .Fx 3.0 .
145 .Sh AUTHORS
146 The NTFS kernel implementation,
147 .Nm
148 utility, and manual were written by
149 .An Semen Ustimenko Aq semenu@FreeBSD.org .