source: lxqt/apps/lxqt-archiver.xml@ 6d90301

<?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 lxqt-archiver-download-http "https://github.com/lxqt/lxqt-archiver/releases/download/&lxqt-archiver-version;/lxqt-archiver-&lxqt-archiver-version;.tar.xz">
  <!ENTITY lxqt-archiver-download-ftp  " ">
  <!ENTITY lxqt-archiver-md5sum        "711a427fe2e3890559b873632b14f452">
  <!ENTITY lxqt-archiver-size          "177 KB">
  <!ENTITY lxqt-archiver-buildsize     "8.0 MB">
  <!ENTITY lxqt-archiver-time          "0.5 SBU">
]>

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


  <title>lxqt-archiver-&lxqt-archiver-version;</title>

  <indexterm zone="lxqt-archiver">
    <primary sortas="a-lxqt-archiver">lxqt-archiver</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to lxqt-archiver</title>

    <para>
      The <application>lxqt-archiver</application> package is a simple and
      lightweight desktop-agnostic Qt file archiver.
    </para>

    &lfs113_checked;

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

    <bridgehead renderas="sect3">lxqt-archiver Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="liblxqt"/> and
      <xref linkend="json-glib"/>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of lxqt-archiver</title>

    <para>
      Install <application>lxqt-archiver</application> by running the
      following commands:
    </para>

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

cmake -DCMAKE_BUILD_TYPE=Release          \
      -DCMAKE_INSTALL_PREFIX=$LXQT_PREFIX \
      ..       &amp;&amp;

make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </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>

    <para>
      <parameter>-DPULL_TRANSLATIONS=no</parameter>: Removes the need for
      <xref linkend="git"/>, which would otherwise be requested to download
      the translation files.
    </para>

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

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

      <seglistitem>
        <seg>
          lxqt-config-archiverhortcuts and lxqt-archiverd
        </seg>
        <seg>
          liblxqt-archiver.so and liblxqt-archiver-ui.so
        </seg>
        <seg>
          $LXQT_PREFIX/include/lxqt-archiver{,-ui} and
          $LXQT_PREFIX/share/cmake/lxqt-archiver{,-ui}
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="lxqt-config-archiverhortcuts">
        <term><command>lxqt-config-archiverhortcuts</command></term>
        <listitem>
          <para>
            is a key shortcuts GUI editor.
          </para>
          <indexterm zone="lxqt-archiver lxqt-config-archiverhortcuts">
            <primary sortas="b-lxqt-config-archiverhortcuts">lxqt-config-archiverhortcuts</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lxqt-archiverd">
        <term><command>lxqt-archiverd</command></term>
        <listitem>
          <para>
            is a global key shortcuts daemon.
          </para>
          <indexterm zone="lxqt-archiver lxqt-archiverd">
            <primary sortas="b-lxqt-archiverd">lxqt-archiverd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lxqt-archiver-lib">
        <term><filename class="libraryfile">lxqt-archiver.so</filename></term>
        <listitem>
          <para>
            contains the <application>lxqt-archiver</application> API
            functions.
          </para>
          <indexterm zone="lxqt-archiver lxqt-archiver-lib">
            <primary sortas="c-lxqt-archiver">lxqt-archiver.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="liblxqt-archiver-ui-lib">
        <term><filename class="libraryfile">liblxqt-archiver-ui.so</filename></term>
        <listitem>
          <para>
            contains the <application>liblxqt-archiver-ui</application> API
            functions.
          </para>
          <indexterm zone="lxqt-archiver liblxqt-archiver-ui-lib">
            <primary sortas="c-liblxqt-archiver-ui">liblxqt-archiver-ui.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>