source: general/genlib/appstream-glib.xml@ 28dc83d

<?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;

  <!-- Place this in the packages.ent file
  <!ENTITY TEMPLATE-version "">
  -->

  <!ENTITY appstream-glib-download-http
   "http://people.freedesktop.org/~hughsient/appstream-glib/releases/appstream-glib-&appstream-glib-version;.tar.xz">
  <!ENTITY appstream-glib-download-ftp  " ">
  <!ENTITY appstream-glib-md5sum        "2ffd46eff1c16f31e435849b706c2287">
  <!ENTITY appstream-glib-size          "2.2 MB">
  <!ENTITY appstream-glib-buildsize     "15 MB (with tests)">
  <!ENTITY appstream-glib-time          "0.1 SBU (with tests)">
]>

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


  <title>appstream-glib-&appstream-glib-version;</title>

  <indexterm zone="appstream-glib">
    <primary sortas="a-appstream-glib">appstream-glib</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to appstream-glib</title>

    <para>
      The <application>appstream-glib</application> provides GObjects and
      helper methods to make it easy to read and write AppStream metadata.
      It also provides a simple DOM (Document Object Model) implementation 
      that makes it easy to edit nodes and convert to and from the 
      standardized XML representation.
    </para>

    &lfs121_checked;

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

    <bridgehead renderas="sect3">appstream-glib Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gdk-pixbuf"/> and
      <xref linkend="libarchive"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="DocBook"/>,
      <xref linkend="docbook-xsl"/>,
      <xref linkend="gtk-doc"/>,
      <xref linkend="libxslt"/>, and
      <xref linkend="libyaml"/>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of appstream-glib</title>

    <para>
      Install <application>appstream-glib</application> by running the following
      commands:
    </para>

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

meson setup --prefix=/usr -D rpm=false .. &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.
    </para>

    <para>
      Now, as the &root; user:
    </para>

<screen role="root"><userinput>ninja install &amp;&amp;
rm -v -rf /usr/share/installed-tests</userinput></screen>
  </sect2>

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

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

      <seglistitem>
        <seg>
          appdata-builder,
          appstream-compose, and
          appstream-util
        </seg>
        <seg>
          libappstream-glib.so
        </seg>
        <seg>
          /usr/include/libappstream-glib and
          /usr/lib/asb-plugins-5
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="appdata-builder">
        <term><command>appdata-builder</command></term>
        <listitem>
          <para>
            builds AppStream metadata.
          </para>
          <indexterm zone="appstream-glib appdata-builder">
            <primary sortas="b-appdata-builder">appdata-builder</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="appdata-compose">
        <term><command>appdata-compose</command></term>
        <listitem>
          <para>
            generates AppStream metadata.
          </para>
          <indexterm zone="appstream-glib appdata-compose">
            <primary sortas="b-appdata-compose">appdata-compose</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="appstream-util">
        <term><command>appstream-util</command></term>
        <listitem>
          <para>
            Is a management tool for appstream-builder.
          </para>
          <indexterm zone="appstream-glib appstream-util">
            <primary sortas="b-appstream-util">appstream-util</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libappstream-glib">
        <term><filename class="libraryfile">libappstream-glib.so</filename></term>
        <listitem>
          <para>
            contains the api functions.
          </para>
          <indexterm zone="appstream-glib libappstream-glib">
            <primary sortas="c-libappstream-glib">libappstream-glib.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>