[src/trunk]: src/sbin/mount_ntfs Couple changes, mainly to address stuff rais...

[jdolecek <jdolecek%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/de4921319f92
branches:  trunk
changeset: 516848:de4921319f92
user:      jdolecek <jdolecek%NetBSD.org@localhost>
date:      Wed Oct 31 19:16:36 2001 +0000

description:
Couple changes, mainly to address stuff raised recently on port-i386
('Does i386 support NTFS5 now?'):

add a note both NTFS4 and NTFS5 are supported
reformat the Limitations a bit
assert the write support is not really useful, and should not be used
add a BUGS section, note missing stuff for the write support to be useful,
and the disk label thing spotted by Christos Zoulas

diffstat:

 sbin/mount_ntfs/mount_ntfs.8 |  54 ++++++++++++++++++++++++++++++++++---------
 1 files changed, 42 insertions(+), 12 deletions(-)

diffs (99 lines):

diff -r 5f0786fb821c -r de4921319f92 sbin/mount_ntfs/mount_ntfs.8
--- a/sbin/mount_ntfs/mount_ntfs.8      Wed Oct 31 18:44:11 2001 +0000
+++ b/sbin/mount_ntfs/mount_ntfs.8      Wed Oct 31 19:16:36 2001 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: mount_ntfs.8,v 1.6 1999/12/17 14:43:07 jdolecek Exp $
+.\" $NetBSD: mount_ntfs.8,v 1.7 2001/10/31 19:16:36 jdolecek Exp $
 .\"
 .\" Copyright (c) 1993,1994 Christopher G. Demetriou
 .\" Copyright (c) 1999 Semen Ustimenko
@@ -31,7 +31,7 @@
 .\"
 .\"    Id: mount_ntfs.8,v 1.3 1999/05/04 11:34:33 jkoshy Exp 
 .\"
-.Dd January 3, 1999
+.Dd October 31, 2001
 .Dt MOUNT_NTFS 8
 .Os
 .Sh NAME
@@ -61,10 +61,13 @@
 of course, that they have appropriate access to the device that
 contains the file system).
 .Pp
+The supported NTFS versions include both NTFS4, as used by Microsoft
+Windows NT 4.0, and NTFS5, as used by Microsoft Windows 2000 and XP.
+.Pp
 The options are as follows:
 .Bl -tag -width Ds
 .It Fl a
-Force behaviour to return MS-DOS 8.3 names also on 
+Force behaviour to return MS-DOS 8.3 names also on
 .Fn readdir .
 .It Fl i
 Make name lookup case insensitive for all names except POSIX names.
@@ -108,25 +111,37 @@
 .Ed
 .Pp
 .Ss Limited support for writing
-There is limited writing ability. Limitations: file must be nonresident,
-must not contain any holes (uninitialized areas) and can't be compressed.
+There is limited writing ability for files. Limitations:
+.Bl -bullet -compact
+.It
+file must be nonresident
+.It
+file must
+.Em not
+contain any holes (uninitialized areas)
+.It
+file can't be compressed
+.El
+.Pp
+Note that that it's not currently possible to create or remove files
+on NTFS filesystem.
 .Pp
 .Sy Warning:
-while read-only mode appears to be very stable and there are
-no known problems, the read-write mode
-has not been very well tested yet and it may well be possible
-that an attempt to write into file residing on NTFS could
-damage the filesystem. Don't experiment with read-write mode unless
-you are ready to recover the trashed contents any time.
+do not mount NTFS filesystems read-write. The write support is
+not very useful and is not tested well. It's not safe to write to any file
+on NTFS, you might damage the filesystem.
+Unless you want to debug NTFS filesystem code, mount the NTFS filesystem
+read-only.
 .Sh SEE ALSO
 .Xr mount 2 ,
 .Xr unmount 2 ,
 .Xr fstab 5 ,
+.Xr disklabel 8 ,
 .Xr mount 8
 .Sh HISTORY
 Support for NTFS first appeared in
 .Fx 3.0 .
-It has been ported to NetBSD and first appeared here in
+It has been ported to NetBSD and first appeared in
 .Nx 1.5 .
 .Sh AUTHOR
 NTFS kernel implementation,
@@ -138,3 +153,18 @@
 .An Christos Zoulas Aq christos%NetBSD.org@localhost
 and
 .An Jaromir Dolecek Aq jdolecek%NetBSD.org@localhost .
+.Sh BUGS
+The write support should be enhanced to actually be able change
+file size, and to create and remove files and directories.
+It's not very useful right now.
+.Pp
+If the attempt to mount NTFS gives you error like this:
+.Bd -literal
+# mount -t ntfs /dev/wd0k /mnt
+mount_ntfs: /dev/wd0k on /mnt: Invalid argument
+.Ed
+.Pp
+make sure that appropriate partition has correct entry in the
+disk label, particularily that the partition offset is correct.
+If the NTFS partition is the first partition on the fisk, the
+offset should be '63' on i386.