Completing syslinux-udeb package contents.
[syslinux-debian/hramrach.git] / doc / syslinux.txt
blobcaf3a06cb3a423378339f769ccc4e4b36d75f0d6
1                          The Syslinux Project
3                    A suite of bootloaders for Linux
5          Copyright 1994-2011 H. Peter Anvin and contributors
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 (SYSLINUX) only; see pxelinux.txt, isolinux.txt and
28 extlinux.txt for what differs in these versions.  The all-caps term
29 "SYSLINUX" generally refers to the FAT loader, whereas "Syslinux"
30 refers to the project as a whole.
32 Help with cleaning up the docs would be greatly appreciated.
35    ++++ Options ++++
37 These are the options common to all versions of Syslinux:
39         -s      Safe, slow, stupid; uses simpler code that boots better
40         -f      Force installing
41         -r      Raid mode.  If boot fails, tell the BIOS to boot the next
42                 device in the boot sequence (usually the next hard disk)
43                 instead of stopping with an error message.
44                 This is useful for RAID-1 booting.
46 These are only in the Windows version:
48         -m      Mbr; install a bootable MBR sector to the beginning of the
49                 drive.
50         -a      Active; marks the partition used active (=bootable)
53    ++++ CREATING A BOOTABLE LINUX FLOPPY +++
55 In order to create a bootable Linux floppy using SYSLINUX, prepare a
56 normal MS-DOS formatted floppy.  Copy one or more Linux kernel files to
57 it, then execute the DOS command:
59         syslinux [-sfrma][-d directory] a: [bootsecfile]
61 (or whichever drive letter is appropriate; the [] meaning optional.)
63 Use "syslinux.com" (in the dos subdirectory of the distribution) for
64 plain DOS (MS-DOS, DR-DOS, PC-DOS, FreeDOS...) or Win9x/ME.
66 Use "syslinux.exe" (in the win32 subdirectory of the distribution) for
67 WinNT/2000/XP.
69 Under Linux, execute the command:
71         syslinux [-sfr][-d directory][-o offset] /dev/fd0
73 (or, again, whichever device is the correct one.)
75 This will alter the boot sector on the disk and copy a file named
76 LDLINUX.SYS into its root directory (or a subdirectory, if the -d
77 option is specified.)
79 The -s option, if given, will install a "safe, slow and stupid"
80 version of SYSLINUX.  This version may work on some very buggy BIOSes
81 on which SYSLINUX would otherwise fail.  If you find a machine on
82 which the -s option is required to make it boot reliably, please send
83 as much info about your machine as you can, and include the failure
84 mode.
86 The -o option is used with a disk image file and specifies the byte
87 offset of the filesystem image in the file.
89 For the DOS and Windows installers, the -m and -a options can be used
90 on hard drives to write a Master Boot Record (MBR), and to mark the
91 specific partition active.
93 If the Shift or Alt keys are held down during boot, or the Caps or Scroll
94 locks are set, Syslinux will display a LILO-style "boot:" prompt.  The
95 user can then type a kernel file name followed by any kernel parameters.
96 The Syslinux loader does not need to know about the kernel file in
97 advance; all that is required is that it is a file located in the root
98 directory on the disk.
100 There are two versions of the Linux installer; one in the "mtools"
101 directory which requires no special privilege (other than write
102 permission to the device where you are installing) but requires the
103 mtools program suite to be available, and one in the "linux" directory
104 which requires root privilege.
107    ++++ CONFIGURATION FILE ++++
109 All options here apply to PXELINUX, ISOLINUX and EXTLINUX as well as
110 SYSLINUX unless otherwise noted.  See the respective .txt files.
112 All the configurable defaults in SYSLINUX can be changed by putting a
113 file called "syslinux.cfg" in the root directory of the boot disk.
115 Starting with version 3.35, the configuration file can also be in
116 either the /boot/syslinux or /syslinux directories (searched in that
117 order.)  If that is the case, then all filenames are assumed to be
118 relative to that same directory, unless preceded with a slash or
119 backslash.
121 The configuration file is a text file in either UNIX or DOS format,
122 containing one or more of the following items, each on its own line with
123 optional leading whitespace.  Case is insensitive for keywords; upper
124 case is used here to indicate that a word should be typed verbatim.
126 #comment
127         A comment line.
129 INCLUDE filename
130         Inserts the contents of another file at this point in the
131         configuration file. Files can currently be nested up to 16
132         levels deep, but it is not guaranteed that more than 8 levels
133         will be supported in the future.
135 DEFAULT kernel options...
136         Sets the default command line.  If Syslinux boots automatically,
137         it will act just as if the entries after DEFAULT had been typed
138         in at the "boot:" prompt.
140         If no configuration file is present, or no DEFAULT entry is
141         present in the config file, an error message is displayed and
142         the boot: prompt is shown.
144 UI module options...
145         Selects a specific user interface module (typically menu.c32
146         or vesamenu.c32).  The command-line interface treats this as a
147         directive that overrides the DEFAULT and PROMPT directives.
149 APPEND options...
150         Add one or more options to the kernel command line.  These are
151         added both for automatic and manual boots.  The options are
152         added at the very beginning of the kernel command line,
153         usually permitting explicitly entered kernel options to override
154         them.  This is the equivalent of the LILO "append" option.
156 IPAPPEND flag_val                       [PXELINUX only]
157         The IPAPPEND option is available only on PXELINUX.  The
158         flag_val is an OR of the following options:
160         1: indicates that an option of the following format
161         should be generated and added to the kernel command line:
163                 ip=<client-ip>:<boot-server-ip>:<gw-ip>:<netmask>
165         ... based on the input from the DHCP/BOOTP or PXE boot server.
167         NOTE: The use of this option is no substitute for running a
168         DHCP client in the booted system.  Without regular renewals,
169         the lease acquired by the PXE BIOS will expire, making the
170         IP address available for reuse by the DHCP server.
172         2: indicates that an option of the following format
173         should be generated and added to the kernel command line:
175                 BOOTIF=<hardware-address-of-boot-interface>
177         ... in dash-separated hexadecimal with leading hardware type
178         (same as for the configuration file; see pxelinux.txt.)
180         This allows an initrd program to determine from which
181         interface the system booted.
183         4: indicates that an option of the following format
184         should be generated and added to the kernel command line:
186                 SYSUUID=<system uuid>
188         ... in lower case hexadecimal in the format normally used for
189         UUIDs (same as for the configuration file; see pxelinux.txt.)
191 LABEL label
192     KERNEL image
193     APPEND options...
194     IPAPPEND flag_val                   [PXELINUX only]
195         Indicates that if "label" is entered as the kernel to boot,
196         Syslinux should instead boot "image", and the specified APPEND
197         and IPAPPEND options should be used instead of the ones
198         specified in the global section of the file (before the first
199         LABEL command.)  The default for "image" is the same as
200         "label", and if no APPEND is given the default is to use the
201         global entry (if any).
203         Starting with version 3.62, the number of LABEL statements is
204         virtually unlimited.
206         Note that LILO uses the syntax:
207         image = mykernel
208           label = mylabel
209           append = "myoptions"
211         ... whereas Syslinux uses the syntax:
212         label mylabel
213           kernel mykernel
214           append myoptions
216         Note: The "kernel" doesn't have to be a Linux kernel; it can
217               be a boot sector (see below.)
219         Since version 3.32 label names are no longer mangled into DOS
220         format (for SYSLINUX.)
222     The following commands are available after a LABEL statement:
224     LINUX image                 - Linux kernel image (default)
225     BOOT image                  - Bootstrap program (.bs, .bin)
226     BSS image                   - BSS image (.bss)
227     PXE image                   - PXE Network Bootstrap Program (.0)
228     FDIMAGE image               - Floppy disk image (.img)
229     COM32 image                 - COM32 program (.c32)
230     CONFIG image                - New configuration file
231         Using one of these keywords instead of KERNEL forces the
232         filetype, regardless of the filename.
234         CONFIG means restart the boot loader using a different
235         configuration file.  The configuration file is read, the
236         working directory is changed (if specified via an APPEND), then
237         the configuration file is parsed.
239     APPEND -
240         Append nothing.  APPEND with a single hyphen as argument in a
241         LABEL section can be used to override a global APPEND.
243     LOCALBOOT type
244         Attempt a different local boot method.  The special value -1
245         causes the boot loader to report failure to the BIOS, which, on
246         recent BIOSes, should mean that the next boot device in the
247         boot sequence should be activated.  Values other than those
248         documented may produce undesired results.
250         On PXELINUX, "type" 0 means perform a normal boot.  "type" 4
251         will perform a local boot with the Universal Network Driver
252         Interface (UNDI) driver still resident in memory.  Finally,
253         "type" 5 will perform a local boot with the entire PXE
254         stack, including the UNDI driver, still resident in memory.
255         All other values are undefined.  If you don't know what the
256         UNDI or PXE stacks are, don't worry -- you don't want them,
257         just specify 0.
259         On ISOLINUX, the "type" specifies the local drive number to
260         boot from; 0x00 is the primary floppy drive and 0x80 is the
261         primary hard drive.
263     INITRD initrd_file
264         Starting with version 3.71, an initrd can be specified in a
265         separate statement (INITRD) instead of as part of the APPEND
266         statement; this functionally appends "initrd=initrd_file" to
267         the kernel command line.
269         It supports multiple filenames separated by commas.
270         This is mostly useful for initramfs, which can be composed of
271         multiple separate cpio or cpio.gz archives.
272         Note: all files except the last one are zero-padded to a
273         4K page boundary.  This should not affect initramfs.
275 IMPLICIT flag_val
276         If flag_val is 0, do not load a kernel image unless it has been
277         explicitly named in a LABEL statement.  The default is 1.
279 ALLOWOPTIONS flag_val
280         If flag_val is 0, the user is not allowed to specify any
281         arguments on the kernel command line.  The only options
282         recognized are those specified in an APPEND statement.  The
283         default is 1.
285 TIMEOUT timeout
286         Indicates how long to wait at the boot: prompt until booting
287         automatically, in units of 1/10 s.  The timeout is cancelled as
288         soon as the user types anything on the keyboard, the assumption
289         being that the user will complete the command line already
290         begun.  A timeout of zero will disable the timeout completely,
291         this is also the default.
293 TOTALTIMEOUT timeout
294         Indicates how long to wait until booting automatically, in
295         units of 1/10 s.  This timeout is *not* cancelled by user
296         input, and can thus be used to deal with serial port glitches
297         or "the user walked away" type situations.  A timeout of zero
298         will disable the timeout completely, this is also the default.
300         Both TIMEOUT and TOTALTIMEOUT can be used together, for
301         example:
303                 # Wait 5 seconds unless the user types something, but
304                 # always boot after 15 minutes.
305                 TIMEOUT 50
306                 TOTALTIMEOUT 9000
308 ONTIMEOUT kernel options...
309         Sets the command line invoked on a timeout.  Normally this is
310         the same thing as invoked by "DEFAULT".  If this is specified,
311         then "DEFAULT" is used only if the user presses <Enter> to
312         boot.
314 ONERROR kernel options...
315         If a kernel image is not found (either due to it not existing,
316         or because IMPLICIT is set), run the specified command.  The
317         faulty command line is appended to the specified options, so
318         if the ONERROR directive reads as:
320                 ONERROR xyzzy plugh
322         ... and the command line as entered by the user is:
324                 foo bar baz
326         ... Syslinux will execute the following as if entered by the
327         user:
329                 xyzzy plugh foo bar baz
331 SERIAL port [[baudrate] flowcontrol]
332         Enables a serial port to act as the console.  "port" is a
333         number (0 = /dev/ttyS0 = COM1, etc.) or an I/O port address
334         (e.g. 0x3F8); if "baudrate" is omitted, the baud rate defaults
335         to 9600 bps.  The serial parameters are hardcoded to be 8
336         bits, no parity, 1 stop bit.
338         "flowcontrol" is a combination of the following bits:
339         0x001 - Assert DTR
340         0x002 - Assert RTS
341         0x008 - Enable interrupts
342         0x010 - Wait for CTS assertion
343         0x020 - Wait for DSR assertion
344         0x040 - Wait for RI assertion
345         0x080 - Wait for DCD assertion
346         0x100 - Ignore input unless CTS asserted
347         0x200 - Ignore input unless DSR asserted
348         0x400 - Ignore input unless RI asserted
349         0x800 - Ignore input unless DCD asserted
351         All other bits are reserved.
353         Typical values are:
355             0 - No flow control (default)
356         0x303 - Null modem cable detect
357         0x013 - RTS/CTS flow control
358         0x813 - RTS/CTS flow control, modem input
359         0x023 - DTR/DSR flow control
360         0x083 - DTR/DCD flow control
362         For the SERIAL directive to be guaranteed to work properly, it
363         should be the first directive in the configuration file.
365         NOTE: "port" values from 0 to 3 means the first four serial
366         ports detected by the BIOS.  They may or may not correspond to
367         the legacy port values 0x3F8, 0x2F8, 0x3E8, 0x2E8.
369         Enabling interrupts (setting the 0x008 bit) may give better
370         responsiveness without setting the NOHALT option, but could
371         potentially cause problems with buggy BIOSes.
373 NOHALT flag_val
374         If flag_val is 1, don't halt the processor while idle.
375         Halting the processor while idle significantly reduces the
376         power consumption, but can cause poor responsiveness to the
377         serial console, especially when using scripts to drive the
378         serial console, as opposed to human interaction.
380 CONSOLE flag_val
381         If flag_val is 0, disable output to the normal video console.
382         If flag_val is 1, enable output to the video console (this is
383         the default.)
385         Some BIOSes try to forward this to the serial console and
386         sometimes make a total mess thereof, so this option lets you
387         disable the video console on these systems.
389 FONT filename
390         Load a font in .psf format before displaying any output
391         (except the copyright line, which is output as ldlinux.sys
392         itself is loaded.)  Syslinux only loads the font onto the
393         video card; if the .psf file contains a Unicode table it is
394         ignored.  This only works on EGA and VGA cards; hopefully it
395         should do nothing on others.
397 KBDMAP keymap
398         Install a simple keyboard map.  The keyboard remapper used is
399         *very* simplistic (it simply remaps the keycodes received from
400         the BIOS, which means that only the key combinations relevant
401         in the default layout -- usually U.S. English -- can be
402         mapped) but should at least help people with AZERTY keyboard
403         layout and the locations of = and , (two special characters
404         used heavily on the Linux kernel command line.)
406         The included program keytab-lilo.pl from the LILO distribution
407         can be used to create such keymaps.  The file keytab-lilo.txt
408         contains the documentation for this program.
410 DISPLAY filename
411         Displays the indicated file on the screen at boot time (before
412         the boot: prompt, if displayed).  Please see the section below
413         on DISPLAY files.
415         NOTE: If the file is missing, this option is simply ignored.
417 SAY message
418         Prints the message on the screen.
420 PROMPT flag_val
421         If flag_val is 0, display the boot: prompt only if the Shift or Alt
422         key is pressed, or Caps Lock or Scroll lock is set (this is the
423         default).  If flag_val is 1, always display the boot: prompt.
425 NOESCAPE flag_val
426         If flag_val is set to 1, ignore the Shift/Alt/Caps Lock/Scroll
427         Lock escapes.  Use this (together with PROMPT 0) to force the
428         default boot alternative.
430 NOCOMPLETE flag_val
431         If flag_val is set to 1, the Tab key does not display labels
432         at the boot: prompt.
434 F1 filename
435 F2 filename
436    ...etc...
437 F9 filename
438 F10 filename
439 F11 filename
440 F12 filename
441         Displays the indicated file on the screen when a function key is
442         pressed at the boot: prompt.  This can be used to implement
443         pre-boot online help (presumably for the kernel command line
444         options.)  Please see the section below on DISPLAY files.
446         When using the serial console, press <Ctrl-F><digit> to get to
447         the help screens, e.g. <Ctrl-F><2> to get to the F2 screen.
448         For F10-F12, hit <Ctrl-F><A>, <Ctrl-F>B, <Ctrl-F>C.  For
449         compatibility with earlier versions, F10 can also be entered as
450         <Ctrl-F>0.
452 PATH path
453         Specify a colon-separated (':') list of directories to search
454         when attempting to load modules. This directive is useful for
455         specifying the directories containing the lib*.c32 library
456         files as other modules may be dependent on these files, but
457         may not reside in the same directory. The list of directories
458         is searched in order. Please see the section below on PATH
459         RULES.
461 Blank lines are ignored.
463 Note that the configuration file is not completely decoded.  Syntax
464 different from the one described above may still work correctly in this
465 version of Syslinux, but may break in a future one.
468    ++++ DISPLAY FILE FORMAT ++++
470 DISPLAY and function-key help files are text files in either DOS or UNIX
471 format (with or without <CR>).  In addition, the following special codes
472 are interpreted:
474 <FF>                                    <FF> = <Ctrl-L> = ASCII 12
475         Clear the screen, home the cursor.  Note that the screen is
476         filled with the current display color.
478 <SI><bg><fg>                            <SI> = <Ctrl-O> = ASCII 15
479         Set the display colors to the specified background and
480         foreground colors, where <bg> and <fg> are hex digits,
481         corresponding to the standard PC display attributes:
483         0 = black               8 = dark grey
484         1 = dark blue           9 = bright blue
485         2 = dark green          a = bright green
486         3 = dark cyan           b = bright cyan
487         4 = dark red            c = bright red
488         5 = dark purple         d = bright purple
489         6 = brown               e = yellow
490         7 = light grey          f = white
492         Picking a bright color (8-f) for the background results in the
493         corresponding dark color (0-7), with the foreground flashing.
495         Colors are not visible over the serial console.
497 <CAN>filename<newline>                  <CAN> = <Ctrl-X> = ASCII 24
498         If a VGA display is present, enter graphics mode and display
499         the graphic included in the specified file.  The file format
500         is an ad hoc format called LSS16; the included Perl program
501         "ppmtolss16" can be used to produce these images.  This Perl
502         program also includes the file format specification.
504         The image is displayed in 640x480 16-color mode.  Once in
505         graphics mode, the display attributes (set by <SI> code
506         sequences) work slightly differently: the background color is
507         ignored, and the foreground colors are the 16 colors specified
508         in the image file.  For that reason, ppmtolss16 allows you to
509         specify that certain colors should be assigned to specific
510         color indicies.
512         Color indicies 0 and 7, in particular, should be chosen with
513         care: 0 is the background color, and 7 is the color used for
514         the text printed by Syslinux itself.
516 <EM>                                    <EM> = <Ctrl-Y> = ASCII 25
517         If we are currently in graphics mode, return to text mode.
519 <DLE>..<ETB>                            <Ctrl-P>..<Ctrl-W> = ASCII 16-23
520         These codes can be used to select which modes to print a
521         certain part of the message file in.  Each of these control
522         characters select a specific set of modes (text screen,
523         graphics screen, serial port) for which the output is actually
524         displayed:
526         Character                       Text    Graph   Serial
527         ------------------------------------------------------
528         <DLE> = <Ctrl-P> = ASCII 16     No      No      No
529         <DC1> = <Ctrl-Q> = ASCII 17     Yes     No      No
530         <DC2> = <Ctrl-R> = ASCII 18     No      Yes     No
531         <DC3> = <Ctrl-S> = ASCII 19     Yes     Yes     No
532         <DC4> = <Ctrl-T> = ASCII 20     No      No      Yes
533         <NAK> = <Ctrl-U> = ASCII 21     Yes     No      Yes
534         <SYN> = <Ctrl-V> = ASCII 22     No      Yes     Yes
535         <ETB> = <Ctrl-W> = ASCII 23     Yes     Yes     Yes
537         For example:
539         <DC1>Text mode<DC2>Graphics mode<DC4>Serial port<ETB>
541         ... will actually print out which mode the console is in!
543 <SUB>                                   <SUB> = <Ctrl-Z> = ASCII 26
544         End of file (DOS convention).
546 <BEL>                                   <BEL> = <Ctrl-G> = ASCII 7
547         Beep the speaker.
550    ++++ COMMAND LINE KEYSTROKES ++++
552 The command line prompt supports the following keystrokes:
554 <Enter>         boot specified command line
555 <BackSpace>     erase one character
556 <Ctrl-U>        erase the whole line
557 <Ctrl-V>        display the current Syslinux version
558 <Ctrl-W>        erase one word
559 <Ctrl-X>        force text mode
560 <Tab>           list matching labels
561 <F1>..<F12>     help screens (if configured)
562 <Ctrl-F><digit> equivalent to F1..F10
563 <Ctrl-C>        interrupt boot in progress
564 <Esc>           interrupt boot in progress
565 <Ctrl-N>        display network information (PXELINUX only)
568    ++++ OTHER OPERATING SYSTEMS ++++
570 This version of Syslinux supports chain loading of other operating
571 systems (such as MS-DOS and its derivatives, including Windows 95/98).
573 Chain loading requires the boot sector of the foreign operating system
574 to be stored in a file in the root directory of the filesystem.
575 Because neither Linux kernels, nor boot sector images have reliable
576 magic numbers, Syslinux will look at the file extension.
577 The following extensions are recognized (case insensitive):
579   none or other Linux kernel image
580   .0            PXE bootstrap program (NBP) [PXELINUX only]
581   .bin          "CD boot sector" [ISOLINUX only]
582   .bs           Boot sector [SYSLINUX only]
583   .bss          Boot sector, DOS superblock will be patched in [SYSLINUX only]
584   .c32          COM32 image (32-bit ELF)
585   .img          Disk image [ISOLINUX only]
587 For filenames given on the command line, Syslinux will search for the
588 file by adding extensions in the order listed above if the plain
589 filename is not found.  Filenames in KERNEL statements must be fully
590 qualified.
592 If this is specified with one of the keywords LINUX, BOOT, BSS,
593 FDIMAGE, COM32, or CONFIG instead of KERNEL, the filetype is
594 considered to be the one specified regardless of the filename.
597       ++++ BOOTING DOS (OR OTHER SIMILAR OPERATING SYSTEMS) ++++
599 This section applies to SYSLINUX only, not to PXELINUX or ISOLINUX.
600 See isolinux.txt for an equivalent procedure for ISOLINUX.
602 This is the recommended procedure for creating a SYSLINUX disk that
603 can boot either DOS or Linux.  This example assumes the drive is A: in
604 DOS and /dev/fd0 in Linux; for other drives, substitute the
605 appropriate drive designator.
607    ---- Linux procedure ----
609 1. Make a DOS bootable disk.  This can be done either by specifying
610    the /s option when formatting the disk in DOS, or by running the
611    DOS command SYS (this can be done under DOSEMU if DOSEMU has
612    direct device access to the relevant drive):
614         format a: /s
615    or
616         sys a:
618 2. Boot Linux.  Copy the DOS boot sector from the disk into a file:
620         dd if=/dev/fd0 of=dos.bss bs=512 count=1
622 3. Run SYSLINUX on the disk:
624         syslinux /dev/fd0
626 4. Mount the disk and copy the DOS boot sector file to it.  The file
627    *must* have extension .bss:
629         mount -t msdos /dev/fd0 /mnt
630         cp dos.bss /mnt
632 5. Copy the Linux kernel image(s), initrd(s), etc to the disk, and
633    create/edit syslinux.cfg and help files if desired:
635         cp vmlinux /mnt
636         cp initrd.gz /mnt
638 6. Unmount the disk (if applicable.)
640         umount /mnt
642    ---- DOS/Windows procedure ----
644 To make this installation in DOS only, you need the utility copybs.com
645 (included with Syslinux) as well as the syslinux.com installer.  If
646 you are on an WinNT-based system (WinNT, Win2k, WinXP or later), use
647 syslinux.exe instead.
649 1. Make a DOS bootable disk.  This can be done either by specifying
650    the /s option when formatting the disk in DOS, or by running the
651    DOS command SYS:
653         format a: /s
654    or
655         sys a:
657 2. Copy the DOS boot sector from the disk into a file.  The file
658    *must* have extension .bss:
660         copybs a: a:dos.bss
662 3. Run SYSLINUX on the disk:
664         syslinux a:
666 4. Copy the Linux kernel image(s), initrd(s), etc to the disk, and
667    create/edit syslinux.cfg and help files if desired:
669         copy vmlinux a:
670         copy initrd.gz a:
673    ++++ NOVICE PROTECTION ++++
675 Syslinux will attempt to detect booting on a machine with too little
676 memory, which means the Linux boot sequence cannot complete.  If so, a
677 message is displayed and the boot sequence aborted.  Holding down the
678 Ctrl key while booting disables this feature.
680 Any file that SYSLINUX uses can be marked hidden, system or readonly
681 if so is convenient; SYSLINUX ignores all file attributes.  The
682 SYSLINUX installed automatically sets the readonly/hidden/system
683 attributes on LDLINUX.SYS.
686    ++++ NOTES ON BOOTABLE CD-ROMS ++++
688 SYSLINUX can be used to create bootdisk images for El
689 Torito-compatible bootable CD-ROMs.  However, it appears that many
690 BIOSes are very buggy when it comes to booting CD-ROMs.  Some users
691 have reported that the following steps are helpful in making a CD-ROM
692 that is bootable on the largest possible number of machines:
694         a) Use the -s (safe, slow and stupid) option to SYSLINUX;
695         b) Put the boot image as close to the beginning of the
696            ISO 9660 filesystem as possible.
698 A CD-ROM is so much faster than a floppy that the -s option shouldn't
699 matter from a speed perspective.
701 Of course, you probably want to use ISOLINUX instead.  See isolinux.txt.
704    ++++ BOOTING FROM A FAT FILESYSTEM PARTITION ON A HARD DISK ++++
706 SYSLINUX can boot from a FAT filesystem partition on a hard disk
707 (including FAT32).  The installation procedure is identical to the
708 procedure for installing it on a floppy, and should work under either
709 DOS or Linux.  To boot from a partition, SYSLINUX needs to be launched
710 from a Master Boot Record or another boot loader, just like DOS itself
711 would.
713 Under DOS, you can install a standard simple MBR on the primary hard
714 disk by running the command:
716         FDISK /MBR
718 Then use the FDISK command to mark the appropriate partition active.
720 A simple MBR, roughly on par with the one installed by DOS (but
721 unencumbered), is included in the SYSLINUX distribution.  To install
722 it under Linux, simply type:
724         cat mbr.bin > /dev/XXX
726 ... where /dev/XXX is the device you wish to install it on.
728 Under DOS or Win32, you can install the SYSLINUX MBR with the -m
729 option to the SYSLINUX installer, and use the -a option to mark the
730 current partition active:
732         syslinux -ma c:
734 Note that this will also install SYSLINUX on the specified partition.
737    ++++ HARDWARE INFORMATION +++
739 I have started to maintain a web page of hardware with known
740 problems.  There are, unfortunately, lots of broken hardware out
741 there; especially early PXE stacks (for PXELINUX) have lots of
742 problems.
744 A list of problems, and workarounds (if known), is maintained at:
746         http://syslinux.zytor.com/hardware.php
749    ++++ BOOT LOADER IDS USED ++++
751 The Linux boot protocol supports a "boot loader ID", a single byte
752 where the upper nybble specifies a boot loader family (3 = Syslinux)
753 and the lower nybble is version or, in the case of Syslinux, media:
755         0x31 (49) = SYSLINUX
756         0x32 (50) = PXELINUX
757         0x33 (51) = ISOLINUX
758         0x34 (52) = EXTLINUX
760 In recent versions of Linux, this ID is available as
761 /proc/sys/kernel/bootloader_type.
764    ++++ PATH RULES ++++
766 The current working directory is *always* searched first, before PATH,
767 when attempting to open a filename. The current working directory is
768 not affected when specifying a file with an absolute path. For
769 example, given the following file system layout,
771          /boot/
772                 /bin/
773                         ls.c32
774                         libls.c32
775                 /foo/
776                         libls.c32
778 assuming that the current working directory is /boot/foo, and assuming
779 that libls.c32 is a dependency of ls.c32, executing /boot/bin/ls.c32
780 will cause /boot/foo/libls.c32 to be loaded, not /boot/bin/libls.c32,
781 even if /boot/bin is specified in the PATH directive of a config file.
783 The reason that things work this way is that typically a user will
784 install all library files in the Syslinux installation directory, as
785 specified with the --directory installer option. This method allows
786 the user to omit the PATH directive from their config file and still
787 have things work correctly.
790    ++++ BUG REPORTS ++++
792 I would appreciate hearing of any problems you have with Syslinux.  I
793 would also like to hear from you if you have successfully used Syslinux,
794 *especially* if you are using it for a distribution.
796 If you are reporting problems, please include all possible information
797 about your system and your BIOS; the vast majority of all problems
798 reported turn out to be BIOS or hardware bugs, and I need as much
799 information as possible in order to diagnose the problems.
801 There is a mailing list for discussion among Syslinux users and for
802 announcements of new and test versions.  To join, or to browse the
803 archive, go to:
805    http://www.zytor.com/mailman/listinfo/syslinux
807 Please DO NOT send HTML messages or attachments to the mailing list
808 (including multipart/alternative or similar.)  All such messages will
809 be bounced.