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