2N/A-*- Text -*-
2N/A
2N/AThis is the GRUB. Welcome.
2N/A
2N/AThis file contains instructions for compiling and installing the GRUB.
2N/A
2N/AThe Requirements
2N/A================
2N/A
2N/AGRUB depends on some software packages installed into your system. If
2N/Ayou don't have any of them, please obtain and install them before
2N/Aconfiguring the GRUB.
2N/A
2N/A* GCC 4.1.3 or later
2N/A* GNU Make
2N/A* GNU Bison 2.3 or later
2N/A* GNU gettext 0.17 or later
2N/A* GNU binutils 2.9.1.0.23 or later
2N/A* Flex 2.5.35 or later
2N/A* Other standard GNU/Unix tools
2N/A
2N/AOn GNU/Linux, you also need:
2N/A
2N/A* libdevmapper 1.02.34 or later (recommended)
2N/A
2N/ATo build grub-emu, you need:
2N/A
2N/A* ncurses
2N/A* libusb (recommended)
2N/A* SDL (recommended)
2N/A
2N/ATo build GRUB's graphical terminal (gfxterm), you need:
2N/A
2N/A* FreeType 2 or later
2N/A* GNU Unifont
2N/A
2N/AIf you use a development snapshot or want to hack on GRUB you may
2N/Aneed the following.
2N/A
2N/A* Python 2.5.2 or later
2N/A* Autoconf 2.60 or later
2N/A* Automake 1.10.1 or later
2N/A* Autogen 5.10 or later
2N/A
2N/APrerequisites for make-check:
2N/A
2N/A* qemu, specifically the binary 'qemu-system-i386'
2N/A
2N/AConfiguring the GRUB
2N/A====================
2N/A
2N/AThe `configure' shell script attempts to guess correct values for
2N/Avarious system-dependent variables used during compilation. It uses
2N/Athose values to create a `Makefile' in each directory of the package.
2N/AIt may also create one or more `.h' files containing system-dependent
2N/Adefinitions. Finally, it creates a shell script `config.status' that
2N/Ayou can run in the future to recreate the current configuration, a
2N/Afile `config.cache' that saves the results of its tests to speed up
2N/Areconfiguring, and a file `config.log' containing compiler output
2N/A(useful mainly for debugging `configure').
2N/A
2N/AIf you need to do unusual things to compile the package, please try to
2N/Afigure out how `configure' could check whether to do them, and mail
2N/Adiffs or instructions to the address given in the `README' so they can
2N/Abe considered for the next release. If at some point `config.cache'
2N/Acontains results you don't want to keep, you may remove or edit it.
2N/A
2N/AThe file `configure.ac' is used to create `configure' by a program
2N/Acalled `autoconf'. You only need `configure.in' if you want to change
2N/Ait or regenerate `configure' using a newer version of `autoconf'.
2N/A
2N/A
2N/ABuilding the GRUB
2N/A=================
2N/A
2N/AThe simplest way to compile this package is:
2N/A
2N/A 1. `cd' to the directory containing the package's source code. If
2N/A you don't use a release tarball you have to type `./autogen.sh'.
2N/A Type `./configure' to configure the package for your system.
2N/A If you're using `csh' on an old version of System V, you might
2N/A need to type `sh ./configure' instead to prevent `csh' from trying
2N/A to execute `configure' itself.
2N/A
2N/A Running `configure' takes awhile. While running, it prints some
2N/A messages telling which features it is checking for.
2N/A
2N/A 2. Type `make' to compile the package.
2N/A
2N/A 3. Optionally, type `make check' to run any self-tests that come with
2N/A the package.
2N/A
2N/A 4. Type `make install' to install the programs and any data files and
2N/A documentation.
2N/A
2N/A 5. You can remove the program binaries and object files from the
2N/A source code directory by typing `make clean'. To also remove the
2N/A files that `configure' created (so you can compile the package for
2N/A a different kind of computer), type `make distclean'. There is
2N/A also a `make maintainer-clean' target, but that is intended mainly
2N/A for the package's developers. If you use it, you may have to get
2N/A all sorts of other programs in order to regenerate files that came
2N/A with the distribution.
2N/A
2N/A
2N/ACompiling For Multiple Architectures
2N/A====================================
2N/A
2N/AYou can compile the package for more than one kind of computer at the
2N/Asame time, by placing the object files for each architecture in their
2N/Aown directory. `cd' to the directory where you want the object files
2N/Aand executables to go and run the `configure' script. `configure'
2N/Aautomatically checks for the source code in the directory that
2N/A`configure' is in and in `..'.
2N/A
2N/A
2N/AInstallation Names
2N/A==================
2N/A
2N/ABy default, `make install' will install the package's files in
2N/A`/usr/local/bin', `/usr/local/man', etc. You can specify an
2N/Ainstallation prefix by giving `configure' the option `--prefix=PATH'.
2N/A
2N/AYou can specify separate installation prefixes for
2N/Aarchitecture-specific files and architecture-independent files. If
2N/Ayou give `configure' the option `--exec-prefix=PATH', the package will
2N/Ause PATH as the prefix for installing programs and libraries.
2N/ADocumentation and other data files will still use the regular prefix.
2N/A
2N/AIn addition, if you use an unusual directory layout you can give
2N/Aoptions like `--bindir=PATH' to specify different values for
2N/Aparticular kinds of files. Run `configure --help' for a list of the
2N/Adirectories you can set and what kinds of files go in them.
2N/A
2N/AIf the package supports it, you can cause programs to be installed
2N/Awith an extra prefix or suffix on their names by giving `configure'
2N/Athe option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
2N/A
2N/APlease note, however, that the GRUB knows where it is located in the
2N/Afilesystem. If you have installed it in an unusual location, the
2N/Asystem might not work properly, or at all. The chief utility of these
2N/Aoptions for the GRUB is to allow you to "install" in some alternate
2N/Alocation, and then copy these to the actual root filesystem later.
2N/A
2N/A
2N/ASharing Defaults
2N/A================
2N/A
2N/AIf you want to set default values for `configure' scripts to share,
2N/Ayou can create a site shell script called `config.site' that gives
2N/Adefault values for variables like `CC', `cache_file', and `prefix'.
2N/A`configure' looks for `PREFIX/share/config.site' if it exists, then
2N/A`PREFIX/etc/config.site' if it exists. Or, you can set the
2N/A`CONFIG_SITE' environment variable to the location of the site script.
2N/AA warning: not all `configure' scripts look for a site script.
2N/A
2N/A
2N/AOperation Controls
2N/A==================
2N/A
2N/A `configure' recognizes the following options to control how it
2N/Aoperates.
2N/A
2N/A`--cache-file=FILE'
2N/A Use and save the results of the tests in FILE instead of
2N/A `./config.cache'. Set FILE to `/dev/null' to disable caching, for
2N/A debugging `configure'.
2N/A
2N/A`--help'
2N/A Print a summary of the options to `configure', and exit.
2N/A
2N/A`--quiet'
2N/A`--silent'
2N/A`-q'
2N/A Do not print messages saying which checks are being made.
2N/A
2N/A`--srcdir=DIR'
2N/A Look for the package's source code in directory DIR. Usually
2N/A `configure' can determine that directory automatically.
2N/A
2N/A`--version'
2N/A Print the version of Autoconf used to generate the `configure'
2N/A script, and exit.