doc/syslinux.txt

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