source: general/genutils/appstream-glib.xml@ f3979ba

<?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        "925a056455b4eef441e692423ac0c5c5">
  <!ENTITY appstream-glib-size          "1.6 MB">
  <!ENTITY appstream-glib-buildsize     "14 MB (additional 1 MB for the tests)">
  <!ENTITY appstream-glib-time          "0.3 SBU ">
]>

<!-- Try to keep the indentation used in this file-->
<sect1 id="appstream-glib" xreflabel="appstream-glib-&appstream-glib-version;">
  <?dbhtml filename="appstream-glib.html"?>

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

  <!-- No other tags inside any title.
       Use Title Case in All Titles -->
  <title>appstream-glib-&appstream-glib-version;</title>

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

  <!--Required section-->
  <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 implementation that makes it easy to 
      edit nodes and convert to and from the standardized XML representation.
    </para>
    
    &lfs75_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="libarchive"/>
      <xref linkend="libsoup"/>, and
      <xref linkend="pango"/> 
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="DocBook"/>,
      <xref linkend="docbook-xsl"/>,
      <xref linkend="gtk-doc"/>,
      <xref linkend="libxslt"/>, and
      <ulink url="http://pyyaml.org/download/libyaml/">yaml</ulink>
    </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 \
            --disable-dep11  &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make -k check</command>. One test
      fails, if <ulink url="http://pyyaml.org/download/libyaml/">yaml</ulink>
      is not installed.
    </para>

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

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

  <!--Optional section-->
  <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>
      <parameter>--disable-dep11</parameter>: Remove this witch, if you have
      <ulink url="http://pyyaml.org/download/libyaml/">yaml</ulink> installed.
    </para>

  </sect2>

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

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

      <!-- If there were no programs, libraries, or directories created, then
           we would list the section as "None". However, a decision must have
           been made to change the "None" to just removing the whole section
           because I've noticed that many packages have had the "None"
           removed and the section completely removed as well. The reasoning
           was that by putting "None", it appears as we know there are none.
           Without anything it appears as we are not sure. -->

      <seglistitem>
        <seg>
          appstream-builder and appstream-util
        </seg>
        <seg>
          libappstream-builder.so and libappstream-glib.so
        </seg>
        <seg>
          /usr/include/libappstream-{builder,glib}, /usr/lib/asb-plugins,
          /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"?>

      <!-- If the program or library name conflicts (is the same) as the
      package name, add -prog or -lib to the varlistentry entity id
      and the 2nd entry of the indexterm zone entity -->

      <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 appstream-builder.
          </para>
          <indexterm zone="appstream-glib appstream-util">
            <primary sortas="b-appstream-util">appstream-util</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libappstream-builder">
        <term><filename class="libraryfile">libappstream-builder.so</filename></term>
        <listitem>
          <para>
            contains functions that aid the developers tool appstream-builder.
          </para>
          <indexterm zone="appstream-glib libappstream-builder">
            <primary sortas="c-libappstream-builder">libappstream-builder.so</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>