Correct comment specific to SYSLINUX in the other derivatives
[syslinux.git] / doc / extlinux.doc
blob2508fa1c6cad589d2062bcee318f46226492415e
1 EXTLINUX is a new syslinux derivative, which boots from a Linux
2 ext2/ext3 filesystem.
4 It works the same way as SYSLINUX, with a few slight modifications.
6 1. The installer is run on a *mounted* filesystem.  Run the extlinux
7    installer on the directory in which you want extlinux installed:
9         extlinux --install /boot
11    Specify --install (-i) to install for the first time, or
12    --update (-U) to upgrade a previous installation.
14    NOTE: this doesn't have to be the root directory of a filesystem.
15    If /boot is a filesystem, you can do:
17         mkdir -p /boot/extlinux
18         extlinux --install /boot/extlinux
20    ... to create a subdirectory and install extlinux in it.
21    /boot/extlinux is the recommended location for extlinux.
24 2. The configuration file is called "extlinux.conf", and is expected
25    to be found in the same directory as extlinux is installed in.
28 3. Pathnames can be absolute or relative; if absolute (with a leading
29    slash), they are relative to the root of the filesystem on which
30    extlinux is installed (/boot in the example above), if relative,
31    they are relative to the extlinux directory.
33    extlinux supports subdirectories, but the total path length is
34    limited to 511 characters.
37 4. EXTLINUX now supports symbolic links.  However, extremely long
38    symbolic links might hit the pathname limit.  Also, please note
39    that absolute symbolic links are interpreted from the root *of the
40    filesystem*, which might be different from now the running system
41    would interpret it (e.g. in the case of a separate /boot
42    partition.)  Therefore, use relative symbolic links if at all
43    possible.
46 5. EXTLINUX now has "boot-once" support.  The boot-once information is
47    stored in an on-disk datastructure, part of extlinux.sys, called
48    the "Auxillary Data Vector".  The Auxilliary Data Vector is also
49    available to COMBOOT/COM32 modules that want to store small amounts
50    of information.
52    To set the boot-once information, do:
54         extlinux --once 'command' /boot/extlinux
56    where 'command' is any command you could enter at the SYSLINUX
57    command line.  It will be executed on the next boot and then
58    erased.
60    To clear the boot-once information, do:
62         extlinux --clear-once /boot/extlinux
64    If EXTLINUX is used on a RAID-1, this is recommended, since under
65    certain circumstances a RAID-1 rebuild can "resurrect" the
66    boot-once information otherwise.
68    To clear the entire Auxillary Data Vector, do:
70         extlinux --reset-adv /boot/extlinux
72    This will erase all data stored in the ADV, including boot-once.
74    The --once, --clear-once, and --reset-adv commands can be combined
75    with --install or --update, if desired.  The ADV is preserved
76    across updates, unless --reset-adv is specified.
77    
79 Note that EXTLINUX installs in the filesystem partition like a
80 well-behaved bootloader :)  Thus, it needs a master boot record in the
81 partition table; the mbr.bin shipped with SYSLINUX should work well.
82 To install it just do:
84         cat mbr.bin > /dev/XXX
86 ... where /dev/XXX is the appropriate master device, e.g. /dev/hda,
87 and make sure the correct partition in set active.
90 If you have multiple disks in a software RAID configuration, the
91 preferred way to boot is:
93 - Create a separate RAID-1 partition for /boot.  Note that the Linux
94   RAID-1 driver can span as many disks as you wish.
96 - Install the MBR on *each disk*, and mark the RAID-1 partition
97   active.
99 - Run "extlinux -i /boot" to install extlinux.  This will install it on
100   all the drives in the RAID-1 set, which means you can boot any
101   combination of drives in any order.
105 It is not required to re-run the extlinux installer after installing
106 new kernels.  If you are using ext3 journalling, however, it might be
107 desirable to do so, since running the extlinux installer will flush
108 the log.  Otherwise a dirty shutdown could cause some of the new
109 kernel image to still be in the log.  This is a general problem for
110 boot loaders on journalling filesystems; it is not specific to
111 extlinux.  The "sync" command does not flush the log on the ext3
112 filesystem.
115 The SYSLINUX series boot loaders support chain loading other operating
116 systems via a separate module, chain.c32 (located in
117 com32/modules/chain.c32).  To use it, specify a LABEL in the
118 configuration file with KERNEL chain.c32 and
119 APPEND [hd|fd]<number> [<partition>]
121 For example:
123 # Windows CE/ME/NT, a very dense operating system.
124 # Second partition (2) on the first hard disk (hd0);
125 # Linux would *typically* call this /dev/hda2 or /dev/sda2.
126 LABEL cement
127         KERNEL chain.c32
128         APPEND hd0 2
130 See also README.menu.