X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fimagex-join.1.in;h=4c062b377c40f8bbdc82a9a101c2fa75bc4ac135;hp=596049f2faa94c8f33b18b5be0584122499572fe;hb=e7396f16433694f9b29deb1e62861ea7799a0774;hpb=64f1e9b6bb2bb4d5b16240ae731bd8a84117cc98 diff --git a/doc/imagex-join.1.in b/doc/imagex-join.1.in index 596049f2..4c062b37 100644 --- a/doc/imagex-join.1.in +++ b/doc/imagex-join.1.in @@ -1,33 +1,40 @@ -.TH IMAGEX "1" "September 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands" +.TH WIMLIB-IMAGEX "1" "August 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_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 -.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'. - +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" all \fIOUT_WIMFILE\fR +.RE .SH SEE ALSO -.BR imagex (1) +.BR @IMAGEX_PROGNAME@ (1) +.BR @IMAGEX_PROGNAME@-export (1)