wimlib-imagex documentation updates

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

diff --git a/doc/imagex-join.1.in b/doc/imagex-join.1.in
index 5d92cdd1add8b772679032a492bca7c54eda7252..4c062b377c40f8bbdc82a9a101c2fa75bc4ac135 100644 (file)
--- a/doc/imagex-join.1.in
+++ b/doc/imagex-join.1.in
@@ -1,25 +1,26 @@
-.TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "August 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-join \- Join split WIMs into a standalone one-part WIM
-
 .SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ join\fR [\fIOPTION\fR...] \fIOUT_WIMFILE\fR \fISPLIT_WIM\fR...
-
+\fB@IMAGEX_PROGNAME@ join\fR [\fIOPTION\fR...] \fIOUT_WIMFILE\fR
+\fISPLIT_WIM_PART\fR...
 .SH DESCRIPTION
+Joins the \fISPLIT_WIM_PARTs\fR into a standalone one-part WIM \fIOUT_WIMFILE\fR.
+This command is also available as simply \fBwimjoin\fR if the appropriate hard
+link or batch file has been installed.
 .PP
-Joins the \fISPLIT_WIMs\fR into a standalone one-part WIM \fIOUT_WIMFILE\fR.
-
 All parts of the split WIM  must be specified.  You probably want to do so using
 a shell wildcard.
-
+.PP
+\fB@IMAGEX_PROGNAME@ join\fR can join both non-pipable and pipable split WIMs.
 .SH OPTIONS
 .TP 6
 \fB--check\fR
-When reading each \fISPLIT_WIM\fR, verify its integrity if the integrity table is
-present; additionally, when writing \fIOUT_WIMFILE\fR,
-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.
-
+When reading each \fISPLIT_WIM_PART\fR, verify its integrity if the integrity table
+is present; additionally, when writing \fIOUT_WIMFILE\fR, write an integrity
+table.  If this option is not specified, an integrity table will be included in
+\fIOUT_WIMFILE\fR if and only if one was present in the first part of the split
+WIM.
 .SH EXAMPLES
 Join a split WIM, with the parts named `windows*.swm' where the * is anything
 (usually the number of the part, except for the first part which may have no
@@ -28,16 +29,12 @@ number), and write the joined WIM to the file `windows.wim'.
 .PP
 @IMAGEX_PROGNAME@ join windows.wim windows*.swm
 .RE
-
 .SH NOTES
 \fB@IMAGEX_PROGNAME@ join\fR is roughly equivalent to:
 .RS
 .PP
-\fB@IMAGEX_PROGNAME@ export\fR \fISWM_PART_1\fR --ref="\fISWM_GLOB\fR" [--check] all \fIOUT_WIMFILE\fR
+\fB@IMAGEX_PROGNAME@ export\fR \fISWM_PART_1\fR --ref="\fISWM_GLOB\fR" all \fIOUT_WIMFILE\fR
 .RE
-.PP
-
-
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-export (1)