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