source: archive/libdazzle.xml

<?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 libdazzle-download-http "&gnome-download-http;/libdazzle/3.44/libdazzle-&libdazzle-version;.tar.xz">
  <!ENTITY libdazzle-download-ftp  "&gnome-download-ftp;/libdazzle/3.44/libdazzle-&libdazzle-version;.tar.xz">
  <!ENTITY libdazzle-md5sum        "203815dd90239ff732c19fc700417c74">
  <!ENTITY libdazzle-size          "448 KB">
  <!ENTITY libdazzle-buildsize     "15 MB (with tests)">
  <!ENTITY libdazzle-time          "0.2 SBU (using parallelism=4; with tests)">
]>

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


  <title>libdazzle-&libdazzle-version;</title>

  <indexterm zone="libdazzle">
    <primary sortas="a-libdazzle">libdazzle</primary>
  </indexterm>

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

    <para>
      <application>libdazzle</application> is a companion library to GObject
      and GTK+ that adds APIs for special graphical effects.
    </para>

    &lfs120_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk3"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="vala"/>
    </para>

  </sect2>

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

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

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

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.
      <!--Two tests may fail due to a theme parsing error.-->
    </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>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>
  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          dazzle-list-counters
        </seg>
        <seg>
          libdazzle-1.0.so
        </seg>
        <seg>
          /usr/include/libdazzle-1.0
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="dazzle-list-counters">
        <term><command>dazzle-list-counters</command></term>
        <listitem>
          <para>
            lists counters that are in use by a process
          </para>
          <indexterm zone="libdazzle dazzle-list-counters">
            <primary sortas="b-dazzle-list-counters">dazzle-list-counters</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libdazzle-lib">
        <term><filename class="libraryfile">libdazzle-1.0.so</filename></term>
        <listitem>
          <para>
            contains API functions for graphical effects
          </para>
          <indexterm zone="libdazzle libdazzle">
            <primary sortas="c-libdazzle">libdazzle-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>