New option -jigdo

libisoburn/trunk/xorriso/xorriso.texi

@@ -44,7 +44,7 @@
 @c man .\" First parameter, NAME, should be all caps
 @c man .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
 @c man .\" other parameters are allowed: see man(7), man(1)
-@c man .TH XORRISO 1 "Sep 10, 2010"
+@c man .TH XORRISO 1 "Sep 29, 2010"
 @c man .\" Please adjust this date whenever revising the manpage.
 @c man .\"
 @c man .\" Some roff macros, for reference:
@@ -715,6 +715,7 @@ inner dashes are interpreted as underscores.
 * Writing::             Writing the result, drive control
 * SetWrite::            Settings for result writing
 * Bootable::            El Torito bootable ISO images
+* Jigdo::               Jigdo Template Extraction
 * Charset::             Character sets
 * Exception::           Exception processing
 * DialogCtl::           Dialog mode control
@@ -2677,7 +2678,7 @@ For images which will never get to a CD it is safe to use -padding 0 .
 @end table
 @c man .TP
 @c man .B El Torito bootable ISO images:
-@node Bootable, Charset, SetWrite, Options
+@node Bootable, Jigdo, SetWrite, Options
 @section El Torito bootable ISO images
 @c man .PP
 Contrary to published specifications many BIOSes will load an El Torito
@@ -2880,8 +2881,84 @@ partition offset. 0 chooses a default value.
 @*
 @end table
 @c man .TP
+@c man .B Jigdo Template Extraction:
+@node Jigdo, Charset, Bootable, Options
+@section Jigdo Template Extraction
+@c man .PP
+@cindex Jigdo Template Extraction, _definition
+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."
+@*
+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.
+@*
+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:
+@*
+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.
+@*
+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.
+@*
+@table @asis
+@sp 1
+@c man .TP
+@item -jigdo parameter_name value
+@kindex -jigdo   clears JTE or sets input/output character set
+@cindex Jigdo Template Extraction, -jigdo
+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.
+@*
+Parameter @strong{clear} with any value empties the whole list.
+No .jigdo and .template file will be produced.
+@*
+@strong{template_path} sets the disk_path for the .template file with the
+holed and compressed ISO image copy.
+Alias: -jigdo-template
+@*
+@strong{jigdo_path} sets the disk_path for the .jigdo file with the checksums
+and download addresses for filling the holes in .template.
+Alias: -jigdo-jigdo
+@*
+@strong{md5_path} sets the disk_path where to find the .md5 input file.
+Alias: -md5-list
+@*
+@strong{min_size} 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
+@*
+@strong{exclude} 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
+@*
+@strong{demand_md5} 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
+@*
+@strong{mapping} 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".
+@end table
+Alias: -jigdo-map
+@c man .TP
 @c man .B Character sets:
-@node Charset, Exception, Bootable, Options
+@node Charset, Exception, Jigdo, Options
 @section Character sets
 @c man .PP
 @cindex Character Set, _definition
@@ -3944,6 +4021,10 @@ instead of -G to apply the effect of -boot_image isolinux partition_table=on.
 @minus{}partition_offset number is
 @minus{}boot_image any partition_offset=number.
 @*
+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.
+@*
 Personalites "@strong{xorrisofs}", "@strong{genisoimage}",
 and "@strong{genisofs}" are aliases for "mkisofs".
 @*