Fix residual use of DX:AX in the KEYMAP command
[syslinux.git] / doc / syslinux.txt
blob54be427bd368cc6ff264baf69bb2aa7061792eb8
1                                SYSLINUX
3                    A suite of bootloaders for Linux
5        Copyright 1994-2008 H. Peter Anvin - All Rights Reserved
7 This program is provided under the terms of the GNU General Public
8 License, version 2 or, at your option, any later version.  There is no
9 warranty, neither expressed nor implied, to the function of this
10 program.  Please see the included file COPYING for details.
12 ----------------------------------------------------------------------
14       SYSLINUX now has a home page at http://syslinux.zytor.com/
16 ----------------------------------------------------------------------
18 The SYSLINUX suite contains the following boot loaders
19 ("derivatives"), for their respective boot media:
21         SYSLINUX - MS-DOS/Windows FAT filesystem
22         PXELINUX - PXE network booting
23         ISOLINUX - ISO9660 CD-ROM
24         EXTLINUX - Linux ext2/ext3 filesystem
26 For historical reasons, some of the sections in this document applies
27 to the FAT loader only; see pxelinux.txt, isolinux.txt and
28 extlinux.txt for what differs in these versions.
30 Help with cleaning up the docs would be greatly appreciated.
33    ++++ Options ++++
35 These are the options common to all versions of Syslinux:
37         -s      Safe, slow, stupid; uses simpler code that boots better
38         -f      Force installing
40 These are only in the Windows version:
42         -m      Mbr; install a bootable MBR sector to the beginning of the
43                 drive.
44         -a      Active; marks the partition used active (=bootable)
47    ++++ CREATING A BOOTABLE LINUX FLOPPY +++
49 In order to create a bootable Linux floppy using SYSLINUX, prepare a
50 normal MS-DOS formatted floppy.  Copy one or more Linux kernel files to
51 it, then execute the DOS command:
53         syslinux [-sfma][-d directory] a:
55 (or whichever drive letter is appropriate; the [] meaning optional.)
57 Use "syslinux.com" (in the dos subdirectory of the distribution) for
58 plain DOS (MS-DOS, DR-DOS, PC-DOS, FreeDOS...) or Win9x/ME.
60 Use "syslinux.exe" (in the win32 subdirectory of the distribution) for
61 WinNT/2000/XP.
63 Under Linux, execute the command:
65         syslinux [-sf][-d directory][-o offset] /dev/fd0
67 (or, again, whichever device is the correct one.)
69 This will alter the boot sector on the disk and copy a file named
70 LDLINUX.SYS into its root directory (or a subdirectory, if the -d
71 option is specified.)
73 The -s option, if given, will install a "safe, slow and stupid"
74 version of SYSLINUX.  This version may work on some very buggy BIOSes
75 on which SYSLINUX would otherwise fail.  If you find a machine on
76 which the -s option is required to make it boot reliably, please send
77 as much info about your machine as you can, and include the failure
78 mode.
80 The -o option is used with a disk image file and specifies the byte
81 offset of the filesystem image in the file.
83 For the DOS and Windows installers, the -m and -a options can be used
84 on hard drives to write a Master Boot Record (MBR), and to mark the
85 specific partition active.
87 On boot time, by default, the kernel will be loaded from the image named
88 LINUX on the boot floppy.  This default can be changed, see the section
89 on the SYSLINUX config file.
91 If the Shift or Alt keys are held down during boot, or the Caps or Scroll
92 locks are set, SYSLINUX will display a LILO-style "boot:" prompt.  The
93 user can then type a kernel file name followed by any kernel parameters.
94 The SYSLINUX loader does not need to know about the kernel file in
95 advance; all that is required is that it is a file located in the root
96 directory on the disk.
98 There are two versions of the Linux installer; one in the "mtools"
99 directory which requires no special privilege (other than write
100 permission to the device where you are installing) but requires the
101 mtools program suite to be available, and one in the "unix" directory
102 which requires root privilege.
105    ++++ CONFIGURATION FILE ++++
107 All the configurable defaults in SYSLINUX can be changed by putting a
108 file called "syslinux.cfg" in the root directory of the boot disk.
110 This is a text file in either UNIX or DOS format, containing one or
111 more of the following items (case is insensitive for keywords; upper
112 case is used here to indicate that a word should be typed verbatim):
114 Starting with version 3.35, the configuration file can also be in
115 either the /boot/syslinux or /syslinux directories (searched in that
116 order.)  If that is the case, then all filenames are assumed to be
117 relative to that same directory, unless preceded with a slash or
118 backslash.
120 All options here applies to PXELINUX, ISOLINUX and EXTLINUX as well as
121 SYSLINUX unless otherwise noted.  See the respective .txt files.
123 # comment
124         A comment line.  The whitespace after the hash mark is mandatory.
126 INCLUDE filename
127         Inserts the contents of another file at this point in the
128         configuration file. Files can currently be nested up to 16
129         levels deep, but it is not guaranteed that more than 8 levels
130         will be supported in the future.
132 DEFAULT kernel options...
133         Sets the default command line.  If SYSLINUX boots automatically,
134         it will act just as if the entries after DEFAULT had been typed
135         in at the "boot:" prompt.
137         If no configuration file is present, or no DEFAULT entry is
138         present in the config file, the default is "linux auto".
140         NOTE: Earlier versions of SYSLINUX used to automatically
141         append the string "auto" to whatever the user specified using
142         the DEFAULT command.  As of version 1.54, this is no longer
143         true, as it caused problems when using a shell as a substitute
144         for "init."  You may want to include this option manually.
146 APPEND options...
147         Add one or more options to the kernel command line.  These are
148         added both for automatic and manual boots.  The options are
149         added at the very beginning of the kernel command line,
150         usually permitting explicitly entered kernel options to override
151         them.  This is the equivalent of the LILO "append" option.
153 IPAPPEND flag_val                       [PXELINUX only]
154         The IPAPPEND option is available only on PXELINUX.  The
155         flag_val is an OR of the following options:
157         1: indicates that an option of the following format
158         should be generated and added to the kernel command line:
160                 ip=<client-ip>:<boot-server-ip>:<gw-ip>:<netmask>
162         ... based on the input from the DHCP/BOOTP or PXE boot server.
164         THE USE OF THIS OPTION IS NOT RECOMMENDED.  If you have to use
165         it, it is probably an indication that your network configuration
166         is broken.  Using just "ip=dhcp" on the kernel command line
167         is a preferrable option, or, better yet, run dhcpcd/dhclient,
168         from an initrd if necessary.
170         2: indicates that an option of the following format
171         should be generated and added to the kernel command line:
173                 BOOTIF=<hardware-address-of-boot-interface>
175         ... in dash-separated hexadecimal with leading hardware type
176         (same as for the configuration file; see pxelinux.txt.)
178         This allows an initrd program to determine from which
179         interface the system booted.
181 LABEL label
182     KERNEL image
183     APPEND options...
184     IPAPPEND flag_val                   [PXELINUX only]
185         Indicates that if "label" is entered as the kernel to boot,
186         SYSLINUX should instead boot "image", and the specified APPEND
187         and IPAPPEND options should be used instead of the ones
188         specified in the global section of the file (before the first
189         LABEL command.)  The default for "image" is the same as
190         "label", and if no APPEND is given the default is to use the
191         global entry (if any).
193         Starting with version 3.62, the number of LABEL statements is
194         virtually unlimited.
196         Note that LILO uses the syntax:
197         image = mykernel
198           label = mylabel
199           append = "myoptions"
201         ... whereas SYSLINUX uses the syntax:
202         label mylabel
203           kernel mykernel
204           append myoptions
206         Note: The "kernel" doesn't have to be a Linux kernel; it can
207               be a boot sector or a COMBOOT file (see below.)
209         Since version 3.32 label names are no longer mangled into DOS
210         format (for SYSLINUX.)
212     The following commands are available after a LABEL statement:
214     LINUX image                 - Linux kernel image (default)
215     BOOT image                  - Bootstrap program (.bs, .bin)
216     BSS image                   - BSS image (.bss)
217     PXE image                   - PXE Network Bootstrap Program (.0)
218     FDIMAGE image               - Floppy disk image (.img)
219     COMBOOT image               - COMBOOT program (.com, .cbt)
220     COM32 image                 - COM32 program (.c32)
221     CONFIG image                - New configuration file
222         Using one of these keywords instead of KERNEL forces the
223         filetype, regardless of the filename.
225         CONFIG means restart the boot loader using a different
226         configuration file.
228     APPEND -
229         Append nothing.  APPEND with a single hyphen as argument in a
230         LABEL section can be used to override a global APPEND.
232     LOCALBOOT type                      [ISOLINUX, PXELINUX]
233         On PXELINUX, specifying "LOCALBOOT 0" instead of a "KERNEL"
234         option means invoking this particular label will cause a local
235         disk boot instead of booting a kernel.
237         The argument 0 means perform a normal boot.  The argument 4
238         will perform a local boot with the Universal Network Driver
239         Interface (UNDI) driver still resident in memory.  Finally,
240         the argument 5 will perform a local boot with the entire PXE
241         stack, including the UNDI driver, still resident in memory.
242         All other values are undefined.  If you don't know what the
243         UNDI or PXE stacks are, don't worry -- you don't want them,
244         just specify 0.
246         On ISOLINUX, the "type" specifies the local drive number to
247         boot from; 0x00 is the primary floppy drive and 0x80 is the
248         primary hard drive.  The special value -1 causes ISOLINUX to
249         report failure to the BIOS, which, on recent BIOSes, should
250         mean that the next boot device in the boot sequence should be
251         activated.
253     INITRD initrd_file
254         Starting with version 3.71, an initrd can be specified in a
255         separate statement (INITRD) instead of as part of the APPEND
256         statement; this functionally appends "initrd=initrd_file" to
257         the kernel command line.
259 IMPLICIT flag_val
260         If flag_val is 0, do not load a kernel image unless it has been
261         explicitly named in a LABEL statement.  The default is 1.
263 ALLOWOPTIONS flag_val
264         If flag_val is 0, the user is not allowed to specify any
265         arguments on the kernel command line.  The only options
266         recognized are those specified in an APPEND statement.  The
267         default is 1.
269 TIMEOUT timeout
270         Indicates how long to wait at the boot: prompt until booting
271         automatically, in units of 1/10 s.  The timeout is cancelled as
272         soon as the user types anything on the keyboard, the assumption
273         being that the user will complete the command line already
274         begun.  A timeout of zero will disable the timeout completely,
275         this is also the default.
277 TOTALTIMEOUT timeout
278         Indicates how long to wait until booting automatically, in
279         units of 1/10 s.  This timeout is *not* cancelled by user
280         input, and can thus be used to deal with serial port glitches
281         or "the user walked away" type situations.  A timeout of zero
282         will disable the timeout completely, this is also the default.
284         Both TIMEOUT and TOTALTIMEOUT can be used together, for
285         example:
287                 # Wait 5 seconds unless the user types something, but
288                 # always boot after 15 minutes.
289                 TIMEOUT 50
290                 TOTALTIMEOUT 9000
292 ONTIMEOUT kernel options...
293         Sets the command line invoked on a timeout.  Normally this is
294         the same thing as invoked by "DEFAULT".  If this is specified,
295         then "DEFAULT" is used only if the user presses <Enter> to
296         boot.
298 ONERROR kernel options...
299         If a kernel image is not found (either due to it not existing,
300         or because IMPLICIT is set), run the specified command.  The
301         faulty command line is appended to the specified options, so
302         if the ONERROR directive reads as:
304                 ONERROR xyzzy plugh
306         ... and the command line as entered by the user is:
308                 foo bar baz
310         ... SYSLINUX will execute the following as if entered by the
311         user:
313                 xyzzy plugh foo bar baz
315 SERIAL port [[baudrate] flowcontrol]
316         Enables a serial port to act as the console.  "port" is a
317         number (0 = /dev/ttyS0 = COM1, etc.) or an I/O port address
318         (e.g. 0x3F8); if "baudrate" is omitted, the baud rate defaults
319         to 9600 bps.  The serial parameters are hardcoded to be 8
320         bits, no parity, 1 stop bit.
322         "flowcontrol" is a combination of the following bits:
323         0x001 - Assert DTR
324         0x002 - Assert RTS
325         0x010 - Wait for CTS assertion
326         0x020 - Wait for DSR assertion
327         0x040 - Wait for RI assertion
328         0x080 - Wait for DCD assertion
329         0x100 - Ignore input unless CTS asserted
330         0x200 - Ignore input unless DSR asserted
331         0x400 - Ignore input unless RI asserted
332         0x800 - Ignore input unless DCD asserted
334         All other bits are reserved.
336         Typical values are:
338             0 - No flow control (default)
339         0x303 - Null modem cable detect
340         0x013 - RTS/CTS flow control
341         0x813 - RTS/CTS flow control, modem input
342         0x023 - DTR/DSR flow control
343         0x083 - DTR/DCD flow control
345         For the SERIAL directive to be guaranteed to work properly, it
346         should be the first directive in the configuration file.
348         NOTE: "port" values from 0 to 3 means the first four serial
349         ports detected by the BIOS.  They may or may not correspond to
350         the legacy port values 0x3F8, 0x2F8, 0x3E8, 0x2E8.
352 CONSOLE flag_val
353         If flag_val is 0, disable output to the normal video console.
354         If flag_val is 1, enable output to the video console (this is
355         the default.)
357         Some BIOSes try to forward this to the serial console and
358         sometimes make a total mess thereof, so this option lets you
359         disable the video console on these systems.
361 FONT filename
362         Load a font in .psf format before displaying any output
363         (except the copyright line, which is output as ldlinux.sys
364         itself is loaded.)  SYSLINUX only loads the font onto the
365         video card; if the .psf file contains a Unicode table it is
366         ignored.  This only works on EGA and VGA cards; hopefully it
367         should do nothing on others.
369 KBDMAP keymap
370         Install a simple keyboard map.  The keyboard remapper used is
371         *very* simplistic (it simply remaps the keycodes received from
372         the BIOS, which means that only the key combinations relevant
373         in the default layout -- usually U.S. English -- can be
374         mapped) but should at least help people with AZERTY keyboard
375         layout and the locations of = and , (two special characters
376         used heavily on the Linux kernel command line.)
378         The included program keytab-lilo.pl from the LILO distribution
379         can be used to create such keymaps.  The file keytab-lilo.txt
380         contains the documentation for this program.
382 DISPLAY filename
383         Displays the indicated file on the screen at boot time (before
384         the boot: prompt, if displayed).  Please see the section below
385         on DISPLAY files.
387         NOTE: If the file is missing, this option is simply ignored.
389 SAY message
390         Prints the message on the screen.
392 PROMPT flag_val
393         If flag_val is 0, display the boot: prompt only if the Shift or Alt
394         key is pressed, or Caps Lock or Scroll lock is set (this is the
395         default).  If flag_val is 1, always display the boot: prompt.
397 NOESCAPE flag_val
398         If flag_val is set to 1, ignore the Shift/Alt/Caps Lock/Scroll
399         Lock escapes.  Use this (together with PROMPT 0) to force the
400         default boot alternative.
402 F1 filename
403 F2 filename
404    ...etc...
405 F9 filename
406 F10 filename
407 F11 filename
408 F11 filename
409         Displays the indicated file on the screen when a function key is
410         pressed at the boot: prompt.  This can be used to implement
411         pre-boot online help (presumably for the kernel command line
412         options.)  Please see the section below on DISPLAY files.
414         When using the serial console, press <Ctrl-F><digit> to get to
415         the help screens, e.g. <Ctrl-F><2> to get to the F2 screen.
416         For F10-F12, hit <Ctrl-F><A>, <Ctrl-F>B, <Ctrl-F>C.  For
417         compatiblity with earlier versions, F10 can also be entered as
418         <Ctrl-F>0.
420 Blank lines are ignored.
422 Note that the configuration file is not completely decoded.  Syntax
423 different from the one described above may still work correctly in this
424 version of SYSLINUX, but may break in a future one.
427    ++++ DISPLAY FILE FORMAT ++++
429 DISPLAY and function-key help files are text files in either DOS or UNIX
430 format (with or without <CR>).  In addition, the following special codes
431 are interpreted:
433 <FF>                                    <FF> = <Ctrl-L> = ASCII 12
434         Clear the screen, home the cursor.  Note that the screen is
435         filled with the current display color.
437 <SI><bg><fg>                            <SI> = <Ctrl-O> = ASCII 15
438         Set the display colors to the specified background and
439         foreground colors, where <bg> and <fg> are hex digits,
440         corresponding to the standard PC display attributes:
442         0 = black               8 = dark grey
443         1 = dark blue           9 = bright blue
444         2 = dark green          a = bright green
445         3 = dark cyan           b = bright cyan
446         4 = dark red            c = bright red
447         5 = dark purple         d = bright purple
448         6 = brown               e = yellow
449         7 = light grey          f = white
451         Picking a bright color (8-f) for the background results in the
452         corresponding dark color (0-7), with the foreground flashing.
454         Colors are not visible over the serial console.
456 <CAN>filename<newline>                  <CAN> = <Ctrl-X> = ASCII 24
457         If a VGA display is present, enter graphics mode and display
458         the graphic included in the specified file.  The file format
459         is an ad hoc format called LSS16; the included Perl program
460         "ppmtolss16" can be used to produce these images.  This Perl
461         program also includes the file format specification.
463         The image is displayed in 640x480 16-color mode.  Once in
464         graphics mode, the display attributes (set by <SI> code
465         sequences) work slightly differently: the background color is
466         ignored, and the foreground colors are the 16 colors specified
467         in the image file.  For that reason, ppmtolss16 allows you to
468         specify that certain colors should be assigned to specific
469         color indicies.
471         Color indicies 0 and 7, in particular, should be chosen with
472         care: 0 is the background color, and 7 is the color used for
473         the text printed by SYSLINUX itself.
475 <EM>                                    <EM> = <Ctrl-Y> = ASCII 25
476         If we are currently in graphics mode, return to text mode.
478 <DLE>..<ETB>                            <Ctrl-P>..<Ctrl-W> = ASCII 16-23
479         These codes can be used to select which modes to print a
480         certain part of the message file in.  Each of these control
481         characters select a specific set of modes (text screen,
482         graphics screen, serial port) for which the output is actually
483         displayed:
485         Character                       Text    Graph   Serial
486         ------------------------------------------------------
487         <DLE> = <Ctrl-P> = ASCII 16     No      No      No
488         <DC1> = <Ctrl-Q> = ASCII 17     Yes     No      No
489         <DC2> = <Ctrl-R> = ASCII 18     No      Yes     No
490         <DC3> = <Ctrl-S> = ASCII 19     Yes     Yes     No
491         <DC4> = <Ctrl-T> = ASCII 20     No      No      Yes
492         <NAK> = <Ctrl-U> = ASCII 21     Yes     No      Yes
493         <SYN> = <Ctrl-V> = ASCII 22     No      Yes     Yes
494         <ETB> = <Ctrl-W> = ASCII 23     Yes     Yes     Yes
496         For example:
498         <DC1>Text mode<DC2>Graphics mode<DC4>Serial port<ETB>
500         ... will actually print out which mode the console is in!
502 <SUB>                                   <SUB> = <Ctrl-Z> = ASCII 26
503         End of file (DOS convention).
505 <BEL>                                   <BEL> = <Ctrl-G> = ASCII 7
506         Beep the speaker.
509    ++++ COMMAND LINE KEYSTROKES ++++
511 The command line prompt supports the following keystrokes:
513 <Enter>         boot specified command line
514 <BackSpace>     erase one character
515 <Ctrl-U>        erase the whole line
516 <Ctrl-V>        display the current SYSLINUX version
517 <Ctrl-W>        erase one word
518 <Ctrl-X>        force text mode
519 <F1>..<F10>     help screens (if configured)
520 <Ctrl-F><digit> equivalent to F1..F10
521 <Ctrl-C>        interrupt boot in progress
522 <Esc>           interrupt boot in progress
525    ++++ COMBOOT IMAGES AND OTHER OPERATING SYSTEMS ++++
527 This version of SYSLINUX supports chain loading of other operating
528 systems (such as MS-DOS and its derivatives, including Windows 95/98),
529 as well as COMBOOT-style standalone executables (a subset of DOS .COM
530 files; see separate section below.)
532 Chain loading requires the boot sector of the foreign operating system
533 to be stored in a file in the root directory of the filesystem.
534 Because neither Linux kernels, boot sector images, nor COMBOOT files
535 have reliable magic numbers, SYSLINUX will look at the file extension.
536 The following extensions are recognized (case insensitive):
538   none or other Linux kernel image
539   .0            PXE bootstrap program (NBP) [PXELINUX only]
540   .bin          "CD boot sector" [ISOLINUX only]
541   .bs           Boot sector [SYSLINUX only]
542   .bss          Boot sector, DOS superblock will be patched in [SYSLINUX only]
543   .c32          COM32 image (32-bit COMBOOT)
544   .cbt          COMBOOT image (not runnable from DOS)
545   .com          COMBOOT image (runnable from DOS)
546   .img          Disk image [ISOLINUX only]
548 For filenames given on the command line, SYSLINUX will search for the
549 file by adding extensions in the order listed above if the plain
550 filename is not found.  Filenames in KERNEL statements must be fully
551 qualified.
553 If this is specified with one of the keywords LINUX, BOOT, BSS,
554 FDIMAGE, COMBOOT, COM32, or CONFIG instead of KERNEL, the filetype is
555 considered to be the one specified regardless of the filename.
558       ++++ BOOTING DOS (OR OTHER SIMILAR OPERATING SYSTEMS) ++++
560 This section applies to SYSLINUX only, not to PXELINUX or ISOLINUX.
561 See isolinux.txt for an equivalent procedure for ISOLINUX.
563 This is the recommended procedure for creating a SYSLINUX disk that
564 can boot either DOS or Linux.  This example assumes the drive is A: in
565 DOS and /dev/fd0 in Linux; for other drives, substitute the
566 appropriate drive designator.
568    ---- Linux procedure ----
570 1. Make a DOS bootable disk.  This can be done either by specifying
571    the /s option when formatting the disk in DOS, or by running the
572    DOS command SYS (this can be done under DOSEMU if DOSEMU has
573    direct device access to the relevant drive):
575         format a: /s
576    or
577         sys a:
579 2. Boot Linux.  Copy the DOS boot sector from the disk into a file:
581         dd if=/dev/fd0 of=dos.bss bs=512 count=1
583 3. Run SYSLINUX on the disk:
585         syslinux /dev/fd0
587 4. Mount the disk and copy the DOS boot sector file to it.  The file
588    *must* have extension .bss:
590         mount -t msdos /dev/fd0 /mnt
591         cp dos.bss /mnt
593 5. Copy the Linux kernel image(s), initrd(s), etc to the disk, and
594    create/edit syslinux.cfg and help files if desired:
596         cp vmlinux /mnt
597         cp initrd.gz /mnt
599 6. Unmount the disk (if applicable.)
601         umount /mnt
603    ---- DOS/Windows procedure ----
605 To make this installation in DOS only, you need the utility copybs.com
606 (included with SYSLINUX) as well as the syslinux.com installer.  If
607 you are on an WinNT-based system (WinNT, Win2k, WinXP or later), use
608 syslinux.exe instead.
610 1. Make a DOS bootable disk.  This can be done either by specifying
611    the /s option when formatting the disk in DOS, or by running the
612    DOS command SYS:
614         format a: /s
615    or
616         sys a:
618 2. Copy the DOS boot sector from the disk into a file.  The file
619    *must* have extension .bss:
621         copybs a: a:dos.bss
623 3. Run SYSLINUX on the disk:
625         syslinux a:
627 4. Copy the Linux kernel image(s), initrd(s), etc to the disk, and
628    create/edit syslinux.cfg and help files if desired:
630         copy vmlinux a:
631         copy initrd.gz a:
634    ++++ COMBOOT EXECUTABLES ++++
636 SYSLINUX supports simple standalone programs, using a file format
637 similar to DOS ".com" files.  A 32-bit version, called COM32, is also
638 provided.  A simple API provides access to a limited set of filesystem
639 and console functions.
641 See the file comboot.txt for more information on COMBOOT and COM32
642 programs.
645    ++++ NOVICE PROTECTION ++++
647 SYSLINUX will attempt to detect booting on a machine with too little
648 memory, which means the Linux boot sequence cannot complete.  If so, a
649 message is displayed and the boot sequence aborted.  Holding down the
650 Ctrl key while booting disables this feature.
652 Any file that SYSLINUX uses can be marked hidden, system or readonly
653 if so is convenient; SYSLINUX ignores all file attributes.  The
654 SYSLINUX installed automatically sets the readonly/hidden/system
655 attributes on LDLINUX.SYS.
658    ++++ NOTES ON BOOTABLE CD-ROMS ++++
660 SYSLINUX can be used to create bootdisk images for El
661 Torito-compatible bootable CD-ROMs.  However, it appears that many
662 BIOSes are very buggy when it comes to booting CD-ROMs.  Some users
663 have reported that the following steps are helpful in making a CD-ROM
664 that is bootable on the largest possible number of machines:
666         a) Use the -s (safe, slow and stupid) option to SYSLINUX;
667         b) Put the boot image as close to the beginning of the
668            ISO 9660 filesystem as possible.
670 A CD-ROM is so much faster than a floppy that the -s option shouldn't
671 matter from a speed perspective.
673 Of course, you probably want to use ISOLINUX instead.  See isolinux.txt.
676    ++++ BOOTING FROM A FAT FILESYSTEM PARTITION ON A HARD DISK ++++
678 SYSLINUX can boot from a FAT filesystem partition on a hard disk
679 (including FAT32).  The installation procedure is identical to the
680 procedure for installing it on a floppy, and should work under either
681 DOS or Linux.  To boot from a partition, SYSLINUX needs to be launched
682 from a Master Boot Record or another boot loader, just like DOS itself
683 would.
685 Under DOS, you can install a standard simple MBR on the primary hard
686 disk by running the command:
688         FDISK /MBR
690 Then use the FDISK command to mark the appropriate partition active.
692 A simple MBR, roughly on par with the one installed by DOS (but
693 unencumbered), is included in the SYSLINUX distribution.  To install
694 it under Linux, simply type:
696         cat mbr.bin > /dev/XXX
698 ... where /dev/XXX is the device you wish to install it on.
700 Under DOS or Win32, you can install the SYSLINUX MBR with the -m
701 option to the SYSLINUX installer, and use the -a option to mark the
702 current partition active:
704         syslinux -ma c:
706 Note that this will also install SYSLINUX on the specified partition.
709    ++++ HARDWARE INFORMATION +++
711 I have started to maintain a web page of hardware with known
712 problems.  There are, unfortunately, lots of broken hardware out
713 there; especially early PXE stacks (for PXELINUX) have lots of
714 problems.
716 A list of problems, and workarounds (if known), is maintained at:
718         http://syslinux.zytor.com/hardware.php
721    ++++ BOOT LOADER IDS USED ++++
723 The Linux boot protocol supports a "boot loader ID", a single byte
724 where the upper nybble specifies a boot loader family (3 = SYSLINUX)
725 and the lower nybble is version or, in the case of SYSLINUX, media:
727         0x31 (49) = SYSLINUX
728         0x32 (50) = PXELINUX
729         0x33 (51) = ISOLINUX
730         0x34 (52) = EXTLINUX
732 In recent versions of Linux, this ID is available as
733 /proc/sys/kernel/bootloader_type.
736    ++++ BUG REPORTS ++++
738 I would appreciate hearing of any problems you have with SYSLINUX.  I
739 would also like to hear from you if you have successfully used SYSLINUX,
740 *especially* if you are using it for a distribution.
742 If you are reporting problems, please include all possible information
743 about your system and your BIOS; the vast majority of all problems
744 reported turn out to be BIOS or hardware bugs, and I need as much
745 information as possible in order to diagnose the problems.
747 There is a mailing list for discussion among SYSLINUX users and for
748 announcements of new and test versions.  To join, or to browse the
749 archive, go to:
751    http://www.zytor.com/mailman/listinfo/syslinux
753 Please DO NOT send HTML messages or attachments to the mailing list
754 (including multipart/alternative or similar.)  All such messages will
755 be bounced.