[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[bb41bc7] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[1fc53421] | 7 | <!ENTITY cairo-download-http "https://www.cairographics.org/releases/cairo-&cairo-version;.tar.xz">
|
---|
[97ccf511] | 8 | <!ENTITY cairo-download-ftp " ">
|
---|
[fa17a25] | 9 | <!ENTITY cairo-md5sum "5ad67c707edd0003f1b91c8bbc0005c1">
|
---|
| 10 | <!ENTITY cairo-size "31 MB">
|
---|
| 11 | <!ENTITY cairo-buildsize "93 MB">
|
---|
| 12 | <!ENTITY cairo-time "0.2 SBU (Using parallelism=4)">
|
---|
[bb41bc7] | 13 | ]>
|
---|
| 14 |
|
---|
[a2912ff] | 15 | <sect1 id="cairo" xreflabel="Cairo-&cairo-version;">
|
---|
[bb41bc7] | 16 | <?dbhtml filename="cairo.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
[a2912ff] | 19 | <title>Cairo-&cairo-version;</title>
|
---|
[bb41bc7] | 20 |
|
---|
| 21 | <indexterm zone="cairo">
|
---|
[a2912ff] | 22 | <primary sortas="a-Cairo">Cairo</primary>
|
---|
[bb41bc7] | 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[4db1ba6] | 26 | <title>Introduction to Cairo</title>
|
---|
[bb41bc7] | 27 |
|
---|
[521cea0] | 28 | <para>
|
---|
| 29 | <application>Cairo</application> is a 2D graphics library with support for
|
---|
| 30 | multiple output devices. Currently supported output targets include the
|
---|
[1fc53421] | 31 | <application>X</application> Window System, Win32, image buffers,
|
---|
[521cea0] | 32 | PostScript, PDF and SVG. Experimental backends include OpenGL, Quartz and
|
---|
[68d01360] | 33 | XCB file output. <application>Cairo</application> is designed to produce
|
---|
| 34 | consistent output on all output media while taking advantage of display
|
---|
[80cb145] | 35 | hardware acceleration when available (e.g. through the X Render
|
---|
[68d01360] | 36 | Extension). The <application>Cairo</application> API provides operations
|
---|
| 37 | similar to the drawing operators of PostScript and PDF. Operations in
|
---|
[521cea0] | 38 | <application>Cairo</application> include stroking and filling cubic
|
---|
| 39 | Bézier splines, transforming and compositing translucent images,
|
---|
| 40 | and antialiased text rendering. All drawing operations can be transformed
|
---|
| 41 | by any
|
---|
[87fc185] | 42 | <ulink url="https://en.wikipedia.org/wiki/Affine_transformation">affine
|
---|
[80cb145] | 43 | transformation</ulink> (scale, rotation, shear, etc.)
|
---|
[521cea0] | 44 | </para>
|
---|
[bb41bc7] | 45 |
|
---|
[3c9b5e9] | 46 | &lfs122_checked;
|
---|
[3af39b1] | 47 |
|
---|
[bb41bc7] | 48 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 49 | <itemizedlist spacing="compact">
|
---|
| 50 | <listitem>
|
---|
[521cea0] | 51 | <para>
|
---|
| 52 | Download (HTTP): <ulink url="&cairo-download-http;"/>
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Download (FTP): <ulink url="&cairo-download-ftp;"/>
|
---|
| 58 | </para>
|
---|
[bb41bc7] | 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
[521cea0] | 61 | <para>
|
---|
| 62 | Download MD5 sum: &cairo-md5sum;
|
---|
| 63 | </para>
|
---|
[bb41bc7] | 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
[521cea0] | 66 | <para>
|
---|
| 67 | Download size: &cairo-size;
|
---|
| 68 | </para>
|
---|
[bb41bc7] | 69 | </listitem>
|
---|
| 70 | <listitem>
|
---|
[521cea0] | 71 | <para>
|
---|
| 72 | Estimated disk space required: &cairo-buildsize;
|
---|
| 73 | </para>
|
---|
[bb41bc7] | 74 | </listitem>
|
---|
| 75 | <listitem>
|
---|
[521cea0] | 76 | <para>
|
---|
| 77 | Estimated build time: &cairo-time;
|
---|
| 78 | </para>
|
---|
[bb41bc7] | 79 | </listitem>
|
---|
[521cea0] | 80 | </itemizedlist>
|
---|
| 81 |
|
---|
[4db1ba6] | 82 | <bridgehead renderas="sect3">Cairo Dependencies</bridgehead>
|
---|
[bb41bc7] | 83 |
|
---|
| 84 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[b8a081c] | 85 | <para role="required">
|
---|
[1cfd61d] | 86 | <xref linkend="libpng"/> and
|
---|
[b0ae5b7] | 87 | <xref linkend="pixman"/>
|
---|
[4db1ba6] | 88 | </para>
|
---|
| 89 |
|
---|
[f575476] | 90 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[4db1ba6] | 91 | <para role="recommended">
|
---|
[1cfd61d] | 92 | <xref linkend="fontconfig"/>,
|
---|
[3df8ea47] | 93 | <xref linkend="glib2"/> (required for most GUIs), and
|
---|
[a2912ff] | 94 | <xref linkend="xorg7-lib"/>
|
---|
[b8a081c] | 95 | </para>
|
---|
[bc9c1def] | 96 |
|
---|
[bb41bc7] | 97 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[b8a081c] | 98 | <para role="optional">
|
---|
[11d14a27] | 99 | <xref linkend="gs"/>,
|
---|
[82b0e62] | 100 | <xref linkend="gtk3"/>,
|
---|
[b8a081c] | 101 | <xref linkend="gtk-doc"/>,
|
---|
[521cea0] | 102 | <xref linkend="libdrm"/>,
|
---|
[11d14a27] | 103 | <xref linkend="librsvg"/>,
|
---|
[f68e46f] | 104 | <xref linkend="libxml2"/>,
|
---|
[652b18b] | 105 | <xref linkend="lzo"/>,
|
---|
[7a395d1] | 106 | <xref linkend="mesa"/>,
|
---|
[11d14a27] | 107 | <xref linkend="poppler"/>,
|
---|
[ae629f3] | 108 | <xref linkend="valgrind"/>,
|
---|
[80cb145] | 109 | >k2;,
|
---|
[11d14a27] | 110 | <ulink url="https://github.com/rillian/jbig2dec/">jbig2dec</ulink>,
|
---|
[dc22bd6] | 111 | <ulink url="https://www.freedesktop.org/wiki/Software/libspectre/">libspectre</ulink>, and
|
---|
| 112 | <ulink url="https://skia.org/">Skia</ulink>
|
---|
[b8a081c] | 113 | </para>
|
---|
[6e08fa52] | 114 |
|
---|
[baac59c] | 115 | <note>
|
---|
| 116 | <para>
|
---|
| 117 | There is a circular dependency between cairo and harfbuzz.
|
---|
| 118 | If cairo is built before harfbuzz, it is necessary to rebuild cairo
|
---|
| 119 | after harfbuzz in order to build pango.
|
---|
| 120 | </para>
|
---|
| 121 | </note>
|
---|
[e641675] | 122 |
|
---|
[bb41bc7] | 123 | </sect2>
|
---|
| 124 |
|
---|
| 125 | <sect2 role="installation">
|
---|
[4db1ba6] | 126 | <title>Installation of Cairo</title>
|
---|
[bb41bc7] | 127 |
|
---|
[521cea0] | 128 | <para>
|
---|
| 129 | Install <application>Cairo</application> by running the following
|
---|
| 130 | commands:
|
---|
| 131 | </para>
|
---|
[bb41bc7] | 132 |
|
---|
[1fc53421] | 133 | <screen><userinput>mkdir build &&
|
---|
| 134 | cd build &&
|
---|
| 135 |
|
---|
| 136 | meson setup --prefix=/usr --buildtype=release .. &&
|
---|
| 137 | ninja</userinput></screen>
|
---|
[bb41bc7] | 138 |
|
---|
[f575476] | 139 | <para>
|
---|
[48771ae] | 140 | This package does not have a working test suite.
|
---|
[1fc53421] | 141 | <!-- The test suite can be run with 'ninja test', but 488 tests fail and
|
---|
[a2ce753] | 142 | 59 tests pass. This seems to be due to minute changes in the expected
|
---|
| 143 | output, similar to librsvg's tests. Since it's a huge chunk of the tests,
|
---|
| 144 | let's keep it as "broken" for now.-->
|
---|
[521cea0] | 145 | </para>
|
---|
[bb41bc7] | 146 |
|
---|
[521cea0] | 147 | <para>
|
---|
| 148 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 149 | </para>
|
---|
[bb41bc7] | 150 |
|
---|
[1fc53421] | 151 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[bb41bc7] | 152 | </sect2>
|
---|
| 153 |
|
---|
[15a4fb4c] | 154 | <sect2 role="commands">
|
---|
| 155 | <title>Command Explanations</title>
|
---|
| 156 |
|
---|
[6d6005b0] | 157 | <!-- Enabled by default in 1.18.0 (would be -D tee=enabled otherwise)
|
---|
[7251b1d] | 158 | <para>
|
---|
[1fc53421] | 159 | <parameter>- -enable-tee</parameter>: This switch enables the
|
---|
[8558044] | 160 | experimental tee surface backend which is required if using
|
---|
[11d14a27] | 161 | system-installed <application>Cairo</application> with Mozilla applications.
|
---|
[7251b1d] | 162 | </para>
|
---|
[1fc53421] | 163 | -->
|
---|
[7251b1d] | 164 |
|
---|
[a98acfe7] | 165 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[1fc53421] | 166 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
[827336dc] | 167 |
|
---|
[74520e8] | 168 | <para>
|
---|
[6d6005b0] | 169 | <option>-D xlib-xcb=enabled</option>: This switch enables several
|
---|
[5ec23d4] | 170 | experimental Xlib/XCB functions used by some window managers.
|
---|
[74520e8] | 171 | </para>
|
---|
| 172 |
|
---|
[f25b2c03] | 173 | <para>
|
---|
[6d6005b0] | 174 | <option>-D gtk_doc=true</option>: Use this parameter if GTK-Doc is
|
---|
[f25b2c03] | 175 | installed and you wish to create and install the documentation.
|
---|
| 176 | </para>
|
---|
[a2912ff] | 177 |
|
---|
[15a4fb4c] | 178 | </sect2>
|
---|
| 179 |
|
---|
[bb41bc7] | 180 | <sect2 role="content">
|
---|
| 181 | <title>Contents</title>
|
---|
| 182 |
|
---|
| 183 | <segmentedlist>
|
---|
| 184 | <segtitle>Installed Programs</segtitle>
|
---|
[742b99e] | 185 | <segtitle>Installed Libraries</segtitle>
|
---|
[bb41bc7] | 186 | <segtitle>Installed Directories</segtitle>
|
---|
| 187 |
|
---|
| 188 | <seglistitem>
|
---|
[b8a081c] | 189 | <seg>
|
---|
[a2ce753] | 190 | cairo-trace
|
---|
[b8a081c] | 191 | </seg>
|
---|
| 192 | <seg>
|
---|
[1fc53421] | 193 | libcairo.so,
|
---|
| 194 | libcairo-gobject.so, and
|
---|
[4db1ba6] | 195 | libcairo-script-interpreter.so
|
---|
[b8a081c] | 196 | </seg>
|
---|
| 197 | <seg>
|
---|
[1fc53421] | 198 | /usr/include/cairo and
|
---|
| 199 | /usr/lib/cairo
|
---|
[b8a081c] | 200 | </seg>
|
---|
[bb41bc7] | 201 | </seglistitem>
|
---|
| 202 | </segmentedlist>
|
---|
| 203 |
|
---|
| 204 | <variablelist>
|
---|
| 205 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 206 | <?dbfo list-presentation="list"?>
|
---|
| 207 | <?dbhtml list-presentation="table"?>
|
---|
| 208 |
|
---|
[827336dc] | 209 | <varlistentry id="cairo-trace">
|
---|
| 210 | <term><command>cairo-trace</command></term>
|
---|
| 211 | <listitem>
|
---|
[521cea0] | 212 | <para>
|
---|
| 213 | generates a log of all calls made by an application to
|
---|
[4c24eb0a] | 214 | <application>Cairo</application>
|
---|
[521cea0] | 215 | </para>
|
---|
[827336dc] | 216 | <indexterm zone="cairo cairo-trace">
|
---|
| 217 | <primary sortas="b-cairo-trace">cairo-trace</primary>
|
---|
| 218 | </indexterm>
|
---|
| 219 | </listitem>
|
---|
| 220 | </varlistentry>
|
---|
| 221 |
|
---|
[bb41bc7] | 222 | <varlistentry id="libcairo">
|
---|
[f575476] | 223 | <term><filename class="libraryfile">libcairo.so</filename></term>
|
---|
[bb41bc7] | 224 | <listitem>
|
---|
[521cea0] | 225 | <para>
|
---|
| 226 | contains the 2D graphics functions required for rendering to the
|
---|
[4c24eb0a] | 227 | various output targets
|
---|
[521cea0] | 228 | </para>
|
---|
[bb41bc7] | 229 | <indexterm zone="cairo libcairo">
|
---|
[4db1ba6] | 230 | <primary sortas="c-libcairo">libcairo.so</primary>
|
---|
[bb41bc7] | 231 | </indexterm>
|
---|
| 232 | </listitem>
|
---|
| 233 | </varlistentry>
|
---|
| 234 |
|
---|
[827336dc] | 235 | <varlistentry id="libcairo-gobject">
|
---|
[7ca0e36] | 236 | <term><filename class="libraryfile">libcairo-gobject.so</filename></term>
|
---|
[827336dc] | 237 | <listitem>
|
---|
[521cea0] | 238 | <para>
|
---|
| 239 | contains functions that integrate
|
---|
[8558044] | 240 | <application>Cairo</application> with
|
---|
[4c24eb0a] | 241 | <application>Glib</application>'s GObject type system
|
---|
[521cea0] | 242 | </para>
|
---|
[827336dc] | 243 | <indexterm zone="cairo libcairo-gobject">
|
---|
[4db1ba6] | 244 | <primary sortas="c-libcairo-gobject">libcairo-gobject.so</primary>
|
---|
[827336dc] | 245 | </indexterm>
|
---|
| 246 | </listitem>
|
---|
| 247 | </varlistentry>
|
---|
| 248 |
|
---|
| 249 | <varlistentry id="libcairo-script-interpreter">
|
---|
[7ca0e36] | 250 | <term><filename class="libraryfile">libcairo-script-interpreter.so</filename></term>
|
---|
[827336dc] | 251 | <listitem>
|
---|
[521cea0] | 252 | <para>
|
---|
| 253 | contains the script interpreter functions for executing and
|
---|
[4c24eb0a] | 254 | manipulating <application>Cairo</application> execution traces
|
---|
[521cea0] | 255 | </para>
|
---|
[827336dc] | 256 | <indexterm zone="cairo libcairo-script-interpreter">
|
---|
[4db1ba6] | 257 | <primary sortas="c-libcairo-script-interpreter">libcairo-script-interpreter.so</primary>
|
---|
[827336dc] | 258 | </indexterm>
|
---|
| 259 | </listitem>
|
---|
| 260 | </varlistentry>
|
---|
[a2912ff] | 261 |
|
---|
[bb41bc7] | 262 | </variablelist>
|
---|
[a2912ff] | 263 |
|
---|
[bb41bc7] | 264 | </sect2>
|
---|
[a2912ff] | 265 |
|
---|
[bb41bc7] | 266 | </sect1>
|
---|