X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fimagex-delete.1.in;h=3e5b4c1e74a3168d5b67c8c116abe26840fa6620;hp=a2bea2329ded4b574686851973f94e8564acaa39;hb=e7396f16433694f9b29deb1e62861ea7799a0774;hpb=370533dcb819ad11d6424e7e0284915eb501812b

diff --git a/doc/imagex-delete.1.in b/doc/imagex-delete.1.in
index a2bea232..3e5b4c1e 100644
--- a/doc/imagex-delete.1.in
+++ b/doc/imagex-delete.1.in
@@ -1,34 +1,57 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "August 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_NUM\fR | \fIIMAGE_NAME\fR | all ) [--check]
-
+\fB@IMAGEX_PROGNAME@ delete\fR \fIWIMFILE\fR \fIIMAGE\fR [--check]
 .SH DESCRIPTION
+\fB@IMAGEX_PROGNAME@ delete\fR deletes the specified image from the Windows Imaging (WIM)
+file \fIWIMFILE\fR.
+This command is also available as simply \fBwimdelete\fR if the appropriate hard
+link or batch file has been installed.
 .PP
-
-\fBimagex delete\fR deletes the specified image from \fIWIMFILE\fR.
-
-The image to delete may be specified by \fIIMAGE_NUM\fR, which must be an
-integer that is an index of an image in the WIM file, starting at 1.
-Alternatively, it may be the name of an image in the WIM file, or the keyword
-"all", which specifies that all images are to be deleted.
-
-The WIM file is recreated with all unnecessary file resources removed.  This is
-different from imagex.exe, which only will delete the metadata and XML entries
-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.
-
+\fIIMAGE\fR specifies the WIM image in \fIWIMFILE\fR 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
+\fB@IMAGEX_PROGNAME@ info\fR (1) command to show what images a WIM file
+contains.
+.SH NOTES
+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
 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.
+present; additionally, when rewriting \fIWIMFILE\fR after the specified image
+was deleted, always write an integrity table.  If this option is not specified,
+the integrity of \fIWIMFILE\fR will not be checked when it's opened, but an
+integrity table will be written in the updated WIM if and only if one was
+present 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 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
+@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)