Allowing up to 32 boot images, -boot_image any id_string=, sel_crit=

libisoburn/trunk/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 "Apr 20, 2010"
+.TH XORRISO 1 "Apr 26, 2010"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
@@ -368,8 +368,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 a boot image, which is a binary program plus some
-other files stored in the ISO image, with the bootstrapping facility of
+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.
 .br
@@ -2146,7 +2146,7 @@ For images which will never get to a CD it is safe to use -padding 0 .
 .B El Torito bootable ISO images:
 .PP
 Contrary to published specifications many BIOSes will load an El Torito
-object from the first session on media and not from the last one, which
+record from the first session on media and not from the last one, which
 gets mounted by default. This makes no problems with overwriteable media,
 because they appear to inadverted readers as one single session.
 .br
@@ -2163,45 +2163,49 @@ can assume overwriteable media.
 .TP
 \fB\-boot_image\fR "any"|"isolinux"|"grub"
 .br
-     "discard"|"keep"|"patch"|"show_status"|bootspec
+     "discard"|"keep"|"patch"|"show_status"|bootspec|"next"
 .br
-Define the handling of an eventual El Torito boot image object which has
-been read from an existing ISO image or define how to make a prepared
+Define the handling of an eventual set of El Torito boot images which
+has been read from an existing ISO image or define how to make a prepared
 boot image file set bootable. Such file sets get produced by ISOLINUX or GRUB.
 .br
 Each -boot_image command has two arguments: type and setting. More than one
--boot_image command may be used to define the handling. Sequence matters.
+-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
-no assumptions about the origin of the boot image.
+no assumptions about the origin of the boot images.
 .br
 
 El Torito boot images of any type can be newly inserted, or discarded,
 or patched, or kept unaltered.
-The latter is only safe if the format of the boot image is
-relocatable without content changes.
+Whether to patch or to keep depends on whether
+the boot images contain boot info tables.
 .br
-Some boot images contain a boot info table, which needs to be patched when
-the boot image gets newly introduced into the ISO image or if an existing
-image gets relocated. This is automatically done if type "isolinux" or "grub"
+A boot info table needs to be patched when the boot image gets 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".
 .br
 "show_status" will print what is known about the loaded image
 and its designated fate.
 .br
-CAUTION:
-This is an expert option. 
-xorriso cannot recognize the inner form of boot images.
+"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.
+.br
+CAUTION: xorriso cannot recognize the inner form of boot images.
 So the user has already to know about the particular needs of the
-boot image which is present on the input media.
+boot images which are present on the input media.
 .br
 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
-activation of a boot image by an El Torito record and eventually a MBR.
-The names "dir" and "bin_path" lead to El Torito boot image activation.
-Name "system_area" activates the given file as MBR.
+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
 On all media types this is possible within the first session. In further
 sessions an existing boot image can get replaced by a new one, but depending
@@ -2225,13 +2229,19 @@ which bundles these individual settings:
 .br
  -boot_image any boot_info_table=on
 .br
-"bin_path=" depicts the binary program which is to be started by the BIOS at
-boot time.
+"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.
+.br
+"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.
 .br
 An El Torito boot catalog file gets inserted into the ISO image 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.
 .br
 "load_size=" is a value which depends on the boot image. Default 2048 should
 be overridden only if a better value is known.
@@ -2239,12 +2249,25 @@ be overridden only if a better value is known.
 "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.
 .br
-"discard" gives up an existing boot image.
+"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.
 .br
-"keep" keeps or copies an existing boot image unaltered.
+"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.
 .br
-"patch" applies boot info table patching if an existing boot image gets copied
-to a new location.
+"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.
+.br
+"discard" gives up an existing boot catalog and its boot images.
+.br
+"keep" keeps or copies boot images unaltered and writes a new catalog.
+.br
+"patch" applies boot info table patching of 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.
@@ -2260,8 +2283,9 @@ to the ISO image.
 446 to 511 of the System Area.
 .br
 With type "isolinux" it shows a partition that begins at byte 0 and it causes
-the boot image LBA to be written into the MBR. For the first session this
-works only if also "system_area=" and "bin_path=" or "dir=" is given.
+the LBA of the first boot image to be written into the MBR. For the first
+session this works only if also "system_area=" and "bin_path=" or "dir="
+is given.
 .br
 With types "any" and "grub" it shows a single
 partiton which starts at byte 512 and ends where the ISO image ends.