INSTALL.in 20.9 KB
Newer Older
1
--------------------------------------
2
Installation instructions for GIMP @GIMP_APP_VERSION@
3
--------------------------------------
4

5
There are some basic steps to building and installing GIMP.
6

7
GIMP @GIMP_APP_VERSION@ replaces earlier GIMP 2.x versions. It is advised that you
8
uninstall them before installing GIMP @GIMP_APP_VERSION@. If you want to keep your
9
older GIMP 2.x installation in parallel to GIMP @GIMP_APP_VERSION@, you have to
Sven Neumann's avatar
Sven Neumann committed
10 11
choose a separate prefix which is not in your default library search
path.
12

13
GIMP @GIMP_APP_VERSION@ is fully backward compatible to all earlier GIMP 2.x version.
14
Plug-ins and scripts written for GIMP 2.6 or earlier GIMP 2.x versions
15
will continue to work and don't need to be changed nor recompiled to
16
be used with GIMP @GIMP_APP_VERSION@.
17

18 19 20 21
The most important part is to make sure the requirements for a build
are fulfilled.  We depend on a number of tools and libraries which are
listed below. For libraries this means you need to also have the
header files installed.
22

Sven Neumann's avatar
Sven Neumann committed
23

24 25 26 27 28 29 30
  ******************************************************************
  * Unless you are experienced with building software from source, *
  * you should not attempt to build all these libraries yourself!  *
  * We suggest that you check if your distributor has development  *
  * packages of them and use these instead.                        *
  ******************************************************************

Sven Neumann's avatar
Sven Neumann committed
31

32
  1. You need to have installed a recent version of pkg-config available
Sven Neumann's avatar
Sven Neumann committed
33
     from http://www.freedesktop.org/software/pkgconfig/.
34

35
  2. You need intltool (at least @INTLTOOL_REQUIRED_VERSION@, but preferably a newer version).
36
     Intltool can be downloaded from
Sven Neumann's avatar
Sven Neumann committed
37
     http://ftp.gnome.org/pub/gnome/sources/intltool/
38

39 40
  3. You need to have GEGL version @GEGL_REQUIRED_VERSION@ or newer and babl version
     @BABL_REQUIRED_VERSION@ or newer. You can get them from http://gegl.org/ or clone
41
     them from the GNOME git repository:
42

43 44
       git://git.gnome.org/babl
       git://git.gnome.org/gegl
Sven Neumann's avatar
Sven Neumann committed
45

46 47 48
  4. You need to have installed GTK+ version @GTK_REQUIRED_VERSION@ or newer.
     GIMP also need a recent versions of GLib (>= @GLIB_REQUIRED_VERSION@), GDK-Pixbuf
     (>= @GDK_PIXBUF_REQUIRED_VERSION@), and Pango (>= @PANGOCAIRO_REQUIRED_VERSION@). Sources for these can be grabbed
49
     from ftp://ftp.gtk.org/.
50

51
  5. We use cairo >= @CAIRO_REQUIRED_VERSION@, which is hosted at
52
     http://www.cairographics.org/.
Sven Neumann's avatar
Sven Neumann committed
53 54 55

  6. We require PangoCairo, a Pango backend using Cairo. Make sure you
     have Cairo, FreeType2 and fontconfig installed before you compile
56 57
     Pango. GIMP depends on freetype2 being newer than version @FREETYPE2_REQUIRED_VERSION@
     and fontconfig @FONTCONFIG_REQUIRED_VERSION@ or newer. Older versions are known to have
Sven Neumann's avatar
Sven Neumann committed
58
     bugs that seriously affect the stability of GIMP.
59

60 61 62 63 64
     We also require HarfBuzz @HARFBUZZ_REQUIRED_VERSION@ or newer, an
     OpenType text shaping tool. As this is a dependency for Pango, you
     will likely have it installed, but you may have to install a
     development package for the headers.

65
  7. Access of remote files is implemented in the URI plug-in. There
