glfs/general/genutils/appdata-tools.xml

<?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 appdata-tools-download-http "http://people.freedesktop.org/~hughsient/releases/appdata-tools-&appdata-tools-version;.tar.xz">
  <!ENTITY appdata-tools-download-ftp  " ">
  <!ENTITY appdata-tools-md5sum        "adc82ce1d396c45203a842a508114ead">
  <!ENTITY appdata-tools-size          "260 KB">
  <!ENTITY appdata-tools-buildsize     "2.7 MB (additional 0.3 MB for the tests)">
  <!ENTITY appdata-tools-time          "less than 0.1 SBU">
]>

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

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

  <title>appdata-tools-&appdata-tools-version;</title>

  <indexterm zone="appdata-tools">
    <primary sortas="a-appdata-tools">appdata-tools</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to appdata-tools</title>

    <para>
      The <application>appdata-tools</application> is used to validate AppData
      files to conform to standard specification.
    </para>

    &lfs75_checked;

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

    <bridgehead renderas="sect3">appdata-tools Dependencies</bridgehead>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="libxml2"/>,
      <xref linkend="libxslt"/>,
      <xref linkend="DocBook"/>,
      <xref linkend="docbook-xsl"/>,
      <ulink url="http://www.thaiopensource.com/download/old/relaxng/20030619/trang.html">trang</ulink>, and
      <ulink url="http://lxml.de/index.html">lxml</ulink>
    </para>

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

  <sect2 role="installation">
    <title>Installation of appdata-tools</title>

    <para>
      Install <application>appdata-tools</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr &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="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>
          appdata-validate
        </seg>
        <seg>
          None
        </seg>
        <seg>
          None
        </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>
            validates AppData metadata.
          </para>
          <indexterm zone="appdata-tools appdata-validate">
            <primary sortas="b-appdata-validate">appdata-validate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>