Rename --including-invalid-names to --include-invalid-names

[wimlib] / doc / imagex-delete.1.in

diff --git a/doc/imagex-delete.1.in b/doc/imagex-delete.1.in
index 1d8c31760ae8705bfc16f04ba8bbcfafb0e1d2da..166eaffd71b690716e8d83c0bd07f552cf0c1db5 100644 (file)
--- a/doc/imagex-delete.1.in
+++ b/doc/imagex-delete.1.in
@@ -1,32 +1,26 @@
-.TH IMAGEX "1" "November 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
-imagex-delete \- Delete an image from a WIM archive
-
+@IMAGEX_PROGNAME@-delete \- Delete an image from a WIM archive
 .SH SYNOPSIS
-\fBimagex delete\fR \fIWIMFILE\fR \fIIMAGE\fR [--check]
-
+\fB@IMAGEX_PROGNAME@ delete\fR \fIWIMFILE\fR \fIIMAGE\fR [--check]
 .SH DESCRIPTION
-.PP
-
-\fBimagex delete\fR deletes the specified image from the Windows Imaging (WIM)
+\fB@IMAGEX_PROGNAME@ delete\fR deletes the specified image from the Windows Imaging (WIM)
 file \fIWIMFILE\fR.
-
+.PP
 \fIIMAGE\fR specifies the WIM image to deleted.  It may be a 1-based index of an
 image in the WIM, the name of an image in the WIM, or the keyword "all" to
-indicate that all images are to be deleted.  Use the \fBimagex info\fR (1)
+indicate that all images are to be deleted.  Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
 command to show what images a WIM file contains.
-
 .SH NOTES
-
-The WIM file is rebuilt with all unnecessary file data removed.  This is
-different from Microsoft's imagex.exe, which only will delete the directory tree
-metadata and XML data for this operation.
-
-Also, unlike imagex.exe, it is legal to delete all the images from a WIM and
-have a WIM with 0 images, although such a file wouldn't be very useful.
-
-\fBimagex delete\fR does not support split WIMs.
-
+By default, the WIM file is rebuilt with all unnecessary file data removed.
+This is different from Microsoft's imagex.exe, which only will delete the
+directory tree metadata and XML data for this operation.  (See the \fB--soft\fR
+option for the other kind of delete).
+.PP
+Also, unlike Microsoft's imagex.exe, it is legal to delete all the images from a
+WIM and have a WIM with 0 images, although such a file wouldn't be very useful.
+.PP
+\fB@IMAGEX_PROGNAME@ delete\fR does not support split WIMs.
 .SH OPTIONS
 .TP 6
 \fB--check\fR
@@ -34,15 +28,25 @@ When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
 present; additionally, when rewriting \fIWIMFILE\fR after the specified image was
 deleted, write an integrity table.  If this option is not specified, no integrity
 table is included in the new WIM file, even if there was one before.
-
+.TP 6
+\fB--soft\fR
+Perform a "soft delete".  Specifying this flag overrides the default behavior of
+rebuilding the entire WIM after deleting an image.  Instead, only minimal
+changes to correctly remove the image from the WIM will be taken.  In
+particular, all streams will be left alone, even if they are no longer
+referenced.  This is probably not what you want, because almost no space will be
+saved by deleting an image in this way.
+.IP ""
+You may use \fB@IMAGEX_PROGNAME@ optimize\fR to delete unreferenced streams from a WIM that
+has had images soft-deleted from it.
 .SH EXAMPLES
 Delete the first image from 'boot.wim':
 .RS
 .PP
-image delete boot.wim 1
+@IMAGEX_PROGNAME@ delete boot.wim 1
 .RE
 .PP
-
 .SH SEE ALSO
-.BR imagex (1)
-
+.BR @IMAGEX_PROGNAME@ (1)
+.BR @IMAGEX_PROGNAME@-info (1)
+.BR @IMAGEX_PROGNAME@-optimize (1)