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