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   Note: older versions may work but support is limited
  16   Note: clang 3.2 or later works for i386 and x86_64 targets but results in
  17         much bigger binaries.
  18   Note: clang 3.2 or later works for arm
  19   Note: clang 3.3 or later works for mips(el)
  20   Note: clang 3.4 or later works for powerpc
  21 * GNU Make
  22 * GNU Bison 2.3 or later
  23 * GNU gettext 0.17 or later
  24 * GNU binutils 2.9.1.0.23 or later
  25 * Flex 2.5.35 or later
  26 * Other standard GNU/Unix tools
  27
  28 On GNU/Linux, you also need:
  29
  30 * libdevmapper 1.02.34 or later (recommended)
  31
  32 For optional grub-emu features, you need:
  33
  34 * SDL (recommended)
  35 * libpciaccess (optional)
  36 * libusb (optional)
  37
  38 To build GRUB's graphical terminal (gfxterm), you need:
  39
  40 * FreeType 2 or later
  41 * GNU Unifont
  42
  43 If you use a development snapshot or want to hack on GRUB you may
  44 need the following.
  45
  46 * Python 2.5.2 or later
  47 * Autoconf 2.60 or later
  48 * Automake 1.10.1 or later
  49 * Autogen 5.10 or later
  50
  51 Prerequisites for make-check:
  52
  53 * qemu, specifically the binary 'qemu-system-i386'
  54 * xorriso 1.2.9 or later, for grub-mkrescue and grub-shell
  55
  56 Configuring the GRUB
  57 ====================
  58
  59 The `configure' shell script attempts to guess correct values for
  60 various system-dependent variables used during compilation.  It uses
  61 those values to create a `Makefile' in each directory of the package.
  62 It may also create one or more `.h' files containing system-dependent
  63 definitions.  Finally, it creates a shell script `config.status' that
  64 you can run in the future to recreate the current configuration, a
  65 file `config.cache' that saves the results of its tests to speed up
  66 reconfiguring, and a file `config.log' containing compiler output
  67 (useful mainly for debugging `configure').
  68
  69 If you need to do unusual things to compile the package, please try to
  70 figure out how `configure' could check whether to do them, and mail
  71 diffs or instructions to the address given in the `README' so they can
  72 be considered for the next release.  If at some point `config.cache'
  73 contains results you don't want to keep, you may remove or edit it.
  74
  75 The file `configure.ac' is used to create `configure' by a program
  76 called `autoconf'.  You only need `configure.in' if you want to change
  77 it or regenerate `configure' using a newer version of `autoconf'.
  78
  79
  80 Building the GRUB
  81 =================
  82
  83 The simplest way to compile this package is:
  84
  85   1. `cd' to the directory containing the package's source code.
  86
  87   2. Skip this and following step if you use release tarball and proceed to
  88      step 4. If you want translations type `./linguas.sh'.
  89
  90   3. Type `./autogen.sh'.
  91
  92   4. Type `./configure' to configure the package for your system.
  93      If you're using `csh' on an old version of System V, you might
  94      need to type `sh ./configure' instead to prevent `csh' from trying
  95      to execute `configure' itself.
  96
  97      Running `configure' takes awhile.  While running, it prints some
  98      messages telling which features it is checking for.
  99
 100   6. Type `make' to compile the package.
 101
 102   7. Optionally, type `make check' to run any self-tests that come with
 103      the package.
 104
 105   8. Type `make install' to install the programs and any data files and
 106      documentation.
 107
 108   9. You can remove the program binaries and object files from the
 109      source code directory by typing `make clean'.  To also remove the
 110      files that `configure' created (so you can compile the package for
 111      a different kind of computer), type `make distclean'.  There is
 112      also a `make maintainer-clean' target, but that is intended mainly
 113      for the package's developers.  If you use it, you may have to get
 114      all sorts of other programs in order to regenerate files that came
 115      with the distribution.
 116
 117 Cross-compiling the GRUB
 118 ========================
 119
 120 GRUB defines 3 platforms:
 121
 122   - "Build" is the one which build systems runs on.
 123   - "Host" is where you execute GRUB utils.
 124   - "Target" is where GRUB itself runs.
 125
 126 For grub-emu host and target must be the same but may differ from build.
 127
 128 If build and host are different make check isn't available.
 129
 130 If build and host are different man pages are not generated.
 131
 132 As an example imagine you have a build system running on FreeBSD on sparc
 133 which prepares packages for developpers running amd64 GNU/Linux laptop and
 134 they need to make images for ARM board running U-boot. In this case:
 135
 136 build=sparc64-freebsd
 137 host=amd64-linux-gnu
 138 target=arm-uboot
 139
 140 For this example the configure line might look like (more details below)
 141 (some options are optional and included here for completeness but some rarely
 142 used options are omited):
 143
 144 ./configure BUILD_CC=gcc BUILD_FREETYPE=freetype-config --host=amd64-linux-gnu
 145 CC=amd64-linux-gnu-gcc CFLAGS="-g -O2" FREETYPE=amd64-linux-gnu-freetype-config
 146 --target=arm --with-platform=uboot TARGET_CC=arm-elf-gcc
 147 TARGET_CFLAGS="-Os -march=armv6" TARGET_CCASFLAGS="-march=armv6"
 148 TARGET_OBJCOPY="arm-elf-objcopy" TARGET_STRIP="arm-elf-strip"
 149 TARGET_NM=arm-elf-nm TARGET_RANLIB=arm-elf-ranlib LEX=gflex
 150
 151 You need to use following options to specify tools and platforms. For minimum
 152 version look at prerequisites. All tools not mentioned in this section under
 153 corresponding platform are not needed for the platform in question.
 154
 155   - For build
 156     1. BUILD_CC= to gcc able to compile for build. This is used, for
 157        example, to compile build-gentrigtables which is then run to
 158        generate sin and cos tables.
 159     2. BUILD_CFLAGS= for C options for build.
 160     3. BUILD_CPPFLAGS= for C preprocessor options for build.
 161     4. BUILD_FREETYPE= for freetype-config for build (optional).
 162
 163   - For host
 164     1. --host= to autoconf name of host.
 165     2. CC= for gcc able to compile for host
 166     3. CFLAGS= for C options for host.
 167     4. CPPFLAGS= for C preprocessor options for host.
 168     5. LDFLAGS= for linker options for host.
 169     6. FREETYPE= for freetype-config for host (optional).
 170     7. Libdevmapper if any must be in standard linker folders (-ldevmapper) (optional).
 171     8. Libfuse if any must be in standard linker folders (-lfuse) (optional).
 172     9. Libzfs if any must be in standard linker folders (-lzfs) (optional).
 173     10. Liblzma if any must be in standard linker folders (-llzma) (optional).
 174
 175   - For target
 176     1. --target= to autoconf cpu name of target.
 177     2. --with-platform to choose firmware.
 178     3. TARGET_CC= for gcc able to compile for target
 179     4. TARGET_CFLAGS= for C options for target.
 180     5. TARGET_CPPFLAGS= for C preprocessor options for target.
 181     6. TARGET_CCASFLAGS= for assembler options for target.
 182     7. TARGET_LDFLAGS= for linker options for target.
 183     8. TARGET_OBJCOPY= for objcopy for target.
 184     9. TARGET_STRIP= for strip for target.
 185     10. TARGET_NM= for nm for target.
 186     11. TARGET_RANLIB= for ranlib for target.
 187
 188   - Additionally for emu, for host and target.
 189     1. SDL is looked for in stadard linker directories (-lSDL) (optional)
 190     2. libpciaccess is looked for in stadard linker directories (-lpciaccess) (optional)
 191     3. libusb is looked for in stadard linker directories (-lusb) (optional)
 192
 193   - Platform-agnostic tools and data.
 194     1. make is the tool you execute after ./configure.
 195     2. Bison is specified in YACC= variable
 196     3. Flex is specified in LEX= variable
 197     4. GNU unifont and Djvu sans are looked for in standard directories.
 198
 199 Compiling For Multiple Architectures
 200 ====================================
 201
 202 You can compile the package for more than one kind of computer at the
 203 same time, by placing the object files for each architecture in their
 204 own directory.  `cd' to the directory where you want the object files
 205 and executables to go and run the `configure' script.  `configure'
 206 automatically checks for the source code in the directory that
 207 `configure' is in and in `..'.
 208
 209
 210 Installation Names
 211 ==================
 212
 213 By default, `make install' will install the package's files in
 214 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
 215 installation prefix by giving `configure' the option `--prefix=PATH'.
 216
 217 You can specify separate installation prefixes for
 218 architecture-specific files and architecture-independent files.  If
 219 you give `configure' the option `--exec-prefix=PATH', the package will
 220 use PATH as the prefix for installing programs and libraries.
 221 Documentation and other data files will still use the regular prefix.
 222
 223 In addition, if you use an unusual directory layout you can give
 224 options like `--bindir=PATH' to specify different values for
 225 particular kinds of files.  Run `configure --help' for a list of the
 226 directories you can set and what kinds of files go in them.
 227
 228 If the package supports it, you can cause programs to be installed
 229 with an extra prefix or suffix on their names by giving `configure'
 230 the option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 231
 232 Please note, however, that the GRUB knows where it is located in the
 233 filesystem.  If you have installed it in an unusual location, the
 234 system might not work properly, or at all.  The chief utility of these
 235 options for the GRUB is to allow you to "install" in some alternate
 236 location, and then copy these to the actual root filesystem later.
 237
 238
 239 Sharing Defaults
 240 ================
 241
 242 If you want to set default values for `configure' scripts to share,
 243 you can create a site shell script called `config.site' that gives
 244 default values for variables like `CC', `cache_file', and `prefix'.
 245 `configure' looks for `PREFIX/share/config.site' if it exists, then
 246 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 247 `CONFIG_SITE' environment variable to the location of the site script.
 248 A warning: not all `configure' scripts look for a site script.
 249
 250
 251 Operation Controls
 252 ==================
 253
 254    `configure' recognizes the following options to control how it
 255 operates.
 256
 257 `--cache-file=FILE'
 258      Use and save the results of the tests in FILE instead of
 259      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 260      debugging `configure'.
 261
 262 `--help'
 263      Print a summary of the options to `configure', and exit.
 264
 265 `--quiet'
 266 `--silent'
 267 `-q'
 268      Do not print messages saying which checks are being made.
 269
 270 `--srcdir=DIR'
 271      Look for the package's source code in directory DIR.  Usually
 272      `configure' can determine that directory automatically.
 273
 274 `--version'
 275      Print the version of Autoconf used to generate the `configure'
 276      script, and exit.