xref: /openbsd/sbin/mount_ntfs/mount_ntfs.8 (revision 8932bfb7)
1.\" $OpenBSD: mount_ntfs.8,v 1.13 2011/06/27 23:10:20 jmc Exp $
2.\" $NetBSD: mount_ntfs.8,v 1.13 2003/02/14 16:21:48 grant Exp $
3.\"
4.\" Copyright (c) 1993,1994 Christopher G. Demetriou
5.\" Copyright (c) 1999 Semen Ustimenko
6.\" All rights reserved.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgment:
18.\"      This product includes software developed by Christopher G. Demetriou.
19.\" 3. The name of the author may not be used to endorse or promote products
20.\"    derived from this software without specific prior written permission
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32.\"
33.\"	Id: mount_ntfs.8,v 1.3 1999/05/04 11:34:33 jkoshy Exp
34.\"
35.Dd $Mdocdate: June 27 2011 $
36.Dt MOUNT_NTFS 8
37.Os
38.Sh NAME
39.Nm mount_ntfs
40.Nd mount an NTFS file system
41.Sh SYNOPSIS
42.Nm mount_ntfs
43.Op Fl ai
44.Op Fl g Ar gid
45.Op Fl m Ar mask
46.Op Fl o Ar options
47.Op Fl u Ar uid
48.Pa special
49.Pa node
50.Sh DESCRIPTION
51The
52.Nm
53command attaches the NTFS filesystem residing on the device
54.Pa special
55to the global filesystem namespace at the location
56indicated by
57.Pa node .
58This command is invoked by
59.Xr mount 8
60when using the syntax
61.Bd -ragged -offset 4h
62.Nm mount Op options
63-t ntfs
64.Ar special Ar node
65.Ed
66.Pp
67The
68.Ar special
69device is either a
70.Xr disklabel 8
71UID (DUID) or an entry in
72.Pa /dev .
73If it is a DUID,
74it will be automatically mapped to the appropriate entry in
75.Pa /dev .
76In either case the partition must be present
77in the disklabel loaded from the device.
78The partition name is the last letter in the entry name.
79For example, /dev/sd0a and 3eb7f9da875cb9ee.a both refer to the
80.Sq a
81partition.
82.Pp
83The supported NTFS versions include both NTFS4, as used by Microsoft
84Windows NT 4.0, and NTFS5, as used by Microsoft Windows 2000 and XP.
85Only read-only operation is permitted, which is automatically enforced.
86.Pp
87The options are as follows:
88.Bl -tag -width Ds
89.It Fl a
90Force behaviour to return MS-DOS 8.3 names also on
91.Fn readdir .
92.It Fl g Ar gid
93Set the group of the files in the file system to
94.Ar gid .
95The default group is the group of the directory
96on which the file system is being mounted.
97.It Fl i
98Make name lookup case insensitive for all names except POSIX names.
99.It Fl m Ar mask
100Specify the maximum file permissions for files
101in the file system.
102.It Fl o Ar options
103Options are specified with a
104.Fl o
105flag followed by a comma separated string of options.
106See the
107.Xr mount 8
108man page for possible options and their meanings.
109.It Fl u Ar uid
110Set the owner of the files in the file system to
111.Ar uid .
112The default owner is the owner of the directory
113on which the file system is being mounted.
114.El
115.Sh FEATURES
116.Ss NTFS file attributes
117NTFS file attributes can be accessed in the following way:
118.Bd -literal -offset indent
119foo[[:ATTRTYPE]:ATTRNAME]
120.Ed
121.Pp
122.Sq ATTRTYPE
123is one of identifier listed in $AttrDef file of volume.
124Default is $DATA.
125.Sq ATTRNAME
126is an attribute name.
127Default is none.
128.Pp
129.Sy Examples :
130.Pp
131To get volume name (in Unicode):
132.Bd -literal -offset indent
133# cat /mnt/\e$Volume:\e$VOLUME_NAME
134.Ed
135.Pp
136To read directory raw data:
137.Bd -literal -offset indent
138# cat /mnt/foodir:\e$INDEX_ROOT:\e$I30
139.Ed
140.Sh SEE ALSO
141.Xr mount 2 ,
142.Xr unmount 2 ,
143.Xr disklabel 5 ,
144.Xr fstab 5 ,
145.Xr disklabel 8 ,
146.Xr mount 8
147.Sh HISTORY
148Support for NTFS first appeared in
149.Fx 3.0 .
150It was later ported to
151.Ox
152and first appeared in
153.Ox 3.4 .
154.Sh AUTHORS
155.An -nosplit
156NTFS kernel implementation,
157.Nm mount_ntfs ,
158and this manual were originally written by
159.An Semen Ustimenko Aq semenu@FreeBSD.org .
160.Pp
161The
162.Ox
163port was done by
164.An Julien Bordet Aq zejames@greyhats.org .
165.Sh BUGS
166Only read support is enabled.
167.Pp
168If the NTFS partition is marked as
169.Ql dynamic
170under Microsoft Windows XP,
171it won't be possible to access it under
172.Ox
173anymore.
174