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