From 399cbf6d66119270abce50a3fa6a8905eed588eb Mon Sep 17 00:00:00 2001 From: Thomas Schmitt Date: Thu, 7 Oct 2010 17:53:54 +0000 Subject: [PATCH] Enhanced xorriso docs about meaning of .md5 file addresses --- xorriso/xorriso.1 | 18 ++++---- xorriso/xorriso.info | 97 ++++++++++++++++++++++---------------------- xorriso/xorriso.texi | 18 ++++---- 3 files changed, 69 insertions(+), 64 deletions(-) diff --git a/xorriso/xorriso.1 b/xorriso/xorriso.1 index be0125de..8efc18bb 100644 --- a/xorriso/xorriso.1 +++ b/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 "Oct 03, 2010" +.TH XORRISO 1 "Oct 07, 2010" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -2420,21 +2420,24 @@ 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 .jigdo file contains checksums and symbolic file 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 +on a blank -outdev, and a .md5 file which lists those data files which may 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: +Each designated 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, -file address +symbolic 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 +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. +After eventual To=From mapping, the file address gets written into the .jigdo +file. Jigdo restore tools will convert these addresses into really +reachable data source addresses from which they can read. .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 @@ -2477,8 +2480,7 @@ 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.) +list. A match causes a MISHAP event. .br Alias: -jigdo-force-md5 .br diff --git a/xorriso/xorriso.info b/xorriso/xorriso.info index 0f75b29c..09b45f2a 100644 --- a/xorriso/xorriso.info +++ b/xorriso/xorriso.info @@ -2156,21 +2156,23 @@ 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. +single-session ISO image. The .jigdo file contains checksums and +symbolic file 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: +on a blank -outdev, and a .md5 file which lists those data files which +may be listed in the .jigdo file and externally referenced in the +.template file. Each designated 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, file address +blanks, symbolic 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. +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. +After eventual To=From mapping, the file address gets written into the +.jigdo file. Jigdo restore tools will convert these addresses into +really reachable data source addresses from which they can read. 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. @@ -2200,8 +2202,7 @@ and eventual padding will be counted as part of the ISO image. 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.) + found in the .md5 list. A match causes a MISHAP event. Alias: -jigdo-force-md5 *mapping* adds a string pair of the form To=From to the parameter list. If a data file gets listed in the .jigdo file, then it is @@ -3921,7 +3922,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 31) + (line 33) * -joliet enables production of Joliet tree: SetWrite. (line 10) * -list_delimiter replaces '--': Scripting. (line 38) * -list_formats lists available formats: Writing. (line 107) @@ -4139,7 +4140,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 31) +* Jigdo Template Extraction, -jigdo: Jigdo. (line 33) * Jigdo Template Extraction, _definition: Jigdo. (line 6) * List delimiter, _definiton: Processing. (line 8) * MBR, _definiton: Extras. (line 26) @@ -4287,37 +4288,37 @@ Node: Writing79789 Node: SetWrite86078 Node: Bootable98029 Node: Jigdo107119 -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 +Node: Charset111377 +Node: Exception114128 +Node: DialogCtl118643 +Node: Inquiry120988 +Node: Navigate125118 +Node: Verify132716 +Node: Restore141136 +Node: Emulation147792 +Node: Scripting155792 +Node: Frontend161354 +Node: Examples162555 +Node: ExDevices163724 +Node: ExCreate164358 +Node: ExDialog165632 +Node: ExGrowing166894 +Node: ExModifying167696 +Node: ExBootable168197 +Node: ExCharset168744 +Node: ExPseudo169572 +Node: ExCdrecord170466 +Node: ExMkisofs170781 +Node: ExGrowisofs171784 +Node: ExException172908 +Node: ExTime173362 +Node: ExIncBackup173821 +Node: ExRestore177293 +Node: ExRecovery178262 +Node: Files178828 +Node: Seealso180056 +Node: Legal180580 +Node: CommandIdx181502 +Node: ConceptIdx195446  End Tag Table diff --git a/xorriso/xorriso.texi b/xorriso/xorriso.texi index 3f32d664..8c5c0cee 100644 --- a/xorriso/xorriso.texi +++ b/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 "Oct 03, 2010" +@c man .TH XORRISO 1 "Oct 07, 2010" @c man .\" Please adjust this date whenever revising the manpage. @c man .\" @c man .\" Some roff macros, for reference: @@ -2894,21 +2894,24 @@ 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 .jigdo file contains checksums and symbolic file 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 +on a blank -outdev, and a .md5 file which lists those data files which may 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: +Each designated 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, -file address +symbolic 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 +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. +After eventual To=From mapping, the file address gets written into the .jigdo +file. Jigdo restore tools will convert these addresses into really +reachable data source addresses from which they can read. @* 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 @@ -2955,8 +2958,7 @@ 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.) +list. A match causes a MISHAP event. @* Alias: -jigdo-force-md5 @*