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