INSTALL

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