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