Update version number

[wimlib] / doc / imagex-dir.1.in

diff --git a/doc/imagex-dir.1.in b/doc/imagex-dir.1.in
index 34dbe54057007c2cda728833114e6df7d771f784..379dddcef19c3806444fc21339e423c4c630ada5 100644 (file)
--- a/doc/imagex-dir.1.in
+++ b/doc/imagex-dir.1.in
@@ -1,26 +1,44 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "March 2014" "@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 the files and directories contained in the specified image of the Windows
+Imaging (WIM) file \fIWIMFILE\fR.
+This command is also available as simply \fBwimdir\fR if the appropriate hard
+link or batch file has been installed.
 .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 image in \fIWIMFILE\fR to show the files of.  It may
+be a 1-based index of an image in \fIWIMFILE\fR, the name of an image in
+\fIWIMFILE\fR, or the keyword "all" to indicate that files from all images in
+\fIWIMFILE\fR 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.
+.TP
+\fB--detailed\fR
+List detailed information about each file.
+.TP
+\fB--one-file-only\fR
+Show information about one file only.  Intended for use with both \fB--path\fR
+and \fB--detailed\fR.
+.SH NOTES
+\fB@IMAGEX_PROGNAME@ dir\fR supports split WIMs, but it will only work on the
+first part of the split WIM.
+.PP
+DOS names and alternate (named) data streams are not listed unless the
+\fB--detailed\fR mode is used.
 .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)