wimlib-imagex: add --image-property option to wimcapture, wimappend, wiminfo
[wimlib] / doc / man1 / wimlib-imagex-info.1
1 .TH WIMLIB-IMAGEX "1" "November 2015" "wimlib 1.8.3" "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 and/or
22 \fB--image-property\fR are specified.  \fINEW_NAME\fR is taken to be the new
23 name of the image specified by \fIIMAGE\fR while \fINEW_DESC\fR is taken to be
24 its new description.  If \fINEW_DESC\fR is not specified, the image's
25 description is unchanged.
26 .PP
27 \fBwimlib-imagex info\fR does not support modifying a split WIM, although you may
28 display information about one.
29 .SH OPTIONS
30 .TP 6
31 \fB--boot\fR
32 Indicates that the specified image is to be made the bootable image of the WIM
33 archive.
34 .TP
35 \fB--check\fR
36 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
37 present; additionally if an action that requires modifying the WIM archive is
38 specified, include an integrity table in the modified WIM.  If this option is
39 not specified and \fIWIMFILE\fR is modified, an integrity table will be included
40 in the modified WIM if and only if there was one before.
41 .TP
42 \fB--nocheck\fR
43 If an action that requires modifying the WIM archive is specified, do not
44 include an integrity table in the modified WIM.  If this option is not specified
45 and \fIWIMFILE\fR is modified, an integrity table will be included in the
46 modified WIM if and only if there was one before.
47 .TP
48 \fB--extract-xml\fR=\fIFILE\fR
49 Extracts the raw data from the XML resource in the WIM file to \fIFILE\fR.
50 Note: the XML data will be encoded using UTF-16LE, and it will begin with a
51 byte-order mark.
52 .TP
53 \fB--header\fR
54 Shows detailed information from the WIM header.
55 .TP
56 \fB--blobs\fR
57 Prints information about all the blobs ("file data") in the WIM.  A WIM file
58 stores only one copy of each unique blob.
59 .TP
60 \fB--xml\fR
61 Prints the raw XML data from the WIM.  Note: the XML data will be encoded using
62 UTF-16LE, and it will begin with a byte-order mark.
63 .TP
64 \fB--image-property\fR \fINAME\fR=\fIVALUE\fR
65 Set an arbitrary per-image property in the XML document of the WIM file.
66 \fINAME\fR is an element path such as "WINDOWS/VERSION/MAJOR", and \fIVALUE\fR
67 is the string to place in the element, such as "10".  See the documentation for
68 this option to \fBwimlib-imagex capture\fR (1) for more details.  This option
69 may be specified multiple times.
70 .SH SEE ALSO
71 .BR wimlib-imagex (1)
72 .BR wimlib-imagex-dir (1)