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