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