66 67 68 69 70 71 72
     are several possible implementations for this. The implementation
     used is determined when you configure GIMP. By default the
     GIO/GVfs backend is used. If you don't have GVfs support on your
     target platform, you should pass the '--without-gvfs' option to
     configure. The configure script will then try to detect another
     method for accessing remote files.

73
  8. The file-compressor plug-in requires zlib, libbzip2, and liblzma to
74
     be installed. All these libraries are required dependencies.
75

76 77 78
  9. For metadata access GIMP requires the gexiv2 library. It is hosted 
     at http://redmine.yorba.org/projects/gexiv2/wiki .

79
 10. Some other third party libraries or programs are needed for some
80 81
     of the available plug-ins. libpng, libjpeg and lcms are hard
     dependencies that can not be disabled.
82

83 84
 11. You may want to install other third party libraries or programs
     that are needed for some of the available plug-ins. We recommend
85 86 87
     to check that the following libraries are installed: libpoppler,
     libtiff, webkit, libmng, librsvg, libwmf, libgs (Ghostscript),
     libaa and libjasper.
88

89 90 91
 12. The Python extension requires Python 2 development headers (@PYTHON2_REQUIRED_VERSION@
     or newer) to be present. You will also need PyGTK and the
     respective development headers.
92

93
 13. Configure GIMP by running the `configure' script. You may want
94
     to pass some options to it, see below.
95

96
 14. Build GIMP by running `make'. The use of GNU make is recommended.
97 98
     If you need to tweak the build to make it work with other flavours
     of make, we'd appreciate if you'd send us a patch with the changes.
99

100
 15. Install GIMP by running `make install'. In order to avoid clashes
101
     with other versions of GIMP, we install a binary called gimp-@GIMP_APP_VERSION@.
102
     By default there's also a link created so that you can type 'gimp'
103 104 105 106
     to start gimp-@GIMP_APP_VERSION@.

 16. Summary of required packages and what version you need:

107
     ATK: @ATK_REQUIRED_VERSION@
108
     babl: @BABL_REQUIRED_VERSION@
109 110 111
     libbzip2
     cairo: @CAIRO_REQUIRED_VERSION@
     Fontconfig: @FONTCONFIG_REQUIRED_VERSION@
112
     freetype2: @FREETYPE2_REQUIRED_VERSION@
113 114 115 116 117 118 119 120 121 122 123
     GDK-PixBuf: @GDK_PIXBUF_REQUIRED_VERSION@
     GEGL: @GEGL_REQUIRED_VERSION@
     GLib: @GLIB_REQUIRED_VERSION@
     GTK+: @GTK_REQUIRED_VERSION@
     HarfBuzz: @HARFBUZZ_REQUIRED_VERSION@
     libjpeg
     libpng: @LIBPNG_REQUIRED_VERSION@
     liblzma: @LIBLZMA_REQUIRED_VERSION@
     Little CMS: @LCMS_REQUIRED_VERSION@
     pangocairo: @PANGOCAIRO_REQUIRED_VERSION@
     zlib
Elliot Lee's avatar
Elliot Lee committed
124

Sven Neumann's avatar
Sven Neumann committed
125 126
Please make sure you don't have any old GTK+-2.x, jpeg, etc. libraries
lying around on your system, otherwise configure may fail to find the
127
new ones.
Manish Singh's avatar
Manish Singh committed
128

129

Elliot Lee's avatar
Elliot Lee committed
130 131
Generic instructions for configuring and compiling auto-configured
packages are included below. Here is an illustration of commands that
Sven Neumann's avatar
Sven Neumann committed
132
might be used to build and install GIMP. The actual configuration,
Elliot Lee's avatar
Elliot Lee committed
133 134
compilation and installation output is not shown.

135 136
  % tar xvfz gimp-@GIMP_VERSION@.tar.gz   # unpack the sources
  % cd gimp-@GIMP_VERSION@                # change to the toplevel directory
Elliot Lee's avatar
Elliot Lee committed
137
  % ./configure                  # run the `configure' script
Sven Neumann's avatar
Sven Neumann committed
138 139
  % make                         # build GIMP
  % make install                 # install GIMP
