wimlib-imagex documentation updates

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

diff --git a/doc/imagex-dir.1.in b/doc/imagex-dir.1.in
index 415e237256ce4d76acb5f99fce1c9d43179bebb9..d5fc076bab96b207273bcb67d7fc5533e25a2200 100644 (file)
--- a/doc/imagex-dir.1.in
+++ b/doc/imagex-dir.1.in
@@ -1,35 +1,38 @@
-.TH IMAGEX "1" "November 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "August 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\fR
-
+\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 the
-Windows Imaging (WIM) file \fIWIMFILE\fR.
-
-\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 \fBimagex
-info\fR (1) command to show what images a WIM file contains.
-
+\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.
 .SH NOTES
-
-\fBimagex dir\fR supports split WIMs, but it will only work on the first part of
-the split WIM.
-
+\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 (named) data streams are not displayed.
 .SH EXAMPLES
-Show all files in the first image of 'boot.wim':
+List all files in the first image of 'boot.wim':
 .RS
 .PP
-image dir boot.wim 1
+@IMAGEX_PROGNAME@ dir boot.wim 1
 .RE
 .PP
-
 .SH SEE ALSO
-.BR imagex (1)
-
+.BR @IMAGEX_PROGNAME@ (1)
+.BR @IMAGEX_PROGNAME@-info (1)