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