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