]> wimlib.net Git - wimlib/blob - doc/imagex-split.1.in
Merge branch with pipable WIM support
[wimlib] / doc / imagex-split.1.in
1 .TH IMAGEX "1" "August 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_WIM_PART\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_WIM_PART\fR and the other parts
9 having names numbered in order of the parts.
10 .PP
11 \fB@IMAGEX_PROGNAME@ split\fR can split both non-pipable and pipable WIMs.
12 .SH OPTIONS
13 .TP 6
14 \fB--check\fR
15 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
16 present; additionally, when writing each \fISPLIT_WIM_PART\fR, write an integrity
17 table.  If this option is not specified, integrity tables will be included in
18 the split WIMs if and only if one was present in \fIWIMFILE\fR.
19 .SH EXAMPLES
20 Splits the WIM 'windows.wim' into 'windows.swm', 'windows2.swm', 'windows3.swm',
21 etc. where each part is at most 100 MiB:
22 .RS
23 .PP
24 @IMAGEX_PROGNAME@ split windows.wim windows.swm 100
25 .RE
26 .SH LIMITATIONS
27 It it possible for the size of the parts to exceed the \fIPART_SIZE\fR given.
28 This is impossible to avoid and Microsoft's program has this problem as well
29 because the WIM file format provides no way to divide a single file resource in
30 the WIM among multiple split WIM parts.  So if you, for example, have a file
31 inside the WIM that is 100 MiB, then an uncompressed split WIM will have at
32 least one part that is 100 MiB in size to contain that file.  However, if the
33 WIM resources are compressed then less space would be needed.
34 .SH SEE ALSO
35 .BR @IMAGEX_PROGNAME@ (1)