xref: /netbsd-src/sbin/mount_ntfs/mount_ntfs.8 (revision 7cc2f76925f078d01ddc9e640a98f4ccfc9f8c3b)
1.\" $NetBSD: mount_ntfs.8,v 1.6 1999/12/17 14:43:07 jdolecek Exp $
2.\"
3.\" Copyright (c) 1993,1994 Christopher G. Demetriou
4.\" Copyright (c) 1999 Semen Ustimenko
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgment:
17.\"      This product includes software developed by Christopher G. Demetriou.
18.\" 3. The name of the author may not be used to endorse or promote products
19.\"    derived from this software without specific prior written permission
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31.\"
32.\"	Id: mount_ntfs.8,v 1.3 1999/05/04 11:34:33 jkoshy 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 mount_ntfs
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.Pa special
48.Pa node
49.Sh DESCRIPTION
50The
51.Nm
52command attaches the NTFS filesystem residing on the device
53.Pa special
54to the global filesystem namespace at the location
55indicated by
56.Pa node .
57This command is normally executed by
58.Xr mount 8
59at boot time, but can be used by any user to mount an
60NTFS file system on any directory that they own (provided,
61of course, that they have appropriate access to the device that
62contains the file system).
63.Pp
64The options are as follows:
65.Bl -tag -width Ds
66.It Fl a
67Force behaviour to return MS-DOS 8.3 names also on
68.Fn readdir .
69.It Fl i
70Make name lookup case insensitive for all names except POSIX names.
71.It Fl u Ar uid
72Set the owner of the files in the file system to
73.Ar uid .
74The default owner is the owner of the directory
75on which the file system is being mounted.
76.It Fl g Ar gid
77Set the group of the files in the file system to
78.Ar gid .
79The default group is the group of the directory
80on which the file system is being mounted.
81.It Fl m Ar mask
82Specify the maximum file permissions for files
83in the file system.
84.El
85.Sh FEATURES
86.Ss NTFS file attributes
87NTFS file attributes can be accessed in following way:
88.Bd -literal -offset indent
89foo[[:ATTRTYPE]:ATTRNAME]
90.Ed
91.Pp
92.Sq ATTRTYPE
93is one of identifier listed in $AttrDef file of
94volume. Default is $DATA.
95.Sq ATTRNAME
96is an attribute name. Default is none.
97.Pp
98.Sy Examples:
99.Pp
100To get volume name (in Unicode):
101.Bd -literal -offset indent
102# cat /mnt/\\$Volume:\\$VOLUME_NAME
103.Ed
104.Pp
105To read directory raw data:
106.Bd -literal -offset indent
107# cat /mnt/foodir:\\$INDEX_ROOT:\\$I30
108.Ed
109.Pp
110.Ss Limited support for writing
111There is limited writing ability. Limitations: file must be nonresident,
112must not contain any holes (uninitialized areas) and can't be compressed.
113.Pp
114.Sy Warning:
115while read-only mode appears to be very stable and there are
116no known problems, the read-write mode
117has not been very well tested yet and it may well be possible
118that an attempt to write into file residing on NTFS could
119damage the filesystem. Don't experiment with read-write mode unless
120you are ready to recover the trashed contents any time.
121.Sh SEE ALSO
122.Xr mount 2 ,
123.Xr unmount 2 ,
124.Xr fstab 5 ,
125.Xr mount 8
126.Sh HISTORY
127Support for NTFS first appeared in
128.Fx 3.0 .
129It has been ported to NetBSD and first appeared here in
130.Nx 1.5 .
131.Sh AUTHOR
132NTFS kernel implementation,
133.Nm
134and this manual were originally written by
135.An Semen Ustimenko Aq semenu@FreeBSD.org .
136
137NetBSD port was done by
138.An Christos Zoulas Aq christos@NetBSD.org
139and
140.An Jaromir Dolecek Aq jdolecek@NetBSD.org .
141