source: x/lib/amtk.xml@ 0945dd2d

<?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 amtk-download-http "&gnome-download-http;/amtk/&amtk-minor;/amtk-&amtk-version;.tar.xz">
  <!ENTITY amtk-download-ftp  "&gnome-download-ftp;/amtk/&amtk-minor;/amtk-&amtk-version;.tar.xz">
  <!ENTITY amtk-md5sum        "26edf5c301e66a02f0ea7829855807f5">
  <!ENTITY amtk-size          "60 KB">
  <!ENTITY amtk-buildsize     "3.1 MB">
  <!ENTITY amtk-time          "0.1 SBU">
]>

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


  <title>Amtk-&amtk-version;</title>

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

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

    <para>
      The <application>Amtk</application> package contains a basic GTKUIManager
      replacement based on GAction.
    </para>

    &lfs113_checked;

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

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> (for documentation) and
      <xref linkend="valgrind"/>
    </para>

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

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

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

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

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

    <para>
      To test the results, issue: <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>

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

    <para>
      <parameter>-Dgtk_doc=false</parameter>: This switch prevents the build
      system from generating and installing the API documentation. Omit this
      switch if you have <xref linkend="gtk-doc" role="nodep"/> installed and
      wish to generate and install the API documentation.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libamtk-5.so
        </seg>
        <seg>
          /usr/include/amtk-5 and
          /usr/share/gtk-doc/html/amtk-5.0
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libamtk-5">
        <term><filename class="libraryfile">libamtk-5.so</filename></term>
        <listitem>
          <para>
            provides a basic GTKUIManager replacement API based on GAction
          </para>
          <indexterm zone="amtk libamtk-5">
            <primary sortas="c-libamtk-5">libamtk-5.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>