source: archive/lxqt/desktop/libfm-qt.xml@ 54bd123

<?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;

<!-- As of August 2017, downloads.lxqt.org is down. Use github archives
     instead, but keep the old link in case the host become available again.
     According to lxqt devs, they are working on it...
  <!ENTITY libfm-qt-download-http "http://downloads.lxqt.org/libfm-qt/&libfm-qt-version;/libfm-qt-&libfm-qt-version;.tar.xz">-->
  <!ENTITY libfm-qt-download-http "https://github.com/lxde/libfm-qt/releases/download/&libfm-qt-version;/libfm-qt-&libfm-qt-version;.tar.xz">
  <!ENTITY libfm-qt-download-ftp  " ">
  <!ENTITY libfm-qt-md5sum        "8eb86b0743fe6c6adb73f516295e4281">
  <!ENTITY libfm-qt-size          "178 KB">
  <!ENTITY libfm-qt-buildsize     "22 MB">
  <!ENTITY libfm-qt-time          "0.9 SBU">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>libfm-qt-&libfm-qt-version;</title>

  <indexterm zone="libfm-qt">
    <primary sortas="a-libfm-qt">libfm-qt</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libfm-qt</title>

    <para>
      <application>libfm-qt</application> is the Qt port of libfm, a library
      providing components to build desktop file managers.
    </para>

    &lfs82_checked;

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

    <bridgehead renderas="sect3">libfm-qt Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/>,
      <xref linkend="libexif"/>,
      <xref linkend="libfm"/>, and
      <xref linkend="qt5"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="git"/>(to download translation files) or
      <xref linkend="lxqt-l10n"/> (to add localization files)
    </para>

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

  <sect2 role="installation">
    <title>Installation of libfm-qt</title>

    <para>
      Install <application>libfm-qt</application> by running the
      following commands:
    </para>

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

cmake -DCMAKE_INSTALL_PREFIX=$LXQT_PREFIX \
      -DCMAKE_BUILD_TYPE=Release          \
      -DPULL_TRANSLATIONS=no              \
      ..                                  &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>: Remove 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 Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libfm-qt.so
        </seg>
        <seg>
          $LXQT_PREFIX/include/libfm-qt, $LXQT_PREFIX/share/libfm-qt, and
          $LXQT_PREFIX/share/cmake/fm-qt
        </seg>
      </seglistitem>
    </segmentedlist>

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

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

    </variablelist>

  </sect2>

</sect1>