Update NEWS, README, and docs
[wimlib] / doc / man1 / wimlib-imagex-capture.1
1 .TH WIMLIB-IMAGEX "1" "January 2015" "wimlib 1.7.4" "User Commands"
2 .SH NAME
3 wimlib-imagex-capture, wimlib-imagex-append \- Create or append a WIM image
4 .SH SYNOPSIS
5 \fBwimlib-imagex capture\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR \
6 [\fIIMAGE_DESCRIPTION\fR]] [\fIOPTION\fR...]
7 .br
8 \fBwimlib-imagex append\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR \
9 [\fIIMAGE_DESCRIPTION\fR]] [\fIOPTION\fR...]
10 .SH DESCRIPTION
11 The \fBwimlib-imagex capture\fR and \fBwimlib-imagex append\fR commands
12 create a Windows Imaging (WIM) image from a directory tree.  The
13 \fBwimlib-imagex capture\fR command creates a new WIM file containing the
14 captured image, while the \fBwimlib-imagex 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
26 directory (see \fBDIRECTORY CAPTURE (UNIX)\fR or \fBDIRECTORY CAPTURE
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.
47 .SH DIRECTORY CAPTURE (UNIX)
48 This section documents how \fBwimlib-imagex\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 \fBwimlib-imagex 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.
82 .SH NTFS VOLUME CAPTURE (UNIX)
83 This section documents how \fBwimlib-imagex\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 \fBwimlib-imagex\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.)
127 .SH DIRECTORY CAPTURE (WINDOWS)
128 On Windows, \fBwimlib-imagex capture\fR and \fBwimlib-imagex 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 \fBwimlib-imagex\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, \fBwimlib-imagex capture\fR and \fBwimlib-imagex 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 \fBwimlib-imagex\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 \fBwimlib-imagex
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.
180 .SH OPTIONS
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 \fBwimlib-imagex 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 (\fBwimlib-imagex capture\fR) or the modified WIM file (\fBwimlib-imagex
190 append\fR).  If this option is not specified, no integrity table is included in
191 a WIM file created with \fBwimlib-imagex capture\fR, while a WIM file
192 updated with \fBwimlib-imagex 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 .IP ""
210 Also note that choosing LZMS compression does not automatically imply solid-mode
211 compression, as it does with DISM.  Use \fB--solid\fR if you want to create a
212 solid WIM, or "ESD file".
213 .TP
214 \fB--chunk-size\fR=\fISIZE\fR
215 Set the compression chunk size to \fISIZE\fR bytes.  A larger compression chunk
216 size results in a better compression ratio.  wimlib supports different chunk
217 sizes depending on the compression type:
218 .RS
219 .IP \[bu] 2
220 XPRESS: 4K, 8K, 16K, 32K, 64K
221 .IP \[bu]
222 LZX: 32K, 64K, 128K, 256K, 512K, 1M, 2M
223 .IP \[bu]
224 LZMS: 32K, 64K, 128K, 256K, 512K, 1M, 2M, 4M, 8M, 16M, 32M, 64M, 128M, 256M, 512M, 1G
225 .RE
226 .IP ""
227 You can provide the full number (e.g. 32768), or you can use one of the K, M, or
228 G suffixes.  KiB, MiB, and GiB are also accepted.
229 .IP ""
230 This option only affects the chunk size used for non-solid WIM resources.  If
231 you are creating a solid WIM (using the \fB--solid\fR option), then you probably
232 want \fB--solid-chunk-size\fR instead.
233 .IP ""
234 Use this option with caution if compatibility with Microsoft's implementation is
235 desired, since their implementation has limited support for non-default chunk
236 sizes.
237 .TP
238 \fB--solid\fR
239 Create a "solid" WIM file that compresses files together rather than
240 independently.  This results in a significantly better compression ratio, but it
241 comes at the cost of various tradeoffs, including: slow compression with very
242 high memory usage; slow random access to the resulting WIM file; and reduced
243 compatibility.
244 .IP ""
245 Compatibility-wise, the first version of Microsoft's WIMGAPI to support solid
246 WIM files was released with Windows 8, and the first version of DISM to do so
247 was released with Windows 8.1.
248 .IP ""
249 If you want to create an "ESD" file, then use this option.  An (unencrypted)
250 "ESD" file is a solid WIM file.
251 .IP ""
252 By default, this option has an effect equivalent to DISM's option
253 \fB/compress:recovery\fR.  The options for wimlib-imagex are different because
254 they try not to conflate the compression type (e.g. LZX or LZMS) with solid-mode
255 compression, as these are two different things.
256 .TP
257 \fB--solid-chunk-size\fR=\fISIZE\fR
258 Like \fB--chunk-size\fR, but set the chunk size used in solid resources.  The
259 default, assuming LZMS compression, is 64MiB (67108864); this requires about
260 640MiB of memory per thread.  This option only has an effect when \fB--solid\fR
261 is also specified.  For maximum compatibility with the Microsoft implementation,
262 do not use this option.
263 .TP
264 \fB--solid-compress\fR=\fITYPE\fR[:\fILEVEL\fR]
265 Like \fB--compress\fR, but set the compression type used in solid resources.
266 The default is LZMS compression.  This option only has an effect when
267 \fB--solid\fR is also specified.  For maximum compatibility with the Microsoft
268 implementation, do not use this option.
269 .TP
270 \fB--threads\fR=\fINUM_THREADS\fR
271 Number of threads to use for compressing data.  Default: autodetect (number of
272 available CPUs).
273 .TP
274 \fB--rebuild\fR
275 For \fBwimlib-imagex append\fR: rebuild the entire WIM rather than appending the new
276 data to the end of it.  Rebuilding the WIM is slower, but will save a little bit
277 of space that would otherwise be left as a hole in the WIM.  Also see \fBwimlib-imagex
278 optimize\fR(1).
279 .TP
280 \fB--flags\fR=\fIEDITIONID\fR
281 Specify a string to use in the <FLAGS> element of the XML data for the new
282 image.
283 .TP
284 \fB--dereference\fR
285 (UNIX-like systems only) Follow symbolic links and archive the files they point
286 to, rather than archiving the links themselves.
287 .TP
288 \fB--config\fR=\fIFILE\fR
289 Specifies a configuration file (UTF-8 or UTF-16LE encoded; plain ASCII also
290 works) for capturing the new image.  The configuration file specifies files that
291 are to be treated specially during the image capture.
292 .IP ""
293 The format of the configuration file is INI-style; that is, it is arranged in
294 bracketed sections.  Currently, only the following sections are recognized:
295 .RS
296 .IP \[bu] 4
297 [ExclusionList] ---  contains a list of path globs to exclude from capture.  If
298 a directory is matched, both the directory and its contents are excluded.
299 .IP \[bu]
300 [ExclusionException] --- contains a list of path globs to include in the
301 capture, even when the file or directory also matches a glob in [ExclusionList].
302 .IP \[bu]
303 [PrepopulateList] --- this does not affect capture, but if the image is applied
304 later with \fB--wimboot\fR, these are globs of files that shall be extracted
305 normally, not as WIMBoot "pointer files".  If a directory is matched, all files
306 and subdirectories are also matched recursively.
307 .RE
308 .IP ""
309 Any unrecognized sections will be ignored, with a warning printed.  Sections
310 dealing with compression (e.g. [CompressionExclusion]) are not particularly
311 important.
312 .IP ""
313 Path globs may contain the '*' and '?' meta-characters.  Relative globs (e.g.
314 *.mp3) match against a filename in any directory.  Absolute globs (e.g.
315 /dir/file), are treated as paths starting at the main directory being captured,
316 or the root of the NTFS volume for NTFS volume capture mode.  Do not use drive
317 letters in the paths; they will be ignored.  Path separators may be either
318 forwards slashes or backwards slashes.
319 .IP ""
320 Lines beginning with the '#' or ';' characters are treated as comments and
321 ignored.  Globs with whitespace in them need not be quoted; however, if they
322 are, both double and single quotes are accepted.
323 .IP ""
324 If this option is not specified the following default configuration file is
325 used:
326 .IP ""
327 .RS
328 .RS
329 .nf
330 [ExclusionList]
331 \\$ntfs.log
332 \\hiberfil.sys
333 \\pagefile.sys
334 \\swapfile.sys
335 \\System Volume Information
336 \\RECYCLER
337 \\Windows\\CSC
338 .RE
339 .RE
340 .fi
341 .IP ""
342 However, special behavior applies if \fB--wimboot\fR is also specified.  By
343 default, with \fB--wimboot\fR specified, the file
344 Windows/System32/WimBootCompress.ini in the directory being captured will be
345 used as the configuration file.  However, this can be overridden using
346 \fB--config\fR; and this also causes the specified configuration file to be
347 saved in the WIM image as Windows/System32/WimBootCompress.ini, overriding any
348 that may be present on the filesystem.
349 .TP
350 \fB--unix-data\fR
351 (UNIX-like systems only) Store the UNIX owner, group, mode, and device ID (major
352 and minor number) of each captured file.  As of wimlib v1.7.0, you can backup
353 and restore not only the standard UNIX file permission information, but also
354 character device nodes, block device nodes, named pipes (FIFOs), and UNIX domain
355 sockets.
356 .IP
357 wimlib stores UNIX data by adding a special tagged metadata item to each
358 directory entry of each file that contains this information.  This extra
359 information is ignored by the Microsoft implementation.  Note: UNIX data stored
360 by wimlib before v1.7.0 used a different format that is no longer supported.  If
361 you have old WIM files with UNIX data, apply them with v1.6.2 and recapture them
362 with v1.7.0 or later.
363 .TP
364 \fB--no-acls\fR
365 Do not capture files' security descriptors.
366 .TP
367 \fB--strict-acls\fR
368 Fail immediately if the full security descriptor of any file cannot be read.  On
369 Windows, the default behavior without this option is to first try omitting the
370 SACL from the security descriptor, then to try omitting the security descriptor
371 entirely.  The purpose of this is to capture as much data as possible without
372 always requiring Administrator privileges.  However, if you desire that all
373 security descriptors be captured exactly, you may wish to provide this option,
374 although the Administrator should have permission to read everything anyway.
375 .TP
376 \fB--rpfix\fR, \fB--norpfix\fR
377 Set whether to fix targets of absolute symbolic links (reparse points in Windows
378 terminology) or not.  When enabled (\fB--rpfix\fR), absolute symbolic links that
379 point inside the directory tree being captured will be adjusted to be absolute
380 relative to the root of the directory tree being captured.  When disabled
381 (\fB--norpfix\fR), absolute symbolic links will be captured exactly as is.
382 .IP ""
383 The default behavior for \fBwimlib-imagex capture\fR is equivalent to
384 \fB--rpfix\fR.  The default behavior for \fBwimlib-imagex append\fR will be
385 \fB--rpfix\fR if reparse point fixups have previously been done on
386 \fIWIMFILE\fR, otherwise \fB--norpfix\fR.
387 .IP ""
388 In the case of a multi-source capture, (\fB--source-list\fR specified), passing
389 \fB--norpfix\fR is recommended.  Otherwise, reparse point fixups will be
390 disabled on all capture sources destined for non-root locations in the WIM
391 image, while capture sources destined for the WIM root will get the default
392 behavior from the previous paragraph.
393 .TP
394 \fB--source-list\fR
395 \fBwimlib-imagex capture\fR and \fBwimlib-imagex append\fR support
396 creating a WIM image from multiple separate files or directories.  When
397 \fB--source-list\fR is specified, the \fISOURCE\fR argument specifies the name
398 of a text file, each line of which is either 1 or 2 whitespace separated file
399 paths.  The first file path, the source, specifies the path to a file or
400 directory to capture into the WIM image.  It may be either absolute or relative
401 to the current working directory.  The second file path, if provided, is the
402 target and specifies the path  in the WIM image that this file or directory will
403 be saved as.  Leading and trailing slashes in the target are ignored, except if
404 it consists entirely of slashes (e.g. "/"), which indicates that the directory
405 is to become the root of the WIM image.  If omitted, the target string defaults
406 to the same as the source string.
407 .IP ""
408 An example source list file is as follows:
409 .IP ""
410 .RS
411 .RS
412 .nf
413 # Make the WIM image from the 'winpe' directory
414 winpe   /
415
416 # Send the 'overlay' directory to '/overlay' in the WIM image
417 overlay /overlay
418
419 # Overlay a separate directory directly on the root of the WIM image.
420 /data/stuff     /
421 .RE
422 .RE
423 .fi
424 .IP ""
425 Subdirectories in the WIM are created as needed.  Multiple source directories
426 may share the same target, which implies an overlay.  In the event that this
427 results a nondirectory file being added to the WIM image multiple times, the
428 last version (as listed in the source list file) overrides any earlier version.
429 .IP ""
430 File paths containing whitespace may be quoted with either single quotes or
431 double quotes.  Quotes may not be escaped.
432 .IP ""
433 Lines consisting only of whitespace and lines beginning with '#' preceded by
434 optional whitespace are ignored.
435 .IP ""
436 As a special case, if \fISOURCE\fR is "-", the source list is read from standard
437 input rather than an external file.
438 .IP ""
439 The NTFS volume capture mode on UNIX-like systems cannot be used with
440 \fB--source-list\fR, as only capturing a full NTFS volume is supported.
441 .TP
442 \fB--pipable\fR
443 Create a "pipable" WIM, which can be applied fully sequentially, including from
444 a pipe.  An image in the resulting WIM can be applied with \fBwimlib-imagex
445 apply\fR, either normally by specifying the WIM file name, or with
446 \fBwimlib-imagex apply -\fR to read the WIM from standard input.  See
447 \fBwimlib-imagex apply\fR(1) for more details.
448 .IP ""
449 For append operations, this option will result in a full rebuild of the WIM to
450 make it pipable.  For capture operations, the captured WIM is simply created as
451 pipable.  Beware that the more images you add to a pipable WIM, the less
452 efficient piping it will be, since more unneeded data will be sent through the
453 pipe.
454 .IP ""
455 When wimlib creates a pipable WIM, it carefully re-arranges the components of
456 the WIM so that they can be read sequentially and also makes several other
457 modifications.  As a result, these "pipable" WIMs are \fInot compatible with
458 Microsoft's software\fR, so keep this in mind if you're going to use them.  If
459 desired, you can use \fBwimlib-imagex optimize --not-pipable\fR to re-write
460 a pipable WIM as a regular WIM.  (\fBwimlib-imagex export\fR also provides
461 the capability to export images from a pipable WIM into a non-pipable WIM, or
462 vice versa.)
463 .IP ""
464 For the most part, wimlib operates on pipable WIMs transparently.  You can
465 modify them, add or delete images, export images, and even create split pipable
466 WIMs.  The main disadvantages are that appending is (currently) less efficient
467 (\fB--rebuild\fR is always implied), and also they aren't compatible with
468 Microsoft's software.
469 .IP ""
470 \fBwimlib-imagex capture\fR and \fBwimlib-imagex append\fR can both
471 write a pipable WIM directly to standard output; this is done automatically if
472 \fIWIMFILE\fR is specified as "-".  (In that case, \fB--pipable\fR is assumed.)
473 .TP
474 \fB--not-pipable\fR
475 Ensure the resulting WIM is in the normal, non-pipable WIM format.  This is the
476 default for \fBwimlib-imagex capture\fR, except when writing to standard
477 output (\fIWIMFILE\fR specified as "-"), and also for \fBwimlib-imagex
478 append\fR, except when appending to a WIM that is already pipable.
479 .TP
480 \fB--update-of\fR=[\fIWIMFILE\fR:]\fIIMAGE\fR
481 Declares that the image being captured or appended from \fISOURCE\fR is mostly the same as
482 the existing image \fIIMAGE\fR in \fIWIMFILE\fR, but captured at a later point
483 in time, possibly with some modifications in the intervening time.  This is
484 designed to be used in incremental backups of the same filesystem or directory
485 tree.  \fIIMAGE\fR can be a 1-based index or name of an existing image in
486 \fIWIMFILE\fR.  It can also be a negative integer to index backwards into the
487 images (e.g.  -1 means the last existing image in \fIWIMFILE\fR).
488 .IP ""
489 When this option is provided, the capture or append of the new image will be
490 optimized by not reading files that, based on metadata such as timestamps,
491 appear not to have been modified since they were archived in the existing
492 \fIIMAGE\fR.  Barring manipulation of timestamps, this option only affects
493 performance and does not change the resulting WIM image.
494 .IP ""
495 As shown, the full syntax for the argument to this option is to specify the WIM
496 file, a colon, and the image; for example, "--update-of mywim.wim:1".  However,
497 the WIM file and colon may be omitted, in which case the WIM file will default
498 to the WIM file being appended to for append operations, or the WIM file from
499 which a delta is being taken (only if \fB--delta-from\fR is specified exactly
500 once) for capture operations.
501 .TP
502 \fB--delta-from\fR=\fIWIMFILE\fR
503 For \fBwimlib-imagex capture\fR only: capture the new WIM as a "delta" from
504 \fIWIMFILE\fR.  Any streams that would ordinarily need to be archived in the new
505 WIM are omitted if they are already present in the \fIWIMFILE\fR on which the
506 delta is being based.  The new WIM will still contain a full copy of the image
507 metadata, but this is typically only a small fraction of a WIM's total size.
508 .IP ""
509 This option can be specified multiple times, in which case the resulting delta
510 WIM will only contain streams not present in any of the specified base WIMs.
511 .IP ""
512 To operate on the resulting delta WIM using other commands such as
513 \fBwimlib-imagex apply\fR, you must specify the delta WIM as the WIM file to
514 operate on, but also reference the base WIM(s) using the \fB--ref\fR option.
515 Beware: to retain the proper functioning of the delta WIM, you can only add, not
516 delete, files and images to the base WIM(s) following the capture of a delta
517 from it.
518 .IP ""
519 \fB--delta-from\fR may be combined with \fB--update-of\fR to increase the
520 speed of capturing a delta WIM.
521 .IP ""
522 As an example, consider the following backup and restore sequence:
523 .IP ""
524 .RS
525 .nf
526 (initial backup)
527
528 $ wimcapture /some/directory bkup-base.wim
529
530 (some days later, create second backup as delta from first)
531
532 $ wimcapture /some/directory bkup-2013-08-20.dwm \\
533         --update-of bkup-base.wim:-1 --delta-from bkup-base.wim
534
535 (restoring the second backup)
536
537 $ wimapply bkup-2013-08-20.dwm --ref=bkup-base.wim 1 \\
538         /some/directory
539 .RE
540 .fi
541 .IP ""
542 However, note that as an alternative to the above sequence that used a delta
543 WIM, the second backup could have simply been appended to the WIM as new image
544 using \fBwimlib-imagex append\fR.  Delta WIMs should be used only if it's
545 desired to base the backups or images on a separate, large file that is rarely
546 modified.
547 .IP ""
548 Note: unlike "pipable" WIMs (created with the \fB--pipable\fR option), "delta"
549 WIMs (created with the \fB--delta-from\fR option) are compatible with
550 Microsoft's software.  For example, you can use the /ref option of ImageX to
551 reference the base WIM(s), similar to above.
552 .IP ""
553 Additional note:  \fBwimlib-imagex\fR is generalized enough that you can in
554 fact combine \fB--pipable\fR and \fB--delta-from\fR to create pipable delta
555 WIMs.  In such cases, the base WIM(s) must be captured as pipable as well as the
556 delta WIM, and when applying an image, the base WIM(s) must be sent over the
557 pipe after the delta WIM.
558 .TP
559 \fB--wimboot\fR
560 Mark the image as WIMBoot-compatible.  See Microsoft's
561 documentation for more information about WIMBoot.  This option will, by default,
562 set the compression type to XPRESS and the chunk size to 4096 bytes; these
563 can, however, still be overridden through the \fB--compress\fR and
564 \fB--chunk-size\fR parameters, respectively.  In addition, this option will, by
565 default, set the configuration file to
566 \fISOURCE\fR\\Windows\\System32\\WimBootCompress.ini if present and accessible;
567 however, this may still be overridden through the \fB--config\fR parameter.
568 .SH NOTES
569 \fBwimlib-imagex append\fR does not support appending an image to a split WIM.
570 .PP
571 It is safe to abort an \fBwimlib-imagex append\fR command partway through;
572 however, after doing this, it is recommended to run \fBwimlib-imagex
573 optimize\fR to remove any data that was appended to the physical WIM file but
574 not yet incorporated into the structure of the WIM, unless the WIM was being
575 fully rebuilt (e.g. with \fB--rebuild\fR), in which case you should delete the
576 temporary file left over.
577 .PP
578 \fBwimlib-imagex\fR creates WIMs compatible with Microsoft's software
579 (WIMGAPI, ImageX, DISM), with some caveats:
580 .IP \[bu] 4
581 With \fBwimlib-imagex\fR on UNIX-like systems, it is possible to create a
582 WIM image containing files with names differing only in case, or files with
583 names containing the characters ':', '*', '?', '"', '<', '>', '|', or '\\',
584 which are valid on POSIX-compliant filesystems but not Windows.  Be warned that
585 such files will not be extracted by default by the Windows version of
586 \fBwimlib-imagex\fR, and (even worse) Microsoft's ImageX can be confused by
587 such names and quit extracting the image partway through.  (It perhaps is worth
588 pointing out that Windows' own default filesystem, NTFS, supports these
589 characters, although Windows does not!)
590 .IP \[bu]
591 Pipable WIMs are incompatible with Microsoft's software.  Pipable WIMs are
592 created only if \fIWIMFILE\fR was specified as "-" (standard output) or if
593 the \fB--pipable\fR flag was specified.
594 .IP \[bu]
595 WIMs captured with a non-default chunk size (with the \fB--chunk-size\fR option)
596 or as solid archives (with the \fB--solid\fR option) or with LZMS
597 compression (with \fB--compress\fR=LZMS or \fB--compress\fR=recovery) have
598 varying levels of compatibility with Microsoft's software.  Generally, more
599 recent versions of Microsoft's software are more compatible.
600 .SH EXAMPLES
601 First example:  Create a new WIM 'mywim.wim' with LZX ("maximum") compression
602 that will contain a captured image of the directory tree 'somedir'.  Note that
603 the image name need not be specified and will default to 'somedir':
604 .RS
605 .PP
606 wimlib-imagex capture somedir mywim.wim
607 .RE
608 .PP
609 or, if the \fBwimcapture\fR hard link or batch file has been installed, the
610 abbreviated form can be used:
611 .RS
612 .PP
613 wimcapture somedir mywim.wim
614 .RE
615 .PP
616 The remaining examples will use the long form, however.  Next, append the image
617 of a different directory tree to the WIM created above:
618 .RS
619 .PP
620 wimlib-imagex append anotherdir mywim.wim
621 .RE
622 .PP
623 Easy enough, and the above examples of imaging directory trees work on both
624 UNIX-like systems and Windows.  Next, capture a WIM with several non-default
625 options, including XPRESS ("fast") compression, an integrity table, no messing
626 with absolute symbolic links, and an image name and description:
627 .RS
628 .PP
629 wimlib-imagex capture somedir mywim.wim --compress=fast \\
630 .RS
631 --check --norpfix "Some Name" "Some Description"
632 .RE
633 .RE
634 .PP
635 Capture an entire NTFS volume into a new WIM file and name the image "Windows
636 7".  On UNIX-like systems, this requires using the special mode described in
637 \fBNTFS VOLUME CAPTURE (UNIX)\fR where \fISOURCE\fR is a file or block device
638 containing an NTFS filesystem:
639 .RS
640 .PP
641 wimlib-imagex capture /dev/sda2 windows7.wim "Windows 7"
642 .RE
643 .PP
644 or, on Windows, to capture a full NTFS volume you instead need to specify the
645 root directory of the mounted volume, for example:
646 .RS
647 .PP
648 wimlib-imagex capture E:\\ windows7.wim "Windows 7"
649 .RE
650 .PP
651 Same as above example with capturing an NTFS volume from \fBwimlib-imagex\fR
652 running on a UNIX-like system, but capture the WIM in the wimlib-specific
653 "pipable" format that can be piped to \fBwimlib-imagex apply\fR:
654 .RS
655 .PP
656 wimlib-imagex capture /dev/sda2 windows7.wim "Windows 7" \\
657 .br
658 .RS
659 --pipable
660 .RE
661 .RE
662 .PP
663 Same as above, but instead of writing the pipable WIM to the file
664 "windows7.wim", write it directly to standard output through a pipe into some
665 other program "someprog", which could, for example, be a program or script that
666 streams the data to a server.  Note that \fB--pipable\fR need not be explicitly
667 specified when using standard output as the WIM "file":
668 .RS
669 .PP
670 wimlib-imagex capture /dev/sda2 - "Windows 7" | someprog
671 .RE
672 .SH SEE ALSO
673 .BR wimlib-imagex (1),
674 .BR wimlib-imagex-apply (1)