com32: remove setjmp.S stub file
[syslinux/sherbszt.git] / txt / isolinux.txt
blob55e7d7c57664ce757910190d5991a8a34d4540e9
1 = isolinux(1) =
2 :doctype: manpage
3 :revdate: 2013-06-12
4 :author: H. Peter Anvin
5 :author-email: hpa@zytor.com
6 :editor1: Gene Cumm
7 :editor1-email: gene.cumm@gmail.com
8 :editor1-revlast: 2013-06-12
11 == NAME ==
12 isolinux - The Syslinux derivative ISOLINUX for ISO9660 CD/DVD media
15 == SYNOPSIS ==
16 [verse]
17 *mkisofs* -o 'isoimage' \
18         -b 'isolinux/isolinux.bin' -c 'isolinux/boot.cat' \
19         -no-emul-boot -boot-load-size 4 -boot-info-table \
20         'root-of-iso-tree'
23 == DESCRIPTION ==
24 ISOLINUX is a boot loader for Linux/i386 that operates off ISO 9660/El
25 Torito CD-ROMs in "no emulation" mode.  This avoids the need to create
26 an "emulation disk image" with limited space (for "floppy emulation")
27 or compatibility problems (for "hard disk emulation".)
29 To create an image, create a directory called "isolinux/" (or, if you
30 prefer, "boot/isolinux/") underneath the root directory of your ISO image
31 master file tree.  Copy isolinux.bin, a config file called
32 "isolinux.cfg" (see *syslinux.cfg*(5) for details on the configuration file),
33 and all necessary files (kernels, initrd, display files, etc.) into this
34 directory, then use the above command to create your ISO image (add
35 additional options as appropriate, such as -J or -R).  If you named the
36 directory boot/isolinux that should of course be +
37         -b boot/isolinux/isolinux.bin -c boot/isolinux/boot.cat.
40 == CONFIG FILE DIRECTORY ==
42 ISOLINUX will search for the config file directory in the order
43 /boot/isolinux, /isolinux, /.  The first directory that exists is
44 used, even if it contains no files.  Therefore, please make sure that
45 these directories don't exist if you don't want ISOLINUX to use them.
48 == HYBRID CD-ROM/HARD DISK MODE ==
50 Starting in version 3.72, ISOLINUX supports a "hybrid mode" which can
51 be booted from either CD-ROM or from a device which BIOS considers a
52 hard disk or ZIP disk, e.g. a USB key or similar.
54 To enable this mode, the .iso image should be postprocessed with the
55 "isohybrid" script from the utils directory:
57         isohybrid filename.iso
59 This script creates the necessary additional information to be able to
60 boot in hybrid mode.  It also pads out the image to an even multiple
61 of 1 MB.
63 This image can then be copied using any raw disk writing tool (on Unix
64 systems, typically "dd" or "cat") to a USB disk, or written to a
65 CD-ROM using standard CD burning tools.
67 The ISO 9660 filesystem is encapsulated in a partition (which starts
68 at offset zero, which may confuse some systems.)  This makes it
69 possible for the operating system, once booted, to use the remainder
70 of the device for persistent storage by creating a second partition.
73 == MISCELLANEOUS ==
74 Make sure you have a recent enough version of mkisofs.  I recommend
75 mkisofs 1.13 (distributed with cdrecord 1.9), but 1.12 might work as
76 well (not tested.)
78 ISOLINUX resolves pathnames the following way:
80 - A pathname consists of names separated by slashes, Unix-style.
81 - A leading / means it searches from the root directory; otherwise the
82   search is from the isolinux directory (think of this as the "current
83   directory".)
84 - . and .. in pathname searches are not supported.
85 - The maximum length of any pathname is 255 characters.
87 Note that ISOLINUX only uses the "plain" ISO 9660 filenames, i.e. it
88 does not support Rock Ridge or Joliet filenames.  It can still be used
89 on a disk which uses Rock Ridge and/or Joliet extensions, of course.
90 Under Linux, you can verify the plain filenames by mounting with the
91 "-o norock,nojoliet" option to the mount command.  Note, however, that
92 ISOLINUX does support "long" (level 2) ISO 9660 plain filenames, so if
93 compatibility with short-names-only operating systems like MS-DOS is
94 not an issue, you can use the "-l" or "-iso-level 2" option to mkisofs
95 to generate long (up to 31 characters) plain filenames.
97 ISOLINUX does not support discontiguous files, interleaved mode, or
98 logical block and sector sizes other than 2048.  This should normally
99 not be a problem.
101 ISOLINUX is by default built in two versions, one version with extra
102 debugging messages enabled.  If you are having problems with ISOLINUX,
103 I would greatly appreciate if you could try out the debugging version
104 (isolinux-debug.bin) and let me know what it reports.  The debugging
105 version does not include hybrid mode support (see below.)
108 == SEE ALSO ==
109 *syslinux.cfg*(5), *syslinux-cli*(1), *lilo*(8), *keytab-lilo.pl*(8),
110 *fdisk*(8), *mkfs*(8), *superformat*(1).
113 == AUTHOR ==
114 This AsciiDoc derived document is a modified version of the original
115 *SYSLINUX* documentation by {author} <{author-email}>.  The conversion
116 to an AsciiDoc was made by {editor1} <{editor1-email}>