Mentioned in the man page that libisofs now memorizes all boot related paths at image load time. Warned of boot file manipulations after -boot_image replay.

This commit is contained in:
Thomas Schmitt 2024-05-12 14:02:45 +02:00
parent 4818eeaa5f
commit 87e1d67417
3 changed files with 135 additions and 75 deletions

View File

@ -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 "Version 1.5.7, May 07, 2024"
.TH XORRISO 1 "Version 1.5.7, May 12, 2024"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@ -3621,9 +3621,19 @@ boot provisions in the System Area. It discards any existing \-boot_image
setting including the system area and executes the commands proposed by
command \-report_el_torito "cmd".
.br
This action will only succeed if the file objects mentioned in the
output of command \-report_el_torito "cmd" are still available. Do not
remove or rename boot image files after \-indev.
Special care has to be taken with manipulations of files in the emerging ISO
filesystem which are mentioned by \-report_el_torito "cmd". Their paths are
memorized at ISO image load time.
In general \-boot_image "any" "replay" should be applied after all file
manipulations are done. All file paths from the \-report_el_torito commands
must then still lead to data files which are suitable for their respective
commands.
.br
The effects of file path changes after \-boot_image "any" "replay" can be
surprising. E.g. removing or replacing a boot image with boot info table
for legacy BIOS leads to a hidden boot image with the content as it was at
"replay" time. Doing the same with a boot image for EFI leads to an error
at \-commit time or to the new file content becomming the EFI boot image.
.br
Out of historical reasons \fBreplay\fR does not revoke all possibly made
\-append_partition settings but only overwrites those for which the loaded
@ -4712,6 +4722,11 @@ reads file paths from file /ppc/bootinfo.txt and tries to find them
case\-insensitively in the ECMA\-119 tree without using Rock Ridge. If such a
path has actually forbidden properties, like the name "powerpc\-ieee1275", then
the relaxations are needed to bring it unmangled into the ECMA\-119 tree.
.br
It is important to keep in mind that the file paths shown in the report lines
and commands were registered directly after image loading. Possible filesystem
manipulations which later remove these paths or replace their file content will
not influence the report lines or commands.
.TP
\fB\-report_system_area\fR mode
With mode \fBplain\fR print a report about the information found in
@ -4726,6 +4741,11 @@ mentioned boot facilities.
Modes \fBcmd\fR and \fBas_mkisofs\fR work like with
command \-report_el_torito. See above.
.br
It is important to keep in mind that the file paths shown in the report lines
and commands were registered directly after image loading. Possible filesystem
manipulations which later remove these paths or replace their file content will
not influence the report lines or commands.
.br
With mode \fBgpt_disk_guid\fR print the GPT disk GUID of the loaded ISO
in RFC 4122 text format to result channel. It is not considered an error if
no GPT is present. In this case nothing is printed to result channel.

View File

