X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fman1%2Fimagex-capture.1.in;h=f81118ff532dd5b92590ef17a296c89707675aed;hp=060430f5e0da2572c9fbccb2349360e227752449;hb=e3dc3c76cf0896eb98f455f2538999d23f95b61a;hpb=e5df7af7c9a9239bcc63d341829485467fa8d09e diff --git a/doc/man1/imagex-capture.1.in b/doc/man1/imagex-capture.1.in index 060430f5..f81118ff 100644 --- a/doc/man1/imagex-capture.1.in +++ b/doc/man1/imagex-capture.1.in @@ -1,4 +1,4 @@ -.TH WIMLIB-IMAGEX "1" "March 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands" +.TH WIMLIB-IMAGEX "1" "May 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands" .SH NAME @IMAGEX_PROGNAME@-capture, @IMAGEX_PROGNAME@-append \- Create or append a WIM image .SH SYNOPSIS @@ -280,37 +280,40 @@ image. to, rather than archiving the links themselves. .TP \fB--config\fR=\fIFILE\fR -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], -[ExclusionException], [CompressionExclusionList], or [AlignmentList]. -Currently, only the [ExclusionList] and [ExclusionException] sections are -implemented. The [ExclusionList] section specifies a list of path globs to -exclude from capture, while the [ExclusionException] section specifies a list of -path globs to include in the capture even if the matched file or directory name -also appears in the [ExclusionList]. -.IP "" -Relative globs with only one path component (e.g. *.mp3) match against a -filename in any directory. Relative globs with multiple path components (e.g. -dir/file), as well as absolute globs (e.g. /dir/file), are treated as paths -starting at the root directory of capture, or the root of the NTFS volume for -NTFS volume capture mode. If a directory is matched by a glob in the -[ExclusionList], the entire directory tree rooted at that directory is excluded -from the capture, unless \fB--dereference\fR is specified and there is another -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. 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. +Specifies a configuration file (UTF-8 or UTF-16LE encoded; plain ASCII also +works) 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 INI-style; that is, it is arranged in +bracketed sections. Currently, only the following sections are recognized: +.RS +.IP \[bu] 4 +[ExclusionList] --- contains a list of path globs to exclude from capture. If +a directory is matched, both the directory and its contents are excluded. +.IP \[bu] +[ExclusionException] --- contains a list of path globs to include in the +capture, even when the file or directory also matches a glob in [ExclusionList]. +.IP \[bu] +[PrepopulateList] --- this does not affect capture, but if the image is applied +later with \fB--wimboot\fR, these are globs of files that shall be extracted +normally, not as WIMBoot "pointer files". If a directory is matched, all files +and subdirectories are also matched recursively. +.RE +.IP "" +Any unrecognized sections will be ignored, with a warning printed. Sections +dealing with compression (e.g. [CompressionExclusion]) are not particularly +important. +.IP "" +Path globs may contain the '*' and '?' meta-characters. Relative globs (e.g. +*.mp3) match against a filename in any directory. Absolute globs (e.g. +/dir/file), are treated as paths starting at the main directory being captured, +or the root of the NTFS volume for NTFS volume capture mode. Do not use drive +letters in the paths; they will be ignored. Path separators may be either +forwards slashes or backwards slashes. +.IP "" +Lines beginning with the '#' or ';' characters are treated as comments and +ignored. Globs with whitespace in them need not be quoted; however, if they +are, both double and single quotes are accepted. .IP "" If this option is not specified the following default configuration file is used: @@ -322,12 +325,21 @@ used: \\$ntfs.log \\hiberfil.sys \\pagefile.sys +\\swapfile.sys \\System Volume Information \\RECYCLER \\Windows\\CSC .RE .RE .fi +.IP "" +However, special behavior applies if \fB--wimboot\fR is also specified. By +default, with \fB--wimboot\fR specified, the file +Windows/System32/WimBootCompress.ini in the directory being captured will be +used as the configuration file. However, this can be overridden using +\fB--config\fR; and this also causes the specified configuration file to be +saved in the WIM image as Windows/System32/WimBootCompress.ini, overriding any +that may be present on the filesystem. .TP \fB--unix-data\fR (UNIX-like systems only) Store the UNIX owner, group, and mode of all captured @@ -536,7 +548,7 @@ delta WIM, and when applying an image, the base WIM(s) must be sent over the pipe after the delta WIM. .TP \fB--wimboot\fR -Windows only: mark the image as WIMBoot-compatible. See Microsoft's +Mark the image as WIMBoot-compatible. See Microsoft's documentation for more information about WIMBoot. This option will, by default, change the compression type to XPRESS and the chunk size to 4096 bytes; these can, however, still be overridden through the \fB--compress\fR and