path: root/ntfsprogs/ntfsls.8 (plain)
blob: 189023179ca98a69b48b94016d5a1f89921e41ac

1	.\" Copyright (c) 2003 Anton Altaparmakov.
2	.\" Copyright (c) 2005 Richard Russon.
3	.\" This file may be copied under the terms of the GNU Public License.
4	.\"
5	.TH NTFSLS 8 "November 2005" "ntfs-3g 2014.2.15"
6	.SH NAME
7	ntfsls \- list directory contents on an NTFS filesystem
8	.SH SYNOPSIS
9	.B ntfsls
10	[\fIoptions\fR] \fIdevice\fR
11	.sp
12	.B ntfsls
13	[
14	.B \-a
15	|
16	.B \-\-all
17	]
18	[
19	.B \-F
20	|
21	.B \-\-classify
22	]
23	[
24	.B \-f
25	|
26	.B \-\-force
27	]
28	[
29	.B \-h
30	|
31	.B \-\-help
32	]
33	[
34	.B \-i
35	|
36	.B \-\-inode
37	]
38	[
39	.B \-l
40	|
41	.B \-\-long
42	]
43	[
44	.B \-p
45	|
46	.B \-\-path
47	.I PATH
48	]
49	[
50	.B \-q
51	|
52	.B \-\-quiet
53	]
54	[
55	.B \-s
56	|
57	.B \-\-system
58	]
59	[
60	.B \-V
61	|
62	.B \-\-version
63	]
64	[
65	.B \-v
66	|
67	.B \-\-verbose
68	]
69	[
70	.B \-x
71	|
72	.B \-\-dos
73	]
74	.I device
75	.SH DESCRIPTION
76	.B ntfsls
77	is used to list information about the files specified by the
78	.I PATH
79	option (the root directory by default).
80	.I DEVICE
81	is the special file corresponding to the device (e.g
82	.IR /dev/hdXX )
83	or an NTFS image file.
84	.SH OPTIONS
85	Below is a summary of all the options that
86	.B ntfsls
87	accepts. Nearly all options have two equivalent names. The short name is
88	preceded by
89	.B \-
90	and the long name is preceded by
91	.BR \-\- .
92	Any single letter options, that don't take an argument, can be combined into a
93	single command, e.g.
94	.B \-fv
95	is equivalent to
96	.BR "\-f \-v" .
97	Long named options can be abbreviated to any unique prefix of their name.
98	.TP
99	\fB\-a\fR, \fB\-\-all\fR
100	Display all files. If this option is not specified file names in the POSIX
101	namespace will not be displayed.
102	.TP
103	\fB\-F\fR, \fB\-\-classify\fR
104	Append indicator (one of */=@|) to entries.
105	.TP
106	\fB\-f\fR, \fB\-\-force\fR
107	Force execution. For example necessary to run on an NTFS partition stored in
108	a normal file.
109	.TP
110	\fB\-h\fR, \fB\-\-help\fR
111	Print the usage information of
112	.B ntfsls
113	and exit.
114	.TP
115	\fB\-i\fR, \fB\-\-inode\fR
116	Print inode number of each file. This is the MFT reference number in NTFS
117	terminology.
118	.TP
119	\fB\-l\fR, \fB\-\-long\fR
120	Use a long listing format.
121	.TP
122	\fB\-p\fR, \fB\-\-path\fR PATH
123	The directory whose contents to list or the file (including the path) about
124	which to display information.
125	.TP
126	\fB\-q\fR, \fB\-\-quiet\fR
127	Suppress some debug/warning/error messages.
128	.TP
129	\fB\-R\fR, \fB\-\-recursive\fR
130	Show the contents of all directories beneath the specified directory.
131	.TP
132	\fB\-s\fR, \fB\-\-system\fR
133	Unless this options is specified, all files beginning with a dollar sign
134	character will not be listed as these files are usually system files.
135	.TP
136	\fB\-v\fR, \fB\-\-verbose\fR
137	Display more debug/warning/error messages.
138	.TP
139	\fB\-V\fR, \fB\-\-version\fR
140	Print the version number of
141	.B ntfsls
142	and exit.
143	.TP
144	\fB\-x\fR, \fB\-\-dos\fR
145	Display short file names, i.e. files in the DOS namespace, instead of long
146	file names, i.e. files in the WIN32 namespace.
147	.SH BUGS
148	There are no known problems with
149	.BR ntfsls .
150	If you find a bug please send an email describing the problem to the
151	development team:
152	.br
153	.nh
154	ntfs\-3g\-devel@lists.sf.net
155	.hy
156	.SH AUTHORS
157	This version of
158	.B ntfsls
159	was written by Lode Leroy, Anton Altaparmakov, Richard Russon, Carmelo Kintana
160	and Giang Nguyen.
161	It was ported to ntfs-3g by Erik Larsson.
162	.SH AVAILABILITY
163	.B ntfsls
164	is part of the
165	.B ntfs-3g
166	package and is available from:
167	.br
168	.nh
169	http://www.tuxera.com/community/
170	.hy
171	.SH SEE ALSO
172	.BR ntfsprogs (8)
173