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