source: xsoft/other/gimp.xml@ cb1db1ef

<?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 gimp-download-http "https://anduin.linuxfromscratch.org/BLFS/gimp/gimp3-&gimp-version;.tar.xz">
  <!ENTITY gimp-download-ftp  " ">
  <!ENTITY gimp-md5sum        "17fcd0bfc8e66fc61d672b4409cb3e3a">
  <!ENTITY gimp-size          "26 MB">
  <!ENTITY gimp-buildsize     "456 MB (162 MB installed)">
  <!ENTITY gimp-time          "1.2 SBU (Using parallelism=4)">

  <!-- pro-tem, a pull of gimp-help, https://gitlab.gnome.org/GNOME/gimp-help.git
  git archive - -format=tar - -prefix=${DIRNAME}/ HEAD | xz >../${DIRNAME}.tar.xz -->

  <!-- renodr: I generated the git tarball using the following instructions:
       cd /tmp &&
       mkdir gimp-help &&
       cd gimp-help &&
       git clone https://gitlab.gnome.org/GNOME/gimp-help.git &&
       cd gimp-help &&
       git checkout gimp-help-2-10 &&
       cd .. &&
       rm -rv gimp-help/.git &&
       mv -v gimp-help gimp-help-<DATE>
       tar -cJvf gimp-help-<DATE>.tar.xz gimp-help-<DATE>

       After you've completed this, run a test build, and upload the tarball to
       anduin.
   *** Review after gim3 stable is released.
       -->

  <!ENTITY gimp-help-version   "&gimp-version;">
  <!ENTITY gimp-help-download  "https://anduin.linuxfromscratch.org/BLFS/gimp/gimp3-help-&gimp-help-version;.tar.xz">
  <!ENTITY gimp-help-md5sum    "162d57a67ff737ed221a8d7f274d119f">
  <!ENTITY gimp-help-size      "129 MB">
  <!ENTITY gimp-help-buildsize "From 351 MB (74 MB installed) for en only to 722 MB (1.5 GB installed) for all languages">
  <!ENTITY gimp-help-time      "0.4 SBU (en only); 5.1 SBU for all languages; using parallelism=4">
]>

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

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

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

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

    <para>
      The <application>Gimp</application> package contains
      the GNU Image Manipulation Program which is useful for
      photo retouching, image composition, and image authoring.
    </para>

    <note>
      <para>
        This package is a snapshot of the upcoming stable release of 
        gimp3. It avoids several deprecated dependencies, notably gtk2.
      </para>
    </note>

    &lfs121_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>

    <note>
      <para>
        The help files English version is complete, but large
        parts of the text for many other languages are not yet translated.
      </para>
    </note>

    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&gimp-help-download;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &gimp-help-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &gimp-help-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &gimp-help-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &gimp-help-time;
        </para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="appstream-glib"/>,
      <xref linkend="gegl"/>,
      <xref linkend="gexiv2"/>,
      <xref linkend="glib-networking"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="harfbuzz"/>.
      <xref linkend="libjpeg"/>,
      <xref linkend="libmypaint"/>,
      <xref linkend="librsvg"/>,
      <xref linkend="libtiff"/>,
      <xref linkend="lcms2"/>,
      <xref linkend="mypaint-brushes"/>,
      <xref linkend="poppler"/> (including poppler-data) and 
      <!-- some parts of Xorg appear to be required, as are deps it pulls in -->
      <xref linkend="x-window-system"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="dbus-glib"/>,
      <xref linkend="graphviz"/>,
      <xref linkend="gs"/> (with libgs installed),
      <xref linkend="iso-codes"/>,
      <xref linkend="libgudev"/>, 
      <xref linkend="pygobject3"/>, and
      <xref linkend="xdg-utils"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="aalib"/>,
      <xref linkend="alsa-lib"/>,
      <xref linkend="gjs"/>,
      <xref linkend="gvfs"/> (to access the online help),
      <xref linkend="libmng"/>,
      <xref linkend="libunwind"/>,
      <xref linkend="libjxl"/>,
      <xref linkend="libwebp"/>,
      <xref linkend="lua"/>,
      <xref linkend="openjpeg2"/>,
      <xref linkend="pygtk"/> (including the gtk, pango and pangocairo modules),
      an <xref linkend="server-mail"/> (that provides a
      <command>sendmail</command> program),
      <xref linkend="gtk-doc"/>,
      <ulink url="https://github.com/HEASARC/cfitsio">cfitsio</ulink>,
      <ulink url="https://github.com/phoboslab/qoi">goi</ulink>,
      <ulink url="https://github.com/ianlancetaylor/libbacktrace">libbacktrace</ulink>,
      <ulink url="https://github.com/strukturag/libheif/">libheif</ulink> with
        <ulink url="https://github.com/strukturag/libde265/">libde265</ulink>
        (both needed to read macOS heic images),
      <ulink url="https://github.com/ianlancetaylor/libbacktrace">libbacktrace</ulink>,
      <ulink url="https://github.com/svanderburg/libiff">libiff</ulink>, 
      <ulink url="https://github.com/svanderburg/libilbm">libilbm</ulink>, and
      <ulink url="https://www.openexr.com/">OpenEXR</ulink>
    </para>

    <bridgehead renderas="sect4">Optional, for building the help system</bridgehead>
    <para role="optional">
      <ulink url="https://dblatex.sourceforge.net/">dblatex</ulink> (for PDF docs),
      <ulink url="https://pngnq.sourceforge.net/">pngnq</ulink> and
      <ulink url="https://pmt.sourceforge.net/pngcrush/">pngcrush</ulink>
      to optimize the png files, but see the note on the help download above
    </para>
  </sect2>

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

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

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

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</userinput></screen>


    <para>
      To test the results (requires an X-Windowed terminal) issue:
      <command>ninja test</command>.
      <!-- In 3.0-pre, 2 failures: gimp:app/save-and-export and gimp:app/ui; bdubbs -->
    </para> 

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

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of Gimp-Help</title>

    <para>
      The <filename>gimp-help</filename> tarball contains images and English
      text help for help files, together with translations. 
      If you wish to install local copies of the help files to read
      offline, unpack the <filename>gimp-help</filename> tarball
      and change into the root of the newly created source tree.
    </para>

