Upstream version 11.39.266.0
[platform/framework/web/crosswalk.git] / src / third_party / freetype2 / src / docs / UPGRADE.UNIX
1
2 SPECIAL NOTE FOR UNIX USERS
3 ===========================
4
5   If  you are  installing  this release  of  FreeType on  a system  that
6   already uses  release 2.0.5  (or even an  older version), you  have to
7   perform a few special steps to ensure that everything goes well.
8
9
10   1. Enable the TrueType bytecode hinter if you need it
11   -----------------------------------------------------
12
13     See the instructions in the file `TRUETYPE' of this directory.
14
15     Note  that FreeType  supports  TrueType fonts  without the  bytecode
16     interpreter through its  auto-hinter, which now generates relatively
17     good results with most fonts.
18
19
20   2. Determine the correct installation path
21   ------------------------------------------
22
23     By   default,  the   configure  script   installs  the   library  in
24     `/usr/local'.   However,  many Unix  distributions  now install  the
25     library  in `/usr',  since FreeType  is becoming  a  critical system
26     component.
27
28     If FreeType is already installed on your system, type
29
30       freetype-config --prefix
31
32     on  the command  line.   This should  return  the installation  path
33     (e.g.,  `/usr'  or `/usr/local').   To  avoid  problems of  parallel
34     FreeType  versions, use  this path  for the  --prefix option  of the
35     configure script.
36
37     Otherwise, simply use `/usr' (or  whatever you think is adequate for
38     your installation).
39
40
41   3. Ensure that you are using GNU Make
42   -------------------------------------
43
44     The FreeType build  system _exclusively_ works with GNU  Make (as an
45     exception you  can use make++ which emulates  GNU Make sufficiently;
46     see http://makepp.sourceforge.net).  You will not be able to compile
47     the library with the  instructions below using any other alternative
48     (including BSD Make).
49
50     Trying to  compile the library with  a different Make  tool prints a
51     message like:
52
53       Sorry, GNU make is required to build FreeType2.
54
55     and the build process is aborted.  If this happens, install GNU Make
56     on your system, and use the GNUMAKE environment variable to name it.
57
58
59   4. Build and install the library
60   --------------------------------
61
62     The  following should  work on  all  Unix systems  where the  `make'
63     command invokes GNU Make:
64
65       ./configure --prefix=<yourprefix>
66       make
67       make install           (as root)
68
69     where `<yourprefix>' must be replaced  by the prefix returned by the
70     `freetype-config' command.
71
72     When using a  different command to invoke GNU  Make, use the GNUMAKE
73     variable.  For  example, if  `gmake' is the  command to use  on your
74     system, do something like:
75
76       GNUMAKE=gmake ./configure --prefix=<yourprefix>
77       gmake
78       gmake install            (as root)
79
80
81   5. Take care of XFree86 version 4
82   ---------------------------------
83
84     Certain Linux  distributions install _several_  versions of FreeType
85     on your  system.  For example, on  a fresh Mandrake  8.1 system, you
86     can find the following files:
87
88       /usr/lib/libfreetype.so             which links to
89       /usr/lib/libfreetype.6.1.0.so
90
91     and
92
93       /usr/X11R6/lib/libfreetype.so       which links to
94       /usr/X11R6/lib/libfreetype.6.0.so
95
96     Note that  these files  correspond to two  distinct versions  of the
97     library!  It seems that this  surprising issue is due to the install
98     scripts of  recent XFree86 servers (from 4.1.0)  which install their
99     own (dated) version of the library in `/usr/X11R6/lib'.
100
101     In certain  _rare_ cases  you may experience  minor problems  if you
102     install this  release of  the library in  `/usr' only,  namely, that
103     certain applications do not benefit from the bug fixes and rendering
104     improvements you would expect.
105
106     There are two good ways to deal with this situation:
107
108       - Install the library _twice_,  in `/usr' and in `/usr/X11R6' (you
109         have to  do that  each time you  install a new  FreeType release
110         though).
111
112       - Change the link in /usr/X11R6/lib/libfreetype.so to point to
113
114           /usr/lib/libfreetype.so,
115
116         and get rid of
117
118           /usr/X11R6/lib/libfreetype.6.0.so
119
120     The FreeType  Team is  not responsible for  this problem,  so please
121     contact  either   the  XFree86   development  team  or   your  Linux
122     distributor to help  clear this issue in case  the information given
123     here doesn't help.
124
125 ------------------------------------------------------------------------
126
127 Copyright 2003, 2005 by
128 David Turner, Robert Wilhelm, and Werner Lemberg.
129
130 This  file is  part  of the  FreeType  project, and  may  only be  used,
131 modified,  and  distributed under  the  terms  of  the FreeType  project
132 license, LICENSE.TXT.  By continuing  to use, modify, or distribute this
133 file  you indicate that  you have  read the  license and  understand and
134 accept it fully.
135
136
137 ---- end of UPGRADE.UNIX ---