Start using NEWS and stop using ChangeLog
[wimlib] / doc / imagex-info.1
1 .TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib 0.6.3" "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 file resources, the metadata
29 resources, or the lookup table, they can be done very quickly by only re-writing
30 the header and XML data.  It will only take significant time if \fB--check\fR is
31 specified for a WIM that had no integrity checks before.
32
33 .SH OPTIONS
34 .TP 6
35 \fB--boot\fR
36 Indicates that the specified image is to be made the bootable image of the WIM
37 archive.
38 .TP
39 \fB--check\fR
40 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
41 present; additionally if an action that requires changing the WIM archive is
42 specified, write an integrity table.  If this option is not specified and
43 \fIWIMFILE\fR is recreated, no integrity table is included in the new WIM file,
44 even if there was one before.
45 .TP
46 \fB--extract-xml\fR \fIFILE\fR
47 Extracts the raw data from the XML resource in the WIM file to \fIFILE\fR.
48 .TP
49 \fB--header\fR
50 Shows detailed information from the WIM header.
51 .TP
52 \fB--lookup-table\fR
53 Prints all the entries in the lookup table of the WIM.
54 .TP
55 \fB--metadata\fR
56 Prints the metadata for the directory tree for the specified image.
57 .TP
58 \fB--xml\fR
59 Prints the XML data for the WIM.
60 .SH SEE ALSO
61 .BR imagex (1)
62