source: archive/cairomm.xml@ b4cbe504

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY cairomm-download-http "https://www.cairographics.org/releases/cairomm-&cairomm-version;.tar.xz">
  <!ENTITY cairomm-download-ftp  " ">
  <!ENTITY cairomm-md5sum        "7b5c3d7ca5578f0de7d05aef756f97f1">
  <!ENTITY cairomm-size          "568 KB">
  <!ENTITY cairomm-buildsize     "29 MB (with tests)">
  <!ENTITY cairomm-time          "0.2 SBU (with tests)">
]>

<sect1 id="cairomm" xreflabel="Cairomm-&cairomm-version;">
  <?dbhtml filename="cairomm.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Cairomm-&cairomm-version;</title>

  <indexterm zone="cairomm">
    <primary sortas="a-Cairomm">Cairomm</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Cairomm</title>

    <para>
      The <application>Cairomm</application> package provides a C++
      interface to <application>Cairo</application>.
    </para>

    &lfs10_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&cairomm-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&cairomm-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &cairomm-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &cairomm-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &cairomm-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &cairomm-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Cairomm Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cairo"/> and
      <xref linkend="libsigc3"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="boost"/> (for tests)
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/cairomm"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of Cairomm</title>

    <para>
      Install <application>Cairomm</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir bld &amp;&amp;
cd    bld &amp;&amp;

meson --prefix=/usr       \
      -Dbuild-tests=true  \
      -Dboost-shared=true \
      ..                  &amp;&amp;
ninja</userinput></screen>

    <para>
      To run the test suite, run: <command>ninja test</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-Dbuild-tests=true</parameter>: This switch is for building
      the unit tests. Remove if you have not installed <xref linkend="boost"/>.
    </para>

    <para>
      <parameter>-Dboost-shared=true</parameter>: This switch has the package
      use the shared version of boost libraries. It is required if you have
      not installed the boost static libraries, and you have passed
      <parameter>-Dbuild-tests=true</parameter>.
    </para>

    <para>
      <option>-Dbuild-documentation=true</option>: This switch builds the
      html documentation if doxygen is installed.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libcairomm-1.16.so
        </seg>
        <seg>
          /usr/{lib,include}/cairomm-1.16 and
          /usr/share/{devhelp/books,doc}/cairomm-1.16 (optional)
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libcairomm-1.16">
        <term><filename class="libraryfile">libcairomm-1.16.so</filename></term>
        <listitem>
          <para>
            contains the <application>Cairo</application> API classes
          </para>
          <indexterm zone="cairomm libcairomm-1.16">
            <primary sortas="c-libcairomm-1.16">libcairomm-1.16.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>