source: xsoft/other/gimp.xml@ b06f0080

<?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 gimp-download-http "http://www.mirrorservice.org/sites/ftp.gimp.org/pub/gimp/v2.8/gimp-&gimp-version;.tar.bz2">
  <!ENTITY gimp-download-ftp  "ftp://ftp.gimp.org/pub/gimp/v2.8/gimp-&gimp-version;.tar.bz2">
  <!ENTITY gimp-md5sum        "28997d14055f15db063eb92e1c8a7ebb">
  <!ENTITY gimp-size          "20 MB">
  <!ENTITY gimp-buildsize     "607 MB (additonal 579 MB to run the test suite, additional 78 MB to install help files)">
  <!ENTITY gimp-time          "4.9 SBU (additional 0.9 SBU to run the test suite)">

  <!ENTITY gimp-help-version  "2.6.0-html-en">
  <!ENTITY gimp-help-download "ftp://gimp.org/pub/gimp/help/gimp-help-&gimp-help-version;.tar.bz2">
  <!ENTITY gimp-help-md5sum   "81da262343316835ebdd3354ce8eab4f">
  <!ENTITY gimp-help-size     "28 MB">
]>

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

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

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

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

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

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

    &lfs71_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>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Optional help files: <ulink url="&gimp-help-download;"/> or one
        of the other available languages - see <ulink
        url="http://www.gimp.org/docs">gimp.org</ulink> for details.</para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &gimp-help-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &gimp-help-size;</para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="fontconfig"/>,
    <xref linkend="gegl"/>,
    <xref linkend="intltool"/>,
    <xref linkend="gtk2"/></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="libpng"/>,
    <xref linkend="libjpeg"/>,
    <xref linkend="libtiff"/> and
    <xref linkend="pygtk"/> (including the gtk and pango modules).</para>

    <note>
      <para>If the recommended dependencies are not installed, the
      <command>configure</command> switches below will need to be modified as
      explained in <xref linkend="gimp-cmd-explanations"/> below.</para>
    </note>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="aalib"/>,
    <xref linkend="alsa-lib"/>,
    <xref linkend="curl"/>,
    <xref linkend="dbus-glib"/>,
    <xref linkend="iso-codes"/>,
    <xref linkend="lcms"/>,
    <xref linkend="libexif"/>,
    <xref linkend="librsvg"/>,
    <ulink url="http://wvware.sourceforge.net/libwmf.html">libwmf</ulink>,
    <xref linkend="poppler"/>,
    an <xref linkend="server-mail"/> (that provides a
    <command>sendmail</command> program),
    <xref linkend="webkitgtk"/> (this must be compiled with the
    <application>gtk+-2</application> backend for the
    <application>Gimp</application> to use it to create its help browser)
    and <xref linkend="gtk-doc"/></para>

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

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

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

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc --without-gvfs &amp;&amp;
make</userinput></screen>

    <para>To test the results, from an xterm or similar, 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>

    <para>The <filename>gimp-help</filename> tarball contains preformatted HTML
    for use with external web browsers, the internal
    <application>Gimp</application> help browser, and HTML renderers. Some of
    the details have changed in <application>gimp-2.8</application>, but much of
    this is still relevant. Please also consult
    <ulink url="http://www.gimp.org/release-notes/gimp-2.8.html"/>.</para>

    <para>If you downloaded the <filename>gimp-help</filename> tarball, unpack
    it and change into the root of the newly created source tree. Issue the
    following commands as the <systemitem class="username">root</systemitem>
    user to install the help files:</para>

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

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

    <para><parameter>--without-gvfs</parameter>: the choice of the backend to
    handle URI information, e.g. when dragging images from a browser into the
    <application>gimp</application>, is made at compile time.  This parameter will
    ensure that <application>curl</application> is used at run-time, instead of
    <application>gvfs</application>.  You can omit this if you are installing
    <application>gvfs</application> AND will be running <command>gvfsd</command>,
    e.g. in a <application>GNOME</application> desktop.</para>

    <para><option>--without-libpng</option>: This option is necessary if
    <application>libpng</application> is not installed.</para>

    <para><option>--without-libjpeg</option>: This option is necessary if
    <application>libjpeg</application> is not installed.</para>

    <para><option>--without-libtiff</option>: This option is necessary if
    <application>libtiff</application> is not installed.</para>

    <para><option>--disable-python</option>: This option is necessary if
    you have not installed <application>pygtk</application>.</para>

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

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

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

      <para><filename>/etc/gimp/2.0/*</filename> and
      <filename>~/.gimp-2.8/gimprc</filename></para>

      <indexterm zone="gimp gimp-config">
        <primary sortas="e-AA.gimp-2.0/gimprc">~/.gimp-2.0/gimprc</primary>
      </indexterm>

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

    <sect3>
      <title>Configuration Information</title>

      <para>The <application>Gimp</application> executes a configuration wizard
      for each user upon their initial use of the program.</para>

      <para>The <application>Gimp</application> executes the
      <command>firefox</command> web browser by default to view the help
      files.  If you do not have <application>firefox</application>, or
      prefer a different web browser, you can set a new system value in
      <filename>/etc/gimp/2.0/gimprc</filename>.  Execute the following
      command as the <systemitem class="username">root</systemitem> user,
      replacing <replaceable>&lt;browser&gt;</replaceable> with your
      preferred web browser:</para>

<screen role="root"><userinput>echo '(web-browser "<replaceable>&lt;browser&gt;</replaceable> %s")' &gt;&gt; /etc/gimp/2.0/gimprc</userinput></screen>
    </sect3>
  </sect2>

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

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

      <seglistitem>
        <seg>gimp, gimp-2.8, gimp-console, gimp-console-2.8,
        and gimptool-2.0</seg>
        <seg>libgimp-2.0.so, libgimpbase-2.0.so, libgimpcolor-2.0.so,
        libgimpconfig-2.0.so, libgimpmath-2.0.so, libgimpmodule-2.0.so,
        libgimpthumb-2.0.so, libgimpui-2.0.so, libgimpwidgets-2.0.so, and many
        other modules and plugin libraries</seg>
        <seg>/etc/gimp, /usr/include/gimp-2.0, /usr/lib/gimp,
        /usr/share/gimp and
        /usr/share/gtk-doc/html/libgimp{,base,color,config,math,module,thumb,widgets}</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.8</command>.</para>
          <indexterm zone="gimp gimp-prog">
            <primary sortas="g-gimp">gimp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gimp-2.8">
        <term><command>gimp-2.8</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.8">
            <primary sortas="b-gimp-2.8">gimp-2.8</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.8</command>.</para>
          <indexterm zone="gimp gimp-console">
            <primary sortas="g-gimp-console">gimp-console</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gimp-console-2.8">
        <term><command>gimp-console-2.8</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.8">
            <primary sortas="b-gimp-console-2.8">gimp-console-2.8</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gimptool-2.0">
        <term><command>gimptool-2.0</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.0</command> can also be used by programs that
          need to know what libraries and include-paths The
          <application>Gimp</application> was compiled with.</para>
          <indexterm zone="gimp gimptool-2.0">
            <primary sortas="b-gimptool-2.0">gimptool-2.0</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgimp-2.0">
        <term><filename class="libraryfile">libgimp-2.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-2.0">
            <primary sortas="c-libgimp-2.0">libgimp-2.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgimpbase-2.0">
        <term><filename class="libraryfile">libgimpbase-2.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-2.0">
            <primary sortas="c-libgimpbase-2.0">libgimpbase-2.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgimpcolor-2.0">
        <term><filename
        class="libraryfile">libgimpcolor-2.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-2.0">
            <primary sortas="c-libgimpcolor-2.0">libgimpcolor-2.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

      <varlistentry id="libgimpmath-2.0">
        <term><filename class="libraryfile">libgimpmath-2.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-2.0">
            <primary sortas="c-libgimpmath-2.0">libgimpmath-2.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

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

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

      <varlistentry id="libgimpwidgets-2.0">
        <term><filename
        class="libraryfile">libgimpwidgets-2.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-2.0">
            <primary
            sortas="c-libgimpwidgets-2.0">libgimpwidgets-2.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>