]> wimlib.net Git - wimlib/blobdiff - doc/imagex-delete.1.in
add_image.c: Add debugging statements for branch attachment
[wimlib] / doc / imagex-delete.1.in
index 0594c3345610751376dc8d4ca93e3c7f85e37613..8dfcd306563f684ebad8c3e3d809e5280848ff1c 100644 (file)
@@ -1,6 +1,6 @@
-.TH IMAGEX "1" "September 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "March 2013" "imagex (wimlib) wimlib @VERSION@" "User Commands"
 .SH NAME
-imagex delete \- Delete an image from a WIM archive
+imagex-delete \- Delete an image from a WIM archive
 
 .SH SYNOPSIS
 \fBimagex delete\fR \fIWIMFILE\fR \fIIMAGE\fR [--check]
@@ -18,14 +18,15 @@ command to show what images a WIM file contains.
 
 .SH NOTES
 
-The WIM file is rebuild with all unnecessary file data removed.  This is
-different from imagex.exe, which only will delete the directory tree metadata
-and XML data for this operation.
+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).
 
 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 yet support split WIMs.
+\fBimagex delete\fR does not support split WIMs.
 
 .SH OPTIONS
 .TP 6
@@ -34,6 +35,17 @@ 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.
+
+You may use \fBimagex 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':