1<?xml version="1.0"?> 2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 3 "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ 4 <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> 5 <!ENTITY version SYSTEM "version.xml"> 6]> 7<book id="index"> 8 <bookinfo> 9 <title>HarfBuzz Manual</title> 10 <abstract> 11 <title>HarfBuzz</title> 12 <graphic fileref="HarfBuzz.png" format="PNG" align="center"/> 13 <para> 14 HarfBuzz is an <ulink url="http://www.microsoft.com/typography/otspec/">OpenType</ulink> 15 text shaping engine. Using the HarfBuzz library allows 16 programs to convert a sequence of Unicode input into 17 properly formatted and positioned glyph output—for any writing 18 system and language. 19 </para> 20 21 <para> 22 The canonical source-code tree is available at 23 <ulink url="https://github.com/harfbuzz/harfbuzz">github.com/harfbuzz/harfbuzz</ulink>. 24 See <xref linkend="download" endterm="download.title"/> for 25 release tarballs. 26 </para> 27 </abstract> 28 </bookinfo> 29 30 <part> 31 <title>User's manual</title> 32 <xi:include href="usermanual-what-is-harfbuzz.xml"/> 33 <xi:include href="usermanual-install-harfbuzz.xml"/> 34 <xi:include href="usermanual-getting-started.xml"/> 35 <xi:include href="usermanual-shaping-concepts.xml"/> 36 <xi:include href="usermanual-object-model.xml"/> 37 <xi:include href="usermanual-buffers-language-script-and-direction.xml"/> 38 <xi:include href="usermanual-fonts-and-faces.xml"/> 39 <xi:include href="usermanual-opentype-features.xml"/> 40 <xi:include href="usermanual-clusters.xml"/> 41 <xi:include href="usermanual-utilities.xml"/> 42 </part> 43 44 <part> 45 <partinfo> 46 <releaseinfo> 47 This document is for HarfBuzz &version;. 48 <!--The latest version of this documentation can be found on-line at 49 <ulink role="online-location" url="http://[SERVER]/libharfbuzz/index.html">http://[SERVER]/libharfbuzz/</ulink>.--> 50 </releaseinfo> 51 </partinfo> 52 53 <note> 54 <para> 55 The current HarfBuzz codebase is versioned 2.x.x and is stable 56 and under active maintenance. This is what is used in latest 57 versions of Firefox, GNOME, ChromeOS, Chrome, LibreOffice, 58 XeTeX, Android, and KDE, among other places. 59 </para> 60 <para> 61 Prior to 2012, the original HarfBuzz codebase (which, these 62 days, is referred to as <emphasis>harfbuzz-old</emphasis>) was 63 derived from code in <ulink 64 url="http://freetype.org/">FreeType</ulink>, <ulink 65 url="http://pango.org/">Pango</ulink>, and 66 <ulink url="http://qt-project.org/">Qt</ulink>. 67 It is <emphasis>not</emphasis> actively developed or 68 maintained, and is extremely buggy. All users of harfbuzz-old 69 are encouraged to switch over to the new HarfBuzz as soon as possible. 70 </para> 71 <para> 72 To make this distinction clearer in discussions, the current 73 HarfBuzz codebase is sometimes referred to as 74 <emphasis>harfbuzz-ng</emphasis>. 75 </para> 76 <para> 77 For reference purposes, the harfbuzz-old source tree is archived 78 <ulink 79 url="http://cgit.freedesktop.org/harfbuzz.old/">here</ulink>. There 80 are no release tarballs of harfbuzz-old whatsoever. 81 </para> 82 </note> 83 84 <title>Reference manual</title> 85 <chapter> 86 <title>Core API</title> 87 <xi:include href="xml/hb-blob.xml"/> 88 <xi:include href="xml/hb-buffer.xml"/> 89 <xi:include href="xml/hb-common.xml"/> 90 <xi:include href="xml/hb-deprecated.xml"/> 91 <xi:include href="xml/hb-face.xml"/> 92 <xi:include href="xml/hb-font.xml"/> 93 <xi:include href="xml/hb-map.xml"/> 94 <xi:include href="xml/hb-set.xml"/> 95 <xi:include href="xml/hb-shape-plan.xml"/> 96 <xi:include href="xml/hb-shape.xml"/> 97 <xi:include href="xml/hb-unicode.xml"/> 98 <xi:include href="xml/hb-version.xml"/> 99 </chapter> 100 101 <chapter> 102 <title>OpenType API</title> 103 <xi:include href="xml/hb-ot-color.xml"/> 104 <xi:include href="xml/hb-ot-font.xml"/> 105 <xi:include href="xml/hb-ot-layout.xml"/> 106 <xi:include href="xml/hb-ot-math.xml"/> 107 <xi:include href="xml/hb-ot-name.xml"/> 108 <xi:include href="xml/hb-ot-shape.xml"/> 109 <xi:include href="xml/hb-ot-var.xml"/> 110 </chapter> 111 112 <chapter> 113 <title>Apple Advanced Typography API</title> 114 <xi:include href="xml/hb-aat-layout.xml"/> 115 </chapter> 116 117 <chapter> 118 <title>Integration API</title> 119 <xi:include href="xml/hb-coretext.xml"/> 120 <xi:include href="xml/hb-ft.xml"/> 121 <xi:include href="xml/hb-glib.xml"/> 122 <xi:include href="xml/hb-gobject.xml"/> 123 <xi:include href="xml/hb-graphite2.xml"/> 124 <xi:include href="xml/hb-icu.xml"/> 125 <xi:include href="xml/hb-uniscribe.xml"/> 126 </chapter> 127 128 <!--chapter id="object-tree"> 129 <title>Object Hierarchy</title> 130 <xi:include href="xml/tree_index.sgml"/> 131 </chapter--> 132 133 <index id="api-index-full"><title>API Index</title><xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include></index> 134 <index id="deprecated-api-index" role="deprecated"><title>Index of deprecated API</title><xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include></index> 135 136 <index id="api-index-2-6-0" role="2.6.0"><title>Index of new symbols in 2.6.0</title><xi:include href="xml/api-index-2.6.0.xml"><xi:fallback /></xi:include></index> 137 <index id="api-index-2-5-0" role="2.5.0"><title>Index of new symbols in 2.5.0</title><xi:include href="xml/api-index-2.5.0.xml"><xi:fallback /></xi:include></index> 138 <index id="api-index-2-4-0" role="2.4.0"><title>Index of new symbols in 2.4.0</title><xi:include href="xml/api-index-2.4.0.xml"><xi:fallback /></xi:include></index> 139 <index id="api-index-2-3-0" role="2.3.0"><title>Index of new symbols in 2.3.0</title><xi:include href="xml/api-index-2.3.0.xml"><xi:fallback /></xi:include></index> 140 <index id="api-index-2-2-0" role="2.2.0"><title>Index of new symbols in 2.2.0</title><xi:include href="xml/api-index-2.2.0.xml"><xi:fallback /></xi:include></index> 141 <index id="api-index-2-1-0" role="2.1.0"><title>Index of new symbols in 2.1.0</title><xi:include href="xml/api-index-2.1.0.xml"><xi:fallback /></xi:include></index> 142 <index id="api-index-2-0-0" role="2.0.0"><title>Index of new symbols in 2.0.0</title><xi:include href="xml/api-index-2.0.0.xml"><xi:fallback /></xi:include></index> 143 <index id="api-index-1-9-0" role="1.9.0"><title>Index of new symbols in 1.9.0</title><xi:include href="xml/api-index-1.9.0.xml"><xi:fallback /></xi:include></index> 144 <index id="api-index-1-8-6" role="1.8.6"><title>Index of new symbols in 1.8.6</title><xi:include href="xml/api-index-1.8.6.xml"><xi:fallback /></xi:include></index> 145 <index id="api-index-1-8-5" role="1.8.5"><title>Index of new symbols in 1.8.5</title><xi:include href="xml/api-index-1.8.5.xml"><xi:fallback /></xi:include></index> 146 <index id="api-index-1-8-1" role="1.8.1"><title>Index of new symbols in 1.8.1</title><xi:include href="xml/api-index-1.8.1.xml"><xi:fallback /></xi:include></index> 147 <index id="api-index-1-8-0" role="1.8.0"><title>Index of new symbols in 1.8.0</title><xi:include href="xml/api-index-1.8.0.xml"><xi:fallback /></xi:include></index> 148 <index id="api-index-1-7-7" role="1.7.7"><title>Index of new symbols in 1.7.7</title><xi:include href="xml/api-index-1.7.7.xml"><xi:fallback /></xi:include></index> 149 <index id="api-index-1-7-5" role="1.7.5"><title>Index of new symbols in 1.7.5</title><xi:include href="xml/api-index-1.7.5.xml"><xi:fallback /></xi:include></index> 150 <index id="api-index-1-6-0" role="1.6.0"><title>Index of new symbols in 1.6.0</title><xi:include href="xml/api-index-1.6.0.xml"><xi:fallback /></xi:include></index> 151 <index id="api-index-1-5-0" role="1.5.0"><title>Index of new symbols in 1.5.0</title><xi:include href="xml/api-index-1.5.0.xml"><xi:fallback /></xi:include></index> 152 <index id="api-index-1-4-3" role="1.4.3"><title>Index of new symbols in 1.4.3</title><xi:include href="xml/api-index-1.4.3.xml"><xi:fallback /></xi:include></index> 153 <index id="api-index-1-4-2" role="1.4.2"><title>Index of new symbols in 1.4.2</title><xi:include href="xml/api-index-1.4.2.xml"><xi:fallback /></xi:include></index> 154 <index id="api-index-1-3-3" role="1.3.3"><title>Index of new symbols in 1.3.3</title><xi:include href="xml/api-index-1.3.3.xml"><xi:fallback /></xi:include></index> 155 <index id="api-index-1-2-3" role="1.2.3"><title>Index of new symbols in 1.2.3</title><xi:include href="xml/api-index-1.2.3.xml"><xi:fallback /></xi:include></index> 156 <index id="api-index-1-1-3" role="1.1.3"><title>Index of new symbols in 1.1.3</title><xi:include href="xml/api-index-1.1.3.xml"><xi:fallback /></xi:include></index> 157 <index id="api-index-1-1-2" role="1.1.2"><title>Index of new symbols in 1.1.2</title><xi:include href="xml/api-index-1.1.2.xml"><xi:fallback /></xi:include></index> 158 <index id="api-index-1-0-5" role="1.0.5"><title>Index of new symbols in 1.0.5</title><xi:include href="xml/api-index-1.0.5.xml"><xi:fallback /></xi:include></index> 159 <index id="api-index-0-9-42" role="0.9.42"><title>Index of new symbols in 0.9.42</title><xi:include href="xml/api-index-0.9.42.xml"><xi:fallback /></xi:include></index> 160 <index id="api-index-0-9-41" role="0.9.41"><title>Index of new symbols in 0.9.41</title><xi:include href="xml/api-index-0.9.41.xml"><xi:fallback /></xi:include></index> 161 <index id="api-index-0-9-39" role="0.9.39"><title>Index of new symbols in 0.9.39</title><xi:include href="xml/api-index-0.9.39.xml"><xi:fallback /></xi:include></index> 162 <index id="api-index-0-9-38" role="0.9.38"><title>Index of new symbols in 0.9.38</title><xi:include href="xml/api-index-0.9.38.xml"><xi:fallback /></xi:include></index> 163 <index id="api-index-0-9-31" role="0.9.31"><title>Index of new symbols in 0.9.31</title><xi:include href="xml/api-index-0.9.31.xml"><xi:fallback /></xi:include></index> 164 <index id="api-index-0-9-30" role="0.9.30"><title>Index of new symbols in 0.9.30</title><xi:include href="xml/api-index-0.9.30.xml"><xi:fallback /></xi:include></index> 165 <index id="api-index-0-9-28" role="0.9.28"><title>Index of new symbols in 0.9.28</title><xi:include href="xml/api-index-0.9.28.xml"><xi:fallback /></xi:include></index> 166 <index id="api-index-0-9-22" role="0.9.22"><title>Index of new symbols in 0.9.22</title><xi:include href="xml/api-index-0.9.22.xml"><xi:fallback /></xi:include></index> 167 <index id="api-index-0-9-20" role="0.9.20"><title>Index of new symbols in 0.9.20</title><xi:include href="xml/api-index-0.9.20.xml"><xi:fallback /></xi:include></index> 168 <index id="api-index-0-9-11" role="0.9.11"><title>Index of new symbols in 0.9.11</title><xi:include href="xml/api-index-0.9.11.xml"><xi:fallback /></xi:include></index> 169 <index id="api-index-0-9-10" role="0.9.10"><title>Index of new symbols in 0.9.10</title><xi:include href="xml/api-index-0.9.10.xml"><xi:fallback /></xi:include></index> 170 <index id="api-index-0-9-8" role="0.9.8"><title>Index of new symbols in 0.9.8</title><xi:include href="xml/api-index-0.9.8.xml"><xi:fallback /></xi:include></index> 171 <index id="api-index-0-9-7" role="0.9.7"><title>Index of new symbols in 0.9.7</title><xi:include href="xml/api-index-0.9.7.xml"><xi:fallback /></xi:include></index> 172 <index id="api-index-0-9-5" role="0.9.5"><title>Index of new symbols in 0.9.5</title><xi:include href="xml/api-index-0.9.5.xml"><xi:fallback /></xi:include></index> 173 <index id="api-index-0-9-2" role="0.9.2"><title>Index of new symbols in 0.9.2</title><xi:include href="xml/api-index-0.9.2.xml"><xi:fallback /></xi:include></index> 174 175 <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> 176 </part> 177</book> 178
