source: lxde/desktop/libfm.xml@ e5324803

<?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 libfm-download-http "&sourceforge-dl;/pcmanfm/libfm-&libfm-version;.tar.xz">
  <!ENTITY libfm-download-ftp  " ">
  <!ENTITY libfm-md5sum        "c87a0ff41ae77825079b2f785ec0741e">
  <!ENTITY libfm-size          "924 KB">
  <!ENTITY libfm-buildsize     "36 MB">
  <!ENTITY libfm-time          "0.3 SBU">
]>

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


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

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

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

    <para>
      The <application>libfm</application> package contains a library used
      to develop file managers providing some file management utilities.
    </para>

    &lfs112_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk2"/> or <xref role="nodep" linkend="gtk3"/>
      (GTK+-2 recommended since LXDE GTK+-3 support is still experimental), and
      <xref linkend="menu-cache"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libexif"/>,
      <xref linkend="vala"/>, and
      <xref linkend="lxmenu-data"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>,
      <xref linkend="dbus-glib"/> and
       <xref linkend="gvfs"/> or
       <ulink url="https://hal.freedesktop.org/releases/">udisks</ulink>
       (for volume management - experimental)
    </para>

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

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

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

<screen><userinput>./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --disable-static  &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="commands">
    <title>Command Explanations</title>

    <para>
      <option>--with-gtk=3</option>: This option selects the
      version of gtk+ to use.  The default is gtk+-2.
    </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"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          libfm-pref-apps and lxshortcut
        </seg>
        <seg>
          libfm.so, libfm-extra.so and libfm-gtk.so
        </seg>
        <seg>
          /etc/xdg/libfm,
          /usr/lib/libfm,
          /usr/share/gtk-doc/html/libfm and
          /usr/share/libfm
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libfm-pref-apps">
        <term><command>libfm-pref-apps</command></term>
        <listitem>
          <para>
            sets preferred applications for programs based
            on <application>libfm</application>
          </para>
          <indexterm zone="libfm libfm-pref-apps">
            <primary sortas="b-libfm-pref-apps">libfm-pref-apps</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lxshortcut">
        <term><command>lxshortcut</command></term>
        <listitem>
          <para>
            is a small program used to edit application shortcuts
          </para>
          <indexterm zone="libfm lxshortcut">
            <primary sortas="a-lxshortcut">lxshortcut</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>