Elliot Lee's avatar
Elliot Lee committed
140

141

Sven Neumann's avatar
Sven Neumann committed
142 143 144
The `configure' script examines your system, and adapts GIMP to run on
it. The script has many options, some of which are described in the
generic instructions included at the end of this file. All of the
Elliot Lee's avatar
Elliot Lee committed
145
options can be listed using the command `./configure --help'. There
146 147
are several special options the GIMP `configure' script recognizes.
These are:
Elliot Lee's avatar
Elliot Lee committed
148

149
  --enable-shared and --disable-shared.  This option affects whether
Elliot Lee's avatar
Elliot Lee committed
150
     shared libraries will be built or not. Shared libraries provide
151 152
     for much smaller executables. The default is to enable shared
     libraries. Disabling shared libraries is almost never a good idea.
Elliot Lee's avatar
Elliot Lee committed
153

154
  --enable-debug and --disable-debug.  This option causes the build
Elliot Lee's avatar
Elliot Lee committed
155
     process to compile with debugging enabled. If debugging is
Sven Neumann's avatar
Sven Neumann committed
156
     disabled, GIMP will instead be compiled with optimizations turned
Elliot Lee's avatar
Elliot Lee committed
157 158 159
     on. The default is for debugging to be disabled. NOTE: This
     option is intended primarily as a convenience for developers.

160 161 162 163 164
  --enable-profile and --disable-profile. This options causes the build
     process to compile with execution profiling enabled. The default is
     for profiling to be disabled. NOTE: This option is intended primarily
     as a convenience for developers.

165
  --enable-ansi and --disable-ansi.  This option causes stricter
Elliot Lee's avatar
Elliot Lee committed
166 167 168 169
     ANSI C checking to be performed when compiling with GCC. The
     default is for strict checking to be disabled. NOTE: This option
     is intended primarily as a convenience for developers.

170
  --with-gimpdir=DIR.  This option changes the default directory
171 172 173 174
     GIMP uses to search for its configuration files from
     ~/.config/GIMP/@GIMP_APP_VERSION@ (the directory .config/GIMP/@GIMP_APP_VERSION@
     in the user's home directory) to ~/.config/DIR/@GIMP_APP_VERSION@.
     If DIR is an absolute path, the directory will be changed to DIR.
Sven Neumann's avatar
Sven Neumann committed
175

Sven Neumann's avatar
Sven Neumann committed
176 177 178 179
  --enable-binreloc.  When compiled for Linux with this option enabled,
     GIMP will be binary relocatable.  Plug-ins and data files will
     be searched relative to the gimp binary instead of in the paths
     defined at compile time.
Sven Neumann's avatar
Sven Neumann committed
180

181 182 183
  --with-shm=[none|sysv|posix|auto].  This option allows you to specify
     how image data is transported between the core and plug-ins. Usually
     the best way to do this is detected automatically.
Sven Neumann's avatar
Sven Neumann committed
184

185 186 187 188 189
  --without-libtiff.  configure will bail out if libtiff can not be
     found. You better fix the underlying problem and install these
     libraries with their header files. If you absolutely want to
     compile GIMP without support for TIFF you need to explicitly
     disable them using this option.
Sven Neumann's avatar
Sven Neumann committed
190

191
  --without-aa.  The AA plug-in needs libaa and configure checks for
192
     its presence. Use --without-aa if you run into problems.
193

Thorsten Vollmer's avatar
Thorsten Vollmer committed
194 195 196 197 198
  --without-libxpm.  The XPM plug-in needs libxpm and configure checks
     for its presence. If for some reason you don't want to build the
     XPM plug-in even though the library is installed, use
     --without-libxpm to disable it explicitly.

199 200
  --without-libmng.  The MNG plug-in needs libmng and configure checks
     for its presence. If for some reason you don't want to build the
201
     MNG plug-in even though the library is installed, use
202
     --without-libmng to disable it explicitly.
203 204

  --without-wmf.  The WMF plug-in needs libwmf2 and configure checks for
205
     its presence. Use --without-wmf if you run into problems.
206

Sven Neumann's avatar
Sven Neumann committed
207 208
  --without-webkit.  If for some reason you don't want to build the
     Help Browser plug-in, you can use --without-webkit to disable
209 210
     it explicitly.

211 212
  --without-librsvg.  If for some reason you want to build GIMP without
     SVG support, you can build --without-librsvg.
213

214
  --without-poppler.  If for some reason you don't want to build the PDF
Sven Neumann's avatar
Sven Neumann committed
215
     Import plug-in that uses libpoppler, you can use --without-poppler.
216

217 218 219
  --without-print.  If for some reason you don't want to build the Print
     plug-in based on the GtkPrint API, you can build with --without-print.

220 221
  --without-gvfs.  If you don't want to use GIO/GVfs to access remote
     files, you can pass --without-gvfs to the configure script.
222

223
  --without-libcurl.  If you don't want to use libcurl to access remote
224
     files, you can pass --without-libcurl to the configure script.
225 226 227 228 229 230 231

  --without-alsa.  If you don't want to compile ALSA support into the
     MIDI input controller module, you can use the --without-alsa option.

  --without-linux-input.  If you don't want to compile the Linux Input
     controller module, you can use the --without-linux-input option.

232 233
  --without-hal.  If you want to build the Linux Input controller module
     without HAL support, you can use the --without-hal option.
234

235 236 237
  --without-mac-twain.  If you don't want to compile the Mac OS X
    TWAIN plug-in, you can use the --without-mac-twain option.

238 239
  --with-gif-compression=[lzw|rle|none].  Allows to tune the compression
     algorithm used by the GIF plug-in. If you are afraid of Unisys' LZW
240 241 242
     patent (which should have expired in most countries by now), you
     can go for simple run-length encoding or even configure the plug-in
     to create uncompressed GIFs.
243

244
  --enable-gtk-doc.  This option controls whether the libgimp API
Sven Neumann's avatar
Sven Neumann committed
245
     references will be created using gtk-doc. The HTML pages are
246
     included in a standard tarball, so you will only need this if you
247
     are building from SVN.
248 249 250

  --with-html-dir=PATH.  This option allows to specify where the
     libgimp API reference should be installed. You might want to modify
251
     the path so it points to the place where glib and gtk+ installed
252 253 254
     their API references so that the libgimp reference can link to
     them.

255 256
  --disable-mp. This option allows you to disable support for multiple
     processors. It is enabled by default.
Marc Lehmann's avatar
Marc Lehmann committed
257

Sven Neumann's avatar
Sven Neumann committed
258
  --with-sendmail=[PATH]. This option is used to tell GIMP where to find
259 260 261
     the sendmail command. Normally this options don't have to be used
     because configure tries to find it in the usual places.

262
  --with-desktop-dir=[PATH]. This option specifies where to install
263 264 265 266 267
     desktop files. These files are used by desktop environments that
     comply to the specs published at freedesktop.org. The default
     value ${prefix}/share should be fine if your desktop environment
     is installed in the same prefix as gimp. No files are installed
     if you call configure with --without-desktop-dir.
Marc Lehmann's avatar
Marc Lehmann committed
268

269
  --disable-default-binary. Use this option if you don't want to make
270 271
     gimp-@GIMP_APP_VERSION@ the default GIMP installation. Otherwise a link called
     gimp pointing to the gimp-@GIMP_APP_VERSION@ executable will be installed.
272

273 274 275
  --disable-gimp-console.  Use this option if you don't want the
     gimp-console binary to be built in addition to the standard binary.
     gimp-console is useful for command-line batch mode or as a server.
276

277
  --disable-python.  If for some reason you don't want to build the
Sven Neumann's avatar
Sven Neumann committed
278
     Python based PyGIMP plug-in, you can use --disable-python.
279

280 281
  --without-script-fu.  If for some reason you don't want to build the
     Script-Fu plug-in, you can use --without-script-fu.
282

283
  --without-xmc.  The X11 Mouse Cursor(XMC) plug-in needs libXcursor
284
     and configure checks for its presence. If for some reason you
285 286 287
     don't want to build the XMC plug-in even though the library is
     installed, use --without-xmc to disable it explicitly.

288

Elliot Lee's avatar
Elliot Lee committed
289
The `make' command builds several things:
290 291 292
 - A bunch of public libraries in the directories starting with 'libgimp'.
 - The plug-in programs in the 'plug-ins' directory.
 - Some modules in the 'modules' subdirectory.
