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