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