From 25460413cef5ab2fe127e411c460f23f569fa849 Mon Sep 17 00:00:00 2001 From: Thomas Schmitt Date: Sun, 3 Oct 2010 17:15:08 +0000 Subject: [PATCH] Corrected xorriso docs about meaning of -jigdo-map and .md5 file addresses --- xorriso/xorriso.1 | 26 ++++++--- xorriso/xorriso.info | 104 ++++++++++++++++++++---------------- xorriso/xorriso.texi | 26 ++++++--- xorriso/xorriso_timestamp.h | 2 +- 4 files changed, 98 insertions(+), 60 deletions(-) diff --git a/xorriso/xorriso.1 b/xorriso/xorriso.1 index 1961647a..be0125de 100644 --- a/xorriso/xorriso.1 +++ b/xorriso/xorriso.1 @@ -2430,8 +2430,11 @@ 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, -basename of file in the disk filesystem (directory path is allowed but gets -ignored). +file address +.br +The file address in an .md5 line has to bear the same basename as the +absolute disk_path of the file which it shall match. The directory path of +the file address is decisive for To=From mapping, not for file recognition. .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 @@ -2449,48 +2452,59 @@ 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. +.br 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. +.br Alias: -jigdo-jigdo .br \fBmd5_path\fR sets the disk_path where to find the .md5 input file. +.br 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. +.br 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. +.br 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.) +.br 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. The From string should end -by a '/' character. +If a data file gets listed in the .jigdo file, then it is referred by the +file address from its line in the .md5 file. This file address gets checked +whether it begins with the From string. If so, then this string will be +replaced by the To string and a ':' character, before it goes into the .jigdo +file. The From string should end by a '/' character. +.br Alias: -jigdo-map .br \fBcompression\fR chooses one of "bzip2" or "gzip" for the compression of the template file. The jigdo file is put out uncompressed. +.br Alias: -jigdo-template-compress .br \fBchecksum_iso\fR chooses one or more of "md5", "sha1", "sha256", "sha512" for the auxiliary "# Image Hex" checksums in the jigdo file. The value may e.g. look like "md5,sha1,sha512". Value "all" chooses all available algorithms. Note that MD5 stays always enabled. +.br Alias: -checksum_algorithm_iso .br \fBchecksum_template\fR is like checksum_iso but for "# Template Hex". +.br Alias: -checksum_algorithm_template .TP .B Character sets: diff --git a/xorriso/xorriso.info b/xorriso/xorriso.info index d96f0bf6..0f75b29c 100644 --- a/xorriso/xorriso.info +++ b/xorriso/xorriso.info @@ -2166,8 +2166,11 @@ 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, basename of file in the disk filesystem (directory path is -allowed but gets ignored). +blanks, file address +The file address in an .md5 line has to bear the same basename as the +absolute disk_path of the file which it shall match. The directory path +of the file address is decisive for To=From mapping, not for file +recognition. 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 eventual padding will be counted as part of the ISO image. @@ -2180,27 +2183,33 @@ and eventual padding will be counted as part of the ISO image. Parameter *clear* with any value empties the whole list. No .jigdo and .template file will be produced. *template_path* sets the disk_path for the .template file with the - holed and compressed ISO image copy. Alias: -jigdo-template + holed and compressed ISO image copy. + Alias: -jigdo-template *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 + .template. + Alias: -jigdo-jigdo *md5_path* sets the disk_path where to find the .md5 input file. Alias: -md5-list *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 + the .jigdo file and being a hole in the .template file. + Alias: -jigdo-min-file-size *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 + file to stay in .template in any case. + Alias: -jigdo-exclude *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 + abort. (Should become a MISHAP event.) + Alias: -jigdo-force-md5 *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. The From string should end by a '/' character. + list. If a data file gets listed in the .jigdo file, then it is + referred by the file address from its line in the .md5 file. This + file address gets checked whether it begins with the From string. + If so, then this string will be replaced by the To string and a + ':' character, before it goes into the .jigdo file. The From + string should end by a '/' character. Alias: -jigdo-map *compression* chooses one of "bzip2" or "gzip" for the compression of the template file. The jigdo file is put out uncompressed. @@ -2209,7 +2218,8 @@ and eventual padding will be counted as part of the ISO image. "sha512" for the auxiliary "# Image Hex" checksums in the jigdo file. The value may e.g. look like "md5,sha1,sha512". Value "all" chooses all available algorithms. Note that MD5 stays always - enabled. Alias: -checksum_algorithm_iso + enabled. + Alias: -checksum_algorithm_iso *checksum_template* is like checksum_iso but for "# Template Hex". Alias: -checksum_algorithm_template @@ -3911,7 +3921,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -indev aquires a drive for input: AqDrive. (line 22) * -iso_rr_pattern controls pattern expansion: Manip. (line 10) * -jigdo clears JTE or sets input/output character set: Jigdo. - (line 28) + (line 31) * -joliet enables production of Joliet tree: SetWrite. (line 10) * -list_delimiter replaces '--': Scripting. (line 38) * -list_formats lists available formats: Writing. (line 107) @@ -4129,7 +4139,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Insert, pathspecs, -add: Insert. (line 42) * Insert, piece of data file, -cut_out: Insert. (line 126) * iso_rr_path, _definition: Insert. (line 7) -* Jigdo Template Extraction, -jigdo: Jigdo. (line 28) +* Jigdo Template Extraction, -jigdo: Jigdo. (line 31) * Jigdo Template Extraction, _definition: Jigdo. (line 6) * List delimiter, _definiton: Processing. (line 8) * MBR, _definiton: Extras. (line 26) @@ -4277,37 +4287,37 @@ Node: Writing79789 Node: SetWrite86078 Node: Bootable98029 Node: Jigdo107119 -Node: Charset110943 -Node: Exception113694 -Node: DialogCtl118209 -Node: Inquiry120554 -Node: Navigate124684 -Node: Verify132282 -Node: Restore140702 -Node: Emulation147358 -Node: Scripting155358 -Node: Frontend160920 -Node: Examples162121 -Node: ExDevices163290 -Node: ExCreate163924 -Node: ExDialog165198 -Node: ExGrowing166460 -Node: ExModifying167262 -Node: ExBootable167763 -Node: ExCharset168310 -Node: ExPseudo169138 -Node: ExCdrecord170032 -Node: ExMkisofs170347 -Node: ExGrowisofs171350 -Node: ExException172474 -Node: ExTime172928 -Node: ExIncBackup173387 -Node: ExRestore176859 -Node: ExRecovery177828 -Node: Files178394 -Node: Seealso179622 -Node: Legal180146 -Node: CommandIdx181068 -Node: ConceptIdx195012 +Node: Charset111222 +Node: Exception113973 +Node: DialogCtl118488 +Node: Inquiry120833 +Node: Navigate124963 +Node: Verify132561 +Node: Restore140981 +Node: Emulation147637 +Node: Scripting155637 +Node: Frontend161199 +Node: Examples162400 +Node: ExDevices163569 +Node: ExCreate164203 +Node: ExDialog165477 +Node: ExGrowing166739 +Node: ExModifying167541 +Node: ExBootable168042 +Node: ExCharset168589 +Node: ExPseudo169417 +Node: ExCdrecord170311 +Node: ExMkisofs170626 +Node: ExGrowisofs171629 +Node: ExException172753 +Node: ExTime173207 +Node: ExIncBackup173666 +Node: ExRestore177138 +Node: ExRecovery178107 +Node: Files178673 +Node: Seealso179901 +Node: Legal180425 +Node: CommandIdx181347 +Node: ConceptIdx195291  End Tag Table diff --git a/xorriso/xorriso.texi b/xorriso/xorriso.texi index fde965fd..3f32d664 100644 --- a/xorriso/xorriso.texi +++ b/xorriso/xorriso.texi @@ -2904,8 +2904,11 @@ 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, -basename of file in the disk filesystem (directory path is allowed but gets -ignored). +file address +@* +The file address in an .md5 line has to bear the same basename as the +absolute disk_path of the file which it shall match. The directory path of +the file address is decisive for To=From mapping, not for file recognition. @* 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 @@ -2927,48 +2930,59 @@ 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. The From string should end -by a '/' character. +If a data file gets listed in the .jigdo file, then it is referred by the +file address from its line in the .md5 file. This file address gets checked +whether it begins with the From string. If so, then this string will be +replaced by the To string and a ':' character, before it goes into the .jigdo +file. The From string should end by a '/' character. +@* Alias: -jigdo-map @* @strong{compression} chooses one of "bzip2" or "gzip" for the compression of the template file. The jigdo file is put out uncompressed. +@* Alias: -jigdo-template-compress @* @strong{checksum_iso} chooses one or more of "md5", "sha1", "sha256", "sha512" for the auxiliary "# Image Hex" checksums in the jigdo file. The value may e.g. look like "md5,sha1,sha512". Value "all" chooses all available algorithms. Note that MD5 stays always enabled. +@* Alias: -checksum_algorithm_iso @* @strong{checksum_template} is like checksum_iso but for "# Template Hex". +@* Alias: -checksum_algorithm_template @end table @c man .TP diff --git a/xorriso/xorriso_timestamp.h b/xorriso/xorriso_timestamp.h index ac5363b4..8fa90d08 100644 --- a/xorriso/xorriso_timestamp.h +++ b/xorriso/xorriso_timestamp.h @@ -1 +1 @@ -#define Xorriso_timestamP "2010.10.03.082304" +#define Xorriso_timestamP "2010.10.03.171305"