docs/INSTALL.UNIX

   1 This  document contains  instructions  on how  to  build the  FreeType
   2 library on Unix  systems.  This also works for  emulations like Cygwin
   3 or MSys on Win32:
   4
   5
   6   1. Ensure that you are using GNU Make
   7   -------------------------------------
   8
   9     The FreeType build system  _exclusively_ works with GNU Make.  You
  10     will  not be  able to  compile the  library with  the instructions
  11     below using any other alternative (including BSD Make).
  12
  13     Check that you have GNU make by running the command:
  14
  15        make -v
  16
  17     This should dump some text that begins with:
  18
  19        GNU Make  <version number>
  20        Copyright (C) <year> Free Software Foundation Inc.
  21
  22     Note that version  3.80 or higher is *required* or the  build will
  23     fail.
  24
  25     It is also fine to have GNU Make under another name (e.g. 'gmake')
  26     if you use the MAKE variable as described below.
  27
  28     As  a  special exception,  'makepp'  can  also  be used  to  build
  29     FreeType 2.  See the file docs/MAKEPP for details.
  30
  31
  32   2. Regenerate the configure script if needed
  33   --------------------------------------------
  34
  35     This only applies if you  are building a git snapshot or checkout,
  36     *not* if you grabbed the sources of an official release.
  37
  38     You  need  to invoke  the  `autogen.sh'  script  in the  top-level
  39     directory  in order  to  create the  `configure'  script for  your
  40     platform.  Normally, this simply means typing:
  41
  42       sh autogen.sh
  43
  44     In case of problems, you  may need to install or upgrade Automake,
  45     Autoconf or  Libtool.  See  README.git in the  top-level directory
  46     for more information.
  47
  48
  49   3. Build and install the library
  50   --------------------------------
  51
  52     The following  should work  on all Unix  systems where  the `make'
  53     command invokes GNU Make:
  54
  55       ./configure [options]
  56       make
  57       make install           (as root)
  58
  59     The default installation path  is `/usr/local'.  It can be changed
  60     with the `--prefix=<path>' option.  Example:
  61
  62       ./configure --prefix=/usr
  63
  64     When using  a different command  to invoke GNU Make,  use the MAKE
  65     variable.  For example,  if `gmake' is the command  to use on your
  66     system, do something like:
  67
  68        MAKE=gmake ./configure [options]
  69        gmake
  70        gmake install            (as root)
  71
  72     If  this still doesn't  work, there  must be  a problem  with your
  73     system (e.g., you are using a very old version of GNU Make).
  74
  75     It  is possible  to  compile FreeType  in  a different  directory.
  76     Assuming the FreeType source  files in directory `/src/freetype' a
  77     compilation in directory `foo' works as follows:
  78
  79       cd foo
  80       /src/freetype/configure [options]
  81       make
  82       make install
  83
  84
  85   3.1 Interdependency with HarfBuzz
  86   .................................
  87
  88     Note that there  is a chicken-and-egg problem  currently since the
  89     HarfBuzz library  (used by the  auto-hinter to improve  support of
  90     OpenType  fonts)  depends on  FreeType,  which  can be  solved  as
  91     follows in case HarfBuzz is not yet installed on your system.
  92
  93     1. Call    FreeType's     `configure'    script     with    option
  94        `--without-harfbuzz', then compile and install FreeType.
  95
  96     2. Compile and install HarfBuzz.
  97
  98     3. Call    FreeType's    `configure'   script    without    option
  99        `--without-harfbuzz' (after  executing `make  distclean'), then
 100        compile and install FreeType again.
 101
 102
 103 ----------------------------------------------------------------------
 104
 105 Copyright 2003-2007, 2013, 2014 by
 106 David Turner, Robert Wilhelm, and Werner Lemberg.
 107
 108 This  file is  part of  the FreeType  project, and  may only  be used,
 109 modified,  and distributed  under the  terms of  the  FreeType project
 110 license,  LICENSE.TXT.  By  continuing to  use, modify,  or distribute
 111 this file you  indicate that you have read  the license and understand
 112 and accept it fully.
 113
 114
 115 --- end of INSTALL.UNIX ---