Added EFI information to manual page example of bootable ISO

libisoburn/trunk/xorriso/xorrisofs.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 XORRISOFS 1 "Version 1.4.1, May 17, 2015"
+.TH XORRISOFS 1 "Version 1.4.1, Jun 30, 2015"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
@@ -928,13 +928,12 @@ entry. Up to 32 catalog entries are possible.
 Specify the boot image file which shall be mentioned in the current
 entry of the El Torito boot catalog. It will be marked as suitable for EFI.
 .br
-Normally no other El Torito options should be used with the catalog entry
+Option \-e should be followed by option \-no\-emul\-boot and no other El Torito
-that points to an EFI image.
+options before an eventual \-eltorito\-alt\-boot.
-Consider to use \-\-efi\-boot rather than \-e.
 .TP
 \fB--efi-boot\fR iso_rr_path
 Perform \-eltorito\-alt\-boot, option \-e with the given
-iso_rr_path, and again \-eltorito\-alt\-boot. This gesture is
+iso_rr_path, \-no\-emul\-boot, and again \-eltorito\-alt\-boot. This gesture is
 used for achieving EFI\-bootability of the GRUB2 rescue CD.
 .TP
 \fB\-boot-load-size\fR number
@@ -1512,7 +1511,7 @@ Incremental backup of a few directory trees
 .br
 Incremental backup with accumulated trees
 .br
-Create bootable images for PC-BIOS
+Create bootable images for PC-BIOS and EFI
 .br
 .SS
 .B A simple image production run
@@ -1788,7 +1787,8 @@ but rather do this manually or by a program that reads from /dev/sr0.
 With the third session, option \-old\-root refers to /session2.
 The new \-root is /session3. And so on.
 .SS
-.B Create bootable images for PC-BIOS
+.B Create bootable images for PC-BIOS and EFI
+The SYSLINUX/ISOLINUX boot loader suite is popular for booting PC\-BIOS.
 The ISOLINUX wiki prescribes to create on disk a directory ./CD_root and
 to copy all desired files underneath that directory. Especially file
 isolinux.bin shall be copied to ./CD_root/isolinux/isolinux.bin .
@@ -1820,7 +1820,7 @@ at block 0. This facilitates later manipulations of the USB stick by
 tools for partitioning and formatting.
 .br
 The image from the following example will be prepared for booting via MBR
-and its first parttion will start at hard disk block 64.
+and its first partition will start at hard disk block 64.
 .br
 It will also boot from optical media.
 .br
@@ -1852,6 +1852,54 @@ Now copy the image onto it
 .br
   # dd bs=2K if=output.iso of=/dev/sdb
 .br
+.sp 1
+Now for EFI:
+.br
+The boot image file has to be the image of an EFI System Partition,
+i.e. a FAT filesystem with directory /EFI/BOOT and boot files with
+EFI prescribed names: BOOTIA32.EFI for 32 bit x86,
+BOOTx64.EFI for 64 bit AMD/x86 (in UEFI\-2.4 there is indeed a lower case "x"),
+BOOTAA64.EFI for 64 bit ARM. The software in the FAT filesystem should be
+able to find and inspect the ISO filesystem for boot loader configuration and
+start of operating system. GRUB2 program grub\-mkimage can produce such a
+FAT filesystem with suitable content, which then uses further GRUB2
+software from the ISO filesystem.
+.br
+EFI boot equipment may be combined with above ISOLINUX isohybrid for PC\-BIOS
+in a not really UEFI\-2.4 compliant way, which obviously works well. It yields
+MBR and GPT partition tables, both with nested partitions.
+Assumed the EFI System Partition image is ready as ./CD_root/boot/grub/efi.img,
+add the following options before the directory address ./CD_root:
+.br
+      \-eltorito\-alt\-boot \-e 'boot/grub/efi.img' \-no\-emul\-boot \\
+.br
+      \-isohybrid\-gpt\-basdat \\
+.br
+More compliant with UEFI\-2.4 is to decide for either MBR or GPT and to
+append a copy of the EFI System Partition in order to avoid overlap of
+ISO partition and EFI partition. Here for MBR:
+.br
+      \-eltorito\-alt\-boot \-e 'boot/grub/efi.img' \-no\-emul\-boot \\
+      \-append_partition 2 0xef ./CD_root/boot/grub/efi.img \\
+.br
+The resulting ISOs are supposed to boot from optical media and USB stick.
+One may omit option \-eltorito\-alt\-boot if no option \-b is used to make
+the ISO bootable via PC\-BIOS.
+.br
+.sp 1
+For ISOs with pure GRUB2 boot equipment consider to use GRUB2 tool
+grub\-mkrescue as frontend to xorrisofs.
+.br
+.sp 1
+If you have a bootable ISO filesystem and want to know its equipment plus
+a proposal how to reproduce it, try:
+.br
+  $ xorriso \-hfsplus on \-indev IMAGE.iso \\
+      \-report_el_torito plain \-report_system_area plain \\
+      \-print "" \-print "======= Proposal for xorrisofs options:" \\
+      \-report_el_torito as_mkisofs
+.br
+.br
 .SH FILES
 .SS 
 .B Startup files:

libisoburn/trunk/xorriso/xorrisofs.texi

@@ -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 XORRISOFS 1 "Version 1.4.1, May 17, 2015"
+@c man .TH XORRISOFS 1 "Version 1.4.1, Jun 30, 2015"
 @c man .\" Please adjust this date whenever revising the manpage.
 @c man .\"
 @c man .\" Some roff macros, for reference:
@@ -1272,15 +1272,14 @@ entry. Up to 32 catalog entries are possible.
 Specify the boot image file which shall be mentioned in the current
 entry of the El Torito boot catalog. It will be marked as suitable for EFI.
 @*
