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