wimlib.net Git - wimlib/blob - doc/man1/wiminfo.1

   1 .TH WIMINFO "1" "December 2021" "wimlib 1.13.5" "User Commands"
   2 .SH NAME
   3 wiminfo \- Display or change information about a WIM file or image
   4 .SH SYNOPSIS
   5 \fBwiminfo\fR \fIWIMFILE\fR [\fIIMAGE\fR [\fINEW_NAME\fR [\fINEW_DESC\fR]]] [\fIOPTION\fR...]
   6 .SH DESCRIPTION
   7 \fBwiminfo\fR, or equivalently \fBwimlib-imagex info\fR, displays information
   8 about \fIWIMFILE\fR or the specified \fIIMAGE\fR in it, and optionally changes
   9 properties of \fIIMAGE\fR such as its name and description, or changes the
  10 bootable image of the WIM.
  11 .PP
  12 If neither an image nor any flags other than \fB--check\fR are specified, then
  13 basic information about the WIM and the images contained in it is shown.  If an
  14 image is specified by \fIIMAGE\fR (as a 1-based image index or an image name),
  15 then the information is restricted to that concerning the specified image.
  16 .PP
  17 Changes to the WIM are made if \fINEW_NAME\fR and/or \fB--boot\fR and/or
  18 \fB--image-property\fR are specified.  \fINEW_NAME\fR is taken to be the new
  19 name of the image specified by \fIIMAGE\fR while \fINEW_DESC\fR is taken to be
  20 its new description.  If \fINEW_DESC\fR is not specified, then the image's
  21 description is not changed.
  22 .PP
  23 \fBwiminfo\fR does not support modifying a split WIM, although you may display
  24 information about one, including any of its parts.
  25 .SH OPTIONS
  26 .TP 6
  27 \fB--boot\fR
  28 Mark the specified \fIIMAGE\fR as the "bootable" image of the WIM.  The
  29 "bootable" image is the image which the Windows bootloader will use when loading
  30 Windows PE from the WIM.
  31 .TP
  32 \fB--check\fR
  33 Verify the integrity of WIM if it contains extra integrity information.  In
  34 addition, if modifying the WIM, add extra integrity information if it was not
  35 present before.
  36 .TP
  37 \fB--nocheck\fR
  38 If modifying the WIM, remove its extra integrity information, if it had any.
  39 .TP
  40 \fB--include-integrity\fR
  41 If modifying the WIM, add extra integrity information if it was not present
  42 before, i.e. like \fB--check\fR but don't also do the verification beforehand.
  43 .TP
  44 \fB--image-property\fR \fINAME\fR=\fIVALUE\fR
  45 Assign an arbitrary property to the specified \fIIMAGE\fR in the XML document of
  46 the WIM.  \fINAME\fR is an element path such as "WINDOWS/VERSION/MAJOR", and
  47 \fIVALUE\fR is the string to place in the element, such as "10".  See the
  48 documentation for this option to \fBwimcapture\fR(1) for more details.  This
  49 option may be specified multiple times.
  50 .TP
  51 \fB--header\fR
  52 Show detailed information from the WIM header.
  53 .TP
  54 \fB--blobs\fR
  55 List all the "blobs" (unique file data) in the WIM.
  56 .TP
  57 \fB--extract-xml\fR=\fIFILE\fR
  58 Extract the WIM's raw XML document to \fIFILE\fR.
  59 .TP
  60 \fB--xml\fR
  61 .br
  62 Extract the WIM's raw XML document to standard output.
  63 .SH SEE ALSO
  64 .BR wimlib-imagex (1)
  65 .BR wimdir (1)