From e79ee34d6c285419853088a11056e69e88f1d641 Mon Sep 17 00:00:00 2001 From: Thomas Schmitt Date: Mon, 26 Apr 2010 17:56:06 +0000 Subject: [PATCH] Some documentation updates --- libisoburn/trunk/xorriso/xorriso.1 | 45 ++++---- libisoburn/trunk/xorriso/xorriso.c | 1 + libisoburn/trunk/xorriso/xorriso.info | 102 +++++++++---------- libisoburn/trunk/xorriso/xorriso.texi | 45 ++++---- libisoburn/trunk/xorriso/xorriso_eng.html | 5 +- libisoburn/trunk/xorriso/xorriso_timestamp.h | 2 +- 6 files changed, 102 insertions(+), 98 deletions(-) diff --git a/libisoburn/trunk/xorriso/xorriso.1 b/libisoburn/trunk/xorriso/xorriso.1 index d33939c5..43011b21 100644 --- a/libisoburn/trunk/xorriso/xorriso.1 +++ b/libisoburn/trunk/xorriso/xorriso.1 @@ -2173,7 +2173,8 @@ Each -boot_image command has two arguments: type and setting. More than one -boot_image command may be used to define the handling of one or more boot images. Sequence matters. .br -Types "isolinux" and "grub" care for known peculiarities. Type "any" makes +Types \fBisolinux\fR and \fBgrub\fR care for known peculiarities. +Type \fBany\fR makes no assumptions about the origin of the boot images. .br @@ -2187,10 +2188,10 @@ introduced into the ISO image or if an existing image gets relocated. This is automatically done if type "isolinux" or "grub" is given, but not with "any". .br -"show_status" will print what is known about the loaded image +\fBshow_status\fR will print what is known about the loaded image and its designated fate. .br -"next" ends the definition of a boot image and starts a new one. +\fBnext\fR ends the definition of a boot image and starts a new one. Any following -bootimage bootspecs will affect the new image. The first "next" discards eventually loaded boot images and their catalog. @@ -2202,8 +2203,8 @@ boot images which are present on the input media. Most safe is the default: -boot_image "any" "discard". .br -A bootspec is a word of the form name=value and is used to describe the -parameters of a boot image by an El Torito record and eventually a MBR. +A \fBbootspec\fR is a word of the form name=value and is used to describe +the parameters of a boot image by an El Torito record and eventually a MBR. The names "dir", "bin_path", "efi_path" lead to El Torito bootable images. Name "system_area" activates a given file as MBR. .br @@ -2229,48 +2230,48 @@ which bundles these individual settings: .br -boot_image any boot_info_table=on .br -"bin_path=" depicts the boot image file, a binary program which is to be +\fBbin_path=\fR depicts the boot image file, a binary program which is to be started by the hardware boot facility (e.g. the BIOS) at boot time. .br -"efi_path=" depicts a boot image file that is ready for EFI booting. +\fBefi_path=\fR depicts a boot image file that is ready for EFI booting. Its load_size is determined automatically, no boot info table gets written, platform_id is 0xef. .br An El Torito boot catalog file gets inserted into the ISO image with address -"cat_path=" at -commit time. +\fBcat_path=\fR at -commit time. It is subject to normal -overwrite and -reassure processing if there is already a file with the same name. The catalog lists the boot images and is read by the boot facility to choose one of the boot images. .br -"load_size=" is a value which depends on the boot image. Default 2048 should -be overridden only if a better value is known. +\fBload_size=\fR is a value which depends on the boot image. +Default 2048 should be overridden only if a better value is known. .br -"boot_info_table=on" may be used to apply patching to a boot image which +\fBboot_info_table=on\fR may be used to apply patching to a boot image which is given by "any" "bin_path=". "boot_info_table=off" disables patching. .br -"platform_id=" defines by two hex digits the Platform ID of the boot image. -"00" is 80x86 PC-BIOS, "01" is PowerPC, "02" is Mac, "ef" is EFI. +\fBplatform_id=\fR defines by two hex digits the Platform ID of the +boot image. "00" is 80x86 PC-BIOS, "01" is PowerPC, "02" is Mac, "ef" is EFI. .br -"id_string="text|56_hexdigits defines the ID string of the boot catalog +\fBid_string=\fRtext|56_hexdigits defines the ID string of the boot catalog section where the boot image will be listed. If the value consists of 56 characters [0-9A-Fa-f] then it is converted into 28 bytes, else the first 28 characters become the ID string. The ID string of the first boot image becomes the overall catalog ID. It is limited to 24 characters. Other id_strings become section IDs. .br -"sel_crit="hexdigits defines the Selection Criteria of the boot image. +\fBsel_crit=\fRhexdigits defines the Selection Criteria of the boot image. Up to 20 bytes get read from the given characters [0-9A-Fa-f]. They get attributed to the boot image entry in the catalog. .br -"discard" gives up an existing boot catalog and its boot images. +\fBdiscard\fR gives up an existing boot catalog and its boot images. .br -"keep" keeps or copies boot images unaltered and writes a new catalog. +\fBkeep\fR keeps or copies boot images unaltered and writes a new catalog. .br -"patch" applies boot info table patching of existing boot images. +\fBpatch\fR applies boot info table patching to existing boot images. .br -"system_area="disk_path copies at most 32768 bytes from the given disk file to -the very start of the ISO image. +\fBsystem_area=\fRdisk_path copies at most 32768 bytes from the given +disk file to the very start of the ISO image. This System Area is reserved for system dependent boot software, e.g. an MBR which can be used to boot from USB stick or hard disk. .br @@ -2279,8 +2280,8 @@ to the ISO image. .br -boot_image isolinux system_area= implies "partition_table=on". .br -"partition_table=on" causes a simple partition table to be written into bytes -446 to 511 of the System Area. +\fBpartition_table=on\fR causes a simple partition table to be written +into bytes 446 to 511 of the System Area. .br With type "isolinux" it shows a partition that begins at byte 0 and it causes the LBA of the first boot image to be written into the MBR. For the first diff --git a/libisoburn/trunk/xorriso/xorriso.c b/libisoburn/trunk/xorriso/xorriso.c index 72735ae6..912b1474 100644 --- a/libisoburn/trunk/xorriso/xorriso.c +++ b/libisoburn/trunk/xorriso/xorriso.c @@ -11302,6 +11302,7 @@ int Xorriso_genisofs_help(struct XorrisO *xorriso, int flag) " -sysid ID Set System ID", " -b FILE, -eltorito-boot FILE", " Set El Torito boot image name", +" -eltorito-alt-boot Start specifying alternative El Torito boot parameters", " --efi-boot FILE Set El Torito EFI boot image name and type", " -c FILE, -eltorito-catalog FILE", " Set El Torito boot catalog name", diff --git a/libisoburn/trunk/xorriso/xorriso.info b/libisoburn/trunk/xorriso/xorriso.info index b9659228..e1a15cda 100644 --- a/libisoburn/trunk/xorriso/xorriso.info +++ b/libisoburn/trunk/xorriso/xorriso.info @@ -1949,8 +1949,8 @@ of the existing sessions, unless one can assume overwriteable media. Each -boot_image command has two arguments: type and setting. More than one -boot_image command may be used to define the handling of one or more boot images. Sequence matters. - Types "isolinux" and "grub" care for known peculiarities. Type - "any" makes no assumptions about the origin of the boot images. + Types *isolinux* and *grub* care for known peculiarities. Type + *any* makes no assumptions about the origin of the boot images. El Torito boot images of any type can be newly inserted, or discarded, or patched, or kept unaltered. Whether to patch or to @@ -1959,9 +1959,9 @@ of the existing sessions, unless one can assume overwriteable media. newly introduced into the ISO image or if an existing image gets relocated. This is automatically done if type "isolinux" or "grub" is given, but not with "any". - "show_status" will print what is known about the loaded image and + *show_status* will print what is known about the loaded image and its designated fate. - "next" ends the definition of a boot image and starts a new one. + *next* ends the definition of a boot image and starts a new one. Any following -bootimage bootspecs will affect the new image. The first "next" discards eventually loaded boot images and their catalog. @@ -1970,7 +1970,7 @@ of the existing sessions, unless one can assume overwriteable media. boot images which are present on the input media. Most safe is the default: -boot_image "any" "discard". - A bootspec is a word of the form name=value and is used to + A *bootspec* is a word of the form name=value and is used to describe the parameters of a boot image by an El Torito record and eventually a MBR. The names "dir", "bin_path", "efi_path" lead to El Torito bootable images. Name "system_area" activates a given @@ -1991,47 +1991,47 @@ of the existing sessions, unless one can assume overwriteable media. -boot_image isolinux cat_path=/boot/isolinux/boot.cat -boot_image isolinux load_size=2048 -boot_image any boot_info_table=on - "bin_path=" depicts the boot image file, a binary program which is + *bin_path=* depicts the boot image file, a binary program which is to be started by the hardware boot facility (e.g. the BIOS) at boot time. - "efi_path=" depicts a boot image file that is ready for EFI + *efi_path=* depicts a boot image file that is ready for EFI booting. Its load_size is determined automatically, no boot info table gets written, platform_id is 0xef. An El Torito boot catalog file gets inserted into the ISO image - with address "cat_path=" at -commit time. It is subject to normal + with address *cat_path=* at -commit time. It is subject to normal -overwrite and -reassure processing if there is already a file with the same name. The catalog lists the boot images and is read by the boot facility to choose one of the boot images. - "load_size=" is a value which depends on the boot image. Default + *load_size=* is a value which depends on the boot image. Default 2048 should be overridden only if a better value is known. - "boot_info_table=on" may be used to apply patching to a boot image + *boot_info_table=on* may be used to apply patching to a boot image which is given by "any" "bin_path=". "boot_info_table=off" disables patching. - "platform_id=" defines by two hex digits the Platform ID of the - boot image. "00" is 80x86 PC-BIOS, "01" is PowerPC, "02" is Mac, + *platform_id=* defines by two hex digits the Platform ID of the + boot image. "00" is 80x86 PC-BIOS, "01" is PowerPC, "02" is Mac, "ef" is EFI. - "id_string="text|56_hexdigits defines the ID string of the boot + *id_string=*text|56_hexdigits defines the ID string of the boot catalog section where the boot image will be listed. If the value consists of 56 characters [0-9A-Fa-f] then it is converted into 28 bytes, else the first 28 characters become the ID string. The ID string of the first boot image becomes the overall catalog ID. It is limited to 24 characters. Other id_strings become section IDs. - "sel_crit="hexdigits defines the Selection Criteria of the boot + *sel_crit=*hexdigits defines the Selection Criteria of the boot image. Up to 20 bytes get read from the given characters [0-9A-Fa-f]. They get attributed to the boot image entry in the catalog. - "discard" gives up an existing boot catalog and its boot images. - "keep" keeps or copies boot images unaltered and writes a new + *discard* gives up an existing boot catalog and its boot images. + *keep* keeps or copies boot images unaltered and writes a new catalog. - "patch" applies boot info table patching of existing boot images. - "system_area="disk_path copies at most 32768 bytes from the given + *patch* applies boot info table patching to existing boot images. + *system_area=*disk_path copies at most 32768 bytes from the given disk file to the very start of the ISO image. This System Area is reserved for system dependent boot software, e.g. an MBR which can be used to boot from USB stick or hard disk. Other than a El Torito boot image, the file disk_path needs not to be added to the ISO image. -boot_image isolinux system_area= implies "partition_table=on". - "partition_table=on" causes a simple partition table to be written + *partition_table=on* causes a simple partition table to be written into bytes 446 to 511 of the System Area. With type "isolinux" it shows a partition that begins at byte 0 and it causes the LBA of the first boot image to be written into @@ -4063,37 +4063,37 @@ Node: Filter73937 Node: Writing78286 Node: SetWrite84575 Node: Bootable94707 -Node: Charset102163 -Node: Exception104917 -Node: DialogCtl109432 -Node: Inquiry111777 -Node: Navigate115917 -Node: Verify123271 -Node: Restore131691 -Node: Emulation138347 -Node: Scripting145034 -Node: Frontend150596 -Node: Examples151797 -Node: ExDevices152966 -Node: ExCreate153448 -Node: ExDialog154722 -Node: ExGrowing155984 -Node: ExModifying156786 -Node: ExBootable157287 -Node: ExCharset157834 -Node: ExPseudo158662 -Node: ExCdrecord159556 -Node: ExMkisofs159871 -Node: ExGrowisofs160874 -Node: ExException161998 -Node: ExTime162452 -Node: ExIncBackup162911 -Node: ExRestore166383 -Node: ExRecovery167352 -Node: Files167918 -Node: Seealso168956 -Node: Legal169480 -Node: CommandIdx170402 -Node: ConceptIdx183703 +Node: Charset102166 +Node: Exception104920 +Node: DialogCtl109435 +Node: Inquiry111780 +Node: Navigate115920 +Node: Verify123274 +Node: Restore131694 +Node: Emulation138350 +Node: Scripting145037 +Node: Frontend150599 +Node: Examples151800 +Node: ExDevices152969 +Node: ExCreate153451 +Node: ExDialog154725 +Node: ExGrowing155987 +Node: ExModifying156789 +Node: ExBootable157290 +Node: ExCharset157837 +Node: ExPseudo158665 +Node: ExCdrecord159559 +Node: ExMkisofs159874 +Node: ExGrowisofs160877 +Node: ExException162001 +Node: ExTime162455 +Node: ExIncBackup162914 +Node: ExRestore166386 +Node: ExRecovery167355 +Node: Files167921 +Node: Seealso168959 +Node: Legal169483 +Node: CommandIdx170405 +Node: ConceptIdx183706  End Tag Table diff --git a/libisoburn/trunk/xorriso/xorriso.texi b/libisoburn/trunk/xorriso/xorriso.texi index 6ff49759..a025b827 100644 --- a/libisoburn/trunk/xorriso/xorriso.texi +++ b/libisoburn/trunk/xorriso/xorriso.texi @@ -2621,7 +2621,8 @@ Each -boot_image command has two arguments: type and setting. More than one -boot_image command may be used to define the handling of one or more boot images. Sequence matters. @* -Types "isolinux" and "grub" care for known peculiarities. Type "any" makes +Types @strong{isolinux} and @strong{grub} care for known peculiarities. +Type @strong{any} makes no assumptions about the origin of the boot images. @* @sp 1 @@ -2636,10 +2637,10 @@ introduced into the ISO image or if an existing image gets relocated. This is automatically done if type "isolinux" or "grub" is given, but not with "any". @* -"show_status" will print what is known about the loaded image +@strong{show_status} will print what is known about the loaded image and its designated fate. @* -"next" ends the definition of a boot image and starts a new one. +@strong{next} ends the definition of a boot image and starts a new one. Any following -bootimage bootspecs will affect the new image. The first "next" discards eventually loaded boot images and their catalog. @@ -2652,8 +2653,8 @@ Most safe is the default: -boot_image "any" "discard". @* @sp 1 -A bootspec is a word of the form name=value and is used to describe the -parameters of a boot image by an El Torito record and eventually a MBR. +A @strong{bootspec} is a word of the form name=value and is used to describe +the parameters of a boot image by an El Torito record and eventually a MBR. The names "dir", "bin_path", "efi_path" lead to El Torito bootable images. Name "system_area" activates a given file as MBR. @* @@ -2679,50 +2680,50 @@ which bundles these individual settings: @* -boot_image any boot_info_table=on @* -"bin_path=" depicts the boot image file, a binary program which is to be +@strong{bin_path=} depicts the boot image file, a binary program which is to be started by the hardware boot facility (e.g. the BIOS) at boot time. @* -"efi_path=" depicts a boot image file that is ready for EFI booting. +@strong{efi_path=} depicts a boot image file that is ready for EFI booting. Its load_size is determined automatically, no boot info table gets written, platform_id is 0xef. @* An El Torito boot catalog file gets inserted into the ISO image with address -"cat_path=" at -commit time. +@strong{cat_path=} at -commit time. It is subject to normal -overwrite and -reassure processing if there is already a file with the same name. The catalog lists the boot images and is read by the boot facility to choose one of the boot images. @* -"load_size=" is a value which depends on the boot image. Default 2048 should -be overridden only if a better value is known. +@strong{load_size=} is a value which depends on the boot image. +Default 2048 should be overridden only if a better value is known. @* -"boot_info_table=on" may be used to apply patching to a boot image which +@strong{boot_info_table=on} may be used to apply patching to a boot image which is given by "any" "bin_path=". "boot_info_table=off" disables patching. @* -"platform_id=" defines by two hex digits the Platform ID of the boot image. -"00" is 80x86 PC-BIOS, "01" is PowerPC, "02" is Mac, "ef" is EFI. +@strong{platform_id=} defines by two hex digits the Platform ID of the +boot image. "00" is 80x86 PC-BIOS, "01" is PowerPC, "02" is Mac, "ef" is EFI. @* -"id_string="text|56_hexdigits defines the ID string of the boot catalog +@strong{id_string=}text|56_hexdigits defines the ID string of the boot catalog section where the boot image will be listed. If the value consists of 56 characters [0-9A-Fa-f] then it is converted into 28 bytes, else the first 28 characters become the ID string. The ID string of the first boot image becomes the overall catalog ID. It is limited to 24 characters. Other id_strings become section IDs. @* -"sel_crit="hexdigits defines the Selection Criteria of the boot image. +@strong{sel_crit=}hexdigits defines the Selection Criteria of the boot image. Up to 20 bytes get read from the given characters [0-9A-Fa-f]. They get attributed to the boot image entry in the catalog. @* -"discard" gives up an existing boot catalog and its boot images. +@strong{discard} gives up an existing boot catalog and its boot images. @* -"keep" keeps or copies boot images unaltered and writes a new catalog. +@strong{keep} keeps or copies boot images unaltered and writes a new catalog. @* -"patch" applies boot info table patching to existing boot images. +@strong{patch} applies boot info table patching to existing boot images. @* @cindex System area, _definiton @cindex MBR, set, -boot_image system_area= -"system_area="disk_path copies at most 32768 bytes from the given disk file to -the very start of the ISO image. +@strong{system_area=}disk_path copies at most 32768 bytes from the given +disk file to the very start of the ISO image. This System Area is reserved for system dependent boot software, e.g. an MBR which can be used to boot from USB stick or hard disk. @* @@ -2732,8 +2733,8 @@ to the ISO image. -boot_image isolinux system_area= implies "partition_table=on". @* @cindex Partition table, _definiton -"partition_table=on" causes a simple partition table to be written into bytes -446 to 511 of the System Area. +@strong{partition_table=on} causes a simple partition table to be written +into bytes 446 to 511 of the System Area. @* With type "isolinux" it shows a partition that begins at byte 0 and it causes the LBA of the first boot image to be written into the MBR. For the first diff --git a/libisoburn/trunk/xorriso/xorriso_eng.html b/libisoburn/trunk/xorriso/xorriso_eng.html index b02c47ed..f4c7c208 100644 --- a/libisoburn/trunk/xorriso/xorriso_eng.html +++ b/libisoburn/trunk/xorriso/xorriso_eng.html @@ -123,7 +123,7 @@ Writes result as completely new image or as add-on session to optical media or filesystem objects.
  • -Can activate ISOLINUX and GRUB boot images by El Torito boot record. +Can activate ISOLINUX and GRUB boot images by El Torito boot record and MBR.
  • Can perform multi-session tasks as emulation of mkisofs and cdrecord. @@ -573,7 +573,8 @@ cdrecord and mkisofs.
    Enhancements towards stable version 0.5.4:
      -
    • - none yet -
      • +
    • New -boot_image bootspecs platform_id=, sel_crit=, id_string=, next
      • +
    • New -as mkisofs options --efi-boot, -eltorito-alt-boot
      • diff --git a/libisoburn/trunk/xorriso/xorriso_timestamp.h b/libisoburn/trunk/xorriso/xorriso_timestamp.h index 545dbf72..1ede4261 100644 --- a/libisoburn/trunk/xorriso/xorriso_timestamp.h +++ b/libisoburn/trunk/xorriso/xorriso_timestamp.h @@ -1 +1 @@ -#define Xorriso_timestamP "2010.04.26.141229" +#define Xorriso_timestamP "2010.04.26.175506"