]>
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 |
6a161fa9 | 15 | * GNU Make |
160034b2 | 16 | * GNU Bison 2.3 or later |
fc8345da | 17 | * GNU gettext 0.17 or later |
6a161fa9 | 18 | * GNU binutils 2.9.1.0.23 or later |
7d8c0213 | 19 | * Flex 2.5.35 or later |
6a161fa9 | 20 | * Other standard GNU/Unix tools |
86e5b1db | 21 | |
795b593a CW |
22 | On GNU/Linux, you also need: |
23 | ||
24 | * libdevmapper (recommended) | |
25 | ||
26 | To build grub-emu, you need: | |
27 | ||
28 | * ncurses | |
29 | * libusb (recommended) | |
30 | * SDL (recommended) | |
31 | ||
32 | To build GRUB's graphical terminal (gfxterm), you need: | |
33 | ||
34 | * FreeType 2 or later | |
35 | * GNU Unifont | |
36 | ||
86e5b1db | 37 | If you use a development snapshot or want to hack on GRUB you may |
38 | need the following. | |
39 | ||
6a161fa9 | 40 | * Ruby 1.6 or later |
8d20dcfc | 41 | * Python 2.5.2 or later |
f022876b | 42 | * Autoconf 2.60 or later |
37fb845b | 43 | * Automake 1.10.1 or later |
6a161fa9 | 44 | |
fc8345da JU |
45 | Prerequisites for make-check: |
46 | ||
47 | * qemu, specifically the binary 'qemu-system-i386' | |
48 | ||
4b13b216 | 49 | Configuring the GRUB |
6a161fa9 | 50 | ==================== |
51 | ||
52 | The `configure' shell script attempts to guess correct values for | |
53 | various system-dependent variables used during compilation. It uses | |
54 | those values to create a `Makefile' in each directory of the package. | |
55 | It may also create one or more `.h' files containing system-dependent | |
56 | definitions. Finally, it creates a shell script `config.status' that | |
57 | you can run in the future to recreate the current configuration, a | |
58 | file `config.cache' that saves the results of its tests to speed up | |
59 | reconfiguring, and a file `config.log' containing compiler output | |
60 | (useful mainly for debugging `configure'). | |
61 | ||
62 | If you need to do unusual things to compile the package, please try to | |
63 | figure out how `configure' could check whether to do them, and mail | |
64 | diffs or instructions to the address given in the `README' so they can | |
65 | be considered for the next release. If at some point `config.cache' | |
66 | contains results you don't want to keep, you may remove or edit it. | |
67 | ||
68 | The file `configure.ac' is used to create `configure' by a program | |
69 | called `autoconf'. You only need `configure.in' if you want to change | |
70 | it or regenerate `configure' using a newer version of `autoconf'. | |
71 | ||
72 | ||
4b13b216 | 73 | Building the GRUB |
6a161fa9 | 74 | ================= |
75 | ||
76 | The simplest way to compile this package is: | |
77 | ||
86e5b1db | 78 | 1. `cd' to the directory containing the package's source code. If |
79 | you don't use a release tarball you have to type `./autogen.sh'. | |
80 | Type `./configure' to configure the package for your system. | |
81 | If you're using `csh' on an old version of System V, you might | |
82 | need to type `sh ./configure' instead to prevent `csh' from trying | |
83 | to execute `configure' itself. | |
6a161fa9 | 84 | |
85 | Running `configure' takes awhile. While running, it prints some | |
86 | messages telling which features it is checking for. | |
87 | ||
88 | 2. Type `make' to compile the package. | |
89 | ||
90 | 3. Optionally, type `make check' to run any self-tests that come with | |
91 | the package. | |
92 | ||
93 | 4. Type `make install' to install the programs and any data files and | |
94 | documentation. | |
95 | ||
96 | 5. You can remove the program binaries and object files from the | |
97 | source code directory by typing `make clean'. To also remove the | |
98 | files that `configure' created (so you can compile the package for | |
99 | a different kind of computer), type `make distclean'. There is | |
100 | also a `make maintainer-clean' target, but that is intended mainly | |
101 | for the package's developers. If you use it, you may have to get | |
102 | all sorts of other programs in order to regenerate files that came | |
103 | with the distribution. | |
104 | ||
105 | ||
106 | Compiling For Multiple Architectures | |
107 | ==================================== | |
108 | ||
109 | You can compile the package for more than one kind of computer at the | |
110 | same time, by placing the object files for each architecture in their | |
111 | own directory. `cd' to the directory where you want the object files | |
112 | and executables to go and run the `configure' script. `configure' | |
113 | automatically checks for the source code in the directory that | |
114 | `configure' is in and in `..'. | |
115 | ||
116 | ||
117 | Installation Names | |
118 | ================== | |
119 | ||
120 | By default, `make install' will install the package's files in | |
121 | `/usr/local/bin', `/usr/local/man', etc. You can specify an | |
122 | installation prefix by giving `configure' the option `--prefix=PATH'. | |
123 | ||
124 | You can specify separate installation prefixes for | |
125 | architecture-specific files and architecture-independent files. If | |
126 | you give `configure' the option `--exec-prefix=PATH', the package will | |
127 | use PATH as the prefix for installing programs and libraries. | |
128 | Documentation and other data files will still use the regular prefix. | |
129 | ||
130 | In addition, if you use an unusual directory layout you can give | |
131 | options like `--bindir=PATH' to specify different values for | |
132 | particular kinds of files. Run `configure --help' for a list of the | |
133 | directories you can set and what kinds of files go in them. | |
134 | ||
135 | If the package supports it, you can cause programs to be installed | |
136 | with an extra prefix or suffix on their names by giving `configure' | |
137 | the option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. | |
138 | ||
4b13b216 | 139 | Please note, however, that the GRUB knows where it is located in the |
6a161fa9 | 140 | filesystem. If you have installed it in an unusual location, the |
141 | system might not work properly, or at all. The chief utility of these | |
4b13b216 | 142 | options for the GRUB is to allow you to "install" in some alternate |
6a161fa9 | 143 | location, and then copy these to the actual root filesystem later. |
144 | ||
145 | ||
146 | Sharing Defaults | |
147 | ================ | |
148 | ||
149 | If you want to set default values for `configure' scripts to share, | |
150 | you can create a site shell script called `config.site' that gives | |
151 | default values for variables like `CC', `cache_file', and `prefix'. | |
152 | `configure' looks for `PREFIX/share/config.site' if it exists, then | |
153 | `PREFIX/etc/config.site' if it exists. Or, you can set the | |
154 | `CONFIG_SITE' environment variable to the location of the site script. | |
155 | A warning: not all `configure' scripts look for a site script. | |
156 | ||
157 | ||
158 | Operation Controls | |
159 | ================== | |
160 | ||
161 | `configure' recognizes the following options to control how it | |
162 | operates. | |
163 | ||
164 | `--cache-file=FILE' | |
165 | Use and save the results of the tests in FILE instead of | |
166 | `./config.cache'. Set FILE to `/dev/null' to disable caching, for | |
167 | debugging `configure'. | |
168 | ||
169 | `--help' | |
170 | Print a summary of the options to `configure', and exit. | |
171 | ||
172 | `--quiet' | |
173 | `--silent' | |
174 | `-q' | |
175 | Do not print messages saying which checks are being made. | |
176 | ||
177 | `--srcdir=DIR' | |
178 | Look for the package's source code in directory DIR. Usually | |
179 | `configure' can determine that directory automatically. | |
180 | ||
181 | `--version' | |
182 | Print the version of Autoconf used to generate the `configure' | |
183 | script, and exit. |