293
 - The main GIMP program 'gimp-@GIMP_APP_VERSION@' in `app'.
Elliot Lee's avatar
Elliot Lee committed
294

Sven Neumann's avatar
Sven Neumann committed
295 296 297
The `make install' commands installs the GIMP header files associated
with the libgimp libraries, the plug-ins, some data files and the GIMP
executable. After running `make install' and assuming the build process
Sven Neumann's avatar
updates  
Sven Neumann committed
298
was successful you should be able to run `gimp'.
Elliot Lee's avatar
Elliot Lee committed
299

Marc Lehmann's avatar
Marc Lehmann committed
300

301 302 303
When ./configure fails
======================

304
'configure' uses pkg-config, a tool that replaces the old foo-config
Sven Neumann's avatar
Sven Neumann committed
305
scripts. The most recent version is available from
306 307
	http://www.freedesktop.org/software/pkgconfig/

308
'configure' tries to compile and run a short GTK+ program. There are
309 310
several reasons why this might fail:

Sven Neumann's avatar
Sven Neumann committed
311
* pkg-config could not find the file 'gtk+-2.0.pc' that gets installed
312 313
  with GTK. (This file is used to get information about where GTK+ is
  installed.)
314

Sven Neumann's avatar
Sven Neumann committed
315 316 317
  Fix: Either make sure that this file is in the path where pkg-config
  looks for it (try 'pkg-config --debug' or add the location of
  gtk+-2.0.pc to the environment variable PKG_CONFIG_PATH before running
318
  configure.
319

Sven Neumann's avatar
Sven Neumann committed
320
* Libraries you installed are not found when you attempt to start GIMP.
321
  The details of how to fix this problem will depend on the system:
322

323 324
  On Linux and other systems using ELF libraries, add the directory to
  holding the library to /etc/ld.so.conf or to the environment variable
325 326 327 328 329 330 331 332 333 334
  LD_LIBRARY_PATH, and run 'ldconfig'.

  On other systems, it may be necessary to encode this path
  into the executable, by setting the LDFLAGS environment variable
  before running configure. For example:

    LDFLAGS="-R/home/joe/lib" ./configure
  or
    LDFLAGS="-Wl,-rpath -Wl,/home/joe/lib" ./configure

Sven Neumann's avatar
Sven Neumann committed
335
* An old version of the GTK+ libraries was found instead of
336
  your newly installed version. This commonly happens if a
Sven Neumann's avatar
Sven Neumann committed
337 338
  binary package of GTK+ was previously installed on your system,
  and you later compiled GTK+ from source.
339

340 341 342 343 344 345 346 347
  Fix: Remove the old libraries and include files.  If you are afraid
  that removing the old libraries may break other packages supplied by
  your distributor, you can try installing GLib, GTK+ and other
  libraries in a different prefix after setting the environment
  variable PKG_CONFIG_LIBDIR to point to lib/pkgconfig/ in that new
  prefix so that it does not try to read the *.pc files from the
  default directory (/usr/lib/pkgconfig).  However, removing the old
  packages is often the easier solution.
348 349 350 351

A detailed log of the ./configure output is written to the file
config.log. This may help diagnose problems.

Manish Singh's avatar
Manish Singh committed
352 353 354 355

When ./configure fails on plug-ins
==================================

Sven Neumann's avatar
Sven Neumann committed
356 357 358
There are some GIMP plug-ins that need additional third-party libraries
installed on your system. For example to compile the plug-ins that load
and save JPEG, PNG or TIFF files you need the related libraries and header
359
files installed, otherwise you'll get a message that plug-in xyz will not
360
be built.
Manish Singh's avatar
Manish Singh committed
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375

If you are sure that those libraries are correctly installed, but configure
fails to detect them, the following might help:

Set your LDFLAGS environment variable to look for the library in a certain
place, e.g. if you are working in a bash shell you would say:
      export LDFLAGS="-L<path_to_library> -L<path_to_another_one>"
before you run configure.

Set your CPPFLAGS environment variable to look for the header file in a
certain place, e.g. if you are working in a bash shell you would say:
      export CPPFLAGS="-I<path_to_header_file> -I<path_to_another_one>"
before you run configure.


Elliot Lee's avatar
Elliot Lee committed
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
      Generic Instructions for Building Auto-Configured Packages
      ==========================================================


To compile this package:

1.  Configure the package for your system.  In the directory that this
file is in, type `./configure'.  If you're using `csh' on an old
version of System V, you might need to type `sh configure' instead to
prevent `csh' from trying to execute `configure' itself.

The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation, and
creates the Makefile(s) (one in each subdirectory of the source
directory).  In some packages it creates a C header file containing
system-dependent definitions.  It also creates a file `config.status'
that you can run in the future to recreate the current configuration.
Running `configure' takes a minute or two.

To compile the package in a different directory from the one
containing the source code, you must use GNU make.  `cd' to the
directory where you want the object files and executables to go and
run `configure' with the option `--srcdir=DIR', where DIR is the
directory that contains the source code.  Using this option is
actually unnecessary if the source code is in the parent directory of
the one in which you are compiling; `configure' automatically checks
for the source code in `..' if it does not find it in the current
directory.

By default, `make install' will install the package's files in
/usr/local/bin, /usr/local/lib, /usr/local/man, etc.  You can specify
an installation prefix other than /usr/local by giving `configure' the
Manish Singh's avatar
Manish Singh committed
408
option `--prefix=PATH'.
Elliot Lee's avatar
Elliot Lee committed
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457

You can specify separate installation prefixes for machine-specific
files and machine-independent files.  If you give `configure' the
option `--exec-prefix=PATH', the package will use PATH as the prefix
for installing programs and libraries.  Normally, all files are
installed using the same prefix.

`configure' ignores any other arguments that you give it.

If your system requires unusual options for compilation or linking
that `configure' doesn't know about, you can give `configure' initial
values for some variables by setting them in the environment.  In
Bourne-compatible shells, you can do that on the command line like
this:
        CC='gcc -traditional' DEFS=-D_POSIX_SOURCE ./configure

The `make' variables that you might want to override with environment
variables when running `configure' are:

(For these variables, any value given in the environment overrides the
value that `configure' would choose:)
CC              C compiler program.
                Default is `cc', or `gcc' if `gcc' is in your PATH.
INSTALL         Program to use to install files.
                Default is `install' if you have it, `cp' otherwise.
INCLUDEDIR      Directory for `configure' to search for include files.
                Default is /usr/include.

(For these variables, any value given in the environment is added to
the value that `configure' chooses:)
DEFS            Configuration options, in the form '-Dfoo -Dbar ...'
LIBS            Libraries to link with, in the form '-lfoo -lbar ...'

If you need to do unusual things to compile the package, we encourage
you to teach `configure' how to do them and mail the diffs to the
address given in the README so we can include them in the next
release.

2.  Type `make' to compile the package.

3.  Type `make install' to install programs, data files, and
documentation.

4.  You can remove the program binaries and object files from the
source directory by typing `make clean'.  To also remove the
Makefile(s), the header file containing system-dependent definitions
(if the package uses one), and `config.status' (all the files that
`configure' created), type `make distclean'.

458
The file `configure.ac' is used as a template to create `configure' by
Elliot Lee's avatar
Elliot Lee committed
459 460
a program called `autoconf'.  You will only need it if you want to
regenerate `configure' using a newer version of `autoconf'.