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