wimlib-imagex: add options to enable unsafe compaction
[wimlib] / doc / man1 / wimlib-imagex-info.1
1 .TH WIMLIB-IMAGEX "1" "August 2015" "wimlib 1.8.2" "User Commands"
2 .SH NAME
3 wimlib-imagex-info \- Display information about a WIM file, or change information about
4 an image
5 .SH SYNOPSIS
6 \fBwimlib-imagex info\fR \fIWIMFILE\fR [\fIIMAGE\fR [\fINEW_NAME\fR
7 [\fINEW_DESC\fR]]] [\fIOPTION\fR...]
8 .SH DESCRIPTION
9 \fBwimlib-imagex info\fR displays information about \fIWIMFILE\fR, and optionally
10 changes which image is bootable, or what the name and description of an image
11 are.
12 This command is also available as simply \fBwiminfo\fR if the appropriate hard
13 link or batch file has been installed.
14 .PP
15 If neither an image nor any flags other than \fB--check\fR are specified, some
16 basic information about the WIM archive as well as information about the images
17 contained in it will be printed.  If an image is specified by \fIIMAGE\fR (as a
18 1-based image index or an image name), the printed information is restricted to
19 that concerning the specified image.
20 .PP
21 Changes to the WIM are made if \fINEW_NAME\fR and/or \fB--boot\fR are specified.
22 \fINEW_NAME\fR is taken to be the new name of the image specified by \fIIMAGE\fR
23 while \fINEW_DESC\fR is taken to be its new description.  If \fINEW_DESC\fR is
24 not specified, the image's description is unchanged.
25 .PP
26 \fBwimlib-imagex info\fR does not support modifying a split WIM, although you may
27 display information about one.
28 .SH OPTIONS
29 .TP 6
30 \fB--boot\fR
31 Indicates that the specified image is to be made the bootable image of the WIM
32 archive.
33 .TP
34 \fB--check\fR
35 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
36 present; additionally if an action that requires modifying the WIM archive is
37 specified, include an integrity table in the modified WIM.  If this option is
38 not specified and \fIWIMFILE\fR is modified, an integrity table will be included
39 in the modified WIM if and only if there was one before.
40 .TP
41 \fB--nocheck\fR
42 If an action that requires modifying the WIM archive is specified, do not
43 include an integrity table in the modified WIM.  If this option is not specified
44 and \fIWIMFILE\fR is modified, an integrity table will be included in the
45 modified WIM if and only if there was one before.
46 .TP
47 \fB--extract-xml\fR=\fIFILE\fR
48 Extracts the raw data from the XML resource in the WIM file to \fIFILE\fR.
49 Note: the XML data will be encoded using UTF-16LE, and it will begin with a
50 byte-order mark.
51 .TP
52 \fB--header\fR
53 Shows detailed information from the WIM header.
54 .TP
55 \fB--blobs\fR
56 Prints information about all the blobs ("file data") in the WIM.  A WIM file
57 stores only one copy of each unique blob.
58 .TP
59 \fB--xml\fR
60 Prints the raw XML data from the WIM.  Note: the XML data will be encoded using
61 UTF-16LE, and it will begin with a byte-order mark.
62 .SH SEE ALSO
63 .BR wimlib-imagex (1)
64 .BR wimlib-imagex-dir (1)