source: general/graphlib/gegl.xml@ 27229db

<?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 gegl-download-http "https://download.gimp.org/pub/gegl/0.3/gegl-&gegl-version;.tar.bz2">
  <!ENTITY gegl-download-ftp  " ">
  <!ENTITY gegl-md5sum        "c23a0ba775bf0f51afa7a999b3b430a3">
  <!ENTITY gegl-size          "6.4 MB">
  <!ENTITY gegl-buildsize     "127 MB (add 22 MB for tests)">
  <!ENTITY gegl-time          "0.8 SBU (using parallelism=4; add 0.4 SBU for tests)">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

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

  <indexterm zone="gegl">
    <primary sortas="a-Gegl">Gegl</primary>
  </indexterm>

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

    <para>
      This package provides the GEneric Graphics Library, which is a graph based
      image processing format.
    </para>

    &lfs82_checked;

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

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="asciidoc"/>,
      <xref linkend="cairo"/>,
      <xref linkend="enscript"/>,
      <xref linkend="exiv2"/>,
      <xref linkend="ffmpeg"/>,
      <xref linkend="gdk-pixbuf"/>,
      <xref linkend="graphviz"/>,
      <xref linkend="libjpeg"/>,
      <xref linkend="libpng"/>,
      <xref linkend="librsvg"/>,
      <xref linkend="libwebp"/>,
      <xref linkend="lua"/>,
      <xref linkend="pango"/>,
      <xref linkend="python2"/>,
      <xref linkend="ruby"/>,
      <xref linkend="sdl"/>,
      <xref linkend="gobject-introspection"/>,
      <xref linkend="vala"/>,
      <xref linkend="w3m"/>,
      <xref linkend="gexiv2"/>,
      <ulink url="http://lensfun.sourceforge.net/">lensfun</ulink>,
      <ulink url="http://libopenraw.freedesktop.org/wiki/">libopenraw</ulink>,
      <ulink url="http://libspiro.sourceforge.net/">libspiro</ulink>,
      <ulink url="http://faculty.cse.tamu.edu/davis/suitesparse.html">libumfpack</ulink>,
      <ulink url="https://github.com/hodefoting/mrg/releases">MRG</ulink>,
      <ulink url="https://www.khronos.org/opencl/">OpenCL</ulink> (for tests), and
      <ulink url="http://www.openexr.org">OpenEXR</ulink>
    </para>

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

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

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

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

    <para>
      To test the results, issue: <command>make check</command>. 
      Several tests are not run due to missing data.
     <!-- for me, no failures : but I don't have all the optional deps,
       no idea which test used to fail. Ken
      To test the results, issue: <command>make -k check</command>. One
      test is known to fail.
      
      For version 0.3.22, the tests failed with 
      /bin/sh: line 1: ../../examples/gegl-video: No such file or directory

      Same failures for 0.3.26.
      No failures in 0.3.28, neither does it require a UTF-8 locale

      0.3.30
      /bin/sh: line 1: ../../examples/gegl-video: No such file or directory
      Seven instances

      Also several warnings: Using AVStream.codec to pass codec parameters 
      to muxers is deprecated
      -->
    </para>

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

<!-- With 0.3.28 make install creates gegl/images and put three pngs
  there.  I was going to keep this as commented (after make install
  but doing that adds a blank line in the box.
install -d -v -m755 /usr/share/gtk-doc/html/gegl/images &amp;&amp; -->
<screen role="root"><userinput>make install &amp;&amp;
install -v -m644 docs/*.{css,html} /usr/share/gtk-doc/html/gegl &amp;&amp;
install -v -m644 docs/images/*.{png,ico,svg} /usr/share/gtk-doc/html/gegl/images</userinput></screen>
  </sect2>

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

    <para>
      <command>install -v -m644/docs/*/{css,html} ...</command>:
      This and the subsequent commands install all the provided documentation
      instead of only the stylesheet <filename>gegl.css</filename> and three
      png files.
    </para>

    <para>
      <parameter>--without-vala</parameter>: Do not create a
      <application>vala</application> API - use this if
      <command>vapigen</command> breaks the build.
    </para>

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

    <!-- commented in case a later version reinstates this problem
    <para>
      <envar>LC_ALL=en_US</envar>: In some locales with <xref linkend='ruby'/>
      installed, one build component fails and prevents completion of the
      procedure.  Using this variable avoids the problem.
    </para> -->

  </sect2>

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

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

      <seglistitem>
        <seg>gegl</seg>
        <seg>libgegl-0.2.so and libraries in /usr/lib/gegl-0.2</seg>
        <seg>/usr/include/gegl-0.2</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gegl-prog">
        <term><command>gegl</command></term>
        <listitem>
          <para>
            is a commandline tool for working with the XML data model.
          </para>
          <indexterm zone="gegl gegl-prog">
            <primary sortas="b-gegl">gegl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgegl-0.2">
        <term><filename class='libraryfile'>libgegl-0.2.so</filename></term>
        <listitem>
          <para>
            provides infrastructure to do demand based cached non destructive
            image editing on larger than RAM buffers.
          </para>
          <indexterm zone="gegl libgegl-0.2">
            <primary sortas="c-libgegl-0.2">libgegl-0.2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>