1 '\" te
   2 .\" Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
   3 .\" Copyright (c) 2002-2006 Szabolcs Szakacsits
   4 .\" Copyright (c) 2002-2005 Anton Altaparmakov
   5 .\" Copyright (c) 2002-2003 Richard Russon
   6 .\" Copyright (c) 2007 Yura Pakhuchiy
   7 .\" This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation ; either version 2 of the License, or (at your option) any later version.  This program is distributed
   8 .\" in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.  You should have received a copy of the GNU General Public License along with this program
   9 .\" (in the main directory of the Linux-NTFS distribution in the file COPYING);  if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 11-1307 USA
  10 .TH NTFSLS 1M "May 28, 2009"
  11 .SH NAME
  12 ntfsls \- list directory contents on an NTFS file system
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fBntfsls\fR [\fIoptions\fR] \fIdevice\fR
  17 .fi
  18 
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBntfsls\fR utility lists information about the files specified by the
  23 \fBPATH\fR option (the root directory by default). \fIdevice\fR (see Synopsis)
  24 is the special file corresponding to the device (for example,
  25 \fB/dev/dsk/c0d0p0\fR\fInum\fR) or an NTFS image file.
  26 .SH OPTIONS
  27 .sp
  28 .LP
  29 Supported options are listed below. Most options have both single-letter and
  30 full-name forms. Multiple single-letter options that do not take an argument
  31 can be combined. For example, \fB-fv\fR is the equivalent of \fB-f\fR \fB-v\fR.
  32 A full-name option can be abbreviated to a unique prefix of its name.
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fB-a\fR, \fB--all\fR\fR
  37 .ad
  38 .sp .6
  39 .RS 4n
  40 Display all files. If this option is not specified file names in the POSIX
  41 namespace are not displayed.
  42 .RE
  43 
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fB-F\fR, \fB--classify\fR\fR
  48 .ad
  49 .sp .6
  50 .RS 4n
  51 Append one of the indicators shown below to entries.
  52 .sp
  53 .in +2
  54 .nf
  55 * / = @ |
  56 .fi
  57 .in -2
  58 .sp
  59 
  60 .RE
  61 
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fB-f\fR, \fB--force\fR\fR
  66 .ad
  67 .sp .6
  68 .RS 4n
  69 Force execution. For example, this option is necessary to run on an NTFS
  70 partition stored in a normal file.
  71 .RE
  72 
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fB-h\fR, \fB--help\fR\fR
  77 .ad
  78 .sp .6
  79 .RS 4n
  80 Display usage information and exit.
  81 .RE
  82 
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fB-i\fR, \fB--inode\fR\fR
  87 .ad
  88 .sp .6
  89 .RS 4n
  90 Display the inode number of each file. This is the MFT reference number, in
  91 NTFS terminology.
  92 .RE
  93 
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fB-l\fR, \fB--long\fR\fR
  98 .ad
  99 .sp .6
 100 .RS 4n
 101 Use a long listing format.
 102 .RE
 103 
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fB-p\fR, \fB--path\fR \fIpath\fR\fR
 108 .ad
 109 .sp .6
 110 .RS 4n
 111 The directory whose contents to list or the file (including the path) about
 112 which to display information.
 113 .RE
 114 
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fB-q\fR, \fB--quiet\fR\fR
 119 .ad
 120 .sp .6
 121 .RS 4n
 122 Suppress some debug, warning, and error messages.
 123 .RE
 124 
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fB-R\fR, \fB--recursive\fR\fR
 129 .ad
 130 .sp .6
 131 .RS 4n
 132 Show the contents of all directories beneath the specified directory.
 133 .RE
 134 
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fB-s\fR, \fB--system\fR\fR
 139 .ad
 140 .sp .6
 141 .RS 4n
 142 Unless this options is specified, all files beginning with a dollar sign
 143 character will not be listed, as these files are usually system files.
 144 .RE
 145 
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fB-v\fR, \fB--verbose\fR\fR
 150 .ad
 151 .sp .6
 152 .RS 4n
 153 Display more debug, warning, and error messages.
 154 .RE
 155 
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fB-V\fR, \fB--version\fR\fR
 160 .ad
 161 .sp .6
 162 .RS 4n
 163 Display the \fBntfsls\fR version number and exit.
 164 .RE
 165 
 166 .sp
 167 .ne 2
 168 .na
 169 \fB\fB-x\fR, \fB--dos\fR\fR
 170 .ad
 171 .sp .6
 172 .RS 4n
 173 Display short file names, that is, files in the DOS namespace, instead of long
 174 file names, that is, files in the WIN32 namespace.
 175 .RE
 176 
 177 .SH ATTRIBUTES
 178 .sp
 179 .LP
 180 See \fBattributes\fR(5) for descriptions of the following attributes:
 181 .sp
 182 
 183 .sp
 184 .TS
 185 box;
 186 c | c
 187 l | l .
 188 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 189 _
 190 Interface Stability     Uncommitted
 191 .TE
 192 
 193 .SH SEE ALSO
 194 .sp
 195 .LP
 196 , \fBntfsprogs\fR(1M), \fBparted\fR(1M), \fBattributes\fR(5)
 197 .sp
 198 .LP
 199 http://wiki.linux-ntfs.org
 200 .SH AUTHORS
 201 .sp
 202 .LP
 203 This version of \fBntfsls\fR was written by Lode Leroy, Anton  Altaparmakov,
 204 Richard Russon, Carmelo Kintana and Giang Nguyen.