Doc fixes
[wimlib] / doc / imagex-dir.1.in
1 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
2 .SH NAME
3 @IMAGEX_PROGNAME@-dir \- Show the files contained in a WIM archive
4 .SH SYNOPSIS
5 \fB@IMAGEX_PROGNAME@ dir\fR \fIWIMFILE\fR \fIIMAGE\fR [\fIOPTIONS\fR]
6 .SH DESCRIPTION
7 Lists all the files and directories contained in the specified image of the
8 Windows Imaging (WIM) file \fIWIMFILE\fR.
9 .PP
10 \fIIMAGE\fR specifies the WIM image to show the files of.  It may be a 1-based
11 index of an image in the WIM, the name of an image in the WIM, or the keyword
12 "all" to indicate that files from all images are to be shown.  Use the
13 \fB@IMAGEX_PROGNAME@ info\fR (1) command to show what images a WIM file
14 contains.
15 .SH OPTIONS
16 .TP 6
17 \fB--path\fR=\fIPATH\fR
18 List the files recursively from the \fIPATH\fR directory instead of from the
19 root directory.
20 .SH NOTES
21 \fB@IMAGEX_PROGNAME@ dir\fR supports split WIMs, but it will only work on the
22 first part of the split WIM.
23 .PP
24 The DOS names of files are not displayed.
25 .PP
26 Alternate data streams are not displayed.
27 .SH EXAMPLES
28 List all files in the first image of 'boot.wim':
29 .RS
30 .PP
31 @IMAGEX_PROGNAME@ dir boot.wim 1
32 .RE
33 .PP
34 .SH SEE ALSO
35 .BR @IMAGEX_PROGNAME@ (1)
36 .BR @IMAGEX_PROGNAME@-info (1)