-Normally no other El Torito options should be used with the catalog entry
+Option -e should be followed by option -no-emul-boot and no other El Torito
-that points to an EFI image.
+options before an eventual -eltorito-alt-boot.
-Consider to use @minus{}@minus{}efi-boot rather than -e.
 @c man .TP
 @item @minus{}@minus{}efi-boot iso_rr_path
 @kindex @minus{}@minus{}efi-boot   El Torito EFI boot image
 @cindex Bootability, control, @minus{}@minus{}efi-boot
 Perform -eltorito-alt-boot, option -e with the given
-iso_rr_path, and again -eltorito-alt-boot. This gesture is
+iso_rr_path, -no-emul-boot, and again -eltorito-alt-boot. This gesture is
 used for achieving EFI-bootability of the GRUB2 rescue CD.
 @c man .TP
 @item -boot-load-size number
@@ -2012,7 +2011,7 @@ and to standard error the version information of xorriso.
 @c man .br
 @c man Incremental backup with accumulated trees
 @c man .br
-@c man Create bootable images for PC-BIOS
+@c man Create bootable images for PC-BIOS and EFI
 @c man .br
 @cindex Examples
 @menu
@@ -2022,7 +2021,7 @@ and to standard error the version information of xorriso.
 * ExGrowisofs::  Let xorriso work underneath growisofs
 * ExIncBackup::  Incremental backup of a few directory trees
 * ExIncBckAcc::  Incremental backup with accumulated trees
-* ExBootable::   Create bootable images for PC-BIOS
+* ExBootable::   Create bootable images for PC-BIOS and EFI
 @end menu
 @c man .SS
 @c man .B A simple image production run
@@ -2354,9 +2353,10 @@ but rather do this manually or by a program that reads from /dev/sr0.
 With the third session, option -old-root refers to /session2.
 The new -root is /session3. And so on.
 @c man .SS
-@c man .B Create bootable images for PC-BIOS
+@c man .B Create bootable images for PC-BIOS and EFI
 @node ExBootable, , ExIncBckAcc, Examples
-@section Create bootable images for PC-BIOS
+@section Create bootable images for PC-BIOS and EFI
+The SYSLINUX/ISOLINUX boot loader suite is popular for booting PC-BIOS.
 The ISOLINUX wiki prescribes to create on disk a directory ./CD_root and
 to copy all desired files underneath that directory. Especially file
 isolinux.bin shall be copied to ./CD_root/isolinux/isolinux.bin .
@@ -2392,7 +2392,7 @@ at block 0. This facilitates later manipulations of the USB stick by
 tools for partitioning and formatting.
 @*
 The image from the following example will be prepared for booting via MBR
-and its first parttion will start at hard disk block 64.
+and its first partition will start at hard disk block 64.
 @*
 It will also boot from optical media.
 @*
@@ -2430,6 +2430,63 @@ Now copy the image onto it
   # dd bs=2K if=output.iso of=/dev/sdb
 @*
 @sp 1
+@c man .sp 1
+Now for EFI:
+@*
+The boot image file has to be the image of an EFI System Partition,
+i.e. a FAT filesystem with directory /EFI/BOOT and boot files with
+EFI prescribed names: BOOTIA32.EFI for 32 bit x86,
+BOOTx64.EFI for 64 bit AMD/x86 (in UEFI-2.4 there is indeed a lower case "x"),
+BOOTAA64.EFI for 64 bit ARM. The software in the FAT filesystem should be
+able to find and inspect the ISO filesystem for boot loader configuration and
+start of operating system. GRUB2 program grub-mkimage can produce such a
+FAT filesystem with suitable content, which then uses further GRUB2
+software from the ISO filesystem.
+@*
+EFI boot equipment may be combined with above ISOLINUX isohybrid for PC-BIOS
+in a not really UEFI-2.4 compliant way, which obviously works well. It yields
+MBR and GPT partition tables, both with nested partitions.
+Assumed the EFI System Partition image is ready as ./CD_root/boot/grub/efi.img,
+add the following options before the directory address ./CD_root:
+@*
+@sp 1
+      -eltorito-alt-boot -e 'boot/grub/efi.img' -no-emul-boot \
+@*
+      -isohybrid-gpt-basdat \
+@*
+@sp 1
+More compliant with UEFI-2.4 is to decide for either MBR or GPT and to
+append a copy of the EFI System Partition in order to avoid overlap of
+ISO partition and EFI partition. Here for MBR:
+@*
+@sp 1
+      -eltorito-alt-boot -e 'boot/grub/efi.img' -no-emul-boot \
+      -append_partition 2 0xef ./CD_root/boot/grub/efi.img \
+@*
+@sp 1
+The resulting ISOs are supposed to boot from optical media and USB stick.
+One may omit option -eltorito-alt-boot if no option -b is used to make
+the ISO bootable via PC-BIOS.
+@*
+@sp 1
+@c man .sp 1
+For ISOs with pure GRUB2 boot equipment consider to use GRUB2 tool
+grub-mkrescue as frontend to xorrisofs.
+@*
+@sp 1
+@c man .sp 1
+If you have a bootable ISO filesystem and want to know its equipment plus
+a proposal how to reproduce it, try:
+@*
+@sp 1
+  $ xorriso -hfsplus on -indev IMAGE.iso \
+      -report_el_torito plain -report_system_area plain \
+      -print "" -print "======= Proposal for xorrisofs options:" \
+      -report_el_torito as_mkisofs
+@*
+@sp 1
+@*
+@sp 1
 @c man .SH FILES
 @node Files, Seealso, Examples, Top 
 @chapter Files