]> wimlib.net Git - wimlib/blobdiff - doc/imagex-extract.1.in
Update docs for path extraction
[wimlib] / doc / imagex-extract.1.in
index 6d21cee43aff8b90cb6a4577b6ca66082e89f32e..d4b34bae86163c22f5582792a29b3ee52a3b8ec2 100644 (file)
@@ -1,4 +1,4 @@
-.TH WIMLIB-IMAGEX "1" "December 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "January 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-extract \- Extract files or directories from a WIM image
 .SH SYNOPSIS
@@ -40,7 +40,9 @@ Each such path must be specified as an absolute path starting from the root of
 the WIM image, like those output by the \fB@IMAGEX_PROGNAME@ dir\fR (1) command.
 However, path separators may be either forward or backward slashes, and the
 leading slash is optional; also, on Windows, the paths are treated
-case-insensitively, while on UNIX, paths are treated case-sensitively.
+case-insensitively, while on UNIX, paths are treated case-sensitively, except
+when overwritten through the \fBWIMLIB_IMAGEX_IGNORE_CASE\fR environmental
+variable, as documented in \fB@IMAGEX_PROGNAME@\fR (1).
 .PP
 If no \fIPATH\fRs are provided, the default behavior is to extract the full
 image, as if the path "/" had been provided.
@@ -52,13 +54,17 @@ each line, leading and trailing whitespace is ignored, and lines beginning with
 the ';' character and otherwise empty lines are ignored.  Each path must be
 unquoted and must specify a full path in the WIM image, as described above.
 However, unless \fB--no-wildcards\fR is specified, each path in the list file
-may also contain the wildcard characters '?' and '*', and therefore may expand
-to multiple actual files or directories.  By default, paths or wildcards that
-match no wildcards only produce a warning; use \fB--strict-wildcards\fR if you
-want an error instead.  Also, when using a list file, files and directories not
-located at the root of the WIM image will be extracted to a corresponding
-subdirectory of the destination directory rather than directly to the
-destination directory itself.
+may also contain the wildcard characters '?' and '*'.  The '?' character matches
+any character other than a path separator, whereas the '*' character matches
+zero or more non-path-separator characters.  Consequently, a single wildcard
+pattern may expand to multiple actual files or directories.
+.PP
+In the \fILISTFILE\fR mode, by default a wildcard pattern that matches no files
+or directories in the WIM image only produces a warning; use
+\fB--strict-wildcards\fR if you want an error instead.  Also, when using a list
+file, files and directories not located at the root of the WIM image will be
+extracted to a corresponding subdirectory of the destination directory rather
+than directly to the destination directory itself.
 .SH SPLIT WIMS
 You may use \fB@IMAGEX_PROGNAME@ extract\fR to extract files or directory trees
 from a split WIM.  This uses the \fB--refs\fR="\fIGLOB\fR" option in the same
@@ -102,12 +108,11 @@ current working directory.
 Do not interpret wildcard characters in paths in the \fILISTFILE\fR.
 .TP
 \fB--strict-wildcards\fR
-Fail if any wildcards or paths in \fILISTFILE\fR do not match any files in the
-WIM image.  The default behavior is to warn only.
-.TP
-\fB--case-insensitive-wildcards\fR
-Treat the wildcards or paths in \fILISTFILE\fR as case-insensitive.  On Windows
-this is already the default behavior, but on UNIX-like systems it is not.
+Fail if any wildcard patterns in \fILISTFILE\fR do not match any files or
+directories in the WIM image.  The default behavior is to warn only.  This
+option has no effect if \fB--no-wildcards\fR is also specified or if \fIPATH\fRs
+are specified instead of a \fILISTFILE\fR; in those cases, an error is issued if
+any file to extract does not exist.
 .SH NOTES
 See the documentation \fB@IMAGEX_PROGNAME@ apply\fR (1) for documentation about
 what data and metadata are extracted on UNIX-like systems versus on Windows.