]> wimlib.net Git - wimlib/blob - doc/imagex-split.1.in
Update version to 1.4.2
[wimlib] / doc / imagex-split.1.in
1 .TH IMAGEX "1" "June 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
2 .SH NAME
3 @IMAGEX_PROGNAME@-split \- Split a WIM into multiple parts
4 .SH SYNOPSIS
5 \fB@IMAGEX_PROGNAME@ split\fR \fIWIMFILE\fR \fISPLIT_WIMFILE\fR \fIPART_SIZE\fR [\fIOPTION...\fR]
6 .SH DESCRIPTION
7 Splits \fIWIMFILE\fR into parts with size at most \fIPART_SIZE\fR mebibytes,
8 with the first part having the name \fISPLIT_WIMFILE\fR and the other parts
9 having names numbered in order of the parts.
10 .SH OPTIONS
11 .TP 6
12 \fB--check\fR
13 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
14 present; additionally, when writing each \fISPLIT_WIMFILE\fR, write an integrity
15 table.  If this option is not specified, no integrity tables are included in the
16 split WIM files, even if there was one in the original WIM.
17 .SH EXAMPLES
18 Splits the WIM 'windows.wim' into 'windows.swm', 'windows2.swm', 'windows3.swm',
19 etc. where each part is at most 100 MiB:
20 .RS
21 .PP
22 @IMAGEX_PROGNAME@ split windows.wim windows.swm 100
23 .RE
24 .SH LIMITATIONS
25 It it possible for the size of the parts to exceed the \fIPART_SIZE\fR given.
26 This is impossible to avoid and Microsoft's program has this problem as well
27 because the WIM file format provides no way to divide a single file resource in
28 the WIM among multiple split WIM parts.  So if you, for example, have a file
29 inside the WIM that is 100 MiB, then an uncompressed split WIM will have at
30 least one part that is 100 MiB in size to contain that file.  However, if the
31 WIM resources are compressed then less space would be needed.
32 .SH SEE ALSO
33 .BR @IMAGEX_PROGNAME@ (1)