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