source: x/lib/imlib2.xml@ 314acdd

<?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 imlib2-download-http "&sourceforge-dl;/enlightenment/imlib2-&imlib2-version;.tar.xz">
  <!ENTITY imlib2-download-ftp  " ">
  <!ENTITY imlib2-md5sum        "93e5b769ed02a183dfd78569f7b0fbe3">
  <!ENTITY imlib2-size          "816 KB">
  <!ENTITY imlib2-buildsize     "13 MB (with docs)">
  <!ENTITY imlib2-time          "0.2 SBU (with docs)">
]>

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


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

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

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

    <para>
      <application>imlib2</application> is a graphics library for fast file
      loading, saving, rendering and manipulation.
    </para>

    &lfs121_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="xorg7-lib"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="giflib"/> and
      <xref linkend="librsvg"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/> (for API documentation),
      <xref linkend="highway"/>,
      <xref linkend="libjpeg"/>,
      <xref linkend="libjxl"/>,
      <xref linkend="libpng"/>,
      <xref linkend="libtiff"/>,
      <xref linkend="libwebp"/>,
      <xref linkend="x265"/>,
      <ulink url="https://github.com/strukturag/libheif">libheif</ulink>,
      <ulink url="https://sourceforge.net/projects/mad">libid3tag</ulink>,
      <ulink url="https://www.freedesktop.org/wiki/Software/libspectre">libspectre</ulink>
    </para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the &root; user:
    </para>

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

    <para>
      If you generated the API documentation, install it as the &root; user:
    </para>

<screen role="root"><userinput>install -v -m755 -d            /usr/share/doc/imlib2-&imlib2-version;/html &amp;&amp;
install -v -m644    doc/html/* /usr/share/doc/imlib2-&imlib2-version;/html</userinput></screen>

  </sect2>

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

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

    <para>
      <option>--enable-doc-build</option>: This switch generates
      the API documentation.  <xref linkend="doxygen"/> must be installed.
    </para>

  </sect2>

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

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

      <!-- imlib2-config dropped in 1.7.5 -->
      <seglistitem>
        <seg>imlib2_bumpmap,
             imlib2_colorspace,
             imlib2_conv,
             imlib2_grab,
             imlib2_load,
             imlib2_poly,
             imlib2_show,
             imlib2_test, and
             imlib2_view</seg>
        <seg>libImlib2.so and various filters and image loader modules.</seg>
        <seg>/usr/lib/imlib2, /usr/share/doc/imlib2-&imlib2-version;, and
        /usr/share/imlib2</seg>
      </seglistitem>
    </segmentedlist>

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

     <varlistentry id="imlib2_bumpmap">
        <term><command>imlib2_bumpmap</command></term>
        <listitem>
          <para>
            is to test the <application>imlib2</application> bumpmap function
          </para>
          <indexterm zone="imlib2 imlib2_bumpmap">
            <primary sortas="b-imlib2_bumpmap">imlib2_bumpmap</primary>
          </indexterm>
        </listitem>
      </varlistentry>

     <varlistentry id="imlib2_colorspace">
        <term><command>imlib2_colorspace</command></term>
        <listitem>
          <para>
            is to test the <application>imlib2</application> colorspace
            function
          </para>
          <indexterm zone="imlib2 imlib2_colorspace">
            <primary sortas="b-imlib2_colorspace">imlib2_colorspace</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="imlib2_conv">
        <term><command>imlib2_conv</command></term>
        <listitem>
          <para>
            converts images between formats
          </para>
          <indexterm zone="imlib2 imlib2_conv">
            <primary sortas="b-imlib2_conv">imlib2_conv</primary>
          </indexterm>
        </listitem>
      </varlistentry>

     <varlistentry id="imlib2_grab">
        <term><command>imlib2_grab</command></term>
        <listitem>
          <para>
            takes screenshots
          </para>
          <indexterm zone="imlib2 imlib2_grab">
            <primary sortas="b-imlib2_grab">imlib2_grab</primary>
          </indexterm>
        </listitem>
     </varlistentry>

     <varlistentry id="imlib2_load">
        <term><command>imlib2_load</command></term>
        <listitem>
          <para>
            loads and caches images
          </para>
          <indexterm zone="imlib2 imlib2_load">
            <primary sortas="b-imlib2_load">imlib2_load</primary>
          </indexterm>
        </listitem>
     </varlistentry>

     <varlistentry id="imlib2_poly">
        <term><command>imlib2_poly</command></term>
        <listitem>
          <para>
            is to test the <application>imlib2</application> poly function
          </para>
          <indexterm zone="imlib2 imlib2_poly">
            <primary sortas="b-imlib2_poly">imlib2_poly</primary>
          </indexterm>
        </listitem>
      </varlistentry>

     <varlistentry id="imlib2_show">
        <term><command>imlib2_show</command></term>
        <listitem>
          <para>
            is an <application>imlib2</application> program test
          </para>
          <indexterm zone="imlib2 imlib2_show">
            <primary sortas="b-imlib2_show">imlib2_show</primary>
          </indexterm>
        </listitem>
      </varlistentry>

     <varlistentry id="imlib2_test">
        <term><command>imlib2_test</command></term>
        <listitem>
          <para>
            is an <application>imlib2</application> program test
          </para>
          <indexterm zone="imlib2 imlib2_test">
            <primary sortas="b-imlib2_test">imlib2_test</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="imlib2_view">
        <term><command>imlib2_view</command></term>
        <listitem>
          <para>
            displays image files
          </para>
          <indexterm zone="imlib2 imlib2_view">
            <primary sortas="b-imlib2_view">imlib2_view</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libImlib2">
        <term><filename class="libraryfile">libImlib2.so</filename></term>
        <listitem>
          <para>
            provides the functions for programs to handle various
            image data formats
          </para>
          <indexterm zone="imlib2 libImlib2">
            <primary sortas="c-libImlib2">libImlib2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>