Start using NEWS and stop using ChangeLog
[wimlib] / doc / imagex-delete.1
1 .TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib 0.6.3" "User Commands"
2 .SH NAME
3 imagex delete \- Delete an image from a WIM archive
4
5 .SH SYNOPSIS
6 \fBimagex delete\fR \fIWIMFILE\fR (\fIIMAGE_NUM\fR | \fIIMAGE_NAME\fR | all ) [--check]
7
8 .SH DESCRIPTION
9 .PP
10
11 \fBimagex delete\fR deletes the specified image from \fIWIMFILE\fR.
12
13 The image to delete may be specified by \fIIMAGE_NUM\fR, which must be an
14 integer that is an index of an image in the WIM file, starting at 1.
15 Alternatively, it may be the name of an image in the WIM file, or the keyword
16 "all", which specifies that all images are to be deleted.
17
18 The WIM file is recreated with all unnecessary file resources removed.  This is
19 different from imagex.exe, which only will delete the metadata and XML entries
20 for this operation.
21
22 Also, unlike imagex.exe, it is legal to delete all the images from a WIM and
23 have a WIM with 0 images, although such a file wouldn't be very useful.
24
25 .SH OPTIONS
26 .TP 6
27 \fB--check\fR
28 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
29 present; additionally, when rewriting \fIWIMFILE\fR after the specified image was
30 deleted, write an integrity table.  If this option is not specified, no integrity
31 table is included in the new WIM file, even if there was one before.
32 .SH SEE ALSO
33 .BR imagex (1)
34