source: xsoft/other/gimp.xml

trunk
Last change on this file was e8b3f50, checked in by Douglas R. Reno <renodr@…>, 2 months ago

Tags

  • Property mode set to 100644
File size: 19.5 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY gimp-download-http "https://download.gimp.org/pub/gimp/v2.10/gimp-&gimp-version;.tar.bz2">
8 <!ENTITY gimp-download-ftp " ">
9 <!ENTITY gimp-md5sum "e44e1c91b09db8fcdc9ef5797ce11b77">
10 <!ENTITY gimp-size "30 MB">
11 <!ENTITY gimp-buildsize "882 MB (197 MB installed, add 835 MB for tests)">
12 <!ENTITY gimp-time "2.3 SBU (Using parallelism=4; add 0.7 SBU for tests)">
13
14 <!-- pro-tem, a pull of gimp-help, https://gitlab.gnome.org/GNOME/gimp-help.git
15 git archive - -format=tar - -prefix=${DIRNAME}/ HEAD | xz >../${DIRNAME}.tar.xz -->
16
17 <!-- renodr: I generated the git tarball using the following instructions:
18 cd /tmp &&
19 mkdir gimp-help &&
20 cd gimp-help &&
21 git clone https://gitlab.gnome.org/GNOME/gimp-help.git &&
22 cd gimp-help &&
23 git checkout gimp-help-2-10 &&
24 cd .. &&
25 rm -rv gimp-help/.git &&
26 mv -v gimp-help gimp-help-<DATE>
27 tar -cJvf gimp-help-<DATE>.tar.xz gimp-help-<DATE>
28
29 After you've completed this, run a test build, and upload the tarball to
30 anduin.-->
31
32 <!ENTITY gimp-help-version "&gimp-version;">
33<!-- <!ENTITY gimp-help-download "&sources-anduin-http;/gimp/gimp-help-&gimp-help-version;.tar.xz"> -->
34 <!ENTITY gimp-help-download "https://download.gimp.org/pub/gimp/help/gimp-help-&gimp-help-version;.tar.bz2">
35 <!ENTITY gimp-help-md5sum "5e393d61c802e73ffe6c550759ed0853">
36 <!ENTITY gimp-help-size "158 MB">
37 <!ENTITY gimp-help-buildsize "From 412 MB (en only) to 1.8 GB (for all
38 languages)">
39 <!ENTITY gimp-help-time "2.1 SBU (en only), 13 SBU, with parallelism=4,
40 for all languages">
41]>
42
43<sect1 id="gimp" xreflabel="Gimp-&gimp-version;">
44 <?dbhtml filename="gimp.html" ?>
45
46
47 <title>Gimp-&gimp-version;</title>
48
49 <indexterm zone="gimp">
50 <primary sortas="a-Gimp">Gimp</primary>
51 </indexterm>
52
53 <sect2 role="package">
54 <title>Introduction to Gimp</title>
55
56 <para>
57 The <application>Gimp</application> package contains
58 the GNU Image Manipulation Program which is useful for
59 photo retouching, image composition and image authoring.
60 </para>
61
62 &lfs121_checked;
63
64 <bridgehead renderas="sect3">Package Information</bridgehead>
65 <itemizedlist spacing="compact">
66 <listitem>
67 <para>
68 Download (HTTP): <ulink url="&gimp-download-http;"/>
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Download (FTP): <ulink url="&gimp-download-ftp;"/>
74 </para>
75 </listitem>
76 <listitem>
77 <para>
78 Download MD5 sum: &gimp-md5sum;
79 </para>
80 </listitem>
81 <listitem>
82 <para>
83 Download size: &gimp-size;
84 </para>
85 </listitem>
86 <listitem>
87 <para>
88 Estimated disk space required: &gimp-buildsize;
89 </para>
90 </listitem>
91 <listitem>
92 <para>
93 Estimated build time: &gimp-time;
94 </para>
95 </listitem>
96 </itemizedlist>
97
98 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
99<!--
100 <note>
101 <para>
102 The creation of local html files with recent versions of the necessary
103 packages is somewhat broken (some png images are not sourced by the
104 generated HTML, only their captions are visible).
105 </para>
106 </note>
107-->
108 <note>
109 <para>
110 The help files English version is complete, but large
111 parts of the text for many other languages are not yet translated.
112 </para>
113 </note>
114
115
116 <itemizedlist spacing="compact">
117 <listitem>
118 <para>
119 Download (HTTP): <ulink url="&gimp-help-download;"/>
120 </para>
121 </listitem>
122 <listitem>
123 <para>
124 Download size: &gimp-help-size;
125 </para>
126 </listitem>
127 <listitem>
128 <para>
129 Download MD5 sum: &gimp-help-md5sum;
130 </para>
131 </listitem>
132 <listitem>
133 <para>
134 Estimated disk space required: &gimp-help-buildsize;
135 </para>
136 </listitem>
137 <listitem>
138 <para>
139 Estimated build time: &gimp-help-time;
140 </para>
141 </listitem>
142 </itemizedlist>
143
144 <bridgehead renderas="sect3">Gimp Dependencies</bridgehead>
145
146 <bridgehead renderas="sect4">Required</bridgehead>
147 <para role="required">
148 <xref linkend="gegl"/>,
149 <xref linkend="gexiv2"/>,
150 <xref linkend="glib-networking"/>,
151 <xref linkend="gtk2"/>,
152 <xref linkend="harfbuzz"/>.
153 <xref linkend="libjpeg"/>,
154 <xref linkend="libmypaint"/>,
155 <xref linkend="librsvg"/>,
156 <xref linkend="libtiff"/>,
157 <!-- en can be built without this -->
158 <xref linkend="libxml2"/> (to build the translated help files),
159 <xref linkend="lcms2"/>,
160 <xref linkend="mypaint-brushes"/>,
161 <xref linkend="poppler"/> (including poppler-data) and
162 <!-- some parts of Xorg appear to be required, as are deps it pulls in -->
163 <xref linkend="x-window-system"/>
164 </para>
165
166 <bridgehead renderas="sect4">Recommended</bridgehead>
167 <para role="recommended">
168 <xref linkend="dbus-glib"/>,
169 <xref linkend="graphviz"/>,
170 <xref linkend="gs"/> (with libgs installed),
171 <xref linkend="iso-codes"/>,
172 <xref linkend="libgudev"/>,
173 <xref linkend="pygtk"/> (including the gtk, pango and pangocairo modules) and
174 <xref linkend="xdg-utils"/>
175 </para>
176
177 <bridgehead renderas="sect4">Optional</bridgehead>
178 <para role="optional">
179 <xref linkend="aalib"/>,
180 <xref linkend="alsa-lib"/>,
181 <xref linkend="gvfs"/> (to access the online help),
182 <xref linkend="libmng"/>,
183 <xref linkend="libunwind"/>,
184 <xref linkend="libwebp"/>,
185 <xref linkend="openjpeg2"/>,
186 an <xref linkend="server-mail"/> (that provides a
187 <command>sendmail</command> program),
188 <xref linkend="gtk-doc"/>,
189 <ulink url="https://people.freedesktop.org/~hughsient/appstream-glib">appstream-glib</ulink>,
190 <ulink url="https://github.com/ianlancetaylor/libbacktrace">libbacktrace</ulink>,
191 <ulink url="https://github.com/strukturag/libheif/">libheif</ulink> with
192 <ulink url="https://github.com/strukturag/libde265/">libde265</ulink>
193 (both needed to read macOS heic images),
194 <ulink url="https://wvware.sourceforge.net/libwmf.html">libwmf</ulink>, and
195 <ulink url="https://www.openexr.com/">OpenEXR</ulink>
196 </para>
197
198 <para>
199 When you have run configure, you will see that WebKit is not found -
200 that dependency is for the legacy webkit-1.0 which should never be used
201 on a modern system exposed to the internet.
202 </para>
203
204 <bridgehead renderas="sect4">Optional, for building the help system</bridgehead>
205 <para role="optional">
206 <ulink url="https://dblatex.sourceforge.net/">dblatex</ulink> (for PDF docs),
207 <ulink url="https://pngnq.sourceforge.net/">pngnq</ulink> and
208 <ulink url="https://pmt.sourceforge.net/pngcrush/">pngcrush</ulink>
209 to optimize the png files, but see the note on the help download above
210 </para>
211
212 <para condition="html" role="usernotes">Editor Notes:
213 <ulink url="&blfs-wiki;/gimp"/>
214 </para>
215 </sect2>
216
217 <sect2 role="installation">
218 <title>Installation of Gimp</title>
219
220 <para>
221 Install <application>Gimp</application> by running
222 the following commands:
223 </para>
224
225<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
226make</userinput></screen>
227
228 <para>
229 To test the results (requires an X-Windowed terminal) issue:
230 <command>make check</command>.
231 <!-- km: in 2.10.16 no failures, 2 tests were skipped -->
232
233 </para>
234
235 <para>
236 Now, as the <systemitem class="username">root</systemitem>
237 user:
238 </para>
239
240<screen role="root"><userinput>make install</userinput></screen>
241
242 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
243 href="../../xincludes/update-icons-and-desktop.xml"/>
244
245 </sect2>
246
247 <sect2 role="installation">
248 <title>Installation of Gimp-Help</title>
249
250 <para>
251 The <filename>gimp-help</filename> tarball contains images and English
252 text help for help files, together with translations. <!--
253 The documentation generated by gimp-help-2.10.34 and online help have
254 the same contents, so I comment this out. [pierre Nov. 2023]
255 Because of the
256 issues mentioned in the note above, you are recommended to use the online
257 help, either by building against <xref linkend="gvfs"/> so that 'help'
258 can open the latest XML files in your browser, or else you can manually
259 open the html in your browser by going to <ulink
260 url="https://docs.gimp.org/2.10/en/">https://docs.gimp.org/2.10/en</ulink>
261 (change the language code if desired).-->
262 </para>
263
264 <para>
265 <!-- If you nevertheless wish to install local copies of the help files to read
266 offline, u-->Unpack the <filename>gimp-help</filename> tarball
267 and change into the root of the newly created source tree. Prepare for
268 the build with the following command:
269 </para>
270
271<screen><userinput>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; \
272./configure --prefix=/usr</userinput></screen>
273
274 <para>
275 Remove from <envar>ALL_LINGUAS</envar> the codes for any languages which
276 you do not wish to install. Alternatively, remove the line starting with
277 <envar>ALL_LINGUAS</envar>, if you wish to build all languages.
278 </para>
279
280 <para>
281 Now build the help files:
282 </para>
283
284<screen><userinput>make</userinput></screen>
285
286 <para>
287 Issue the following commands as the
288 <systemitem class="username">root</systemitem> user to install the help
289 files:
290 </para>
291
292<screen role="root"><userinput>make install &amp;&amp;
293chown -R root:root /usr/share/gimp/2.0/help</userinput></screen>
294
295 </sect2>
296
297 <sect2 role="commands" id="gimp-cmd-explanations">
298 <title>Command Explanations</title>
299
300 <para>
301 <envar>ALL_LINGUAS=&quot;ca cs da de en en_GB es fa...&quot;</envar>: by
302 default, the help files will be rendered in all the available languages.
303 Remove the codes of any languages you do not wish to build.
304 </para>
305
306 <para>
307 <option>--disable-python</option>: This option is necessary if
308 you have not installed <application>PyGTK</application>.
309 </para>
310
311 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
312 href="../../xincludes/gtk-doc-rebuild.xml"/>
313
314 </sect2>
315
316 <sect2 role="configuration">
317 <title>Configuring The Gimp</title>
318
319 <sect3 id="gimp-config">
320 <title>Config Files</title>
321
322 <para>
323 <filename>/etc/gimp/2.0/*</filename> and
324 <filename>~/.gimp-2.8/gimprc</filename>
325 </para>
326
327 <indexterm zone="gimp gimp-config">
328 <primary sortas="e-AA.gimp-2.0/gimprc">~/.g/GIMP/2.10/*</primary>
329 </indexterm>
330
331 <indexterm zone="gimp gimp-config">
332 <primary sortas="e-etc-gimp-2.0-star">/etc/gimp/2.0/*</primary>
333 </indexterm>
334
335 </sect3>
336
337 </sect2>
338
339 <sect2 role="content">
340 <title>Contents</title>
341
342 <segmentedlist>
343 <segtitle>Installed Programs</segtitle>
344 <segtitle>Installed Libraries</segtitle>
345 <segtitle>Installed Directories</segtitle>
346
347 <seglistitem>
348 <seg>
349 gimp (symlink), gimp-2.10,
350 gimp-console (symlink), gimp-console-2.10,
351 gimp-test-clipboard-2.0, and
352 gimptool-2.0
353 </seg>
354 <seg>
355 libgimp-2.0.so, libgimpbase-2.0.so, libgimpcolor-2.0.so,
356 libgimpconfig-2.0.so, libgimpmath-2.0.so, libgimpmodule-2.0.so,
357 libgimpthumb-2.0.so, libgimpui-2.0.so, and libgimpwidgets-2.0.so
358 </seg>
359 <seg>
360 /etc/gimp,
361 /usr/include/gimp-2.0,
362 /usr/{lib,share}/gimp,
363 /usr/share/gtk-doc/html/libgimp{,base,color,config}, and
364 /usr/share/gtk-doc/html/libgimp{math,module,thumb,widgets}
365 </seg>
366 </seglistitem>
367 </segmentedlist>
368
369 <variablelist>
370 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
371 <?dbfo list-presentation="list"?>
372 <?dbhtml list-presentation="table"?>
373
374 <varlistentry id="gimp-prog">
375 <term><command>gimp</command></term>
376 <listitem>
377 <para>
378 is a symbolic link to <command>gimp-2.10</command>
379 </para>
380 <indexterm zone="gimp gimp-prog">
381 <primary sortas="b-gimp">gimp</primary>
382 </indexterm>
383 </listitem>
384 </varlistentry>
385
386 <varlistentry id="gimp-2.10">
387 <term><command>gimp-2.10</command></term>
388 <listitem>
389 <para>
390 is the Gnu Image Manipulation Program. It works with a variety
391 of image formats and provides a large selection of tools
392 </para>
393 <indexterm zone="gimp gimp-2.10">
394 <primary sortas="b-gimp-2.10">gimp-2.10</primary>
395 </indexterm>
396 </listitem>
397 </varlistentry>
398
399 <varlistentry id="gimp-console">
400 <term><command>gimp-console</command></term>
401 <listitem>
402 <para>
403 is a symbolic link to <command>gimp-console-2.10</command>
404 </para>
405 <indexterm zone="gimp gimp-console">
406 <primary sortas="b-gimp-console">gimp-console</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410
411 <varlistentry id="gimp-console-2.10">
412 <term><command>gimp-console-2.10</command></term>
413 <listitem>
414 <para>
415 is a console program that behaves as if The
416 <application>Gimp</application> was called with the
417 <option>--no-interface</option> command-line option
418 </para>
419 <indexterm zone="gimp gimp-console-2.10">
420 <primary sortas="b-gimp-console-2.10">gimp-console-2.10</primary>
421 </indexterm>
422 </listitem>
423 </varlistentry>
424
425 <varlistentry id="gimptool-2.0">
426 <term><command>gimptool-2.0</command></term>
427 <listitem>
428 <para>
429 is a tool that can build plug-ins or scripts and install them
430 if they are distributed in one source file.
431 <command>gimptool-2.0</command> can also be used by programs that
432 need to know what libraries and include-paths The
433 <application>Gimp</application> was compiled with
434 </para>
435 <indexterm zone="gimp gimptool-2.0">
436 <primary sortas="b-gimptool-2.0">gimptool-2.0</primary>
437 </indexterm>
438 </listitem>
439 </varlistentry>
440
441 <varlistentry id="libgimp-2.0">
442 <term><filename class="libraryfile">libgimp-2.0.so</filename></term>
443 <listitem>
444 <para>
445 provides C bindings for The <application>Gimp</application>'s
446 Procedural Database (PDB) which offers an interface to core functions
447 and to functionality provided by plug-ins
448 </para>
449 <indexterm zone="gimp libgimp-2.0">
450 <primary sortas="c-libgimp-2.0">libgimp-2.0.so</primary>
451 </indexterm>
452 </listitem>
453 </varlistentry>
454
455 <varlistentry id="libgimpbase-2.0">
456 <term><filename class="libraryfile">libgimpbase-2.0.so</filename></term>
457 <listitem>
458 <para>
459 provides the C functions for basic
460 <application>Gimp</application> functionality such as determining
461 enumeration data types, gettext translation, determining The
462 <application>Gimp</application>'s version number and capabilities,
463 handling data files and accessing the environment
464 </para>
465 <indexterm zone="gimp libgimpbase-2.0">
466 <primary sortas="c-libgimpbase-2.0">libgimpbase-2.0.so</primary>
467 </indexterm>
468 </listitem>
469 </varlistentry>
470
471 <varlistentry id="libgimpcolor-2.0">
472 <term><filename class="libraryfile">libgimpcolor-2.0.so</filename></term>
473 <listitem>
474 <para>
475 provides the C functions relating to RGB, HSV and CMYK colors as
476 well as converting colors between different color models and
477 performing adaptive supersampling on an area
478 </para>
479 <indexterm zone="gimp libgimpcolor-2.0">
480 <primary sortas="c-libgimpcolor-2.0">libgimpcolor-2.0.so</primary>
481 </indexterm>
482 </listitem>
483 </varlistentry>
484
485 <varlistentry id="libgimpconfig-2.0">
486 <term><filename class="libraryfile">libgimpconfig-2.0.so</filename></term>
487 <listitem>
488 <para>
489 contains C functions for reading and writing config information
490 </para>
491 <indexterm zone="gimp libgimpconfig-2.0">
492 <primary sortas="c-libgimpconfig-2.0">libgimpconfig-2.0.so</primary>
493 </indexterm>
494 </listitem>
495 </varlistentry>
496
497 <varlistentry id="libgimpmath-2.0">
498 <term><filename class="libraryfile">libgimpmath-2.0.so</filename></term>
499 <listitem>
500 <para>
501 contains C functions which provide mathematical definitions and
502 macros, manipulate 3x3 transformation matrices, set up and manipulate
503 vectors and the MD5 message-digest algorithm
504 </para>
505 <indexterm zone="gimp libgimpmath-2.0">
506 <primary sortas="c-libgimpmath-2.0">libgimpmath-2.0.so</primary>
507 </indexterm>
508 </listitem>
509 </varlistentry>
510
511 <varlistentry id="libgimpmodule-2.0">
512 <term><filename class="libraryfile">libgimpmodule-2.0.so</filename></term>
513 <listitem>
514 <para>
515 provides the C functions which implement module loading using
516 GModule and supports keeping a list of GimpModule's found in a given
517 searchpath
518 </para>
519 <indexterm zone="gimp libgimpmodule-2.0">
520 <primary sortas="c-libgimpmodule-2.0">libgimpmodule-2.0.so</primary>
521 </indexterm>
522 </listitem>
523 </varlistentry>
524
525 <varlistentry id="libgimpthumb-2.0">
526 <term><filename class="libraryfile">libgimpthumb-2.0.so</filename></term>
527 <listitem>
528 <para>
529 provides the C functions for handling The
530 <application>Gimp</application>'s thumbnail objects
531 </para>
532 <indexterm zone="gimp libgimpthumb-2.0">
533 <primary sortas="c-libgimpthumb-2.0">libgimpthumb-2.0.so</primary>
534 </indexterm>
535 </listitem>
536 </varlistentry>
537
538 <varlistentry id="libgimpui-2.0">
539 <term><filename class="libraryfile">libgimpui-2.0.so</filename></term>
540 <listitem>
541 <para>
542 contains The <application>Gimp</application>'s common user
543 interface functions
544 </para>
545 <indexterm zone="gimp libgimpui-2.0">
546 <primary sortas="c-libgimpui-2.0">libgimpui-2.0.so</primary>
547 </indexterm>
548 </listitem>
549 </varlistentry>
550
551 <varlistentry id="libgimpwidgets-2.0">
552 <term><filename class="libraryfile">libgimpwidgets-2.0.so</filename></term>
553 <listitem>
554 <para>
555 contains The <application>Gimp</application>
556 and <application>GTK</application>'s widget creation and
557 manipulation functions
558 </para>
559 <indexterm zone="gimp libgimpwidgets-2.0">
560 <primary sortas="c-libgimpwidgets-2.0">libgimpwidgets-2.0.so</primary>
561 </indexterm>
562 </listitem>
563 </varlistentry>
564
565 </variablelist>
566
567 </sect2>
568
569</sect1>
Note: See TracBrowser for help on using the repository browser.