@ -3063,9 +3063,19 @@ Examples:
boot provisions in the System Area. It discards any existing
-boot_image setting including the system area and executes the
commands proposed by command -report_el_torito "cmd".
This action will only succeed if the file objects mentioned in the
output of command -report_el_torito "cmd" are still available. Do
not remove or rename boot image files after -indev.
Special care has to be taken with manipulations of files in the
emerging ISO filesystem which are mentioned by -report_el_torito
"cmd". Their paths are memorized at ISO image load time. In
general -boot_image "any" "replay" should be applied after all file
manipulations are done. All file paths from the -report_el_torito
commands must then still lead to data files which are suitable for
their respective commands.
The effects of file path changes after -boot_image "any" "replay"
can be surprising. E.g. removing or replacing a boot image with
boot info table for legacy BIOS leads to a hidden boot image with
the content as it was at "replay" time. Doing the same with a boot
image for EFI leads to an error at -commit time or to the new file
content becomming the EFI boot image.
Out of historical reasons *replay* does not revoke all possibly
made -append_partition settings but only overwrites those for which
the loaded ISO image provides candidates.
@ -3959,6 +3969,11 @@ File: xorriso.info, Node: Inquiry, Next: Navigate, Prev: DialogCtl, Up: Comm
Rock Ridge. If such a path has actually forbidden properties, like
the name "powerpc-ieee1275", then the relaxations are needed to
bring it unmangled into the ECMA-119 tree.
It is important to keep in mind that the file paths shown in the
report lines and commands were registered directly after image
loading. Possible filesystem manipulations which later remove
these paths or replace their file content will not influence the
report lines or commands.
-report_system_area mode
With mode *plain* print a report about the information found in the
System Area of the loaded ISO image. The report consists of zero
@ -3969,6 +3984,11 @@ File: xorriso.info, Node: Inquiry, Next: Navigate, Prev: DialogCtl, Up: Comm
boot facilities.
Modes *cmd* and *as_mkisofs* work like with command
-report_el_torito. See above.
It is important to keep in mind that the file paths shown in the
report lines and commands were registered directly after image
loading. Possible filesystem manipulations which later remove
these paths or replace their file content will not influence the
report lines or commands.
With mode *gpt_disk_guid* print the GPT disk GUID of the loaded ISO
in RFC 4122 text format to result channel. It is not considered an
error if no GPT is present. In this case nothing is printed to
@ -5734,7 +5754,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -alter_date sets timestamps in ISO image: Manip. (line 139)
* -alter_date_r sets timestamps in ISO image: Manip. (line 174)
* -append_partition adds arbitrary file after image end: Bootable.
(line 454)
(line 464)
* -application_id sets application id: SetWrite. (line 218)
* -application_use sets application use field: SetWrite. (line 293)
* -as emulates mkisofs or cdrecord: Emulation. (line 13)
@ -5910,7 +5930,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -reassure enables confirmation question: DialogCtl. (line 29)
* -report_about controls verbosity: Exception. (line 53)
* -report_el_torito shows Boot Catalog: Inquiry. (line 150)
* -report_system_area shows MBR, GPT, and alike: Inquiry. (line 180)
* -report_system_area shows MBR, GPT, and alike: Inquiry. (line 185)
* -return_with controls exit value: Exception. (line 38)
* -rm deletes files from ISO image: Manip. (line 20)
* -rmdir deletes ISO directory: Manip. (line 29)
@ -5986,14 +6006,14 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* ACL, show in ISO image, -getfacl: Navigate. (line 60)
* ACL, show in ISO image, -getfacl_r: Navigate. (line 66)
* ACL, _definition: Extras. (line 50)
* APM block size: Bootable. (line 445)
* APM block size: Bootable. (line 455)
* APM, _definition: Extras. (line 42)
* Appendable media, _definition: Media. (line 43)
* Appended Filesystem Image, -append_partition: Bootable. (line 454)
* Appended partition, in APM: Bootable. (line 310)
* Appended partition, in MBR or GPT: Bootable. (line 301)
* Appended partitions, GPT: Bootable. (line 483)
* Appended partitions, MBR: Bootable. (line 464)
* Appended Filesystem Image, -append_partition: Bootable. (line 464)
* Appended partition, in APM: Bootable. (line 320)
* Appended partition, in MBR or GPT: Bootable. (line 311)
* Appended partitions, GPT: Bootable. (line 493)
* Appended partitions, MBR: Bootable. (line 474)
* Automatic execution order, of arguments, -x: ArgSort. (line 16)
* Backslash Interpretation, _definition: Processing. (line 57)
* Backup, enable fast incremental, -disk_dev_ino: Loading. (line 255)
@ -6011,15 +6031,15 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Character set, learn from image, -auto_charset: Loading. (line 117)
* Character Set, of terminal, -local_charset: Charset. (line 57)
* Character Set, _definition: Charset. (line 6)
* CHRP partition, _definition: Bootable. (line 317)
* CHRP partition, _definition: Bootable. (line 327)
* Closed media, _definition: Media. (line 49)
* Comment, #: Scripting. (line 156)
* Control, signal handling, -signal_handling: Exception. (line 66)
* Create, new ISO image, _definition: Methods. (line 7)
* Cylinder alignment, _definition: Bootable. (line 361)
* Cylinder size, _definition: Bootable. (line 346)
* Cylinder alignment, _definition: Bootable. (line 371)
* Cylinder size, _definition: Bootable. (line 356)
* Damaged track and session, close, -close_damaged: Writing. (line 209)
* DEC Alpha SRM boot sector, production: Bootable. (line 431)
* DEC Alpha SRM boot sector, production: Bootable. (line 441)
* Delete, from ISO image, -rm: Manip. (line 20)
* Delete, from ISO image, -rm_r: Manip. (line 26)
* Delete, ISO directory, -rmdir: Manip. (line 29)
@ -6051,7 +6071,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Drive, _definition: Drives. (line 6)
* EA, _definition: Extras. (line 66)
* ECMA-119, _definition: Model. (line 6)
* EFI system partition, _definition: Bootable. (line 326)
* EFI system partition, _definition: Bootable. (line 336)
* El Torito, _definition: Extras. (line 19)
* Emulation, -as: Emulation. (line 13)
* Emulation, .mkisofsrc, -read_mkisofsrc: Emulation. (line 155)
@ -6076,19 +6096,19 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Filter, _definition: Filter. (line 6)
* Frontend program, start at pipes, -launch_frontend: Frontend.
(line 141)
* GPT Legacy BIOS bootable flag, set for ISO: Bootable. (line 383)
* GPT read-only flag, do not set for ISO: Bootable. (line 388)
* GPT, control GUID, -boot_image gpt_disk_guid=: Bootable. (line 242)
* GPT Legacy BIOS bootable flag, set for ISO: Bootable. (line 393)
* GPT read-only flag, do not set for ISO: Bootable. (line 398)
* GPT, control GUID, -boot_image gpt_disk_guid=: Bootable. (line 252)
* GPT, _definition: Extras. (line 39)
* Group, global in ISO image, -gid: SetWrite. (line 314)
* Group, in ISO image, -chgrp: Manip. (line 49)
* Group, in ISO image, -chgrp_r: Manip. (line 53)
* Growing, _definition: Methods. (line 20)
* Hard links, control handling, -hardlinks: Loading. (line 128)
* HFS+ allocation block size: Bootable. (line 442)
* HFS+ serial number: Bootable. (line 439)
* HFS+ allocation block size: Bootable. (line 452)
* HFS+ serial number: Bootable. (line 449)
* hidden, set in ISO image, -hide: Manip. (line 177)
* HP-PA boot sector, production: Bootable. (line 414)
* HP-PA boot sector, production: Bootable. (line 424)
* Image reading, cache size, -data_cache_size: Loading. (line 361)
* Image, demand volume ID, -assert_volid: Loading. (line 105)
* Image, discard pending changes, -rollback: Writing. (line 9)
@ -6108,7 +6128,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Image, set volume timestamp, -volume_date: SetWrite. (line 232)
* Image, show Boot Catalog: Inquiry. (line 150)
* Image, show id strings, -pvd_info: Inquiry. (line 142)
* Image, show MBR, GPT, and alike, -pvd_info: Inquiry. (line 180)
* Image, show MBR, GPT, and alike, -pvd_info: Inquiry. (line 185)
* Image, _definition: Model. (line 9)
* Input Character Set, _definition: Charset. (line 25)
* Insert, enable overwriting, -overwrite: SetInsert. (line 140)
@ -6145,15 +6165,15 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Linux device type, -scsi_dev_family: AqDrive. (line 95)
* List delimiter, _definition: Processing. (line 13)
* Local Character Set, _definition: Charset. (line 11)
* MBR bootable/active flag, enforce: Bootable. (line 372)
* MBR, set, -boot_image system_area=: Bootable. (line 217)
* MBR bootable/active flag, enforce: Bootable. (line 382)
* MBR, set, -boot_image system_area=: Bootable. (line 227)
* MBR, _definition: Extras. (line 27)
* MD5, control handling, -md5: Loading. (line 183)
* Media, erase, -blank: Writing. (line 57)
* Media, format, -format: Writing. (line 87)
* Media, list formats, -list_formats: Writing. (line 128)
* Media, list write speeds, -list_speeds: Writing. (line 139)
* MIPS boot file, activation: Bootable. (line 393)
* MIPS boot file, activation: Bootable. (line 403)
* mkisofs, Emulation: Emulation. (line 17)
* Modifying, _definition: Methods. (line 28)
* Multi-session media, _definition: Media. (line 7)
@ -6181,15 +6201,15 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Ownership, global in ISO image, -uid: SetWrite. (line 311)
* Ownership, in ISO image, -chown: Manip. (line 43)
* Ownership, in ISO image, -chown_r: Manip. (line 47)
* Partition offset, _definition: Bootable. (line 336)
* Partition table, _definition: Bootable. (line 282)
* Partition offset, _definition: Bootable. (line 346)
* Partition table, _definition: Bootable. (line 292)
* Pathspec, _definition: SetInsert. (line 126)
* Pattern expansion, for disk paths, -disk_pattern: Insert. (line 34)
* Pattern expansion, for ISO paths, -iso_rr_pattern: Manip. (line 10)
* Pattern expansion, _definition: Processing. (line 29)
* Permissions, in ISO image, -chmod: Manip. (line 55)
* Permissions, in ISO image, -chmod_r: Manip. (line 66)
* PReP partition, _definition: Bootable. (line 321)
* PReP partition, _definition: Bootable. (line 331)
* Problems, reporting: Bugreport. (line 6)
* Process, consolidate text output, -pkt_output: Frontend. (line 7)
* Process, control abort on error, -abort_on: Exception. (line 27)
@ -6251,10 +6271,10 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Session, select as input, -load: Loading. (line 54)
* Session, _definition: Model. (line 6)
* Sorting order, for -x, -list_arg_sorting: ArgSort. (line 26)
* SUN Disk Label, production: Bootable. (line 404)
* SUN SPARC boot images, activation: Bootable. (line 501)
* SUN Disk Label, production: Bootable. (line 414)
* SUN SPARC boot images, activation: Bootable. (line 511)
* Symbolic link, create, -lns: Insert. (line 192)
* System area, _definition: Bootable. (line 217)
* System area, _definition: Bootable. (line 227)
* Table-of-content, search sessions, -rom_toc_scan: Loading. (line 307)
* Table-of-content, show, -toc: Inquiry. (line 27)
* Timestamps, set in ISO image, -alter_date: Manip. (line 139)
@ -6322,40 +6342,40 @@ Node: Filter110633
Node: Writing115255
Node: SetWrite127749
Node: Bootable159024
Node: Jigdo189289
Node: Charset194292
Node: Exception197621
Node: DialogCtl203750
Node: Inquiry206352
Node: Navigate217610
Node: Verify226317
Node: Restore237466
Node: Emulation249673
Node: Scripting260129
Node: Frontend267912
Node: Examples277538
Node: ExDevices278716
Node: ExCreate279377
Node: ExDialog280677
Node: ExGrowing281948
Node: ExModifying282757
Node: ExBootable283267
Node: ExCharset283822
Node: ExPseudo284718
Node: ExCdrecord285645
Node: ExMkisofs285965
Node: ExGrowisofs287862
Node: ExException289015
Node: ExTime289473
Node: ExIncBackup289931
Node: ExRestore293957
Node: ExRecovery294903
Node: Files295475
Node: Environ296809
Node: Seealso297557
Node: Bugreport298274
Node: Legal298865
Node: CommandIdx299877
Node: ConceptIdx317775
Node: Jigdo189944
Node: Charset194947
Node: Exception198276
Node: DialogCtl204405
Node: Inquiry207007
Node: Navigate218879
Node: Verify227586
Node: Restore238735
Node: Emulation250942
Node: Scripting261398
Node: Frontend269181
Node: Examples278807
Node: ExDevices279985
Node: ExCreate280646
Node: ExDialog281946
Node: ExGrowing283217
Node: ExModifying284026
Node: ExBootable284536
Node: ExCharset285091
Node: ExPseudo285987
Node: ExCdrecord286914
Node: ExMkisofs287234
Node: ExGrowisofs289131
Node: ExException290284
Node: ExTime290742
Node: ExIncBackup291200
Node: ExRestore295226
Node: ExRecovery296172
Node: Files296744
Node: Environ298078
Node: Seealso298826
Node: Bugreport299543
Node: Legal300134
Node: CommandIdx301146
Node: ConceptIdx319044

