source: archive/libhandy.xml@ ccded7e

<?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 libhandy-download-http "https://source.puri.sm/Librem5/libhandy/-/archive/v&libhandy-version;/libhandy-v&libhandy-version;.tar.bz2">
  <!ENTITY libhandy-download-ftp  " ">
  <!ENTITY libhandy-md5sum        "932ba6e80908c7579fa0392d6e0d0ceb">
  <!ENTITY libhandy-size          "388 KB">
  <!ENTITY libhandy-buildsize     "16 MB (with tests)">
  <!ENTITY libhandy-time          "0.2 SBU (with tests)">
]>

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

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

  <title>Libhandy-&libhandy-version;</title>

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

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

    <para>
      The <application>libhandy</application> package provides additional
      GTK UI widgets for use in developing user interfaces.
    </para>

    &lfs10_checked;

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> and
      <ulink url="https://glade.gnome.org/">Glade</ulink>
    </para>

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

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

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

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

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

    <para>
      To test the results, issue: <command>ninja test</command>.
      The tests must be run from a graphical session.
    </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>
      <option>-Dgtk_doc=true</option>: Use this option if you have
      <xref linkend="gtk-doc"/> installed and wish to install the documentation.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          handy-demo-0.0
        </seg>
        <seg>
          libhandy-0.0.so
        </seg>
        <seg>
          /usr/include/libhandy-0.0
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="handy-demo-0.0">
        <term><command>handy-demo-0.0</command></term>
        <listitem>
          <para>
            provides an example of how to use the
            <application>libhandy</application> library.
          </para>
          <indexterm zone="libhandy handy-demo-0.0">
            <primary sortas="b-handy-demo-0.0">handy-demo-0.0</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libhandy-0.0">
        <term><filename class="libraryfile">libhandy-0.0.so</filename></term>
        <listitem>
          <para>
            provides additional GTK widgets for use in creating user interfaces.
          </para>
          <indexterm zone="libhandy libhandy-0.0">
            <primary sortas="c-libhandy-0.0">libhandy-0.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>