Update docs for capture config and paths files
authorEric Biggers <ebiggers3@gmail.com>
Thu, 24 Apr 2014 05:47:14 +0000 (00:47 -0500)
committerEric Biggers <ebiggers3@gmail.com>
Thu, 24 Apr 2014 05:47:14 +0000 (00:47 -0500)
doc/man1/imagex-capture.1.in
doc/man1/imagex-extract.1.in

index c096b6a..5b302e6 100644 (file)
@@ -280,8 +280,9 @@ image.
 to, rather than archiving the links themselves.
 .TP
 \fB--config\fR=\fIFILE\fR
-Specifies a configuration file for capturing the new image.  The configuration
-file specifies files that are to be treated specially during the image capture.
+Specifies a configuration file (UTF-8 or UTF-16LE encoded) for capturing the new
+image.  The configuration file specifies files that are to be treated specially
+during the image capture.
 .IP ""
 The format of the configuration file is a number of sections containing path
 globs one per line, where each section begins with the tag [ExclusionList],
@@ -303,9 +304,10 @@ path into that directory through a symbolic link.
 .IP ""
 For compatibility with Windows, the path separators in the globs may be either
 forward slashes or backslashes, and the line separators may be either UNIX-style
-or DOS-style.  Globs with spaces in them must be quoted, and leading and
-trailing whitespace is not significant.  Empty lines and lines beginning with
-\'#' or whitespace followed by '#' are ignored.
+or DOS-style.  Trailing and leading whitespace is ignored.  Lines beginning with
+the '#' or ';' characters are treated as comments and ignored.  Globs with
+whitespace in them need not be quoted, unless the whitespace is leading or
+trailing.  Both double and single quotes are accepted.
 .IP ""
 Paths may not have drive letters in them, as they are all relative to the root
 of capture and not absolute external paths.
@@ -320,7 +322,7 @@ used:
 \\$ntfs.log
 \\hiberfil.sys
 \\pagefile.sys
-"\\System Volume Information"
+\\System Volume Information
 \\RECYCLER
 \\Windows\\CSC
 .RE
index 309430b..7109b73 100644 (file)
@@ -60,20 +60,21 @@ wildcard pattern may expand to multiple actual files or directories.  Use the
 \fB--no-wildcards\fR option to disable wildcard matching and search for each
 path literally.
 .PP
-Each \fILISTFILE\fR must be a UTF-8 text file that contains a list of paths to
-extract, one per line.  Wildcard characters are allowed by default.  The
-following demonstrates an example listfile:
+Each \fILISTFILE\fR must be a text file (UTF-8 or UTF-16LE encoded) that
+contains a list of paths to extract, one per line.  Wildcard characters are
+allowed by default.  The following demonstrates an example listfile:
 .PP
 .RS
 .nf
 
 ; This is a comment (begins with semicolon)
+# This is also a comment (begins with number sign)
 /Users
 /Windows/explorer.exe
 /Windows/System32/en-US/*
 
 ; Both forward and backslashes are valid.
-; Don't quote paths containing spaces.
+; It's not necessary to quote paths containing internal spaces.
 \\Program Files\\A*
 
 ; Leading and trailing whitespace is ignored