diff options
Diffstat (limited to 'docs/CUSTOMIZE')
| -rw-r--r-- | docs/CUSTOMIZE | 61 |
1 files changed, 33 insertions, 28 deletions
diff --git a/docs/CUSTOMIZE b/docs/CUSTOMIZE index e2beb6891..e1b3c065e 100644 --- a/docs/CUSTOMIZE +++ b/docs/CUSTOMIZE @@ -1,5 +1,5 @@ -How to customize the compilation of the library: -================================================ +How to customize the compilation of the library +=============================================== FreeType is highly customizable to fit various needs, and this document describes how it is possible to select options and components @@ -8,7 +8,7 @@ How to customize the compilation of the library: I. Configuration macros - The file found in "include/freetype/config/ftoption.h" contains a list + The file found in `include/freetype/config/ftoption.h' contains a list of commented configuration macros that can be toggled by developers to indicate which features should be active while building the library. @@ -22,23 +22,28 @@ I. Configuration macros II. Modules list - The file found in "include/freetype/config/ftmodule.h" contains a list + The file found in `include/freetype/config/ftmodule.h' contains a list of names corresponding to the modules and font drivers to be statically compiled in the FreeType library during the build. You can change it to suit your own preferences. Be aware that certain - modules depend on others, as described by the file "modules.txt" in + modules depend on others, as described by the file `modules.txt' in this directory. You can modify the file's content to suit your needs, or override it at compile time with one of the methods described below. + Note that you also have to rename the various `*.mk' files in the + module directories which you want to exclude so that the extension + isn't `.mk' -- GNU make uses a simple globbing mechanism to include + all those files. + III. System interface FreeType's default interface to the system (i.e., the parts that deal with memory management and i/o streams) is located in - "src/base/ftsystem.c". + `src/base/ftsystem.c'. The current implementation uses standard C library calls to manage memory and to read font files. It is however possible to write custom @@ -74,32 +79,32 @@ IV. Overriding default configuration and module headers Use the C include path to ensure that your own versions of the files are used at compile time when the lines - #include FT_CONFIG_OPTIONS_H - #include FT_CONFIG_MODULES_H + #include FT_CONFIG_OPTIONS_H + #include FT_CONFIG_MODULES_H are compiled. Their default values being <freetype/config/ftoption.h> and <freetype/config/ftmodule.h>, you can do something like: - custom/ - freetype/ - config/ - ftoption.h => custom options header - ftmodule.h => custom modules list + custom/ + freetype/ + config/ + ftoption.h => custom options header + ftmodule.h => custom modules list - include/ => normal FreeType 2 include - freetype/ - ... + include/ => normal FreeType 2 include + freetype/ + ... - then change the C include path to always give the path to "custom" - before the FreeType 2 "include". + then change the C include path to always give the path to `custom' + before the FreeType 2 `include'. - 2. Re-defining FT_CONFIG_OPTIONS_H and FT_CONFIG_MODULES_H + 2. Redefining FT_CONFIG_OPTIONS_H and FT_CONFIG_MODULES_H Another way to do the same thing is to redefine the macros used to name the configuration headers. To do so, you need a custom - "ft2build.h" whose content can be as simple as: + `ft2build.h' whose content can be as simple as: #ifndef __FT2_BUILD_MY_PLATFORM_H__ #define __FT2_BUILD_MY_PLATFORM_H__ @@ -111,25 +116,25 @@ IV. Overriding default configuration and module headers #endif /* __FT2_BUILD_MY_PLATFORM_H__ */ - Place those files in a separate directory, e.g.: + Place those files in a separate directory, e.g., custom/ ft2build.h => custom version described above my-ftoption.h => custom options header my-ftmodule.h => custom modules list header - and change the C include path to ensure that "custom" is always - placed before the FT2 "include" during compilation. + and change the C include path to ensure that `custom' is always + placed before the FT2 `include' during compilation. ------------------------------------------------------------------------ -Copyright 2003 by +Copyright 2003, 2005 by David Turner, Robert Wilhelm, and Werner Lemberg. -This file is part of the FreeType project, and may only be used, -modified, and distributed under the terms of the FreeType project -license, LICENSE.TXT. By continuing to use, modify, or distribute this -file you indicate that you have read the license and understand and +This file is part of the FreeType project, and may only be used, +modified, and distributed under the terms of the FreeType project +license, LICENSE.TXT. By continuing to use, modify, or distribute this +file you indicate that you have read the license and understand and accept it fully. |