restore patches lost when merging NMU diff
[debian/elilo] / debian / elilo.8
1 .TH ELILO 8 "18 Mar 2002"
2 .SH NAME
3 elilo \- install EFI boot loader
4 .SH SYNOPSIS
5 .B elilo
6 .RI [ options ]
7 .SH DESCRIPTION
8 This manual page documents briefly the
9 .B elilo
10 command, which was written specifically for the Debian distribution to
11 simplify configuring and using the elilo.efi bootloader.
12 .sp
13 There are two parts to elilo, the bootloader itself and this utility which
14 installs or updates a bootload configuration.
15 .sp
16 The primary function of elilo is to copy files necessary for booting
17 Debian GNU/Linux from the main filesystem to a subdirectory /EFI/debian
18 on the boot partition.  These include elilo.efi, elilo.conf, and the kernel
19 and ramdisk images referenced by elilo.conf.  
20 .sp
21 In addition, elilo can create a default
22 configuration file, /etc/elilo.conf, and can invoke efibootmgr to create
23 an entry in the EFI Boot Manager menu such that a system will autoboot
24 in to Debian GNU/Linux on power up.
25 .sp
26 .B elilo 
27 requires a couple of extra parameters in elilo.conf that elio.efi does
28 not currently support. 
29 These are needed so that a normal run of elilo with no parameters can find 
30 the elilo.efi binary and boot partition in order to rebuild it.
31 They are:
32 .sp
33 install=<path to elilo.efi>
34 .br
35 boot=<boot partition>
36 .sp
37 .SH OPTIONS
38 This program follows the usual GNU command line syntax, with long
39 options starting with two dashes (`-').
40 .TP
41 .B \-b, \-\-boot
42 set bootstrap partition device [ -b /dev/sda1 ]
43 .TP
44 .B \-i, \-\-install
45 pathname to the actual bootloader binary,
46 default: /usr/{local/}lib/elilo/elilo.efi
47 .TP
48 .B \-C, \-\-config
49 use alternate configuration file [ -C config_file ]
50 .TP
51 .B \-\-autoconf
52 auto-generate a /etc/elilo.conf.  Typically only used during system
53 installation.  In normal use, an elilo.conf file already exists and will not
54 be modified by elilo.
55 .TP
56 .B \-\-efiboot
57 elilo auto configuration: create an efi boot manager entry for elilo.  This
58 option requires that the 
59 .B efibootmgr
60 package also be installed.
61 .TP
62 .B \-\-timeout
63 elilo auto configuration: sets the time elilo
64 will wait for user input before booting default
65 image default: 20 (2 seconds)
66 .TP
67 .B \-\-image
68 elilo auto configuration: sets the path to the
69 kernel image. default: /vmlinuz
70 .TP
71 .B \-\-label
72 elilo auto configuration: sets the image label
73 default: Linux
74 .TP
75 .B \-\-root
76 elilo auto configuration: sets the root device default: /dev/sda3
77 .TP
78 .B \-\-format
79 create a new FAT filesystem on the boot partition.  Use this cautiously if
80 you have more than one operating system installed, and they may be sharing
81 the same EFI partition!
82 .TP
83 .B \-v, \-\-verbose
84 make elilo more verbose
85 .TP
86 .B \-\-debug
87 print boring junk only useful for debugging
88 .TP
89 .B \-h, \-\-help
90 display this help and exit
91 .TP
92 .B \-V, \-\-version
93 output version information and exit
94 .SH FILES
95 .I /etc/elilo.conf      
96 .br
97 .I /usr/lib/elilo/elilo.efi 
98 .SH SEE ALSO
99 .BR efibootmgr (8)
100 .sp
101 Additional information about 
102 .B elilo
103 is available in the /usr/share/doc/elilo directory.
104 .SH AUTHOR
105 The
106 .B elilo
107 program and this manual page were written by 
108 Richard Hirst <rhirst@linuxcare.com> and Bdale Garbee <bdale@gag.com> 
109 as additions to the 
110 .B elilo
111 bootloader package from Stephane Eranian <eranian@hpl.hp.com>
112 for the Debian GNU/Linux system (but may be used by others).