wimlib-imagex: add options to enable unsafe compaction
[wimlib] / doc / man1 / wimlib-imagex-verify.1
1 .TH WIMLIB-IMAGEX "1" "August 2015" "wimlib 1.8.2" "User Commands"
2 .SH NAME
3 wimlib-imagex-verify \- Verify a WIM file
4 .SH SYNOPSIS
5 \fBwimlib-imagex verify\fR \fIWIMFILE\fR [\fIOPTION\fR...]
6 .SH DESCRIPTION
7 \fBwimlib-imagex verify\fR checks the validity of the specified WIM archive.
8 This command is also available as simply \fBwimverify\fR if the appropriate hard
9 link or batch file has been installed.
10 .PP
11 Specifically, this command performs the following verifications on the WIM
12 archive:
13 .IP \[bu] 4
14 Verify that the WIM file can be successfully opened, which involves parsing the
15 header, blob table, and XML data.
16 .IP \[bu]
17 If the WIM archive contains an integrity table, verify the integrity of the
18 entire WIM archive.  Otherwise, print a warning.
19 .IP \[bu]
20 Verify that the metadata for each image in the WIM archive can be successfully
21 parsed.
22 .IP \[bu]
23 Verify that all files needed by each image are actually contained in the WIM
24 archive or in one of the WIM archives referenced by the \fB--ref\fR option.
25 .IP \[bu]
26 Verify that all files contained in the WIM archive can be successfully
27 decompressed, with matching cryptographic checksums.
28 .SH OPTIONS
29 .TP 6
30 \fB--ref\fR="\fIGLOB\fR"
31 File glob of additional WIMs or split WIM parts to reference resources from.
32 This option can be specified multiple times.  Note: \fIGLOB\fR is listed in
33 quotes because it is interpreted by \fBwimlib-imagex\fR and may need to be
34 quoted to protect against shell expansion.
35 .TP
36 \fB--nocheck\fR
37 Do not check the WIM file's contents against its integrity table (if it has one).
38 .SH NOTES
39 This is a read-only command.  It will never modify the WIM file.
40 .PP
41 In the future, this command might do more thorough verifications than it does
42 now.
43 .SH EXAMPLES
44 Verify the WIM file 'boot.wim':
45 .RS
46 .PP
47 wimverify boot.wim
48 .RE
49 .PP
50 Verify the split WIM file consisting of 'boot.swm', 'boot2.swm', 'boot3.swm', ...:
51 .RS
52 .PP
53 wimverify boot.swm --ref="boot*.swm"
54 .RE
55 .PP
56 .SH SEE ALSO
57 .BR wimlib-imagex (1)
58 .BR wimlib-imagex-optimize (1)