source: gnome/platform/gnome-autoar.xml@ 1e6da19b

<?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 gnome-autoar-download-http "&gnome-download-http;/gnome-autoar/0.4/gnome-autoar-&gnome-autoar-version;.tar.xz">
  <!ENTITY gnome-autoar-download-ftp  " ">
  <!ENTITY gnome-autoar-md5sum        "ac1a423f861ed5765a5d03251c00746d">
  <!ENTITY gnome-autoar-size          "52 KB">
  <!ENTITY gnome-autoar-buildsize     "2.7 MB">
  <!ENTITY gnome-autoar-time          "0.1 SBU">
]>

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


  <title>gnome-autoar-&gnome-autoar-version;</title>

  <indexterm zone="gnome-autoar">
    <primary sortas="a-gnome-autoar">gnome-autoar</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to gnome-autoar</title>

    <para>
      The <application>gnome-autoar</application> package provides a framework
      for automatic archive extraction, compression, and management.
    </para>

    &lfs120_checked;

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

    <bridgehead renderas="sect3">gnome-autoar Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libarchive"/> and <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"/> (for building documentation)
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of gnome-autoar</title>

    <para>
      Install <application>gnome-autoar</application> by running the following
      commands:
    </para>

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

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dvapi=true         \
            -Dtests=true        \
            ..                  &amp;&amp;
ninja</userinput></screen>

    <para>
       To test the results, issue: <command>ninja test</command>
    </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>
      <parameter>- -disable-debug</parameter>: Disable the debug mode,
      in which this package would be built with <option>-O0 -g</option>.
    </para>
    -->

    <!--
    <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"/>
    -->

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

    <para>
      <option>-Dgtk_doc=true</option>: Use this parameter if GTK-Doc is
      installed and you wish to rebuild and install the API documentation.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libgnome-autoar-0.so and libgnome-autoar-gtk-0.so
        </seg>
        <seg>
          /usr/include/gnome-autoar-0 and /usr/share/gtk-doc/html/gnome-autoar
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgnome-autoar-0">
        <term><filename class="libraryfile">libgnome-autoar-0.so</filename></term>
        <listitem>
          <para>
            provides API functions for automatic archive management
          </para>
          <indexterm zone="gnome-autoar libgnome-autoar-0">
            <primary sortas="c-libgnome-autoar-0.so">libgnome-autoar-0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgnome-autoar-gtk-0">
         <term><filename class="libraryfile">libgnome-autoar-gtk-0.so</filename></term>
         <listitem>
           <para>
             provides GTK+ widgets to aid in automatic archive management
           </para>
           <indexterm zone="gnome-autoar libgnome-autoar-gtk-0">
             <primary sortas="c-libgnome-autoar-gtk-0.so">libgnome-autoar-gtk-0.so</primary>
           </indexterm>
         </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>