X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fimagex-capture.1.in;h=a3c0ac653333396f4a921efcfb679eadf6d319c9;hp=5822d16401aa2cd7bf457a945706e0bb4599cec1;hb=bc0480e80627467ff64818235fbd164ed179f64c;hpb=f2db311f527e6037c836cf1b14debb841e09b440 diff --git a/doc/imagex-capture.1.in b/doc/imagex-capture.1.in index 5822d164..a3c0ac65 100644 --- a/doc/imagex-capture.1.in +++ b/doc/imagex-capture.1.in @@ -1,4 +1,4 @@ -.TH IMAGEX "1" "March 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands" +.TH IMAGEX "1" "April 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands" .SH NAME @IMAGEX_PROGNAME@-capture, @IMAGEX_PROGNAME@-append \- Create or append a WIM image @@ -180,27 +180,32 @@ capture mode. Specifies a configuration file for capturing the new image. The configuration file specifies files that are to be treated specially during the image capture. -The format of the configuration file is a number of sections containing file +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 file globs to +implemented. The [ExclusionList] section specifies a list of path globs to exclude from capture, while the [ExclusionException] section specifies a list of -file globs to include in the capture even if the matched file or directory name +path globs to include in the capture even if the matched file or directory name also appears in the [ExclusionList]. -Relative globs with only one path component match against a filename in any -directory. Relative globs with multiple path components, as well as absolute -globs, are treated as paths starting at the root directory of capture, or the -root of the NTFS volume for NTFS 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. +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 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. 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. However, globs with spaces in them currently must not be quoted. -Empty lines are ignored. +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. + +Paths may not have drive letters in them, as they are all relative to the root +of capture and not absolute external paths. If this option is not specified the following default configuration file is used: @@ -213,15 +218,9 @@ used: \\$ntfs.log \\hiberfil.sys \\pagefile.sys -\\System Volume Information +"\\System Volume Information" \\RECYCLER \\Windows\\CSC - -[CompressionExclusionList] -*.mp3 -*.zip -*.cab -\\WINDOWS\\inf\\*.pnf .RE .RE @@ -238,6 +237,24 @@ information. In the NTFS capture mode, do not capture security descriptors. This flag is also available in the native Win32 build of wimlib. .TP +\fB--rpfix\fR, \fB--norpfix\fR +Set whether to fix targets of absolute symbolic links (reparse points in Windows +terminology) or not. When enabled (\fB--rpfix\fR), absolute symbolic links that +point inside the directory tree being captured will be adjusted to be absolute +relative to the root of the directory tree being captured. In addition, +absolute symbolic links that point outside the directory tree being captured +will be ignored and not be captured at all. When disabled (\fB--norpfix\fR), +absolute symbolic links will be captured exactly as is. + +The default behavior for \fBimagex capture\fR is equivalent to \fB--rpfix\fR. +The default behavior for \fBimagex append\fR will be \fB--rpfix\fR if reparse +point fixups have previously been done on \fIWIMFILE\fR, otherwise +\fB--norpfix\fR. + +Links are fixed up on a per-source basis in the case of a multi-source capture +(\fB--source-list\fR specified), so you may wish to set \fB--norpfix\fR in that +case. +.TP \fB--strict-acls\fR In the Win32 native build of wimlib, fail immediately if the full security descriptor of any file or directory cannot be read. The default behavior @@ -314,17 +331,6 @@ of an aborted \fB@IMAGEX_PROGNAME@ append\fR, \fB@IMAGEX_PROGNAME@ optimize\fR m extra data that may have been partially appended to the physical WIM file but not yet incorporated into the structure of the WIM. -Capturing or appending an image happens in two main phases: (1) scanning the -directory or NTFS volume to checksum all the files and determine the streams to -be written, and (2) writing the new streams to the WIM file. Streams are not -stored in memory after (1), since there could easily be gigabytes of data; -instead, they are read again during step (2); however, duplicate streams in the -image, and streams already existing in any other image in the WIM, are not read -again. In the future, it may be possible to introduce the ability to capture an -image with reading each file only one time, although this mode would have some -limitations--- for example, a stream might be compressed only to be thrown away -as a duplicate once it's been checksummed. - \fISOURCE\fR may be a symbolic link to a directory rather than a directory itself. However, additional symbolic links in subdirectories, or in additional source directories not destined for the WIM image root (with