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