Man page updates
[wimlib] / doc / imagex-delete.1.in
1 .TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "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\fR [--check]
7
8 .SH DESCRIPTION
9 .PP
10
11 \fBimagex 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 \fBimagex info\fR (1)
17 command to show what images a WIM file contains.
18
19 .SH NOTES
20
21 The WIM file is rebuild with all unnecessary file data removed.  This is
22 different from imagex.exe, which only will delete the directory tree metadata
23 and XML data for this operation.
24
25 Also, unlike imagex.exe, it is legal to delete all the images from a WIM and
26 have a WIM with 0 images, although such a file wouldn't be very useful.
27
28 \fBimagex delete\fR does not yet support split WIMs.
29
30 .SH OPTIONS
31 .TP 6
32 \fB--check\fR
33 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
34 present; additionally, when rewriting \fIWIMFILE\fR after the specified image was
35 deleted, write an integrity table.  If this option is not specified, no integrity
36 table is included in the new WIM file, even if there was one before.
37
38 .SH EXAMPLES
39 Delete the first image from 'boot.wim':
40 .RS
41 .PP
42 image delete boot.wim 1
43 .RE
44 .PP
45
46 .SH SEE ALSO
47 .BR imagex (1)
48