<screen><userinput>tar -xf ../../gimp3-help-&gimp-help-version;.tar.xz &amp;&amp;
cd gimp3-help-&gimp-help-version;

ALL_LINGUAS=&quot;ca cs da de en en_GB es fa fr hr ko lt nl nn pt pt_BR ro sl sv uk zh_CN&quot; \
./configure --prefix=/usr</userinput></screen>

    <para>
      Remove from <envar>ALL_LINGUAS</envar> the codes for any languages which
      you do not wish to install. Alternatively, remove the line starting with
      <envar>ALL_LINGUAS</envar>, if you wish to build all languages.
    </para>

    <para>
      Now build the help files:
    </para>

<screen><userinput>make</userinput></screen>

    <para>
      Issue the following commands as the &root; user to install the help files:
    </para>

<screen role="root"><userinput>make install &amp;&amp;
chown -R root:root /usr/share/gimp/3.0/help</userinput></screen>


  </sect2>
  <sect2 role="commands" id="gimp-cmd-explanations">
    <title>Command Explanations</title>

    <para>
      <envar>ALL_LINGUAS=&quot;ca cs da de en en_GB es fa...&quot;</envar>: by
      default, the help files will be rendered in all the available languages.
      Remove the codes of any languages you do not wish to build.
    </para>
  </sect2>

  <sect2 role="configuration">
    <title>Configuring The Gimp</title>

    <sect3 id="gimp-config">
      <title>Config Files</title>

      <para>
        <filename>/etc/gimp/3.0/*</filename> 
      </para>

      <indexterm zone="gimp gimp-config">
        <primary sortas="e-etc-gimp-3.0-star">/etc/gimp/3.0/*</primary>
      </indexterm>
    </sect3>
  </sect2>

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

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

      <seglistitem>
        <seg>
          gimp-2.99,
          gimp-console-2.99,
          gimptool-2.99, 
          gimp-test-clipboard-2.99, and
          gimp-script-fu-interpreter-3.0
        </seg>
        <seg>
          libgimp-3.0.so, 
          libgimp-scriptfu-3.0,
          libgimpbase-3.0.so, 
          libgimpcolor-3.0.so,
          libgimpconfig-3.0.so, 
          libgimpmath-3.0.so, 
          libgimpmodule-3.0.so,
          libgimpui-3.0.so, and 
          libgimpwidgets-3.0.so
        </seg>
        <seg>
          /etc/gimp,
          /usr/include/gimp-3.0,
          /usr/lib/gimp/3.0,
          /usr/share/gimp/3.0, and
          /usr/share/doc/gimp-2.99
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>
<!--
      <varlistentry id="gimp-prog">
        <term><command>gimp</command></term>
        <listitem>
          <para>
            is a symbolic link to <command>gimp-2.10</command>
          </para>
          <indexterm zone="gimp gimp-prog">
            <primary sortas="b-gimp">gimp</primary>
          </indexterm>
        </listitem>
      </varlistentry>
-->
      <varlistentry id="gimp-2.99">
        <term><command>gimp-2.99</command></term>
        <listitem>
          <para>
            is the Gnu Image Manipulation Program. It works with a variety
            of image formats and provides a large selection of tools
          </para>
          <indexterm zone="gimp gimp-2.99">
            <primary sortas="b-gimp-2.99">gimp-2.99</primary>
          </indexterm>
        </listitem>
      </varlistentry>
<!--
      <varlistentry id="gimp-console">
        <term><command>gimp-console</command></term>
        <listitem>
          <para>
            is a symbolic link to <command>gimp-console-2.10</command>
          </para>
          <indexterm zone="gimp gimp-console">
            <primary sortas="b-gimp-console">gimp-console</primary>
          </indexterm>
        </listitem>
      </varlistentry>
-->
      <varlistentry id="gimp-console-2.99">
        <term><command>gimp-console-2.10</command></term>
        <listitem>
          <para>
            is a console program that behaves as if The
            <application>Gimp</application> was called with the
            <option>- -no-interface</option> command-line option
          </para>
          <indexterm zone="gimp gimp-console-2.99">
            <primary sortas="b-gimp-console-2.99">gimp-console-2.99</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gimptool-2.99">
        <term><command>gimptool-2.99</command></term>
        <listitem>
          <para>
            is a tool that can build plug-ins or scripts and install them
            if they are distributed in one source file.
            <command>gimptool-2.99</command> can also be used by programs that
            need to know what libraries and include-paths used when 
            <application>gimp</application> was compiled
          </para>
          <indexterm zone="gimp gimptool-2.99">
            <primary sortas="b-gimptool-2.99">gimptool-2.99</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgimp-3.0">
        <term><filename class="libraryfile">libgimp-3.0.so</filename></term>
        <listitem>
          <para>
            provides C bindings for The <application>Gimp</application>'s
            Procedural Database (PDB) which offers an interface to core functions
            and to functionality provided by plug-ins
          </para>
          <indexterm zone="gimp libgimp-3.0">
            <primary sortas="c-libgimp-3.0">libgimp-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgimpbase-3.0">
        <term><filename class="libraryfile">libgimpbase-3.0.so</filename></term>
        <listitem>
          <para>
            provides the C functions for basic
            <application>Gimp</application> functionality such as determining
            enumeration data types, gettext translation, determining The
            <application>Gimp</application>'s version number and capabilities,
            handling data files and accessing the environment
          </para>
          <indexterm zone="gimp libgimpbase-3.0">
            <primary sortas="c-libgimpbase-3.0">libgimpbase-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgimpcolor-3.0">
        <term><filename class="libraryfile">libgimpcolor-3.0.so</filename></term>
        <listitem>
          <para>
            provides the C functions relating to RGB, HSV and CMYK colors as
            well as converting colors between different color models and
            performing adaptive supersampling on an area
          </para>
          <indexterm zone="gimp libgimpcolor-3.0">
            <primary sortas="c-libgimpcolor-3.0">libgimpcolor-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgimpconfig-3.0">
        <term><filename class="libraryfile">libgimpconfig-3.0.so</filename></term>
        <listitem>
          <para>
            contains C functions for reading and writing config information
          </para>
          <indexterm zone="gimp libgimpconfig-3.0">
            <primary sortas="c-libgimpconfig-3.0">libgimpconfig-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgimpmath-3.0">
        <term><filename class="libraryfile">libgimpmath-3.0.so</filename></term>
        <listitem>
          <para>
            contains C functions which provide mathematical definitions and
            macros, manipulate 3x3 transformation matrices, set up and manipulate
            vectors and the MD5 message-digest algorithm
          </para>
          <indexterm zone="gimp libgimpmath-3.0">
            <primary sortas="c-libgimpmath-3.0">libgimpmath-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgimpmodule-3.0">
        <term><filename class="libraryfile">libgimpmodule-3.0.so</filename></term>
        <listitem>
          <para>
            provides the C functions which implement module loading using
            GModule and supports keeping a list of GimpModule's found in a given
            searchpath
          </para>
          <indexterm zone="gimp libgimpmodule-3.0">
            <primary sortas="c-libgimpmodule-3.0">libgimpmodule-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgimpthumb-3.0">
        <term><filename class="libraryfile">libgimpthumb-3.0.so</filename></term>
        <listitem>
          <para>
            provides the C functions for handling The
            <application>Gimp</application>'s thumbnail objects
          </para>
          <indexterm zone="gimp libgimpthumb-3.0">
            <primary sortas="c-libgimpthumb-3.0">libgimpthumb-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgimpui-3.0">
        <term><filename class="libraryfile">libgimpui-3.0.so</filename></term>
        <listitem>
          <para>
            contains The <application>Gimp</application>'s common user
            interface functions
          </para>
          <indexterm zone="gimp libgimpui-3.0">
            <primary sortas="c-libgimpui-3.0">libgimpui-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgimpwidgets-3.0">
        <term><filename class="libraryfile">libgimpwidgets-3.0.so</filename></term>
        <listitem>
          <para>
            contains The <application>Gimp</application>
            and <application>GTK</application>'s widget creation and
            manipulation functions
          </para>
          <indexterm zone="gimp libgimpwidgets-3.0">
            <primary sortas="c-libgimpwidgets-3.0">libgimpwidgets-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>
</sect1>