1.1.2
by Otavio Salvador
Import upstream version 1.92 |
1 |
-*- Text -*- |
2 |
||
3 |
This is the GRUB. Welcome. |
|
4 |
||
5 |
This file contains instructions for compiling and installing the GRUB. |
|
6 |
||
7 |
The Requirements |
|
8 |
================
|
|
9 |
||
10 |
GRUB depends on some software packages installed into your system. If |
|
11 |
you don't have any of them, please obtain and install them before |
|
12 |
configuring the GRUB.
|
|
13 |
||
17.2.16
by Felix Zielcke, sparc, Updated translations
* New upstream beta release. |
14 |
* GCC 4.1.3 or later
|
1.15.17
by Colin Watson
Import upstream version 2.00+20131208 |
15 |
Note: older versions may work but support is limited
|
16 |
Note: clang 3.2 or later works for i386 and x86_64 targets but results in
|
|
17 |
much bigger binaries.
|
|
18 |
earlier versions not tested
|
|
19 |
Note: clang 3.2 or later works for arm
|
|
1.15.18
by Colin Watson
Import upstream version 2.02~beta2 |
20 |
None of tested clang versions generated usable thumb code
|
1.15.17
by Colin Watson
Import upstream version 2.00+20131208 |
21 |
earlier versions not tested
|
22 |
Note: clang 3.3 or later works for arm64
|
|
23 |
earlier versions have no arm64 support
|
|
24 |
Note: clang 3.3 or later works for mips(el)
|
|
25 |
earlier versions fail to generate .reginfo and hence gprel relocations
|
|
26 |
fail.
|
|
27 |
Note: clang 3.2 or later works for powerpc
|
|
28 |
earlier versions not tested
|
|
1.15.18
by Colin Watson
Import upstream version 2.02~beta2 |
29 |
Note: clang doesn't support -mno-app-regs and so can't be used for sparc64 |
1.15.17
by Colin Watson
Import upstream version 2.00+20131208 |
30 |
Note: clang has no support for ia64 and hence you can't compile GRUB |
31 |
for ia64 with clang |
|
1.1.2
by Otavio Salvador
Import upstream version 1.92 |
32 |
* GNU Make |
1.2.6
by Felix Zielcke
Import upstream version 1.97~beta2 |
33 |
* GNU Bison 2.3 or later |
1.13.10
by Colin Watson
Import upstream version 1.98 |
34 |
* GNU gettext 0.17 or later |
1.1.2
by Otavio Salvador
Import upstream version 1.92 |
35 |
* GNU binutils 2.9.1.0.23 or later |
1.13.11
by Colin Watson
Import upstream version 1.98+20100527 |
36 |
* Flex 2.5.35 or later |
1.1.2
by Otavio Salvador
Import upstream version 1.92 |
37 |
* Other standard GNU/Unix tools |
1.10.1
by Felix Zielcke
Import upstream version 1.97+20091115 |
38 |
|
1.13.13
by Colin Watson
Import upstream version 1.98+20100614 |
39 |
On GNU/Linux, you also need: |
40 |
||
1.26.4
by Colin Watson
Import upstream version 1.99~20101122 |
41 |
* libdevmapper 1.02.34 or later (recommended) |
1.13.13
by Colin Watson
Import upstream version 1.98+20100614 |
42 |
|
1.15.17
by Colin Watson
Import upstream version 2.00+20131208 |
43 |
For optional grub-emu features, you need: |
1.13.13
by Colin Watson
Import upstream version 1.98+20100614 |
44 |
|
45 |
* SDL (recommended) |
|
1.15.17
by Colin Watson
Import upstream version 2.00+20131208 |
46 |
* libpciaccess (optional) |
47 |
* libusb (optional) |
|
1.13.13
by Colin Watson
Import upstream version 1.98+20100614 |
48 |
|
49 |
To build GRUB's graphical terminal (gfxterm), you need: |
|
50 |
||
51 |
* FreeType 2 or later
|
|
52 |
* GNU Unifont
|
|
53 |
||
1.10.1
by Felix Zielcke
Import upstream version 1.97+20091115 |
54 |
If you use a development snapshot or want to hack on GRUB you may
|
55 |
need the following.
|
|
56 |
||
1.15.17
by Colin Watson
Import upstream version 2.00+20131208 |
57 |
* Python 2.6 or later
|
1.10.2
by Felix Zielcke
Import upstream version 1.97+20091125 |
58 |
* Autoconf 2.60 or later
|
59 |
* Automake 1.10.1 or later
|
|
1.1.2
by Otavio Salvador
Import upstream version 1.92 |
60 |
|
1.13.10
by Colin Watson
Import upstream version 1.98 |
61 |
Prerequisites for make-check:
|
62 |
||
63 |
* qemu, specifically the binary 'qemu-system-i386' |
|
1.15.17
by Colin Watson
Import upstream version 2.00+20131208 |
64 |
* xorriso 1.2.9 or later, for grub-mkrescue and grub-shell
|
1.13.10
by Colin Watson
Import upstream version 1.98 |
65 |
|
1.1.2
by Otavio Salvador
Import upstream version 1.92 |
66 |
Configuring the GRUB
|
67 |
====================
|
|
68 |
||
69 |
The `configure' shell script attempts to guess correct values for |
|
70 |
various system-dependent variables used during compilation. It uses |
|
71 |
those values to create a `Makefile' in each directory of the package. |
|
72 |
It may also create one or more `.h' files containing system-dependent |
|
73 |
definitions. Finally, it creates a shell script `config.status' that |
|
74 |
you can run in the future to recreate the current configuration, a
|
|
75 |
file `config.cache' that saves the results of its tests to speed up |
|
76 |
reconfiguring, and a file `config.log' containing compiler output |
|
77 |
(useful mainly for debugging `configure'). |
|
78 |
||
79 |
If you need to do unusual things to compile the package, please try to |
|
80 |
figure out how `configure' could check whether to do them, and mail |
|
81 |
diffs or instructions to the address given in the `README' so they can |
|
82 |
be considered for the next release. If at some point `config.cache' |
|
83 |
contains results you don't want to keep, you may remove or edit it. |
|
84 |
||
85 |
The file `configure.ac' is used to create `configure' by a program |
|
86 |
called `autoconf'. You only need `configure.in' if you want to change |
|
87 |
it or regenerate `configure' using a newer version of `autoconf'. |
|
88 |
||
89 |
||
90 |
Building the GRUB |
|
91 |
=================
|
|
92 |
||
93 |
The simplest way to compile this package is: |
|
94 |
||
1.15.17
by Colin Watson
Import upstream version 2.00+20131208 |
95 |
1. `cd' to the directory containing the package's source code. |
96 |
||
97 |
2. Skip this and following step if you use release tarball and proceed to |
|
98 |
step 4. If you want translations type `./linguas.sh'. |
|
99 |
|
|
100 |
3. Type `./autogen.sh'. |
|
101 |
||
102 |
4. Type `./configure' to configure the package for your system. |
|
1.10.1
by Felix Zielcke
Import upstream version 1.97+20091115 |
103 |
If you're using `csh' on an old version of System V, you might |
104 |
need to type `sh ./configure' instead to prevent `csh' from trying |
|
105 |
to execute `configure' itself. |
|
1.1.2
by Otavio Salvador
Import upstream version 1.92 |
106 |
|
107 |
Running `configure' takes awhile. While running, it prints some |
|
108 |
messages telling which features it is checking for.
|
|
109 |
||
1.15.17
by Colin Watson
Import upstream version 2.00+20131208 |
110 |
6. Type `make' to compile the package. |
1.1.2
by Otavio Salvador
Import upstream version 1.92 |
111 |
|
1.15.17
by Colin Watson
Import upstream version 2.00+20131208 |
112 |
7. Optionally, type `make check' to run any self-tests that come with |
1.1.2
by Otavio Salvador
Import upstream version 1.92 |
113 |
the package.
|
114 |
||
1.15.17
by Colin Watson
Import upstream version 2.00+20131208 |
115 |
8. Type `make install' to install the programs and any data files and |
1.1.2
by Otavio Salvador
Import upstream version 1.92 |
116 |
documentation. |
117 |
||
1.15.17
by Colin Watson
Import upstream version 2.00+20131208 |
118 |
9. You can remove the program binaries and object files from the |
1.1.2
by Otavio Salvador
Import upstream version 1.92 |
119 |
source code directory by typing `make clean'. To also remove the |
120 |
files that `configure' created (so you can compile the package for |
|
121 |
a different kind of computer), type `make distclean'. There is |
|
122 |
also a `make maintainer-clean' target, but that is intended mainly |
|
123 |
for the package's developers. If you use it, you may have to get |
|
124 |
all sorts of other programs in order to regenerate files that came
|
|
125 |
with the distribution.
|
|
126 |
||
1.15.17
by Colin Watson
Import upstream version 2.00+20131208 |
127 |
Cross-compiling the GRUB
|
128 |
========================
|
|
129 |
||
130 |
GRUB defines 3 platforms:
|
|
131 |
||
132 |
- "Build" is the one which build systems runs on.
|
|
133 |
- "Host" is where you execute GRUB utils.
|
|
134 |
- "Target" is where GRUB itself runs.
|
|
135 |
||
136 |
For grub-emu host and target must be the same but may differ from build.
|
|
137 |
||
138 |
If build and host are different make check isn't available. |
|
139 |
||
140 |
If build and host are different man pages are not generated. |
|
141 |
||
142 |
As an example imagine you have a build system running on FreeBSD on sparc |
|
143 |
which prepares packages for developpers running amd64 GNU/Linux laptop and |
|
144 |
they need to make images for ARM board running U-boot. In this case: |
|
145 |
||
146 |
build=sparc64-freebsd |
|
147 |
host=amd64-linux-gnu |
|
148 |
target=arm-uboot |
|
149 |
||
150 |
For this example the configure line might look like (more details below) |
|
151 |
(some options are optional and included here for completeness but some rarely |
|
152 |
used options are omited): |
|
153 |
||
154 |
./configure BUILD_CC=gcc BUILD_FREETYPE=freetype-config --host=amd64-linux-gnu |
|
155 |
CC=amd64-linux-gnu-gcc CFLAGS="-g -O2" FREETYPE=amd64-linux-gnu-freetype-config |
|
156 |
--target=arm --with-platform=uboot TARGET_CC=arm-elf-gcc
|
|
157 |
TARGET_CFLAGS="-Os -march=armv6" TARGET_CCASFLAGS="-march=armv6" |
|
158 |
TARGET_OBJCOPY="arm-elf-objcopy" TARGET_STRIP="arm-elf-strip" |
|
159 |
TARGET_NM=arm-elf-nm TARGET_RANLIB=arm-elf-ranlib LEX=gflex |
|
160 |
||
161 |
You need to use following options to specify tools and platforms. For minimum |
|
162 |
version look at prerequisites. All tools not mentioned in this section under |
|
163 |
corresponding platform are not needed for the platform in question. |
|
164 |
||
165 |
- For build |
|
166 |
1. BUILD_CC= to gcc able to compile for build. This is used, for |
|
167 |
example, to compile build-gentrigtables which is then run to |
|
168 |
generate sin and cos tables. |
|
169 |
2. BUILD_CFLAGS= for C options for build. |
|
170 |
3. BUILD_CPPFLAGS= for C preprocessor options for build. |
|
171 |
4. BUILD_FREETYPE= for freetype-config for build (optional). |
|
172 |
||
173 |
- For host |
|
174 |
1. --host= to autoconf name of host. |
|
175 |
2. CC= for gcc able to compile for host |
|
176 |
3. CFLAGS= for C options for host. |
|
177 |
4. CPPFLAGS= for C preprocessor options for host. |
|
178 |
5. LDFLAGS= for linker options for host. |
|
179 |
6. FREETYPE= for freetype-config for host (optional). |
|
180 |
7. Libdevmapper if any must be in standard linker folders (-ldevmapper) (optional). |
|
181 |
8. Libfuse if any must be in standard linker folders (-lfuse) (optional). |
|
182 |
9. Libzfs if any must be in standard linker folders (-lzfs) (optional). |
|
183 |
10. Liblzma if any must be in standard linker folders (-llzma) (optional). |
|
184 |
||
185 |
- For target |
|
186 |
1. --target= to autoconf cpu name of target. |
|
187 |
2. --with-platform to choose firmware. |
|
188 |
3. TARGET_CC= for gcc able to compile for target |
|
189 |
4. TARGET_CFLAGS= for C options for target. |
|
190 |
5. TARGET_CPPFLAGS= for C preprocessor options for target. |
|
191 |
6. TARGET_CCASFLAGS= for assembler options for target. |
|
192 |
7. TARGET_LDFLAGS= for linker options for target. |
|
193 |
8. TARGET_OBJCOPY= for objcopy for target. |
|
194 |
9. TARGET_STRIP= for strip for target. |
|
195 |
10. TARGET_NM= for nm for target. |
|
196 |
11. TARGET_RANLIB= for ranlib for target. |
|
197 |
||
198 |
- Additionally for emu, for host and target. |
|
199 |
1. SDL is looked for in stadard linker directories (-lSDL) (optional) |
|
200 |
2. libpciaccess is looked for in stadard linker directories (-lpciaccess) (optional) |
|
201 |
3. libusb is looked for in stadard linker directories (-lusb) (optional) |
|
202 |
||
203 |
- Platform-agnostic tools and data. |
|
204 |
1. make is the tool you execute after ./configure. |
|
205 |
2. Bison is specified in YACC= variable |
|
206 |
3. Flex is specified in LEX= variable |
|
207 |
4. GNU unifont and Djvu sans are looked for in standard directories. |
|
1.1.2
by Otavio Salvador
Import upstream version 1.92 |
208 |
|
209 |
Compiling For Multiple Architectures |
|
210 |
====================================
|
|
211 |
||
212 |
You can compile the package for more than one kind of computer at the |
|
213 |
same time, by placing the object files for each architecture in their |
|
214 |
own directory. `cd' to the directory where you want the object files |
|
215 |
and executables to go and run the `configure' script. `configure' |
|
216 |
automatically checks for the source code in the directory that
|
|
217 |
`configure' is in and in `..'. |
|
218 |
||
219 |
||
220 |
Installation Names
|
|
221 |
==================
|
|
222 |
||
223 |
By default, `make install' will install the package's files in |
|
224 |
`/usr/local/bin', `/usr/local/man', etc. You can specify an |
|
225 |
installation prefix by giving `configure' the option `--prefix=PATH'. |
|
226 |
||
227 |
You can specify separate installation prefixes for |
|
228 |
architecture-specific files and architecture-independent files. If |
|
229 |
you give `configure' the option `--exec-prefix=PATH', the package will |
|
230 |
use PATH as the prefix for installing programs and libraries. |
|
231 |
Documentation and other data files will still use the regular prefix. |
|
232 |
||
233 |
In addition, if you use an unusual directory layout you can give |
|
234 |
options like `--bindir=PATH' to specify different values for |
|
235 |
particular kinds of files. Run `configure --help' for a list of the |
|
236 |
directories you can set and what kinds of files go in them. |
|
237 |
||
238 |
If the package supports it, you can cause programs to be installed |
|
239 |
with an extra prefix or suffix on their names by giving `configure' |
|
240 |
the option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. |
|
241 |
||
242 |
Please note, however, that the GRUB knows where it is located in the |
|
243 |
filesystem. If you have installed it in an unusual location, the |
|
244 |
system might not work properly, or at all. The chief utility of these |
|
245 |
options for the GRUB is to allow you to "install" in some alternate |
|
246 |
location, and then copy these to the actual root filesystem later. |
|
247 |
||
248 |
||
249 |
Sharing Defaults |
|
250 |
================
|
|
251 |
||
252 |
If you want to set default values for `configure' scripts to share, |
|
253 |
you can create a site shell script called `config.site' that gives |
|
254 |
default values for variables like `CC', `cache_file', and `prefix'. |
|
255 |
`configure' looks for `PREFIX/share/config.site' if it exists, then |
|
256 |
`PREFIX/etc/config.site' if it exists. Or, you can set the |
|
257 |
`CONFIG_SITE' environment variable to the location of the site script. |
|
258 |
A warning: not all `configure' scripts look for a site script. |
|
259 |
||
260 |
||
261 |
Operation Controls |
|
262 |
==================
|
|
263 |
||
264 |
`configure' recognizes the following options to control how it |
|
265 |
operates.
|
|
266 |
||
267 |
`--cache-file=FILE'
|
|
268 |
Use and save the results of the tests in FILE instead of |
|
269 |
`./config.cache'. Set FILE to `/dev/null' to disable caching, for |
|
270 |
debugging `configure'. |
|
271 |
||
272 |
`--help'
|
|
273 |
Print a summary of the options to `configure', and exit. |
|
274 |
||
275 |
`--quiet'
|
|
276 |
`--silent' |
|
277 |
`-q' |
|
278 |
Do not print messages saying which checks are being made.
|
|
279 |
||
280 |
`--srcdir=DIR'
|
|
281 |
Look for the package's source code in directory DIR. Usually |
|
282 |
`configure' can determine that directory automatically. |
|
283 |
||
284 |
`--version' |
|
285 |
Print the version of Autoconf used to generate the `configure' |
|
286 |
script, and exit. |