Update version to 1.3.3
[wimlib] / doc / imagex-info.1.in
1 .TH IMAGEX "1" "April 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
2 .SH NAME
3 @IMAGEX_PROGNAME@-info \- Display information about a WIM file, or change information about
4 an image
5
6 .SH SYNOPSIS
7 \fB@IMAGEX_PROGNAME@ 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 \fB@IMAGEX_PROGNAME@ 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 flags other than \fB--check\fR are specified, some
19 basic information about the WIM archive as well as information about the images
20 contained in it will be printed.  If an image is specified (as a 1-based image
21 index or an image name), the printed information is restricted to that
22 concerning the specified image.
23
24 Changes to the WIM are made if \fINEW_NAME\fR and/or \fB--boot\fR are specified.
25 \fINEW_NAME\fR is taken to be the new name of the image specified by
26 \fIIMAGE_NUM\fR or \fIIMAGE_NAME\fR, while \fINEW_DESC\fR is taken to be its new
27 description.  If \fINEW_DESC\fR is not specified, the image's description is
28 unchanged.
29
30 \fB@IMAGEX_PROGNAME@ info\fR does not support modifying a split WIM, although you may
31 display information about one.
32
33 .SH NOTES
34
35 The possible modifications to \fIWIMFILE\fR by \fB@IMAGEX_PROGNAME@ info\fR are made
36 quickly without re-building the entire WIM.  \fB@IMAGEX_PROGNAME@ info\fR will only take a
37 significant amount of time to complete if \fB--check\fR is specified when the
38 WIM previously had no integrity table.
39
40 Aborting an \fB@IMAGEX_PROGNAME@ info\fR command that modifies \fIWIMFILE\fR is unlikely to
41 result in corruption of \fIWIMFILE\fR.  Even if \fB@IMAGEX_PROGNAME@ info\fR is aborted
42 while the integrity table is being calculated (with \fB--check\fR), the WIM
43 should be in a consistent state with any changes to the bootable index,
44 name, or description of the specified image committed.
45
46 .SH OPTIONS
47 .TP 6
48 \fB--boot\fR
49 Indicates that the specified image is to be made the bootable image of the WIM
50 archive.
51 .TP
52 \fB--check\fR
53 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
54 present; additionally if an action that requires modifying the WIM archive is
55 specified, include an integrity table in the modified WIM.  If this option is
56 not specified and \fIWIMFILE\fR is modified, no integrity table is included in
57 the modified WIM, even if there was one before.
58 .TP
59 \fB--extract-xml\fR \fIFILE\fR
60 Extracts the raw data from the XML resource in the WIM file to \fIFILE\fR.
61 Note: the XML data will be encoded using UTF-16LE, and it will begin with a
62 byte-order mark.
63 .TP
64 \fB--header\fR
65 Shows detailed information from the WIM header.
66 .TP
67 \fB--lookup-table\fR
68 Prints all the entries in the stream lookup table of the WIM.
69 .TP
70 \fB--metadata\fR
71 Prints the metadata, including the security data and the directory entry tree
72 but not the XML data, for the specified image.  If no image is specified, the
73 metadata for all images is printed.  This only works on standalone WIMs or on
74 the first part of a split WIM.
75 .TP
76 \fB--xml\fR
77 Prints the raw XML data from the WIM.  Note: the XML data will be encoded using
78 UTF-16LE, and it will begin with a byte-order mark.
79 .SH SEE ALSO
80 .BR @IMAGEX_PROGNAME@ (1)
81