blob: 48c746d703c21bea7e76a309951f1d59c1673983 [file] [log] [blame]
David Turner66cbc202003-03-20 07:04:40 +00001
2SPECIAL NOTE FOR UNIX USERS
3===========================
4
Werner Lemberga16c4a72003-04-21 13:30:27 +00005 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
David Turner66cbc202003-03-20 07:04:40 +00007 perform a few special steps to ensure that everything goes well.
8
9
Werner Lemberga16c4a72003-04-21 13:30:27 +000010 1. Enable the TrueType bytecode hinter if you need it
David Turner66cbc202003-03-20 07:04:40 +000011 -----------------------------------------------------
12
Werner Lemberga7235262005-08-30 00:22:46 +000013 See the instructions in the file `TRUETYPE' of this directory.
Werner Lemberg9b774e22007-01-16 06:11:27 +000014
Werner Lemberga16c4a72003-04-21 13:30:27 +000015 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.
David Turner66cbc202003-03-20 07:04:40 +000018
19
Werner Lemberga16c4a72003-04-21 13:30:27 +000020 2. Determine the correct installation path
21 ------------------------------------------
David Turner66cbc202003-03-20 07:04:40 +000022
Werner Lemberga7235262005-08-30 00:22:46 +000023 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
David Turner66cbc202003-03-20 07:04:40 +000026 component.
27
28 If FreeType is already installed on your system, type
29
30 freetype-config --prefix
31
Werner Lemberga16c4a72003-04-21 13:30:27 +000032 on the command line. This should return the installation path
Werner Lemberga7235262005-08-30 00:22:46 +000033 (e.g., `/usr' or `/usr/local'). To avoid problems of parallel
Werner Lemberga16c4a72003-04-21 13:30:27 +000034 FreeType versions, use this path for the --prefix option of the
35 configure script.
36
Werner Lemberga7235262005-08-30 00:22:46 +000037 Otherwise, simply use `/usr' (or whatever you think is adequate for
Werner Lemberga16c4a72003-04-21 13:30:27 +000038 your installation).
David Turner66cbc202003-03-20 07:04:40 +000039
40
Werner Lemberga16c4a72003-04-21 13:30:27 +000041 3. Ensure that you are using GNU Make
42 -------------------------------------
David Turner66cbc202003-03-20 07:04:40 +000043
Werner Lemberga16c4a72003-04-21 13:30:27 +000044 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).
David Turner66cbc202003-03-20 07:04:40 +000049
Werner Lemberga7235262005-08-30 00:22:46 +000050 Trying to compile the library with a different Make tool prints a
51 message like:
David Turner66cbc202003-03-20 07:04:40 +000052
53 Sorry, GNU make is required to build FreeType2.
54
Werner Lemberga7235262005-08-30 00:22:46 +000055 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.
David Turner66cbc202003-03-20 07:04:40 +000057
58
Werner Lemberga16c4a72003-04-21 13:30:27 +000059 4. Build and install the library
60 --------------------------------
David Turner66cbc202003-03-20 07:04:40 +000061
Werner Lemberga16c4a72003-04-21 13:30:27 +000062 The following should work on all Unix systems where the `make'
David Turner66cbc202003-03-20 07:04:40 +000063 command invokes GNU Make:
64
65 ./configure --prefix=<yourprefix>
66 make
67 make install (as root)
68
Werner Lemberga7235262005-08-30 00:22:46 +000069 where `<yourprefix>' must be replaced by the prefix returned by the
70 `freetype-config' command.
David Turner66cbc202003-03-20 07:04:40 +000071
Werner Lemberga16c4a72003-04-21 13:30:27 +000072 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
David Turner66cbc202003-03-20 07:04:40 +000074 system, do something like:
75
Werner Lemberga7235262005-08-30 00:22:46 +000076 GNUMAKE=gmake ./configure --prefix=<yourprefix>
77 gmake
78 gmake install (as root)
David Turner66cbc202003-03-20 07:04:40 +000079
David Turner66cbc202003-03-20 07:04:40 +000080
Werner Lemberga16c4a72003-04-21 13:30:27 +000081 5. Take care of XFree86 version 4
David Turner66cbc202003-03-20 07:04:40 +000082 ---------------------------------
83
Werner Lemberga7235262005-08-30 00:22:46 +000084 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:
David Turner66cbc202003-03-20 07:04:40 +000087
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
Werner Lemberga16c4a72003-04-21 13:30:27 +000096 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
Werner Lemberga7235262005-08-30 00:22:46 +000099 own (dated) version of the library in `/usr/X11R6/lib'.
David Turner66cbc202003-03-20 07:04:40 +0000100
Werner Lemberga16c4a72003-04-21 13:30:27 +0000101 In certain _rare_ cases you may experience minor problems if you
Werner Lemberga7235262005-08-30 00:22:46 +0000102 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.
David Turner66cbc202003-03-20 07:04:40 +0000105
106 There are two good ways to deal with this situation:
107
Werner Lemberga7235262005-08-30 00:22:46 +0000108 - Install the library _twice_, in `/usr' and in `/usr/X11R6' (you
Werner Lemberga16c4a72003-04-21 13:30:27 +0000109 have to do that each time you install a new FreeType release
110 though).
David Turner66cbc202003-03-20 07:04:40 +0000111
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
Werner Lemberga16c4a72003-04-21 13:30:27 +0000120 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
David Turner66cbc202003-03-20 07:04:40 +0000123 here doesn't help.
Werner Lemberga16c4a72003-04-21 13:30:27 +0000124
Werner Lemberg56c368c2005-06-04 23:00:25 +0000125------------------------------------------------------------------------
126
Werner Lemberga7235262005-08-30 00:22:46 +0000127Copyright 2003, 2005 by
Werner Lemberg56c368c2005-06-04 23:00:25 +0000128David Turner, Robert Wilhelm, and Werner Lemberg.
129
Werner Lemberga7235262005-08-30 00:22:46 +0000130This file is part of the FreeType project, and may only be used,
131modified, and distributed under the terms of the FreeType project
132license, LICENSE.TXT. By continuing to use, modify, or distribute this
133file you indicate that you have read the license and understand and
Werner Lemberg56c368c2005-06-04 23:00:25 +0000134accept it fully.
135
Werner Lemberga16c4a72003-04-21 13:30:27 +0000136
Werner Lemberg82a07e92006-10-12 06:20:44 +0000137---- end of UPGRADE.UNIX ---