[2a75b9b] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!-- the master source at palaso.org looks easy in a browser, but in fact
|
---|
| 8 | everything is in numbered attachment directories, one per file, so that will
|
---|
[73006114] | 9 | probably be even worse than sf.net for finding if there is a new version -->
|
---|
[2a75b9b] | 10 | <!ENTITY graphite2-download-http
|
---|
| 11 | "&sourceforge-repo;/silgraphite/graphite2-&graphite2-version;.tgz">
|
---|
| 12 | <!ENTITY graphite2-download-ftp " ">
|
---|
[7841f70] | 13 | <!ENTITY graphite2-md5sum "5b8d22a8bbf031838e31432868c0109c">
|
---|
| 14 | <!ENTITY graphite2-size "3.8 MB">
|
---|
| 15 | <!ENTITY graphite2-buildsize "27 MB (with docs and tests)">
|
---|
[8763a1da] | 16 | <!ENTITY graphite2-time "0.3 SBU (with docs and tests)">
|
---|
[2a75b9b] | 17 | ]>
|
---|
| 18 |
|
---|
| 19 | <sect1 id="graphite2" xreflabel="Graphite2-&graphite2-version;">
|
---|
| 20 | <?dbhtml filename="graphite2.html"?>
|
---|
| 21 |
|
---|
| 22 | <sect1info>
|
---|
| 23 | <othername>$LastChangedBy$</othername>
|
---|
| 24 | <date>$Date$</date>
|
---|
| 25 | </sect1info>
|
---|
| 26 |
|
---|
| 27 | <title>Graphite2-&graphite2-version;</title>
|
---|
| 28 |
|
---|
| 29 | <indexterm zone="graphite2">
|
---|
| 30 | <primary sortas="a-Graphite2">Graphite2</primary>
|
---|
| 31 | </indexterm>
|
---|
| 32 |
|
---|
| 33 | <sect2 role="package">
|
---|
| 34 | <title>Introduction to Graphite2</title>
|
---|
| 35 |
|
---|
| 36 | <para>
|
---|
| 37 | <application>Graphite2</application> is a rendering engine for graphite
|
---|
| 38 | fonts. These are TrueType fonts with additional tables containing smart
|
---|
| 39 | rendering information and were originally developed to support complex
|
---|
| 40 | non-Roman writing systems. They may contain rules for e.g. ligatures,
|
---|
| 41 | glyph substitution, kerning, justification - this can make them useful
|
---|
| 42 | even on text written in Roman writing systems such as English. Note that
|
---|
| 43 | <application>firefox</application> provides an internal copy of the
|
---|
| 44 | graphite engine and cannot use a system version, but it too should benefit
|
---|
| 45 | from the availability of graphite fonts.
|
---|
| 46 | </para>
|
---|
| 47 |
|
---|
[f3429309] | 48 | &lfs78_checked;
|
---|
[2a75b9b] | 49 |
|
---|
| 50 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 51 | <itemizedlist spacing="compact">
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download (HTTP): <ulink url="&graphite2-download-http;"/>
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Download (FTP): <ulink url="&graphite2-download-ftp;"/>
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Download MD5 sum: &graphite2-md5sum;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
| 68 | <para>
|
---|
| 69 | Download size: &graphite2-size;
|
---|
| 70 | </para>
|
---|
| 71 | </listitem>
|
---|
| 72 | <listitem>
|
---|
| 73 | <para>
|
---|
| 74 | Estimated disk space required: &graphite2-buildsize;
|
---|
| 75 | </para>
|
---|
| 76 | </listitem>
|
---|
| 77 | <listitem>
|
---|
| 78 | <para>
|
---|
| 79 | Estimated build time: &graphite2-time;
|
---|
| 80 | </para>
|
---|
| 81 | </listitem>
|
---|
| 82 | </itemizedlist>
|
---|
| 83 |
|
---|
| 84 | <bridgehead renderas="sect3">Graphite2 Dependencies</bridgehead>
|
---|
| 85 |
|
---|
| 86 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 87 | <para role="required">
|
---|
[affbf28] | 88 | <xref linkend="cmake"/>
|
---|
[2a75b9b] | 89 | </para>
|
---|
| 90 |
|
---|
| 91 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 92 | <para role="optional">
|
---|
[affbf28] | 93 | <xref linkend="freetype2"/>,
|
---|
| 94 | <xref linkend="python2"/>, and
|
---|
[2a75b9b] | 95 | <ulink url="http://sourceforge.net/projects/silgraphite/files/silgraphite/2.3.1/">silgraphite</ulink>
|
---|
| 96 | to build the <command>comparerender</command> test and benchmarking tool,
|
---|
| 97 | and if that is present,
|
---|
| 98 | <xref linkend="harfbuzz"/> to add more functionality to it (this is a
|
---|
| 99 | circular dependency, you would need to first build
|
---|
| 100 | <application>graphite2</application> without
|
---|
| 101 | <application>harfbuzz</application>).
|
---|
| 102 | </para>
|
---|
[8763a1da] | 103 |
|
---|
| 104 | <para>To build the documentation:
|
---|
[2a75b9b] | 105 | <ulink url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink>,
|
---|
[2dcd27e] | 106 | <xref linkend="doxygen"/>,
|
---|
| 107 | <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>), and
|
---|
| 108 | <ulink url="http://dblatex.sourceforge.net/">
|
---|
| 109 | dblatex</ulink> (for PDF docs)
|
---|
[2a75b9b] | 110 | </para>
|
---|
| 111 |
|
---|
[8763a1da] | 112 | <para>To execute the test suite you will need
|
---|
| 113 | <ulink url="https://pypi.python.org/pypi/FontTools">FontTools</ulink>
|
---|
[7841f70] | 114 | (Python 2 module), otherwise, the "cmp" tests fail.
|
---|
[8763a1da] | 115 | </para>
|
---|
| 116 |
|
---|
[2a75b9b] | 117 | <bridgehead renderas="sect4">Optional (at runtime)</bridgehead>
|
---|
| 118 | <para role="optional">
|
---|
| 119 | You will need at least one suitable <ulink
|
---|
| 120 | url="http://scripts.sil.org/cms/scripts/page.php?site_id=projects&item_id=graphite_fonts">graphite font</ulink>
|
---|
| 121 | for the package to be useful.
|
---|
| 122 | </para>
|
---|
| 123 |
|
---|
| 124 | <para condition="html" role="usernotes">
|
---|
| 125 | User Notes: <ulink url="&blfs-wiki;/graphite2"/>
|
---|
| 126 | </para>
|
---|
| 127 | </sect2>
|
---|
| 128 |
|
---|
| 129 | <sect2 role="installation">
|
---|
| 130 | <title>Installation of Graphite2</title>
|
---|
| 131 |
|
---|
| 132 | <para>
|
---|
| 133 | Install <application>Graphite2</application> by running the following
|
---|
| 134 | commands:
|
---|
| 135 | </para>
|
---|
| 136 |
|
---|
| 137 | <screen><userinput>mkdir build &&
|
---|
[059a1a5c] | 138 | cd build &&
|
---|
| 139 |
|
---|
[8763a1da] | 140 | cmake -G "Unix Makefiles" \
|
---|
| 141 | -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
[7841f70] | 142 | .. &&
|
---|
[a0e6e8dd] | 143 |
|
---|
[2a75b9b] | 144 | make</userinput></screen>
|
---|
| 145 |
|
---|
| 146 | <para>
|
---|
[8763a1da] | 147 | If you wish to build the documentation, issue:
|
---|
| 148 | </para>
|
---|
| 149 |
|
---|
| 150 | <screen><userinput>make docs</userinput></screen>
|
---|
| 151 |
|
---|
| 152 | <para>
|
---|
[7841f70] | 153 | Some tests fail if
|
---|
| 154 | <ulink url="https://pypi.python.org/pypi/FontTools">FontTools</ulink>
|
---|
| 155 | (Python 2 module) is not installed. These tests can be removed with:
|
---|
| 156 | </para>
|
---|
| 157 |
|
---|
| 158 | <screen><userinput>sed -i '/cmptest/d' tests/CMakeLists.txt</userinput></screen>
|
---|
| 159 |
|
---|
| 160 | <para>
|
---|
| 161 | To test the results, issue: <command>make test</command>.
|
---|
[2a75b9b] | 162 | </para>
|
---|
| 163 |
|
---|
| 164 | <para>
|
---|
| 165 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 166 | </para>
|
---|
| 167 |
|
---|
| 168 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[8763a1da] | 169 |
|
---|
| 170 | <para>
|
---|
| 171 | If you built the documentation, install, as the
|
---|
| 172 | <systemitem class="username">root</systemitem> user:
|
---|
| 173 | </para>
|
---|
| 174 |
|
---|
| 175 | <screen role="root"><userinput>install -v -d -m755 /usr/share/doc/graphite2-&graphite2-version;/api &&
|
---|
| 176 | cp -v -r -f doc/doxygen/{html,latex/refman.pdf} \
|
---|
| 177 | /usr/share/doc/graphite2-&graphite2-version;/api &&
|
---|
| 178 | cp -v -r -f doc/{GTF,manual}.html \
|
---|
| 179 | /usr/share/doc/graphite2-&graphite2-version;</userinput></screen>
|
---|
| 180 |
|
---|
| 181 | </sect2>
|
---|
| 182 |
|
---|
| 183 | <sect2 role="commands">
|
---|
| 184 | <title>Command Explanations</title>
|
---|
| 185 |
|
---|
| 186 | <para><option>-DCMAKE_VERBOSE_MAKEFILE=ON</option>: This switch turns on
|
---|
| 187 | build verbose mode.</para>
|
---|
| 188 |
|
---|
[2a75b9b] | 189 | </sect2>
|
---|
| 190 |
|
---|
| 191 | <sect2 role="content">
|
---|
| 192 | <title>Contents</title>
|
---|
| 193 |
|
---|
| 194 | <segmentedlist>
|
---|
| 195 | <segtitle>Installed Programs</segtitle>
|
---|
| 196 | <segtitle>Installed Libraries</segtitle>
|
---|
| 197 | <segtitle>Installed Directories</segtitle>
|
---|
| 198 |
|
---|
| 199 | <seglistitem>
|
---|
| 200 | <seg>
|
---|
| 201 | gr2fonttest, and optionally comparerender
|
---|
| 202 | </seg>
|
---|
| 203 | <seg>
|
---|
| 204 | libgraphite2.so
|
---|
| 205 | </seg>
|
---|
| 206 | <seg>
|
---|
[16e895e] | 207 | /usr/{include,share}/graphite2 and optionally
|
---|
[8763a1da] | 208 | /usr/share/doc/graphite2-&graphite2-version;
|
---|
[2a75b9b] | 209 | </seg>
|
---|
| 210 | </seglistitem>
|
---|
| 211 | </segmentedlist>
|
---|
| 212 |
|
---|
| 213 | <variablelist>
|
---|
| 214 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 215 | <?dbfo list-presentation="list"?>
|
---|
| 216 | <?dbhtml list-presentation="table"?>
|
---|
| 217 |
|
---|
| 218 | <varlistentry id="comparerender">
|
---|
| 219 | <term><command>comparerender</command></term>
|
---|
| 220 | <listitem>
|
---|
| 221 | <para>
|
---|
| 222 | is a test and benchmarking tool.
|
---|
| 223 | </para>
|
---|
| 224 | <indexterm zone="graphite2 comparerender">
|
---|
| 225 | <primary sortas="b-comparerender">comparerender</primary>
|
---|
| 226 | </indexterm>
|
---|
| 227 | </listitem>
|
---|
| 228 | </varlistentry>
|
---|
| 229 |
|
---|
| 230 | <varlistentry id="gr2fonttest">
|
---|
| 231 | <term><command>gr2fonttest</command></term>
|
---|
| 232 | <listitem>
|
---|
| 233 | <para>
|
---|
| 234 | is a diagnostic console tool for graphite fonts.
|
---|
| 235 | </para>
|
---|
| 236 | <indexterm zone="graphite2 gr2fonttest">
|
---|
| 237 | <primary sortas="b-gr2fonttest">gr2fonttest</primary>
|
---|
| 238 | </indexterm>
|
---|
| 239 | </listitem>
|
---|
| 240 | </varlistentry>
|
---|
| 241 |
|
---|
| 242 | <varlistentry id="libgraphite2">
|
---|
| 243 | <term><filename class="libraryfile">libgraphite2.so</filename></term>
|
---|
| 244 | <listitem>
|
---|
| 245 | <para>
|
---|
| 246 | is a rendering engine for graphite fonts.
|
---|
| 247 | </para>
|
---|
| 248 | <indexterm zone="graphite2 libgraphite2">
|
---|
| 249 | <primary sortas="c-libgraphite2">libgraphite2.so</primary>
|
---|
| 250 | </indexterm>
|
---|
| 251 | </listitem>
|
---|
| 252 | </varlistentry>
|
---|
| 253 |
|
---|
| 254 | </variablelist>
|
---|
| 255 |
|
---|
| 256 | </sect2>
|
---|
| 257 |
|
---|
| 258 | </sect1>
|
---|