Fix some typos
[wimlib] / doc / man1 / wimdelete.1
1 .TH WIMDELETE "1" "May 2019" "wimlib 1.13.1" "User Commands"
2 .SH NAME
3 wimdelete \- Delete an image from a WIM archive
4 .SH SYNOPSIS
5 \fBwimdelete\fR \fIWIMFILE\fR \fIIMAGE\fR [\fIOPTION\fR...]
6 .SH DESCRIPTION
7 \fBwimdelete\fR, or equivalently \fBwimlib-imagex delete\fR, deletes the
8 specified image from the Windows Imaging (WIM) archive \fIWIMFILE\fR.
9 .PP
10 \fIIMAGE\fR specifies the WIM image in \fIWIMFILE\fR to delete.  It may be the
11 1-based index of an image, the name of an image, or the keyword "all" to specify
12 all images.  You can use \fBwiminfo\fR(1) to list the images contained in
13 \fIWIMFILE\fR.
14 .SH NOTES
15 By default, \fBwimdelete\fR rebuilds the WIM with all unnecessary file data
16 removed.  This is different from Microsoft's ImageX and DISM, which only will
17 delete the directory tree metadata and XML data for this operation.  Use
18 \fB--soft\fR if you want the other kind of delete.
19 .PP
20 wimlib allows you to delete all the images from a WIM and have a WIM with 0
21 images, although such a file may not be very useful.
22 .PP
23 \fBwimdelete\fR does not support split WIMs.
24 .SH OPTIONS
25 .TP 6
26 \fB--check\fR
27 Before deleting the image, verify the WIM's integrity if extra integrity
28 information is present.  In addition, include extra integrity information in the
29 modified WIM, even if it was not present before.
30 .TP
31 \fB--include-integrity\fR
32 Include extra integrity information in the modified WIM, i.e. like \fB--check\fR
33 but don't do any verification beforehand.
34 .TP
35 \fB--soft\fR
36 Perform a "soft delete".  Specifying this flag overrides the default behavior of
37 rebuilding the entire WIM after deleting an image.  Instead, only minimal
38 changes to correctly remove the image from the WIM will be taken.  In
39 particular, all file resources will be left alone, even if they are no longer
40 referenced.  This may not be what you want, because no space will be saved by
41 deleting an image in this way.  However, \fBwimoptimize\fR can later be used to
42 rebuild a WIM file that has had images soft-deleted from it.
43 .TP
44 \fB--unsafe-compact\fR
45 Compact the WIM archive in-place, eliminating "holes".  This is efficient, but
46 in general this option should \fInot\fR be used because a failed or interrupted
47 compaction will corrupt the WIM archive.  For more information, see the
48 documentation for this option to \fBwimoptimize\fR(1).
49 .SH EXAMPLES
50 Delete the first image from 'boot.wim':
51 .RS
52 .PP
53 wimdelete boot.wim 1
54 .RE
55 .PP
56 .SH SEE ALSO
57 .BR wimlib-imagex (1)
58 .BR wiminfo (1)
59 .BR wimoptimize (1)