From 5427d7a8f210aa1f8d26204e5731110349ef4614 Mon Sep 17 00:00:00 2001 From: Thomas Schmitt Date: Sat, 11 Dec 2010 08:28:23 +0000 Subject: [PATCH] Clarification about -md5, -check_media and -find ... -damaged --- xorriso/xorriso.1 | 25 +++++-- xorriso/xorriso.info | 151 +++++++++++++++++++++++-------------------- xorriso/xorriso.texi | 25 +++++-- 3 files changed, 117 insertions(+), 84 deletions(-) diff --git a/xorriso/xorriso.1 b/xorriso/xorriso.1 index c42310d8..9354f63c 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 "Dec 06, 2010" +.TH XORRISO 1 "Dec 10, 2010" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -376,9 +376,8 @@ demands a file name length of up to 255 characters and paths of up to 1024 characters. Rock Ridge fulfills this demand. .PP An \fBEl Torito\fR -boot record connects one or more boot images, which are binary program files -stored in the ISO image, with the bootstrapping facility of -contemporary computers. +boot record points the BIOS bootstrapping facility to one or more boot +images, which are binary program files stored in the ISO image. The content of the boot image files is not in the scope of El Torito. .br Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images. @@ -397,7 +396,8 @@ Emulation -as mkisofs supports the example options out of the ISOLINUX wiki, the options used in GRUB script grub-mkrescue, and the example in the FreeBSD AvgLiveCD wiki. .br -The support for other boot image types is sparse. +There is support for boot facilities other than PC BIOS: +EFI, MIPS Big Endian (SGI), MIPS Little Endian (DEC), SUN SPARC. .br .PP \fBACL\fR @@ -1505,6 +1505,9 @@ Matches files which use data blocks marked as damaged by a previous run of -check_media. The damage info vanishes when a new ISO image gets loaded. .br +Note that a MD5 session mismatch marks all files of the session as damaged. +If finer distinction is desired, perform -md5 off before -check_media. +.br \fB\-pending_data\fR : Matches files which get their content from outside the loaded ISO image. .br @@ -1718,7 +1721,7 @@ E.g.: .br \fBestimate_size\fR prints a lower and an upper estimation of the number of blocks which the -found files together will occupy in the emering ISO image. +found files together will occupy in the emerging ISO image. This does not account for the superblock, for the directories in the -find path, or for image padding. .br @@ -3042,7 +3045,7 @@ given as start address for -findx. actions it will always perform action "echo". .br \fBin_iso\fR -reports the path if its counterpart exist in the ISO image. +reports the path if its counterpart exists in the ISO image. For this the disk_path of the -findx command gets replaced by the iso_rr_path given as parameter. .br @@ -3066,6 +3069,12 @@ contains files. To be used with -type "m" to report mount points. \fBempty_iso_dir\fR deletes all files from the counterpart in the ISO image. To be used with -type "m" to truncate mount points. +.br +\fBestimate_size\fR +prints a lower and an upper estimation of the number of blocks which the +found files together will occupy in the emerging ISO image. +This does not account for the superblock, +for the directories in the -findx path, or for image padding. .TP \fB\-compare\fR disk_path iso_rr_path Compare attributes and eventual data file content of a fileobject in the @@ -3177,6 +3186,8 @@ Non-default options are: \fBreport="files"\fR lists the files which use damaged blocks (not with use=outdev). The format is like with find -exec report_damage. +Note that a MD5 session mismatch marks all files of the session as damaged. +If finer distinction is desired, perform -md5 off before -check_media. .br \fBreport="blocks_files"\fR first lists damaged blocks and then affected files. diff --git a/xorriso/xorriso.info b/xorriso/xorriso.info index 33c7f474..add55080 100644 --- a/xorriso/xorriso.info +++ b/xorriso/xorriso.info @@ -335,10 +335,10 @@ characters of filename length. It is the X/Open System Interface standard XSI which demands a file name length of up to 255 characters and paths of up to 1024 characters. Rock Ridge fulfills this demand. - An *El Torito* boot record connects one or more boot images, which -are binary program files stored in the ISO image, with the -bootstrapping facility of contemporary computers. The content of the -boot image files is not in the scope of El Torito. + An *El Torito* boot record points the BIOS bootstrapping facility to +one or more boot images, which are binary program files stored in the +ISO image. The content of the boot image files is not in the scope of +El Torito. Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images. xorriso is able to create or maintain an El Torito object which makes such an image bootable. For details see option -boot_image. @@ -351,7 +351,8 @@ follow-up session can get in effect only on overwriteable media. Emulation -as mkisofs supports the example options out of the ISOLINUX wiki, the options used in GRUB script grub-mkrescue, and the example in the FreeBSD AvgLiveCD wiki. -The support for other boot image types is sparse. +There is support for boot facilities other than PC BIOS: EFI, MIPS Big +Endian (SGI), MIPS Little Endian (DEC), SUN SPARC. *ACL* are an advanced way of controlling access permissions to file objects. Neither ISO 9660 nor Rock Ridge specify a way to record ACLs. @@ -1377,6 +1378,9 @@ File: xorriso.info, Node: CmdFind, Next: Filter, Prev: Manip, Up: Options Matches files which use data blocks marked as damaged by a previous run of -check_media. The damage info vanishes when a new ISO image gets loaded. + Note that a MD5 session mismatch marks all files of the + session as damaged. If finer distinction is desired, perform + -md5 off before -check_media. -pending_data : Matches files which get their content from outside the loaded ISO image. @@ -1546,7 +1550,7 @@ File: xorriso.info, Node: CmdFind, Next: Filter, Prev: Manip, Up: Options estimate_size prints a lower and an upper estimation of the number of blocks which the found files together will occupy in the - emering ISO image. This does not account for the superblock, + emerging ISO image. This does not account for the superblock, for the directories in the -find path, or for image padding. find performs another run of -find on the matching file address. @@ -2695,7 +2699,7 @@ File: xorriso.info, Node: Navigate, Next: Verify, Prev: Inquiry, Up: Options following few actions it will always perform action "echo". in_iso - reports the path if its counterpart exist in the ISO image. + reports the path if its counterpart exists in the ISO image. For this the disk_path of the -findx command gets replaced by the iso_rr_path given as parameter. E.g.: -findx /home/thomas -exec in_iso /thomas_on_cd -- @@ -2712,6 +2716,11 @@ File: xorriso.info, Node: Navigate, Next: Verify, Prev: Inquiry, Up: Options empty_iso_dir deletes all files from the counterpart in the ISO image. To be used with -type "m" to truncate mount points. + estimate_size + prints a lower and an upper estimation of the number of + blocks which the found files together will occupy in the + emerging ISO image. This does not account for the superblock, + for the directories in the -findx path, or for image padding. -compare disk_path iso_rr_path Compare attributes and eventual data file content of a fileobject @@ -2812,7 +2821,9 @@ transmission errors. report="files" lists the files which use damaged blocks (not with use=outdev). The format is like with find -exec - report_damage. + report_damage. Note that a MD5 session mismatch marks all + files of the session as damaged. If finer distinction is + desired, perform -md5 off before -check_media. report="blocks_files" first lists damaged blocks and then affected files. use="outdev" @@ -3945,8 +3956,8 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -cd sets working directory in ISO: Navigate. (line 7) * -cdx sets working directory on disk: Navigate. (line 16) * -charset sets input/output character set: Charset. (line 43) -* -check_md5 verifies file checksum: Verify. (line 144) -* -check_md5_r verifies file tree checksums: Verify. (line 160) +* -check_md5 verifies file checksum: Verify. (line 146) +* -check_md5_r verifies file tree checksums: Verify. (line 162) * -check_media reads media block by block: Verify. (line 21) * -check_media_defaults sets -check_media options: Verify. (line 40) * -chgrp sets group in ISO image: Manip. (line 50) @@ -3959,9 +3970,9 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -close_filter_list bans filter registration: Filter. (line 52) * -commit writes pending ISO image: Writing. (line 13) * -commit_eject writes and ejects: Writing. (line 40) -* -compare reports ISO/disk differences: Navigate. (line 134) -* -compare_l reports ISO/disk differences: Navigate. (line 152) -* -compare_r reports ISO/disk differences: Navigate. (line 147) +* -compare reports ISO/disk differences: Navigate. (line 139) +* -compare_l reports ISO/disk differences: Navigate. (line 157) +* -compare_r reports ISO/disk differences: Navigate. (line 152) * -compliance controls standard compliance: SetWrite. (line 14) * -copyright_file sets copyright file name: SetWrite. (line 125) * -cp_rx copies file trees to disk: Restore. (line 104) @@ -4092,8 +4103,8 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -setfattr sets xattr in ISO image: Manip. (line 110) * -setfattr_list sets xattr in ISO image: Manip. (line 126) * -setfattr_r sets xattr in ISO image: Manip. (line 123) -* -show_stream shows data source and filters: Navigate. (line 157) -* -show_stream_r shows data source and filters: Navigate. (line 172) +* -show_stream shows data source and filters: Navigate. (line 162) +* -show_stream_r shows data source and filters: Navigate. (line 177) * -speed set write speed: SetWrite. (line 182) * -split_size enables large file splitting: SetInsert. (line 140) * -status shows current settings: Scripting. (line 25) @@ -4125,7 +4136,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top [index] * Menu: -* ACL, _definiton: Extras. (line 37) +* ACL, _definiton: Extras. (line 38) * ACL, control handling, -acl: Loading. (line 142) * ACL, set in ISO image, -setfacl: Manip. (line 73) * ACL, set in ISO image, -setfacl_list: Manip. (line 100) @@ -4186,8 +4197,8 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Filter, apply to file, -set_filter: Filter. (line 59) * Filter, ban registration, -close_filter_list: Filter. (line 52) * Filter, register, -external_filter: Filter. (line 20) -* Filter, show chain, -show_stream: Navigate. (line 157) -* Filter, show chains of tree, -show_stream_r: Navigate. (line 172) +* Filter, show chain, -show_stream: Navigate. (line 162) +* Filter, show chains of tree, -show_stream_r: Navigate. (line 177) * Filter, unregister, -unregister_filter: Filter. (line 48) * Filter, zisofs parameters, -zisofs: SetWrite. (line 170) * Group, global in ISO image, -gid: SetWrite. (line 166) @@ -4331,11 +4342,11 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Tree, disk, traverse, -findx: Navigate. (line 105) * Tree, ISO, traverse and alter, -find: CmdFind. (line 7) * Verify, check blocks, -check_media: Verify. (line 21) -* Verify, compare ISO and disk file, -compare: Navigate. (line 134) -* Verify, compare ISO and disk tree, -compare_r: Navigate. (line 147) -* Verify, compare ISO and disk, -compare_l: Navigate. (line 152) -* Verify, file checksum, -check_md5: Verify. (line 144) -* Verify, file tree checksums, -check_md5_r: Verify. (line 160) +* Verify, compare ISO and disk file, -compare: Navigate. (line 139) +* Verify, compare ISO and disk tree, -compare_r: Navigate. (line 152) +* Verify, compare ISO and disk, -compare_l: Navigate. (line 157) +* Verify, file checksum, -check_md5: Verify. (line 146) +* Verify, file tree checksums, -check_md5_r: Verify. (line 162) * Verify, preset -check_media, -check_media_defaults: Verify. (line 40) * Write, block size, -dvd_obs: SetWrite. (line 209) * Write, bootability, -boot_image: Bootable. (line 26) @@ -4353,7 +4364,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Write, predict image size, -print_size: Inquiry. (line 69) * Write, set speed, -speed: SetWrite. (line 182) * Write, simulation, -dummy: SetWrite. (line 222) -* xattr, _definiton: Extras. (line 51) +* xattr, _definiton: Extras. (line 52) * xattr, control handling, -xattr: Loading. (line 150) * xattr, set in ISO image, -setfattr: Manip. (line 110) * xattr, set in ISO image, -setfattr_list: Manip. (line 126) @@ -4371,51 +4382,51 @@ Node: Media6089 Node: Methods8739 Node: Drives11295 Node: Extras14601 -Node: Processing18028 -Node: Dialog21524 -Node: Options23181 -Node: AqDrive24789 -Node: Loading27695 -Node: Insert40839 -Node: SetInsert49196 -Node: Manip57763 -Node: CmdFind66444 -Node: Filter76689 -Node: Writing81038 -Node: SetWrite87327 -Node: Bootable99278 -Node: Jigdo111585 -Node: Charset115843 -Node: Exception118594 -Node: DialogCtl123109 -Node: Inquiry125454 -Node: Navigate129584 -Node: Verify137182 -Node: Restore145602 -Node: Emulation152258 -Node: Scripting160547 -Node: Frontend166109 -Node: Examples167404 -Node: ExDevices168573 -Node: ExCreate169207 -Node: ExDialog170481 -Node: ExGrowing171743 -Node: ExModifying172545 -Node: ExBootable173046 -Node: ExCharset173593 -Node: ExPseudo174421 -Node: ExCdrecord175315 -Node: ExMkisofs175630 -Node: ExGrowisofs176633 -Node: ExException177757 -Node: ExTime178211 -Node: ExIncBackup178670 -Node: ExRestore182142 -Node: ExRecovery183111 -Node: Files183677 -Node: Seealso184905 -Node: Legal185429 -Node: CommandIdx186351 -Node: ConceptIdx200577 +Node: Processing18074 +Node: Dialog21570 +Node: Options23227 +Node: AqDrive24835 +Node: Loading27741 +Node: Insert40885 +Node: SetInsert49242 +Node: Manip57809 +Node: CmdFind66490 +Node: Filter76914 +Node: Writing81263 +Node: SetWrite87552 +Node: Bootable99503 +Node: Jigdo111810 +Node: Charset116068 +Node: Exception118819 +Node: DialogCtl123334 +Node: Inquiry125679 +Node: Navigate129809 +Node: Verify137704 +Node: Restore146293 +Node: Emulation152949 +Node: Scripting161238 +Node: Frontend166800 +Node: Examples168095 +Node: ExDevices169264 +Node: ExCreate169898 +Node: ExDialog171172 +Node: ExGrowing172434 +Node: ExModifying173236 +Node: ExBootable173737 +Node: ExCharset174284 +Node: ExPseudo175112 +Node: ExCdrecord176006 +Node: ExMkisofs176321 +Node: ExGrowisofs177324 +Node: ExException178448 +Node: ExTime178902 +Node: ExIncBackup179361 +Node: ExRestore182833 +Node: ExRecovery183802 +Node: Files184368 +Node: Seealso185596 +Node: Legal186120 +Node: CommandIdx187042 +Node: ConceptIdx201268  End Tag Table diff --git a/xorriso/xorriso.texi b/xorriso/xorriso.texi index fc0fbb48..3ee3ee0d 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 "Dec 06, 2010" +@c man .TH XORRISO 1 "Dec 10, 2010" @c man .\" Please adjust this date whenever revising the manpage. @c man .\" @c man .\" Some roff macros, for reference: @@ -504,9 +504,8 @@ characters. Rock Ridge fulfills this demand. @sp 1 @cindex El Torito, _definiton An @strong{El Torito} -boot record connects one or more boot images, which are binary program files -stored in the ISO image, with the bootstrapping facility of -contemporary computers. +boot record points the BIOS bootstrapping facility to one or more boot +images, which are binary program files stored in the ISO image. The content of the boot image files is not in the scope of El Torito. @* Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images. @@ -526,7 +525,8 @@ Emulation -as mkisofs supports the example options out of the ISOLINUX wiki, the options used in GRUB script grub-mkrescue, and the example in the FreeBSD AvgLiveCD wiki. @* -The support for other boot image types is sparse. +There is support for boot facilities other than PC BIOS: +EFI, MIPS Big Endian (SGI), MIPS Little Endian (DEC), SUN SPARC. @* @c man .PP @sp 1 @@ -1852,6 +1852,9 @@ Matches files which use data blocks marked as damaged by a previous run of -check_media. The damage info vanishes when a new ISO image gets loaded. @* +Note that a MD5 session mismatch marks all files of the session as damaged. +If finer distinction is desired, perform -md5 off before -check_media. +@* @item -pending_data : Matches files which get their content from outside the loaded ISO image. @* @@ -2083,7 +2086,7 @@ E.g.: @* @item estimate_size prints a lower and an upper estimation of the number of blocks which the -found files together will occupy in the emering ISO image. +found files together will occupy in the emerging ISO image. This does not account for the superblock, for the directories in the -find path, or for image padding. @* @@ -3633,7 +3636,7 @@ actions it will always perform action "echo". @table @asis @sp 1 @item in_iso -reports the path if its counterpart exist in the ISO image. +reports the path if its counterpart exists in the ISO image. For this the disk_path of the -findx command gets replaced by the iso_rr_path given as parameter. @* @@ -3657,6 +3660,12 @@ contains files. To be used with -type "m" to report mount points. @item empty_iso_dir deletes all files from the counterpart in the ISO image. To be used with -type "m" to truncate mount points. +@* +@item estimate_size +prints a lower and an upper estimation of the number of blocks which the +found files together will occupy in the emerging ISO image. +This does not account for the superblock, +for the directories in the -findx path, or for image padding. @end table @c man .TP @item -compare disk_path iso_rr_path @@ -3791,6 +3800,8 @@ Non-default options are: @item report="files" lists the files which use damaged blocks (not with use=outdev). The format is like with find -exec report_damage. +Note that a MD5 session mismatch marks all files of the session as damaged. +If finer distinction is desired, perform -md5 off before -check_media. @* @item report="blocks_files" first lists damaged blocks and then affected files.