source: xsoft/other/feh.xml

<?xml version="1.0" encoding="UTF-8"?>
<!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 feh-download-http "https://feh.finalrewind.org/feh-&feh-version;.tar.bz2">
  <!ENTITY feh-download-ftp  " ">
  <!ENTITY feh-md5sum        "0a780bf321c0653d03e3e18410f4d1ba">
  <!ENTITY feh-size          "2.1 MB">
  <!ENTITY feh-buildsize     "6.9 MB (with tests)">
  <!ENTITY feh-time          "less than 0.1 SBU (with tests)">
]>

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


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

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

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

    <para>
      <application>feh</application> is a fast, lightweight image viewer which
      uses Imlib2. It is commandline-driven and supports multiple images
      through slideshows, thumbnail browsing or multiple windows, and montages
      or index prints (using TrueType fonts to display file info). Advanced
      features include fast dynamic zooming, progressive loading, loading via
      HTTP (with reload support for watching webcams), recursive file opening
      (slideshow of a directory hierarchy), and mouse wheel/keyboard control.
    </para>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">

<!--  Seems to work OK now
    <note>
      <para>
        For some reason, using a browser, the link will not download the
        package as a tarball, but instead, as a page. Therefore, you will need
        to use <quote>Save link as</quote> or the <command>wget</command> or
        another similar command, in the command line.
      </para>
    </note>
-->
      <listitem>
        <para>
          Download (HTTP): <ulink url="&feh-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&feh-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &feh-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &feh-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &feh-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &feh-time;
        </para>
      </listitem>
    </itemizedlist>

<!-- I don't think this is needed as of 2.17. -renodr -->
<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Optional patch, for the test suite:
          <ulink
            url="&patch-root;/feh-&feh-version;-disable_some_tests-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>
-->
    <bridgehead renderas="sect3">feh Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libpng"/> and
      <xref linkend="imlib2"/> (built with
      <xref linkend="giflib"/> support, for the tests)
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="curl"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="libexif"/>
    </para>

    <bridgehead renderas="sect4">Optional (runtime)</bridgehead>
    <para role="optional">
      <xref role="runtime" linkend="libjpeg"/> (for lossless image rotation) and
      <xref role="runtime" linkend="imagemagick"/> (to load unsupported formats)
    </para>

    <bridgehead renderas="sect4">Optional (test suite)</bridgehead>
    <para role="optional">
      <xref linkend="perl-test-command"/> (required) and
      <xref linkend="mandoc"/> (optional)
    </para>


  </sect2>

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

<!--
    <para>
      Due to well-known problems when <application>feh</application> try to
      load gif images (sometimes <application>imlib2</application> being blamed
      for that), some tests fail. To avoid that, apply the following patch, if
      you intend to run the test suite:
    </para>

<screen><userinput>patch -Np1 -i ../feh-&feh-version;-disable_some_tests-1.patch</userinput></screen>
-->

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

<screen><userinput>sed -i "s:doc/feh:&amp;-&feh-version;:" config.mk &amp;&amp;
make PREFIX=/usr</userinput></screen>

    <para>
      To test the results, issue: <command>make test</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make PREFIX=/usr install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <command>sed -i "s:doc/feh:&amp;-&feh-version;:" config.mk</command>: This
      sed fixes the doc directory to a versioned one, as used in BLFS.
   </para>

    <para>
      <option>curl=0</option>: Use this make flag if you don't have the cURL
      package installed.
    </para>

    <para>
      <option>exif=1</option>: This make flag enables builtin Exif tag display
      support.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          feh
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/share/doc/feh-&feh-version; and
          /usr/share/feh
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="feh-prog">
        <term><command>feh</command></term>
        <listitem>
          <para>
            is an image viewer and cataloguer
          </para>
          <indexterm zone="feh feh-prog">
            <primary sortas="b-feh">feh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>