wimlib.net Git - wimlib/blob - doc/imagex-delete.1.in

   1 .TH IMAGEX "1" "August 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
   2 .SH NAME
   3 @IMAGEX_PROGNAME@-delete \- Delete an image from a WIM archive
   4 .SH SYNOPSIS
   5 \fB@IMAGEX_PROGNAME@ delete\fR \fIWIMFILE\fR \fIIMAGE\fR [--check]
   6 .SH DESCRIPTION
   7 \fB@IMAGEX_PROGNAME@ delete\fR deletes the specified image from the Windows Imaging (WIM)
   8 file \fIWIMFILE\fR.
   9 .PP
  10 \fIIMAGE\fR specifies the WIM image to deleted.  It may be a 1-based index of an
  11 image in the WIM, the name of an image in the WIM, or the keyword "all" to
  12 indicate that all images are to be deleted.  Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
  13 command to show what images a WIM file contains.
  14 This command is also available as simply \fBwimdelete\fR if the appropriate hard
  15 link is installed.
  16 .SH NOTES
  17 By default, the WIM file is rebuilt with all unnecessary file data removed.
  18 This is different from Microsoft's imagex.exe, which only will delete the
  19 directory tree metadata and XML data for this operation.  (See the \fB--soft\fR
  20 option for the other kind of delete).
  21 .PP
  22 Also, unlike Microsoft's imagex.exe, it is legal to delete all the images from a
  23 WIM and have a WIM with 0 images, although such a file wouldn't be very useful.
  24 .PP
  25 \fB@IMAGEX_PROGNAME@ delete\fR does not support split WIMs.
  26 .SH OPTIONS
  27 .TP 6
  28 \fB--check\fR
  29 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
  30 present; additionally, when rewriting \fIWIMFILE\fR after the specified image
  31 was deleted, always write an integrity table.  If this option is not specified,
  32 the integrity of \fIWIMFILE\fR will not be checked when it's opened, but an
  33 integrity table will be written in the updated WIM if and only if one was
  34 present before.
  35 .TP 6
  36 \fB--soft\fR
  37 Perform a "soft delete".  Specifying this flag overrides the default behavior of
  38 rebuilding the entire WIM after deleting an image.  Instead, only minimal
  39 changes to correctly remove the image from the WIM will be taken.  In
  40 particular, all streams will be left alone, even if they are no longer
  41 referenced.  This is probably not what you want, because almost no space will be
  42 saved by deleting an image in this way.
  43 .IP ""
  44 You may use \fB@IMAGEX_PROGNAME@ optimize\fR to delete unreferenced streams from a WIM that
  45 has had images soft-deleted from it.
  46 .SH EXAMPLES
  47 Delete the first image from 'boot.wim':
  48 .RS
  49 .PP
  50 @IMAGEX_PROGNAME@ delete boot.wim 1
  51 .RE
  52 .PP
  53 .SH SEE ALSO
  54 .BR @IMAGEX_PROGNAME@ (1)
  55 .BR @IMAGEX_PROGNAME@-info (1)
  56 .BR @IMAGEX_PROGNAME@-optimize (1)