]> wimlib.net Git - wimlib/blobdiff - doc/imagex-dir.1.in
Doc fixes
[wimlib] / doc / imagex-dir.1.in
index 34dbe54057007c2cda728833114e6df7d771f784..df598856ac66c8767171496cab0f90adf624ecea 100644 (file)
@@ -1,26 +1,36 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
-imagex dir \- Show the files contained in a WIM archive
-
+@IMAGEX_PROGNAME@-dir \- Show the files contained in a WIM archive
 .SH SYNOPSIS
-\fBimagex dir\fR \fIWIMFILE\fR (\fIIMAGE_NUM\fR | \fIIMAGE_NAME\fR | all),
-
+\fB@IMAGEX_PROGNAME@ dir\fR \fIWIMFILE\fR \fIIMAGE\fR [\fIOPTIONS\fR]
 .SH DESCRIPTION
+Lists all the files and directories contained in the specified image of the
+Windows Imaging (WIM) file \fIWIMFILE\fR.
 .PP
-Lists all the files and directories contained in the specified image of
-\fIWIMFILE\fR.
-
-The image may be specified by \fIIMAGE_NUM\fR, which must be an integer that is
-an index of an image in the WIM file, starting at 1.  Alternatively, it may be
-the name of an image in the WIM file.  It also may be the keyword "all", which
-specifies all images.
-
+\fIIMAGE\fR specifies the WIM image to show the files of.  It may be a 1-based
+index of an image in the WIM, the name of an image in the WIM, or the keyword
+"all" to indicate that files from all images are to be shown.  Use the
+\fB@IMAGEX_PROGNAME@ info\fR (1) command to show what images a WIM file
+contains.
+.SH OPTIONS
+.TP 6
+\fB--path\fR=\fIPATH\fR
+List the files recursively from the \fIPATH\fR directory instead of from the
+root directory.
+.SH NOTES
+\fB@IMAGEX_PROGNAME@ dir\fR supports split WIMs, but it will only work on the
+first part of the split WIM.
+.PP
+The DOS names of files are not displayed.
+.PP
+Alternate data streams are not displayed.
 .SH EXAMPLES
-.IP 
-image dir boot.wim 1
-.LP 
-Show all files in the first image of 'boot.wim'
-
+List all files in the first image of 'boot.wim':
+.RS
+.PP
+@IMAGEX_PROGNAME@ dir boot.wim 1
+.RE
+.PP
 .SH SEE ALSO
-.BR imagex (1)
-
+.BR @IMAGEX_PROGNAME@ (1)
+.BR @IMAGEX_PROGNAME@-info (1)