End Tag Table

View File

@ -50,7 +50,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 "Version 1.5.7, May 07, 2024"
@c man .TH XORRISO 1 "Version 1.5.7, May 12, 2024"
@c man .\" Please adjust this date whenever revising the manpage.
@c man .\"
@c man .\" Some roff macros, for reference:
@ -4175,9 +4175,19 @@ boot provisions in the System Area. It discards any existing -boot_image
setting including the system area and executes the commands proposed by
command -report_el_torito "cmd".
@*
This action will only succeed if the file objects mentioned in the
output of command -report_el_torito "cmd" are still available. Do not
remove or rename boot image files after -indev.
Special care has to be taken with manipulations of files in the emerging ISO
filesystem which are mentioned by -report_el_torito "cmd". Their paths are
memorized at ISO image load time.
In general -boot_image "any" "replay" should be applied after all file
manipulations are done. All file paths from the -report_el_torito commands
must then still lead to data files which are suitable for their respective
commands.
@*
The effects of file path changes after -boot_image "any" "replay" can be
surprising. E.g. removing or replacing a boot image with boot info table
for legacy BIOS leads to a hidden boot image with the content as it was at
"replay" time. Doing the same with a boot image for EFI leads to an error
at -commit time or to the new file content becomming the EFI boot image.
@*
Out of historical reasons @strong{replay} does not revoke all possibly made
-append_partition settings but only overwrites those for which the loaded
@ -5372,6 +5382,11 @@ reads file paths from file /ppc/bootinfo.txt and tries to find them
case-insensitively in the ECMA-119 tree without using Rock Ridge. If such a
path has actually forbidden properties, like the name "powerpc-ieee1275", then
the relaxations are needed to bring it unmangled into the ECMA-119 tree.
@*
It is important to keep in mind that the file paths shown in the report lines
and commands were registered directly after image loading. Possible filesystem
manipulations which later remove these paths or replace their file content will
not influence the report lines or commands.
@c man .TP
@item -report_system_area mode
@kindex -report_system_area shows MBR, GPT, and alike
@ -5388,6 +5403,11 @@ mentioned boot facilities.
Modes @strong{cmd} and @strong{as_mkisofs} work like with
command -report_el_torito. See above.
@*
It is important to keep in mind that the file paths shown in the report lines
and commands were registered directly after image loading. Possible filesystem
manipulations which later remove these paths or replace their file content will
not influence the report lines or commands.
@*
With mode @strong{gpt_disk_guid} print the GPT disk GUID of the loaded ISO
in RFC 4122 text format to result channel. It is not considered an error if
no GPT is present. In this case nothing is printed to result channel.