[wimlib] / doc / man1 / imagex-capture.1.in
1 .TH WIMLIB-IMAGEX "1" "June 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
3 @IMAGEX_PROGNAME@-capture, @IMAGEX_PROGNAME@-append \- Create or append a WIM image
7 .br
11 The \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR commands
12 create a Windows Imaging (WIM) image from a directory tree.  The
13 \fB@IMAGEX_PROGNAME@ capture\fR command creates a new WIM file containing the
14 captured image, while the \fB@IMAGEX_PROGNAME@ append\fR command appends the
15 captured image to an existing WIM file.
16 These commands are also available as simply \fBwimcapture\fR and \fBwimappend\fR
17 if the appropriate hard links or batch files are installed.
18 .PP
19 Background information: A WIM image is an independent directory tree in a WIM
20 file.  A WIM file may contain any number of separate images.  WIM files are
21 single-instancing with regards to file data, so a file is stored only one time
22 in the entire WIM, regardless of how many images the file appears in.
23 .PP
24 \fISOURCE\fR specifies the location of the files to create the new WIM image
25 from.  If \fISOURCE\fR is a directory, the WIM image is captured from that
27 (WINDOWS)\fR).   Alternatively, if the \fB--source-list\fR option is specified,
28 \fISOURCE\fR is interpreted as a file that itself provides a list of
29 files and directories to include in the new WIM image.  Still
30 alternatively, only on UNIX-like systems, if \fISOURCE\fR is a
31 regular file or block device, it is interpreted as an NTFS volume from
32 which a WIM image is to be captured using libntfs-3g (see \fBNTFS VOLUME CAPTURE
33 (UNIX)\fR).
34 .PP
35 \fIIMAGE_NAME\fR and \fIIMAGE_DESCRIPTION\fR specify the name and description to
36 give the new WIM image.  If \fIIMAGE_NAME\fR is not specified, it defaults to
37 the base name (excluding path to parent directory) of \fISOURCE\fR, but if this
38 name already exists in \fIWIMFILE\fR, a unique suffix is added.  Otherwise,
39 \fIIMAGE_NAME\fR must be either a name that does not already exist as an image in
40 \fIWIMFILE\fR, or the empty string to create an image with no name.  If
41 \fIIMAGE_DESCRIPTION\fR is not specified, no description is given to the new
42 image.
43 .PP
44 As a special case, if \fIWIMFILE\fR is "-", the \fB--pipable\fR option is
45 assumed and the WIM file is written to standard output in a special pipable
46 format.   See the documentation for \fB--pipable\fR for more details.
48 This section documents how \fB@IMAGEX_PROGNAME@\fR captures files from a
49 directory tree on UNIX-like systems.  See \fBDIRECTORY CAPTURE (WINDOWS)\fR for
50 the corresponding documentation for Windows.
51 .PP
52 On UNIX-like systems, when \fISOURCE\fR specifies a directory or a symbolic link
53 to a directory, the WIM image will be captured from the directory tree rooted at
54 this directory.  This directory can be on any type of filesystem, and mount
55 points are followed recursively.  However, it is important to keep in mind that
56 the WIM format was designed for Windows, so it cannot store all possible
57 metadata from filesystems used on UNIX-like systems.  The main information that
58 will \fInot\fR be stored is:
59 .IP \[bu] 4
60 UNIX file owners, groups, modes, and device IDs (major and minor numbers),
61 unless the \fB--unix-data\fR option is specified.  By default (without
62 \fB--unix-data\fR), files that are neither regular files, directories, nor
63 symbolic links, such as device nodes and FIFOs, will be excluded.
64 .IP \[bu]
65 Extended attributes.  This mainly includes extensions to the traditional UNIX
66 security model, such as SELinux security labels, POSIX ACLs, and capabilities
67 labels.
68 .IP \[bu]
69 Linux file attributes, as can be changed using the \fBchattr\fR (1) utility.
70 .PP
71 Notes: Timestamps are stored with 100 nanosecond granularity and include last
72 modification time (mtime) and last access time (atime), but not last status
73 change time (ctime).  Hard links and symbolic links are supported by the WIM
74 format and \fIare\fR stored.  Symbolic links are turned into "native" Windows
75 symbolic links, or "reparse points"; this process is fully reversible, e.g.
76 automatically by \fB@IMAGEX_PROGNAME@ apply\fR, unless the symbolic link target
77 contains backslash characters.
78 .PP
79 Pedantic note: A limitation of the WIM format prevents the unusual case where a
80 single symbolic link file itself has multiple names (hard links); in this
81 unlikely case, each symbolic link is stored as an independent file.
83 This section documents how \fB@IMAGEX_PROGNAME@\fR captures files directly from
84 an NTFS volume image on UNIX-like systems.
85 .PP
86 On UNIX-like systems, a special image capture mode is entered when \fISOURCE\fR
87 is a regular file or block device.  In this mode, \fISOURCE\fR is assumed to be
88 an NTFS volume or volume image, and \fB@IMAGEX_PROGNAME@\fR will capture a WIM
89 image containing the full contents of the NTFS volume, including NTFS-specific
90 data.  This is done using libntfs-3g.
91 .PP
92 Please note that the NTFS volume capture mode is \fInot\fR entered if
93 \fISOURCE\fR is a directory, even if an NTFS filesystem is mounted on
94 \fISOURCE\fR using ntfs-3g.  You must specify the NTFS volume itself (and it
95 must be unmounted, and you must have permission to read from it).
96 .PP
97 The NTFS volume capture mode attempts to capture as much data and metadata as
98 possible, including:
99 .IP \[bu] 4
100 All data streams of all unencrypted files, including the unnamed data stream as
101 well as all named data streams.
102 .IP \[bu]
103 Reparse points, including symbolic links, junction points, and other reparse
104 points.
105 .IP \[bu]
106 File and directory creation, access, and modification timestamps, using the
107 native NTFS resolution of 100 nanoseconds.
108 .IP \[bu]
109 Windows security descriptors, including all components (owner, group, DACL, and
110 SACL).
111 .IP \[bu]
112 DOS/Windows file attribute flags.
113 .IP \[bu]
114 All names of all files, including names in the Win32 namespace, DOS namespace,
115 Win32+DOS namespace, and POSIX namespace.  This includes hard links.
116 .PP
117 However, the main limitations of this NTFS volume capture mode are:
118 .IP \[bu] 4
119 Encrypted files are excluded by default.  Although ntfs-3g can read their data,
120 they need to be stored in the WIM file in a special format that wimlib does not
121 yet support (except on Windows, where wimlib can treat the data as opaque and
122 hand it off to the appropriate API function).
123 .IP \[bu]
124 The sparse attribute on sparse files will be saved, but the data stored will be
125 the full data of the file rather than the "sparse" data.  (The data is, however,
126 subject to the WIM format's compression.)
128 On Windows, \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR
129 natively support Windows-specific and NTFS-specific data.  They therefore act
130 similarly to the corresponding commands of Microsoft's ImageX or DISM.  For best
131 results, the directory being captured should be on an NTFS volume and
132 \fB@IMAGEX_PROGNAME@\fR should be run with Administrator privileges; however,
133 non-NTFS filesystems and running without Administrator privileges are also
134 supported.
135 .PP
136 On Windows, \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR
137 try to archive as much data and metadata as possible, including:
138 .IP \[bu] 4
139 All data streams of all files.
140 .IP \[bu]
141 Reparse points, including symbolic links, junction points, and other reparse
142 points, if supported by the source filesystem.  (Note: see \fB--rpfix\fR and
143 \fB--norpfix\fR for documentation on exactly how absolute symbolic links and
144 junctions are captured.)
145 .IP \[bu]
146 File and directory creation, access, and modification timestamps.  These are
147 stored with Windows NT's native timestamp resolution of 100 nanoseconds.
148 .IP \[bu]
149 Security descriptors, if supported by the source filesystem and \fB--no-acls\fR
150 is not specified.  However, beware that unless \fB--strict-acls\fR is specified,
151 the security descriptors for individual files or directories may be omitted or
152 only partially captured if the user does not have permission to read them, which
153 can be a problem if \fB@IMAGEX_PROGNAME@\fR is run as a non-Administrator.
154 .IP \[bu]
155 File attributes, including hidden, sparse, compressed, encrypted, etc.
156 Encrypted files will be stored in encrypted form rather than in plain text.
157 Transparently compressed files will be read as uncompressed and stored subject
158 to the WIM's own compression.  There is no special handling for storing sparse
159 files, but they are likely to compress to a small size.
160 .IP \[bu]
161 DOS names (8.3) names of files; however, the failure to read them is not
162 considered an error condition.
163 .IP \[bu]
164 Hard links, if supported by the source filesystem.
165 .PP
166 Note: the capture process is reversible, since when \fB@IMAGEX_PROGNAME@
167 apply\fR (on Windows) extracts the captured WIM image, it will extract all of
168 the above information, at least to the extent supported by the destination
169 filesystem.  One exception is that since encrypted files are stored as
170 encrypted, their data will not be available if restored on a Windows system
171 that does not have the decryption key.
172 .PP
173 Pedantic note: since Windows is not fully compatible with its own filesystem
174 (NTFS), on Windows wimlib cannot archive certain files that may exist on a valid
175 NTFS filesystem but are inaccessible to the Windows API, for example two files
176 with names differing only in case in the same directory, or a file whose name
177 contains certain characters considered invalid by Windows.  If you run into
178 problems archiving such files consider using the \fBNTFS VOLUME CAPTURE
179 (UNIX)\fR mode from Linux.
181 .TP 6
182 \fB--boot\fR
183 Specifies that the new image is to be made the bootable image of the WIM archive.
184 .TP
185 \fB--check\fR
186 For \fB@IMAGEX_PROGNAME@ append\fR, before performing the append operation,
187 check the integrity of \fIWIMFILE\fR if an integrity table is present.
188 Furthermore, include an integrity table in the new WIM file
189 (\fB@IMAGEX_PROGNAME@ capture\fR) or the modified WIM file (\fB@IMAGEX_PROGNAME@
190 append\fR).  If this option is not specified, no integrity table is included in
191 a WIM file created with \fB@IMAGEX_PROGNAME@ capture\fR, while a WIM file
192 updated with \fB@IMAGEX_PROGNAME@ append\fR will be written with an integrity
193 table if and only if one was present before.
194 .TP
195 \fB--compress\fR=\fITYPE\fR[:\fILEVEL\fR]
196 Specifies the compression format for the new WIM file.  \fITYPE\fR may be
197 "none", "XPRESS" (alias: "fast"), "LZX" (alias: "maximum"), or "LZMS" (alias:
198 "recovery").  \fITYPE\fR is matched case-insensitively.  The default is "LZX".
199 .IP ""
200 You can optionally also specify an integer compression \fILEVEL\fR.  The
201 compression level specifies how hard the compression algorithm for the specified
202 compression \fITYPE\fR will work to compress the data.  The values are scaled so
203 that 20 is quick compression, 50 is medium compression, and 100 is high
204 compression.  However, you can choose any value, and not just these particular
205 values.  The default is 50.
206 .IP ""
207 Be careful if you choose LZMS compression.  It is not compatible with wimlib
208 before v1.6.0, WIMGAPI before Windows 8, DISM before Windows 8.1, and 7-Zip.
209 .TP
210 \fB--chunk-size\fR=\fISIZE\fR
211 Set the WIM compression chunk size to \fISIZE\fR bytes.  Larger chunks mean larger
212 LZ77 dictionaries and better compression ratios on sufficiently large files, but
213 slower random access.  \fBUsing this option is generally not recommended because
214 of the compatibility limitations detailed in the next paragraph.\fR  But if you
215 decide to use this option regardless, you may choose a chunk size that is
216 allowed by the compression format.  All formats only allow power-of-2 chunk
217 sizes.  For LZX ("maximum") compression the maximum allowed chunk size is 2^21
218 (2097152), for XPRESS ("fast") compression the maximum allowed chunk size is
219 2^16 (65536), and for LZMS ("recovery") compression the maximum allowed chunk
220 size is 2^30 (1073741824).
221 .IP ""
222 Beware that Microsoft's implementation has limited support for non-default chunk
223 sizes.  Depending on the version, their software may refuse to open the WIM, or
224 open it and crash, or open it and report the data is invalid, or even extract
225 the data incorrectly.  In addition, wimlib versions before 1.6.0 do not support
226 alternate chunk sizes.
227 .TP
228 \fB--solid\fR
229 Create a "solid" archive that compresses multiple unique streams ("files")
230 together, rather than each unique stream ("file") independently.  This can
231 result in a significantly better compression ratio, but this format greatly
232 decreases the performance of random access to the data, as may occur on a WIM
233 mounted with \fB@IMAGEX_PROGNAME@ mount\fR.  Also, WIMs created using this
234 option use a different version number in their header and are only compatible
235 with WIMGAPI Windows 8 and later, and DISM Windows 8.1 and later.
236 .IP ""
237 The default compression type and chunk size in solid blocks is LZMS with 2^25
238 (33554432) byte chunks.  This is independent of the WIM's main compression type
239 and chunk size.
240 .TP
241 \fB--solid-chunk-size\fR=\fISIZE\fR
242 Like \fB--chunk-size\fR, but set the chunk size used in solid blocks.  The
243 default is LZMS compression with 2^25 (33554432) byte chunks.  This option only
244 has an effect when \fB--solid\fR is also specified.  For maximum compatibility
245 with the Microsoft implementation, do not use either of these options.
246 .TP
247 \fB--solid-compress\fR=\fITYPE\fR[:\fILEVEL\fR]
248 Like \fB--compress\fR, but set the compression type used in solid blocks.  The
249 default is LZMS compression with 2^25 (33554432) byte chunks.  This option only
250 has an effect when \fB--solid\fR is also specified.  For maximum compatibility
251 with the Microsoft implementation, do not use either of these options.
252 .TP
253 \fB--threads\fR=\fINUM_THREADS\fR
254 Number of threads to use for compressing data.  Default: autodetect (number of
255 available CPUs).
256 .TP
257 \fB--rebuild\fR
258 For \fB@IMAGEX_PROGNAME@ append\fR: rebuild the entire WIM rather than appending the new
259 data to the end of it.  Rebuilding the WIM is slower, but will save a little bit
260 of space that would otherwise be left as a hole in the WIM.  Also see \fB@IMAGEX_PROGNAME@
261 optimize\fR(1).
262 .TP
263 \fB--flags\fR=\fIEDITIONID\fR
264 Specify a string to use in the <FLAGS> element of the XML data for the new
265 image.
266 .TP
267 \fB--dereference\fR
268 (UNIX-like systems only) Follow symbolic links and archive the files they point
269 to, rather than archiving the links themselves.
270 .TP
271 \fB--config\fR=\fIFILE\fR
272 Specifies a configuration file (UTF-8 or UTF-16LE encoded; plain ASCII also
273 works) for capturing the new image.  The configuration file specifies files that
274 are to be treated specially during the image capture.
275 .IP ""
276 The format of the configuration file is INI-style; that is, it is arranged in
277 bracketed sections.  Currently, only the following sections are recognized:
278 .RS
279 .IP \[bu] 4
280 [ExclusionList] ---  contains a list of path globs to exclude from capture.  If
281 a directory is matched, both the directory and its contents are excluded.
282 .IP \[bu]
283 [ExclusionException] --- contains a list of path globs to include in the
284 capture, even when the file or directory also matches a glob in [ExclusionList].
285 .IP \[bu]
286 [PrepopulateList] --- this does not affect capture, but if the image is applied
287 later with \fB--wimboot\fR, these are globs of files that shall be extracted
288 normally, not as WIMBoot "pointer files".  If a directory is matched, all files
289 and subdirectories are also matched recursively.
290 .RE
291 .IP ""
292 Any unrecognized sections will be ignored, with a warning printed.  Sections
293 dealing with compression (e.g. [CompressionExclusion]) are not particularly
294 important.
295 .IP ""
296 Path globs may contain the '*' and '?' meta-characters.  Relative globs (e.g.
297 *.mp3) match against a filename in any directory.  Absolute globs (e.g.
298 /dir/file), are treated as paths starting at the main directory being captured,
299 or the root of the NTFS volume for NTFS volume capture mode.  Do not use drive
300 letters in the paths; they will be ignored.  Path separators may be either
301 forwards slashes or backwards slashes.
302 .IP ""
303 Lines beginning with the '#' or ';' characters are treated as comments and
304 ignored.  Globs with whitespace in them need not be quoted; however, if they
305 are, both double and single quotes are accepted.
306 .IP ""
307 If this option is not specified the following default configuration file is
308 used:
309 .IP ""
310 .RS
311 .RS
312 .nf
313 [ExclusionList]
314 \\$ntfs.log
315 \\hiberfil.sys
316 \\pagefile.sys
317 \\swapfile.sys
318 \\System Volume Information
320 \\Windows\\CSC
321 .RE
322 .RE
323 .fi
324 .IP ""
325 However, special behavior applies if \fB--wimboot\fR is also specified.  By
326 default, with \fB--wimboot\fR specified, the file
327 Windows/System32/WimBootCompress.ini in the directory being captured will be
328 used as the configuration file.  However, this can be overridden using
329 \fB--config\fR; and this also causes the specified configuration file to be
330 saved in the WIM image as Windows/System32/WimBootCompress.ini, overriding any
331 that may be present on the filesystem.
332 .TP
333 \fB--unix-data\fR
334 (UNIX-like systems only) Store the UNIX owner, group, mode, and device ID (major
335 and minor number) of each captured file.  As of wimlib v1.7.0, you can backup
336 and restore not only the standard UNIX file permission information, but also
337 character device nodes, block device nodes, named pipes (FIFOs), and UNIX domain
338 sockets.
339 .IP
340 wimlib stores UNIX data by adding a special tagged metadata item to each
341 directory entry of each file that contains this information.  This extra
342 information is ignored by the Microsoft implementation.  Note: UNIX data stored
343 by wimlib before v1.7.0 used a different format that is no longer supported.  If
344 you have old WIM files with UNIX data, apply them with v1.6.2 and recapture them
345 with v1.7.0 or later.
346 .TP
347 \fB--no-acls\fR
348 Do not capture files' security descriptors.
349 .TP
350 \fB--strict-acls\fR
351 Fail immediately if the full security descriptor of any file cannot be read.  On
352 Windows, the default behavior without this option is to first try omitting the
353 SACL from the security descriptor, then to try omitting the security descriptor
354 entirely.  The purpose of this is to capture as much data as possible without
355 always requiring Administrator privileges.  However, if you desire that all
356 security descriptors be captured exactly, you may wish to provide this option,
357 although the Administrator should have permission to read everything anyway.
358 .TP
359 \fB--rpfix\fR, \fB--norpfix\fR
360 Set whether to fix targets of absolute symbolic links (reparse points in Windows
361 terminology) or not.  When enabled (\fB--rpfix\fR), absolute symbolic links that
362 point inside the directory tree being captured will be adjusted to be absolute
363 relative to the root of the directory tree being captured.  When disabled
364 (\fB--norpfix\fR), absolute symbolic links will be captured exactly as is.
365 .IP ""
366 The default behavior for \fB@IMAGEX_PROGNAME@ capture\fR is equivalent to
367 \fB--rpfix\fR.  The default behavior for \fB@IMAGEX_PROGNAME@ append\fR will be
368 \fB--rpfix\fR if reparse point fixups have previously been done on
369 \fIWIMFILE\fR, otherwise \fB--norpfix\fR.
370 .IP ""
371 In the case of a multi-source capture, (\fB--source-list\fR specified), passing
372 \fB--norpfix\fR is recommended.  Otherwise, reparse point fixups will be
373 disabled on all capture sources destined for non-root locations in the WIM
374 image, while capture sources destined for the WIM root will get the default
375 behavior from the previous paragraph.
376 .TP
377 \fB--source-list\fR
378 \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR support
379 creating a WIM image from multiple separate files or directories.  When
380 \fB--source-list\fR is specified, the \fISOURCE\fR argument specifies the name
381 of a text file, each line of which is either 1 or 2 whitespace separated file
382 paths.  The first file path, the source, specifies the path to a file or
383 directory to capture into the WIM image.  It may be either absolute or relative
384 to the current working directory.  The second file path, if provided, is the
385 target and specifies the path  in the WIM image that this file or directory will
386 be saved as.  Leading and trailing slashes in the target are ignored, except if
387 it consists entirely of slashes (e.g. "/"), which indicates that the directory
388 is to become the root of the WIM image.  If omitted, the target string defaults
389 to the same as the source string.
390 .IP ""
391 An example source list file is as follows:
392 .IP ""
393 .RS
394 .RS
395 .nf
396 # Make the WIM image from the 'winpe' directory
397 winpe   /
399 # Send the 'overlay' directory to '/overlay' in the WIM image
400 overlay /overlay
402 # Overlay a separate directory directly on the root of the WIM image.
403 # This is only legal if there are no conflicting files.
404 /data/stuff     /
405 .RE
406 .RE
407 .fi
408 .IP ""
409 Subdirectories in the WIM are created as needed.  Multiple source directories
410 may share the same target, which implies an overlay; however, an error is issued
411 if the same file appears in different overlays to the same directory.
412 .IP ""
413 File paths containing whitespace may be quoted with either single quotes or
414 double quotes.  Quotes may not be escaped.
415 .IP ""
416 Lines consisting only of whitespace and lines beginning with '#' preceded by
417 optional whitespace are ignored.
418 .IP ""
419 As a special case, if \fISOURCE\fR is "-", the source list is read from standard
420 input rather than an external file.
421 .IP ""
422 The NTFS volume capture mode on UNIX-like systems cannot be used with
423 \fB--source-list\fR, as only capturing a full NTFS volume is supported.
424 .TP
425 \fB--pipable\fR
426 Create a "pipable" WIM, which can be applied fully sequentially, including from
427 a pipe.  An image in the resulting WIM can be applied with \fB@IMAGEX_PROGNAME@
428 apply\fR, either normally by specifying the WIM file name, or with
429 \fB@IMAGEX_PROGNAME@ apply -\fR to read the WIM from standard input.  See
430 \fB@IMAGEX_PROGNAME@ apply\fR(1) for more details.
431 .IP ""
432 For append operations, this option will result in a full rebuild of the WIM to
433 make it pipable.  For capture operations, the captured WIM is simply created as
434 pipable.  Beware that the more images you add to a pipable WIM, the less
435 efficient piping it will be, since more unneeded data will be sent through the
436 pipe.
437 .IP ""
438 When wimlib creates a pipable WIM, it carefully re-arranges the components of
439 the WIM so that they can be read sequentially and also makes several other
440 modifications.  As a result, these "pipable" WIMs are \fInot compatible with
441 Microsoft's software\fR, so keep this in mind if you're going to use them.  If
442 desired, you can use \fB@IMAGEX_PROGNAME@ optimize --not-pipable\fR to re-write
443 a pipable WIM as a regular WIM.  (\fB@IMAGEX_PROGNAME@ export\fR also provides
444 the capability to export images from a pipable WIM into a non-pipable WIM, or
445 vice versa.)
446 .IP ""
447 For the most part, wimlib operates on pipable WIMs transparently.  You can
448 modify them, add or delete images, export images, and even create split pipable
449 WIMs.  The main disadvantages are that appending is (currently) less efficient
450 (\fB--rebuild\fR is always implied), and also they aren't compatible with
451 Microsoft's software.
452 .IP ""
453 \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR can both
454 write a pipable WIM directly to standard output; this is done automatically if
455 \fIWIMFILE\fR is specified as "-".  (In that case, \fB--pipable\fR is assumed.)
456 .TP
457 \fB--not-pipable\fR
458 Ensure the resulting WIM is in the normal, non-pipable WIM format.  This is the
459 default for \fB@IMAGEX_PROGNAME@ capture\fR, except when writing to standard
460 output (\fIWIMFILE\fR specified as "-"), and also for \fB@IMAGEX_PROGNAME@
461 append\fR, except when appending to a WIM that is already pipable.
462 .TP
463 \fB--update-of\fR=[\fIWIMFILE\fR:]\fIIMAGE\fR
464 Declares that the image being captured or appended from \fISOURCE\fR is mostly the same as
465 the existing image \fIIMAGE\fR in \fIWIMFILE\fR, but captured at a later point
466 in time, possibly with some modifications in the intervening time.  This is
467 designed to be used in incremental backups of the same filesystem or directory
468 tree.  \fIIMAGE\fR can be a 1-based index or name of an existing image in
469 \fIWIMFILE\fR.  It can also be a negative integer to index backwards into the
470 images (e.g.  -1 means the last existing image in \fIWIMFILE\fR).
471 .IP ""
472 When this option is provided, the capture or append of the new image will be
473 optimized by not reading files that, based on metadata such as timestamps,
474 appear not to have been modified since they were archived in the existing
475 \fIIMAGE\fR.  Barring manipulation of timestamps, this option only affects
476 performance and does not change the resulting WIM image.
477 .IP ""
478 As shown, the full syntax for the argument to this option is to specify the WIM
479 file, a colon, and the image; for example, "--update-of mywim.wim:1".  However,
480 the WIM file and colon may be omitted, in which case the WIM file will default
481 to the WIM file being appended to for append operations, or the WIM file from
482 which a delta is being taken (only if \fB--delta-from\fR is specified exactly
483 once) for capture operations.
484 .TP
485 \fB--delta-from\fR=\fIWIMFILE\fR
486 For \fB@IMAGEX_PROGNAME@ capture\fR only: capture the new WIM as a "delta" from
487 \fIWIMFILE\fR.  Any streams that would ordinarily need to be archived in the new
488 WIM are omitted if they are already present in the \fIWIMFILE\fR on which the
489 delta is being based.  The new WIM will still contain a full copy of the image
490 metadata, but this is typically only a small fraction of a WIM's total size.
491 .IP ""
492 This option can be specified multiple times, in which case the resulting delta
493 WIM will only contain streams not present in any of the specified base
494 .IP ""
495 To operate on the resulting delta WIM using other commands such as
496 \fB@IMAGEX_PROGNAME@ apply\fR, you must specify the delta WIM as the WIM file to
497 operate on, but also reference the base WIM(s) using the \fB--ref\fR option.
498 Beware: to retain the proper functioning of the delta WIM, you can only add, not
499 delete, files and images to the base WIM(s) following the capture of a delta
500 from it.
501 .IP ""
502 \fB--delta-from\fR may be combined with \fB--update-of\fR to increase the
503 speed of capturing a delta WIM.
504 .IP ""
505 As an example, consider the following backup and restore sequence:
506 .IP ""
507 .RS
508 .nf
509 (initial backup)
511 $ wimcapture /some/directory bkup-base.wim
513 (some days later, create second backup as delta from first)
515 $ wimcapture /some/directory bkup-2013-08-20.dwm \\
516         --update-of bkup-base.wim:-1 --delta-from bkup-base.wim
518 (restoring the second backup)
520 $ wimapply bkup-2013-08-20.dwm --ref=bkup-base.wim 1 \\
521         /some/directory
522 .RE
523 .fi
524 .IP ""
525 However, note that as an alternative to the above sequence that used a delta
526 WIM, the second backup could have simply been appended to the WIM as new image
527 using \fB@IMAGEX_PROGNAME@ append\fR.  Delta WIMs should be used only if it's
528 desired to base the backups or images on a separate, large file that is rarely
529 modified.
530 .IP ""
531 Note: unlike "pipable" WIMs (created with the \fB--pipable\fR option), "delta"
532 WIMs (created with the \fB--delta-from\fR option) are compatible with
533 Microsoft's software.  For example, you can use the /ref option of ImageX to
534 reference the base WIM(s), similar to above.
535 .IP ""
536 Additional note:  \fB@IMAGEX_PROGNAME@\fR is generalized enough that you can in
537 fact combine \fB--pipable\fR and \fB--delta-from\fR to create pipable delta
538 WIMs.  In such cases, the base WIM(s) must be captured as pipable as well as the
539 delta WIM, and when applying an image, the base WIM(s) must be sent over the
540 pipe after the delta WIM.
541 .TP
542 \fB--wimboot\fR
543 Mark the image as WIMBoot-compatible.  See Microsoft's
544 documentation for more information about WIMBoot.  This option will, by default,
545 change the compression type to XPRESS and the chunk size to 4096 bytes; these
546 can, however, still be overridden through the \fB--compress\fR and
547 \fB--chunk-size\fR parameters, respectively.  In addition, this option will, by
548 default, set the configuration file to
549 \fISOURCE\fR\\Windows\\System32\\WimBootCompress.ini if present and accessible;
550 however, this may still be overridden through the \fB--config\fR parameter.
552 \fB@IMAGEX_PROGNAME@ append\fR does not support appending an image to a split WIM.
553 .PP
554 It is safe to abort an \fB@IMAGEX_PROGNAME@ append\fR command partway through;
555 however, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
556 optimize\fR to remove any data that was appended to the physical WIM file but
557 not yet incorporated into the structure of the WIM, unless the WIM was being
558 fully rebuilt (e.g. with \fB--rebuild\fR), in which case you should delete the
559 temporary file left over.
560 .PP
561 \fB@IMAGEX_PROGNAME@\fR creates WIMs compatible with Microsoft's software
562 (WIMGAPI, ImageX, DISM), with some caveats:
563 .IP \[bu] 4
564 With \fB@IMAGEX_PROGNAME@\fR on UNIX-like systems, it is possible to create a
565 WIM image containing files with names differing only in case, or files with
566 names containing the characters ':', '*', '?', '"', '<', '>', '|', or '\\',
567 which are valid on POSIX-compliant filesystems but not Windows.  Be warned that
568 such files will not be extracted by default by the Windows version of
569 \fB@IMAGEX_PROGNAME@\fR, and (even worse) Microsoft's ImageX can be confused by
570 such names and quit extracting the image partway through.  (It perhaps is worth
571 pointing out that Windows' own default filesystem, NTFS, supports these
572 characters, although Windows does not!)
573 .IP \[bu]
574 Pipable WIMs are incompatible with Microsoft's software.  Pipable WIMs are
575 created only if \fIWIMFILE\fR was specified as "-" (standard output) or if
576 the \fB--pipable\fR flag was specified.
577 .IP \[bu]
578 WIMs captured with a non-default chunk size (with the \fB--chunk-size\fR option)
579 or as solid archives (with the \fB--solid\fR option) or with LZMS
580 compression (with \fB--compress\fR=LZMS or \fB--compress\fR=recovery) have
581 varying levels of compatibility with Microsoft's software.  Generally, more
582 recent versions of Microsoft's software are more compatible.
584 First example:  Create a new WIM 'mywim.wim' with "maximum" (LZX) compression
585 that will contain a captured image of the directory tree 'somedir'.  Note that
586 the image name need not be specified and will default to 'somedir':
587 .RS
588 .PP
589 @IMAGEX_PROGNAME@ capture somedir mywim.wim --compress=maximum
590 .RE
591 .PP
592 or, if the \fBwimcapture\fR hard link or batch file has been installed, the
593 abbreviated form can be used:
594 .RS
595 .PP
596 wimcapture somedir mywim.wim --compress=maximum
597 .RE
598 .PP
599 The remaining examples will use the long form, however.  Next, append the image
600 of a different directory tree to the WIM created above:
601 .RS
602 .PP
603 @IMAGEX_PROGNAME@ append anotherdir mywim.wim
604 .RE
605 .PP
606 Easy enough, and the above examples of imaging directory trees work on both
607 UNIX-like systems and Windows.  Next, capture a WIM with several non-default
608 options, including "fast" (XPRESS) compression, an integrity table, no messing
609 with absolute symbolic links, and an image name and description:
610 .RS
611 .PP
612 @IMAGEX_PROGNAME@ capture somedir mywim.wim --compress=fast \\
613 .RS
614 --check --norpfix "Some Name" "Some Description"
615 .RE
616 .RE
617 .PP
618 Capture an entire NTFS volume into a new WIM file and name the image "Windows
619 7".  On UNIX-like systems, this requires using the special mode described in
620 \fBNTFS VOLUME CAPTURE (UNIX)\fR where \fISOURCE\fR is a file or block device
621 containing an NTFS filesystem:
622 .RS
623 .PP
624 @IMAGEX_PROGNAME@ capture /dev/sda2 windows7.wim "Windows 7"
625 .RE
626 .PP
627 or, on Windows, to capture a full NTFS volume you instead need to specify the
628 root directory of the mounted volume, for example:
629 .RS
630 .PP
631 @IMAGEX_PROGNAME@ capture E:\\ windows7.wim "Windows 7"
632 .RE
633 .PP
634 Same as above example with capturing an NTFS volume from \fB@IMAGEX_PROGNAME@\fR
635 running on a UNIX-like system, but capture the WIM in the wimlib-specific
636 "pipable" format that can be piped to \fB@IMAGEX_PROGNAME@ apply\fR:
637 .RS
638 .PP
639 @IMAGEX_PROGNAME@ capture /dev/sda2 windows7.wim "Windows 7" \\
640 .br
641 .RS
642 --pipable
643 .RE
644 .RE
645 .PP
646 Same as above, but instead of writing the pipable WIM to the file
647 "windows7.wim", write it directly to standard output through a pipe into some
648 other program "someprog", which could, for example, be a program or script that
649 streams the data to a server.  Note that \fB--pipable\fR need not be explicitly
650 specified when using standard output as the WIM "file":
651 .RS
652 .PP
653 @IMAGEX_PROGNAME@ capture /dev/sda2 - "Windows 7" | someprog
654 .RE
657 .BR @IMAGEX_PROGNAME@-apply (1)