source: general/genlib/appstream-glib.xml@ 59a8407

<?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 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        "f02ef07ddd24d2b4e10dcd1d3f892d79">
  <!ENTITY appstream-glib-size          "1.8 MB">
  <!ENTITY appstream-glib-buildsize     "25 MB">
  <!ENTITY appstream-glib-time          "0.4 SBU ">
]>

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

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

  <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> package contains a library
      that provides GObjects and helper methods to make it easy to read and
      write AppStream metadata. It also provides a simple DOM implementation
      that makes it easy to edit nodes and convert to and from the
      standardized XML representation.
    </para>

    &lfs79_checked;&gcc6_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"/>,
      <xref linkend="json-glib"/>,
      <xref linkend="libarchive"/>,
      <xref linkend="libsoup"/> and
      <xref linkend="pango"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gcab"/>,
      <xref linkend="gobject-introspection"/>,
      <xref linkend="gtk3"/> and
      <xref linkend="yaml"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="DocBook"/>,
      <xref linkend="docbook-xsl"/> and
      <xref linkend="libxslt"/> (to build manual pages) and
      <xref linkend="gtk-doc"/>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/appstream-glib"/>
    </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>./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>

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

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gtk-doc-rebuild.xml"/>

    <para>
      <option>--disable-builder</option>: Use this switch if
      you have not installed <xref linkend="gcab"/> and
      <xref linkend="gtk3"/>.
    </para>

    <para>
      <option>--disable-dep11</option>: Use this switch if you
      have not installed <xref linkend="yaml"/>.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          appstream-builder, appstream-compose, and appstream-util
        </seg>
        <seg>
          libappstream-builder.so and libappstream-glib.so
        </seg>
        <seg>
          /usr/include/libappstream-builder,
          /usr/include/libappstream-glib,
          /usr/lib/asb-plugins-5,
          /usr/share/gtk-doc/html/appstream-glib, and
          /usr/share/installed-tests/appstream-glib
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="appdata-validate">
        <term><command>appdata-validate</command></term>
        <listitem>
          <para>
            is used to validate AppData for formatting and style guidelines.
          </para>
          <indexterm zone="appstream-glib appdata-validate">
            <primary sortas="b-appdata-validate">appdata-validate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="appstream-builder">
        <term><command>appstream-builder</command></term>
        <listitem>
          <para>
            is a developers tool to build metadata.
          </para>
          <indexterm zone="appstream-glib appstream-builder">
            <primary sortas="b-appstream-builder">appstream-builder</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="appstream-util">
        <term><command>appstream-util</command></term>
        <listitem>
          <para>
            is a management tool for <command>appstream-builder</command>.
          </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 objects and helper methods to help with reading and writing
            AppStream metadata.
          </para>
          <indexterm zone="appstream-glib libappstream-glib">
            <primary sortas="c-libappstream-glib">libappstream-glib.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
 
   </variablelist>

  </sect2>

</sect1>