X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fimagex-dir.1.in;h=379dddcef19c3806444fc21339e423c4c630ada5;hp=229628fe4c491b7be7d6b490a06d7ec5cf18fedf;hb=2bba9abc868d81e85a2a165db9ade09fdb30ac8e;hpb=64f1e9b6bb2bb4d5b16240ae731bd8a84117cc98 diff --git a/doc/imagex-dir.1.in b/doc/imagex-dir.1.in index 229628fe..379dddce 100644 --- a/doc/imagex-dir.1.in +++ b/doc/imagex-dir.1.in @@ -1,33 +1,44 @@ -.TH IMAGEX "1" "September 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\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. +.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 - -\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 +DOS names and alternate (named) data streams are not listed unless the +\fB--detailed\fR mode is used. .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)