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