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