New option -jigdo

xorriso/xorriso.1

@@ -9,7 +9,7 @@
 .\" First parameter, NAME, should be all caps
 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
 .\" other parameters are allowed: see man(7), man(1)
-.TH XORRISO 1 "Sep 10, 2010"
+.TH XORRISO 1 "Sep 29, 2010"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
@@ -2410,6 +2410,74 @@ partition offset. 0 chooses a default value.
 partition offset. 0 chooses a default value.
 .br
 .TP
+.B Jigdo Template Extraction:
+.PP
+From man genisoimage:
+"Jigdo is a tool to help in the distribution of large files like CD and
+DVD images; see http://atterer.net/jigdo/ for more details. Debian CDs
+and DVD ISO images are published on the web in jigdo format to allow
+end users to download them more efficiently."
+.br
+xorriso can produce a .jigdo and a .template file together with a
+single-session ISO image.
+The .jigdo file contains checksums and file download addresses.
+The .template file contains the compressed ISO image with reference tags
+instead of the content bytes of the listed files.
+.br
+Input for this process are the normal arguments for a xorriso session
+on a blank -outdev, and a .md5 file which lists those files which shall be
+listed in the .jigdo file and externally referenced in the .template file.
+Each desired file is represented in the .md5 file by a single text line:
+.br
+MD5 as 32 hex digits, 2 blanks, size as 12 decimal digits or blanks, 2 blanks,
+absolute path in the disk filesystem as given to xorriso.
+.br
+If the list of jigdo parameters is not empty, then xorriso will refuse to
+write to non-blank targets, it will disable multi-session emulation and
+padding.
+.br
+.TP
+\fB\-jigdo\fR parameter_name value
+Clear Jigdo Template Extraction parameter list or add a parameter to that list.
+The alias names are the corresponding genisoimage options. They are accepted
+as parameter names as well. Especially they are recognized by the -as mkisofs
+emulation command.
+.br
+Parameter \fBclear\fR with any value empties the whole list.
+No .jigdo and .template file will be produced.
+.br
+\fBtemplate_path\fR sets the disk_path for the .template file with the
+holed and compressed ISO image copy.
+Alias: -jigdo-template
+.br
+\fBjigdo_path\fR sets the disk_path for the .jigdo file with the checksums
+and download addresses for filling the holes in .template.
+Alias: -jigdo-jigdo
+.br
+\fBmd5_path\fR sets the disk_path where to find the .md5 input file.
+Alias: -md5-list
+.br
+\fBmin_size\fR sets the minimum size for a data file to be listed
+in the .jigdo file and being a hole in the .template file.
+Alias: -jigdo-min-file-size
+.br
+\fBexclude\fR adds a regular expression pattern which will get compared
+with the absolute disk_path of any data file. A match causes the file to
+stay in .template in any case.
+Alias: -jigdo-exclude
+.br
+\fBdemand_md5\fR adds a regular expression pattern which will get compared
+with the absolute disk_path of any data file that was not found in the .md5
+list. A match currently causes sudden program abort.
+(Should become a MISHAP event.)
+Alias: -jigdo-force-md5
+.br
+\fBmapping\fR adds a string pair of the form To=From to the parameter list.
+The absolute disk_path of any file that will be listed in the .jigdo file will
+be checked whether it begins with the From string. If so, this string will
+be replaced by the To string and a ':' character. E.g. "Debian=/mirror/debian".
+Alias: -jigdo-map
+.TP
 .B Character sets:
 .PP
 File names are strings of non-zero bytes with 8 bit each. Unfortunately
@@ -3307,6 +3375,10 @@ instead of -G to apply the effect of -boot_image isolinux partition_table=on.
 -partition_offset number is
 -boot_image any partition_offset=number.
 .br
+The options of genisoimage Jigdo Template Extraction are recognized and
+performed via xorriso option -jigdo. See the "Alias:" names there for the
+meaning of the genisoimage options.
+.br
 Personalites "\fBxorrisofs\fR", "\fBgenisoimage\fR",
 and "\fBgenisofs\fR" are aliases for "mkisofs".
 .br