Better describe what this macro does (comment fix.)
[syslinux.git] / extlinux.doc
blob78f0910e7b9e1673e9be14335e252621877c5ce9
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 -i /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 -i /boot/extlinux
20    ... to create a subdirectory and install extlinux in it.
23 2. The configuration file is called "extlinux.conf", and is expected
24    to be found in the same directory as extlinux is installed in.
27 3. Pathnames can be absolute or relative; if absolute (with a leading
28    slash), they are relative to the root of the filesystem on which
29    extlinux is installed (/boot in the example above), if relative,
30    they are relative to the extlinux directory.
32    extlinux supports subdirectories, but the total path length is
33    limited to 511 characters.
36 4. EXTLINUX now supports symbolic links.  However, extremely long
37    symbolic links might hit the pathname limit.  Also, please note
38    that absolute symbolic links are interpreted from the root *of the
39    filesystem*, which might be different from now the running system
40    would interpret it (e.g. in the case of a separate /boot
41    partition.)  Therefore, use relative symbolic links if at all
42    possible.
45 Note that EXTLINUX installs in the filesystem partition like a
46 well-behaved bootloader :)  Thus, it needs a master boot record in the
47 partition table; the mbr.bin shipped with SYSLINUX should work well.
48 To install it just do:
50         cat mbr.bin > /dev/XXX
52 ... where /dev/XXX is the appropriate master device, e.g. /dev/hda,
53 and make sure the correct partition in set active.
56 If you have multiple disks in a software RAID configuration, the
57 preferred way to boot is:
59 - Create a separate RAID-1 partition for /boot.  Note that the Linux
60   RAID-1 driver can span as many disks as you wish.
62 - Install the MBR on *each disk*, and mark the RAID-1 partition
63   active.
65 - Run "extlinux -i /boot" to install extlinux.  This will install it on
66   all the drives in the RAID-1 set, which means you can boot any
67   combination of drives in any order.
71 It is not required to re-run the extlinux installer after installing
72 new kernels.  If you are using ext3 journalling, however, it might be
73 desirable to do so, since running the extlinux installer will flush
74 the log.  Otherwise a dirty shutdown could cause some of the new
75 kernel image to still be in the log.  This is a general problem for
76 boot loaders on journalling filesystems; it is not specific to
77 extlinux.  The "sync" command does not flush the log on the ext3
78 filesystem.
81 The SYSLINUX series boot loaders support chain loading other operating
82 systems via a separate module, chain.c32 (located in
83 com32/modules/chain.c32).  To use it, specify a LABEL in the
84 configuration file with KERNEL chain.c32 and
85 APPEND [hd|fd]<number> [<partition>]
87 For example:
89 # Windows CE/ME/NT, a very dense operating system.
90 # Second partition (2) on the first hard disk (hd0);
91 # Linux would *typically* call this /dev/hda2 or /dev/sda2.
92 LABEL cement
93         KERNEL chain.c32
94         APPEND hd0 2
96 See also README.menu.