wimlib-imagex documentation updates

[wimlib] / doc / imagex.1.in

diff --git a/doc/imagex.1.in b/doc/imagex.1.in
index 69222a85d4b5b9a7d67bc66e0d72e73d08d68ff4..6a952ac24a313b27599b4f802ba54003a817f2f1 100644 (file)
--- a/doc/imagex.1.in
+++ b/doc/imagex.1.in
@@ -1,4 +1,4 @@
-.TH IMAGEX 1 "June 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX 1 "August 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@ \- Create, modify, extract, mount, or unmount a WIM (Windows Imaging Format) archive
 .SH SYNOPSIS
@@ -40,7 +40,11 @@ To do its work, \fB@IMAGEX_PROGNAME@\fR uses \fBwimlib\fR, a library which
 provides interfaces for manipulating WIM archives.  You could wimlib in your own
 programs if you wanted to.  wimlib's public interface is documented.
 .SH COMMANDS
-There is a separate manual page for each \fB@IMAGEX_PROGNAME@\fR command.
+The available commands were listed above, and there is a separate manual page
+for each.  Note: to save typing, if the appropriate hard links are installed, a
+command \fB@IMAGEX_PROGNAME@ \fICOMMAND\fR can be accessed as simply
+\fBwim\fICOMMAND\fR; for example, \fBwimapply\fR for
+\fB@IMAGEX_PROGNAME@ apply\fR.
 .SH SUPPORTED FEATURES
 The following general features are currently supported (note: this is not a
 complete list; also, certain features, such as mounting, are supported on UNIX
@@ -48,12 +52,18 @@ but not Windows):
 .IP \[bu] 4
 Create a stand-alone WIM from a directory or NTFS volume (\fB@IMAGEX_PROGNAME@ capture\fR)
 .IP \[bu]
+Capture a WIM image directly to standard output in a special pipable format
+(\fB@IMAGEX_PROGNAME@ capture\fR)
+.IP \[bu]
 Append a directory or NTFS volume onto a stand-alone WIM as a new image (\fB@IMAGEX_PROGNAME@
 append\fR)
 .IP \[bu]
 Apply an image from a stand-alone or split WIM to a directory or NTFS volume
 (\fB@IMAGEX_PROGNAME@ apply\fR)
 .IP \[bu]
+Apply an image from a special pipable WIM format sent over standard input
+(\fB@IMAGEX_PROGNAME@ apply\fR)
+.IP \[bu]
 Mount an image from a stand-alone or split WIM read-only (\fB@IMAGEX_PROGNAME@ mount\fR)
 .IP \[bu]
 Mount an image from a stand-alone WIM read-write (\fB@IMAGEX_PROGNAME@ mountrw\fR)
@@ -92,6 +102,16 @@ thus, much functionality was designed around this.
 .IP \[bu]
 The command-line syntax of the two programs is similar but not exactly the same.
 .IP \[bu]
+As of wimlib v1.5.0, for convenience \fB@IMAGEX_PROGNAME@\fR automatically
+preserves the integrity table in WIMs that have one, even when \fB--check\fR is
+not specified.
+.IP \[bu]
+As of wimlib v1.5.0, a special "pipable" WIM format that is not compatible with
+Microsoft's software is supported.  This allows capturing and applying images
+directly to standard output or from standard input, respectively; this can be
+used to pipe images to or from a server over the network to implement fast
+filesystem imaging and restore.
+.IP \[bu]
 On UNIX, because Microsoft designed the WIM file format to accomodate
 Windows-specific and NTFS-specific features, wimlib must have two separate image
 capture and application modes (although the \fB@IMAGEX_PROGNAME@\fR subcommands