bdd2041d117980755c029894b9480b6ac0795907
[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\fR [\fINEW_NAME\fR
8 [\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 by \fIIMAGE\fR (as a
21 1-based image index or an image name), the printed information is restricted to
22 that 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 \fIIMAGE\fR
26 while \fINEW_DESC\fR is taken to be its new description.  If \fINEW_DESC\fR is
27 not specified, the image's description is unchanged.
28
29 \fB@IMAGEX_PROGNAME@ info\fR does not support modifying a split WIM, although you may
30 display information about one.
31
32 .SH OPTIONS
33 .TP 6
34 \fB--boot\fR
35 Indicates that the specified image is to be made the bootable image of the WIM
36 archive.
37 .TP
38 \fB--check\fR
39 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
40 present; additionally if an action that requires modifying the WIM archive is
41 specified, include an integrity table in the modified WIM.  If this option is
42 not specified and \fIWIMFILE\fR is modified, no integrity table is included in
43 the modified WIM, even if there was one before.
44 .TP
45 \fB--extract-xml\fR=\fIFILE\fR
46 Extracts the raw data from the XML resource in the WIM file to \fIFILE\fR.
47 Note: the XML data will be encoded using UTF-16LE, and it will begin with a
48 byte-order mark.
49 .TP
50 \fB--header\fR
51 Shows detailed information from the WIM header.
52 .TP
53 \fB--lookup-table\fR
54 Prints all the entries in the stream lookup table of the WIM.
55 .TP
56 \fB--metadata\fR
57 Prints the metadata, including the security data and the directory entry tree
58 but not the XML data, for the specified image.  If no image is specified, the
59 metadata for all images is printed.  This only works on standalone WIMs or on
60 the first part of a split WIM.
61 .TP
62 \fB--xml\fR
63 Prints the raw XML data from the WIM.  Note: the XML data will be encoded using
64 UTF-16LE, and it will begin with a byte-order mark.
65 .SH SEE ALSO
66 .BR @IMAGEX_PROGNAME@ (1)
67