git.gag.com Git - debian/elilo/blob - debian/README.elilo

   1
   2                         /usr/sbin/elilo documentation
   3
   4 There are two parts to elilo:
   5
   6 /usr/lib/elilo/elilo.efi   The bootloader itself.
   7 /usr/sbin/elilo            Utility to install/update a bootload configuration.
   8
   9 This document describes /usr/sbin/elilo; for information on elilo.efi, or
  10 the configuration file format, please refer to /usr/doc/elilo/elilo.txt.
  11
  12
  13 elilo option summary:
  14
  15   -b, --boot                 set bootstrap partition device [ -b /dev/sda1 ]
  16   -i, --install              pathname to the actual bootloader binary
  17                                default: /usr/{local/}lib/elilo/elilo.efi
  18   -C, --config               use alternate configuration file [ -C config_file ]
  19       --autoconf             auto-generate a /etc/elilo.conf
  20       --efiboot              elilo auto configuration: create an efi boot
  21                                manager entry for elilo
  22       --timeout              elilo auto configuration: sets the time elilo
  23                                will wait for user input before booting default
  24                                image default: 20 (2 seconds)
  25       --image                elilo auto configuration: sets the path to the
  26                                kernel image. default: /vmlinuz
  27       --label                elilo auto configuration: sets the image label
  28                                default: Linux
  29       --root                 elilo auto configuration: sets the root device
  30                                default: /dev/sda3
  31       --format               create a new FAT filesystem on the boot partition
  32   -v, --verbose              make elilo more verbose
  33       --debug                print boring junk only useful for debugging
  34   -h, --help                 display this help and exit
  35   -V, --version              output version information and exit
  36
  37
  38 The primary function of elilo is to copy files necessary for booting
  39 Debian GNU/Linux from the main filesystem to a subdirectory /EFI/debian
  40 on the boot partition.  In addition, elilo can create a default
  41 configuration file, /etc/elilo.conf, and can invoke efibootmgr to create
  42 an entry in the EFI Boot Manager menu such that a system will autoboot
  43 in to Debian GNU/Linux on power up.
  44
  45 It is important to note that elilo will recreate the /EFI/debian
  46 directory on your boot partition every time it is run, so any local
  47 changes you might have made under that direcotry will be lost.  The
  48 intention of elilo is to hide the boot partition from the user; the
  49 partition is not normally mounted so the user is unlikely to make local
  50 modifications.
  51
  52 elilo does various checks on the partition (e.g. must pass dosfsck, must
  53 be a partition rather than a whole disk, must not be mounted, etc.)
  54 before overwriting it.  Invoking it with --format will run mkdosfs on
  55 the partition; this is generally not advisable, if the partition may be
  56 shared with other operating systems.
  57
  58
  59 /etc/elilo.conf generation:
  60
  61 This is generally only used during system installation.  Typically elilo.conf
  62 will already exist, and is not modified by elilo.  To generate a new config
  63 file, you must specify --autoconf, along with any of the other auto
  64 configuration options necessary to override defaults.  Defaults are given
  65 in the option summary above.
  66
  67
  68 Invoking efibootmgr:
  69
  70 --efiboot will cause elilo to run efibootmgr and create a default boot entry
  71 in the EFI Boot Manager menu called "Debian GNU/Linux".  Any other entries
  72 of that name are assumed to be left over from some previous installation and
  73 are deleted.  If the descriptions for the first two boot mansger entries
  74 start with strings "floppy" and "CD" or "DVD", then the new boot entry
  75 is created as the third entry, so that the system will still boot
  76 exchangeable media first by default.
  77
  78
  79 elilo.conf extensions:
  80
  81 elilo requires a couple of extra parameters in elilo.conf that elio.efi does
  82 not currently support.  They are:
  83
  84 install=<path to elilo.efi>  # default /usr/lib/elilo/elilo.efi
  85 boot=<boot partition>        # /dev/sda1
  86
  87 These are needed so that a normal run of elilo with no parameters can find
  88 the elilo.efi binary and boot partition in order to rebuild it.
  89
  90
  91 Boot partition creation:
  92
  93 Once the /EFI/debian directory has been created, elilo copies various
  94 files to it.  These include elilo.efi, elilo.conf, and certain kernel
  95 and ramdisk images referenced by elilo.conf.  elilo.conf is modified as
  96 it is copied, to comment out the install= and boot= lines so as not to
  97 confuse elilo.efi, and to prefix any file paths with /EFI/debian.  All
  98 kernel and initrd images that are referenced via standard UNIX paths are
  99 copied to the boot partition, so that elilo.efi can find them easily.
 100 Any paths containing a ':' are assumed to be EFI device paths, and as
 101 such are not copied.  Device path names depend on features of elilo.efi,
 102 but a typical path might be "scsi1:/vmlinux-2.4.7".  It is hoped that
 103 eventually a sufficiently robust device path naming scheme will be
 104 devised, and then devices paths will be used throughout, and it will no
 105 longer be necessary to copy images to the boot partition.
 106