acc2ca18fc91055e0679a33d05a5257c1381e97b
[wimlib] / doc / imagex-info.1.in
1 .TH IMAGEX "1" "October 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
2 .SH NAME
3 imagex info \- Display information about a WIM file, or change information about
4 an image
5
6 .SH SYNOPSIS
7 \fBimagex info\fR \fIWIMFILE\fR [\fIIMAGE_NUM\fR | \fIIMAGE_NAME\fR]  \
8 [\fINEW_NAME\fR] [\fINEW_DESC\fR] [\fIOPTION\fR]...
9
10
11 .SH DESCRIPTION
12 .PP
13
14 \fBimagex info\fR displays information about \fIWIMFILE\fR, and optionally
15 changes which image is bootable, or what the name and description of an image
16 are.
17
18 If neither an image nor any other flags other than \fB--check\fR are specified,
19 some basic information about the WIM archive as well as information about the
20 images contained in it will be printed.  If an image is specified, the printed
21 information is restricted to that concerning the specified image.
22
23 Changes to the WIM are made if \fINEW_NAME\fR and/or \fB--boot\fR are specified.
24 \fINEW_NAME\fR is taken to be the new name of the image specified by
25 \fIIMAGE_NUM\fR or \fIIMAGE_NAME\fR, while \fINEW_DESC\fR is taken to be its new
26 description. \fINEW_DESC\fR defaults to the old description if it is not given.
27
28 Since none of these changes require changing the WIM's file resources, metadata
29 resources, or stream lookup table, they can be done very quickly by only
30 re-writing the header and XML data.  It will only take significant time if
31 \fB--check\fR is specified for a WIM that had no integrity checks before.
32
33 \fBimagex info\fR does not support modifying a split WIM, although you may
34 display information about one.
35
36 .SH OPTIONS
37 .TP 6
38 \fB--boot\fR
39 Indicates that the specified image is to be made the bootable image of the WIM
40 archive.
41 .TP
42 \fB--check\fR
43 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
44 present; additionally if an action that requires changing the WIM archive is
45 specified, include an integrity table in the modified WIM.  If this option is
46 not specified and \fIWIMFILE\fR is recreated, no integrity table is included in
47 the modified WIM, even if there was one before.
48 .TP
49 \fB--extract-xml\fR \fIFILE\fR
50 Extracts the raw data from the XML resource in the WIM file to \fIFILE\fR.
51 Note: the XML data should be encoded using UTF-16LE, and it should begin with a
52 byte-order mark.
53 .TP
54 \fB--header\fR
55 Shows detailed information from the WIM header.
56 .TP
57 \fB--lookup-table\fR
58 Prints all the entries in the stream lookup table of the WIM.
59 .TP
60 \fB--metadata\fR
61 Prints the metadata, including the security data and the directory entry tree,
62 for the specified image.  This only works on standalone WIMs or on the first
63 part of a split WIM.
64 .TP
65 \fB--xml\fR
66 Prints the XML data for the WIM.
67 .SH SEE ALSO
68 .BR imagex (1)
69