source: x/lib/libgedit-amtk.xml@ db8d44a9

<?xml version="1.0" encoding="UTF-8"?>
<!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 libgedit-amtk-download-http "https://gitlab.gnome.org/World/gedit/libgedit-amtk/-/archive/5.9.0/libgedit-amtk-&libgedit-amtk-version;.tar.bz2">
  <!ENTITY libgedit-amtk-download-ftp  " ">
  <!ENTITY libgedit-amtk-md5sum        "8eaca94c4808fb00e6057ebf731f4daa">
  <!ENTITY libgedit-amtk-size          "60 KB">
  <!ENTITY libgedit-amtk-buildsize     "2.4 MB (with tests)">
  <!ENTITY libgedit-amtk-time          "0.1 SBU (with tests)">
]>

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


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

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

  <sect2 role="package">
    <title>Introduction to libgedit-amtk</title>

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

    &lfs122_checked;

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

    <bridgehead renderas="sect3">libgedit-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>

  </sect2>

  <sect2 role="installation">
    <title>Installation of libgedit-amtk</title>

    <para>
      Install <application>libgedit-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   \
      -D gtk_doc=false      &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.
      One test, test-action-map, is known to fail.
    </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>-D gtk_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>
          libgedit-amtk-5.so
        </seg>
        <seg>
          /usr/include/libgedit-amtk-5 and
          /usr/share/gtk-doc/html/libgedit-amtk-5.0
        </seg>
      </seglistitem>
    </segmentedlist>

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

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

</sect1>