]> wimlib.net Git - wimlib/blobdiff - doc/man1/wimcapture.1
v1.13.1
[wimlib] / doc / man1 / wimcapture.1
index ffcc798c387a1341ede5388f97db96f3d6159592..3d2bf39782e6adce2b940e1da53f92253b56bab0 100644 (file)
@@ -1,4 +1,4 @@
-.TH WIMCAPTURE "1" "January 2017" "wimlib 1.11.0" "User Commands"
+.TH WIMCAPTURE "1" "May 2019" "wimlib 1.13.1" "User Commands"
 .SH NAME
 wimcapture, wimappend \- Capture or append a WIM image
 .SH SYNOPSIS
@@ -10,7 +10,8 @@ The \fBwimcapture\fR (equivalently: \fBwimlib-imagex capture\fR) and
 \fBwimappend\fR (equivalently: \fBwimlib-imagex append\fR) commands create
 ("capture") a new Windows Imaging (WIM) image.  \fBwimcapture\fR creates a new
 WIM archive \fIWIMFILE\fR to contain the new image, while \fBwimappend\fR adds
-the image to the existing WIM archive \fIWIMFILE\fR.
+the image to the existing WIM archive \fIWIMFILE\fR (or with \fB--create\fR,
+creating it if needed).
 .PP
 \fISOURCE\fR specifies the location of the files from which to create the WIM
 image.  If \fISOURCE\fR is a directory or a symbolic link pointing to a
@@ -90,6 +91,8 @@ However, the main limitations of this mode are:
 .IP \[bu] 4
 Encrypted files are excluded.
 .IP \[bu]
+Extended attributes (EAs) are not stored yet.
+.IP \[bu]
 Sparse files will be flagged as such, but their full data will still be stored,
 subject to the usual compression.
 .IP \[bu]
@@ -137,8 +140,8 @@ considered an error condition.
 Hard links, if supported by the source filesystem.
 .IP \[bu]
 Object IDs, if supported by the source filesystem.
-.PP
-There is no support yet for capturing NTFS extended attributes.
+.IP \[bu]
+Extended attributes (EAs), if supported by the source filesystem.
 .SH REPARSE POINTS AND SYMLINKS
 A "symbolic link" (or "symlink") is a special file which "points to" some other
 file or directory.  On Windows, a "reparse point" is a generalization of a
@@ -171,7 +174,12 @@ WIM.
 .TP
 \fB--check\fR
 Include extra integrity information in the resulting WIM.  With \fBwimappend\fR,
-also check the integrity of the WIM before appending to it.
+also check the integrity of the WIM before appending to it.  Also verify the
+integrity of any WIMs specified by \fB--update-of\fR and/or \fB--delta-from\fR.
+.TP
+\fB--include-integrity\fR
+Include extra integrity information in the resulting WIM, i.e. like
+\fB--check\fR but don't do any verification beforehand.
 .TP
 \fB--compress\fR=\fITYPE\fR[:\fILEVEL\fR]
 With \fBwimcapture\fR, use the specified compression format in the new WIM file.
@@ -284,8 +292,13 @@ bracketed sections.  Currently, the following sections are recognized:
 [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].
+[ExclusionException] --- contains a list of path globs to include, even when the
+file or directory also matches a glob in [ExclusionList].  If a directory is
+matched, then all its contents are included as well.  Files or directories
+\fIwithin\fR a directory excluded by [ExclusionList] may even be included using
+this, though currently it only works for absolute globs (those that begin with
+"/" or "\\"); for example, "/dir/file" can be included while "/dir" can be
+excluded, but including simply "file" won't work in that case.
 .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
@@ -317,6 +330,8 @@ used:
 \\swapfile.sys
 \\System Volume Information
 \\RECYCLER
+\\$RECYCLE.BIN
+\\$Recycle.Bin
 \\Windows\\CSC
 .RE
 .RE
@@ -574,6 +589,10 @@ running into problems with locked files.  For the VSS snapshot to be
 successfully created, \fBwimlib-imagex\fR must be run as an Administrator, and
 it cannot be run in WoW64 mode (i.e. if Windows is 64-bit, then
 \fBwimlib-imagex\fR must be 64-bit as well).
+.TP
+\fB--create\fR
+With \fBwimappend\fR, if the WIM file doesn't exist yet, then create it (like
+\fBwimcapture\fR).
 .SH NOTES
 \fBwimappend\fR does not support appending an image to a split WIM.
 .PP