.\" -*- nroff -*-
.\" Copyright (c) 2003 Anton Altaparmakov. All Rights Reserved.
.\" This file may be copied under the terms of the GNU Public License.
.\"
.TH NTFSLS 8 "August 2003" "ntfsprogs version @VERSION@"
.SH NAME
ntfsls \- list directory contents on an NTFS filesystem
.SH SYNOPSIS
.B ntfsls
[
.B \-a
|
.B \-\-all
]
[
.B \-F
|
.B \-\-classify
]
[
.B \-f
|
.B \-\-force
]
[
.B \-h
|
.B \-?
|
.B \-\-help
]
[
.B \-i
|
.B \-\-inode
]
[
.B \-l
|
.B \-\-long
]
[
.B \-p
|
.B \-\-path
.I PATH
]
[
.B \-q
|
.B \-\-quiet
]
[
.B \-s
|
.B \-\-system
]
[
.B \-V
|
.B \-\-version
]
[
.B \-v
|
.B \-\-verbose
]
[
.B \-x
|
.B \-\-dos
]
.B \-d
|
.B \-\-device
.I DEVICE
.SH DESCRIPTION
.B ntfsls
is used to list information about the files specified by the
.I PATH
option (the root directory by default).
.I DEVICE
is the special file corresponding to the device (e.g
.IR /dev/hdXX ).
.SH OPTIONS
.TP
.B \-a, \-\-all
Display all files.  If this option is not specified file names in the POSIX
namespace will not be displayed.
.TP
.B \-F, \-\-classify
Append indicator (one of */=@|) to entries.
.TP
.B \-f, \-\-force
Force execution.  For example necessary to run on an NTFS partition stored in
a normal file.
.TP
.B \-h, \-?, \-\-help
Print the usage information of 
.B ntfsls
and exit.
.TP
.B \-i, \-\-inode
Print inode number of each file.  This is the MFT reference number in NTFS
terminology.
.TP
.B \-l, \-\-long
Use a long listing format.
.TP
.B \-p, \-\-path
The directory whose contents to list or the file (including the path) about
which to display information.
.TP
.B \-q, \-\-quiet
Suppress some debug/warning/error messages.
.TP
.B \-s, \-\-system
Unless this options is specified, all files beginning with a dollar sign
character will not be listed as these files are usually system files.
.TP
.B \-V, \-\-version
Print the version number of
.B ntfsls
and exit.
.TP
.B \-v, \-\-verbose
Display more debug/warning/error messages.
.TP
.B \-x, \-\-dos
Display short file names, i.e. files in the DOS namespace, instead of long
file names, i.e. files in the WIN32 namespace.
.TP
.BI "\-d, \-\-device" " DEVICE"
The special file corresponding to the device that contains the NTFS partition
to read.  If you want to use an image of an NTFS partition stored on a normal
file, you will also need to specify the
.B \-f
or
.B \-\-force
options.
.SH BUGS
We are not aware of any bugs.  If you find a bug, please report it to
<linux-ntfs-dev@lists.sourceforge.net>.  Thank you.
.SH AUTHOR
This version of
.B ntfsls
has been written by Lode Leroy <lode_leroy@hotmail.com> and enhanced by 
Anton Altaparmakov <aia21@cantab.net>.  This man page has been written by
Anton Altaparmakov.
.SH AVAILABILITY
.B ntfsls
is part of the ntfsprogs package and is available for download from
http://sourceforge.net/project/showfiles.php?group_id=13956 in source (tar ball
and rpm) and pre-compiled binary (i386 rpm and deb) form.
.SH SEE ALSO
.BR ntfsprogs (8)