Allow "imagex" to be renamed (default: wimlib-imagex)

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

diff --git a/doc/imagex-join.1.in b/doc/imagex-join.1.in
index 5b65238c9ee69cb0e9b05247f5af827ce590353b..3b0e910b813f964594faf38c3327d7f3e40b0c2b 100644 (file)
--- a/doc/imagex-join.1.in
+++ b/doc/imagex-join.1.in
@@ -1,9 +1,9 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "March 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"

 .SH NAME
 .SH NAME

-imagex join \- Join split WIMs into a standalone one-part WIM
+@IMAGEX_PROGNAME@-join \- Join split WIMs into a standalone one-part WIM

 
 .SH SYNOPSIS
 
 .SH SYNOPSIS

-\fBimagex join\fR [\fIOPTION...] \fIOUT_WIMFILE\fR \fISPLIT_WIM...\fR
+\fB@IMAGEX_PROGNAME@ join\fR [\fIOPTION...] \fIOUT_WIMFILE\fR \fISPLIT_WIM...\fR

 
 .SH DESCRIPTION
 .PP
 
 .SH DESCRIPTION
 .PP


@@ -12,7 +12,6 @@ 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.
 
 All parts of the split WIM  must be specified.  You probably want to do so using
 a shell wildcard.
 

-

 .SH OPTIONS
 .TP 6
 \fB--check\fR
 .SH OPTIONS
 .TP 6
 \fB--check\fR


@@ -22,12 +21,23 @@ 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.
 
 .SH EXAMPLES
 is included in the new WIM file, even if there was one before.
 
 .SH EXAMPLES

-.IP 
-imagex join windows.wim windows*.swm
-.LP

 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
 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

-number), and write the joined with to the file `windows.wim'.
+number), and write the joined WIM to the file `windows.wim'.
+.RS
+.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
+.RE
+.PP
+

 
 .SH SEE ALSO
 
 .SH SEE ALSO

-.BR imagex (1)
+.BR @IMAGEX_PROGNAME@ (1)
+.BR @IMAGEX_PROGNAME@-export (1)