Fix some typos
[wimlib] / doc / man1 / wimverify.1
1 .TH WIMVERIFY "1" "May 2019" "wimlib 1.13.1" "User Commands"
2 .SH NAME
3 wimverify \- Verify a WIM archive
4 .SH SYNOPSIS
5 \fBwimverify\fR \fIWIMFILE\fR [\fIOPTION\fR...]
6 .SH DESCRIPTION
7 \fBwimverify\fR (or equivalently \fBwimlib-imagex verify\fR) checks the validity
8 and integrity of the specified WIM archive.
9 .PP
10 Specifically, this command performs the following verifications on the WIM:
11 .IP \[bu] 4
12 Verify that the WIM can be successfully opened, which involves parsing the
13 header, blob table, and XML data.
14 .IP \[bu]
15 If the WIM contains extra integrity information, verify the integrity of the
16 entire WIM.
17 .IP \[bu]
18 Verify that the metadata for each image in the WIM can be successfully parsed.
19 .IP \[bu]
20 Verify that all files needed by each image are actually contained in the WIM or
21 in one of the WIMs referenced by the \fB--ref\fR option.
22 .IP \[bu]
23 Verify that all files contained in the WIM can be successfully decompressed,
24 with matching checksums.
25 .SH OPTIONS
26 .TP 6
27 \fB--ref\fR="\fIGLOB\fR"
28 File glob of additional WIMs or split WIM parts to reference resources from.
29 This option can be specified multiple times.  Note: \fIGLOB\fR is listed in
30 quotes because it is interpreted by \fBwimverify\fR and may need to be quoted to
31 protect against shell expansion.
32 .TP
33 \fB--nocheck\fR
34 Do not verify the WIM's integrity using the extra integrity information (the
35 integrity table).
36 .SH NOTES
37 \fBwimverify\fR is a read-only operation; it does not modify the WIM file.
38 .PP
39 Even if the WIM does not contain extra integrity information (e.g. generated
40 with the \fB--check\fR option to \fBwimcapture\fR), \fBwimverify\fR may still be
41 quite useful because all file data is still checksummed.
42 .PP
43 In the future, \fBwimverify\fR might do more thorough verifications than it does
44 now.
45 .SH EXAMPLES
46 Verify the WIM file 'boot.wim':
47 .RS
48 .PP
49 wimverify boot.wim
50 .RE
51 .PP
52 Verify the split WIM file consisting of 'boot.swm', 'boot2.swm', 'boot3.swm', ...:
53 .RS
54 .PP
55 wimverify boot.swm --ref="boot*.swm"
56 .RE
57 .PP
58 .SH SEE ALSO
59 .BR wimlib-imagex (1)