]> wimlib.net Git - wimlib/blobdiff - doc/imagex-join.1.in
Update version number to 1.4.0; update NEWS
[wimlib] / doc / imagex-join.1.in
index db149fa57d1a2dc91cac9c5f8c4cc53c9029df22..5d92cdd1add8b772679032a492bca7c54eda7252 100644 (file)
@@ -1,9 +1,9 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .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
-\fBimagex join\fR [\fIOPTION...] \fIOUT_WIMFILE\fR \fISPLIT_WIM...\fR
+\fB@IMAGEX_PROGNAME@ join\fR [\fIOPTION\fR...] \fIOUT_WIMFILE\fR \fISPLIT_WIM\fR...
 
 .SH DESCRIPTION
 .PP
@@ -12,15 +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.
 
-.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
-number), and write the joined with to the file `windows.wim'.
-
 .SH OPTIONS
 .TP 6
 \fB--check\fR
@@ -28,6 +19,25 @@ When reading each \fISPLIT_WIM\fR, verify its integrity if the integrity table i
 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.
-.TP
+
+.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
+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
-.BR imagex (1)
+.BR @IMAGEX_PROGNAME@ (1)
+.BR @IMAGEX_PROGNAME@-export (1)