Difference between revisions of "Dev:Build Instructions"

From Synfig Studio :: Documentation
Jump to: navigation, search
(rework notes section, fix some notes, add note about installing in a non-default location)
Line 8: Line 8:
 
If you are using packages for synfig's dependencies, you want the '''development packages''' not the main packages. Check below for your distribution's packages.
 
If you are using packages for synfig's dependencies, you want the '''development packages''' not the main packages. Check below for your distribution's packages.
  
Please read the [[Download|download page]] and the [[FAQ]] to find out about any issues that you may run into along the way.
+
Please read the [[Source code|source code]] page, [[Download|download page]] and the [[FAQ]] to find out about any issues that you may run into along the way.
  
There is a complete copy of the subversion repository (as a [http://git.or.cz/ git] mirror) available for viewing in a web browser at [http://snipr.com/synfigit http://snipr.com/synfigit].
+
Some Linux/BSD distros have a pkg-config that doesn't look in /usr/local/lib/pkgconfig by default. So if you are installing in anywhere other than the system pkg-config path, please run "export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig" or similar before building or installing anything.
  
== System-Specific ==
+
Don't use automake 1.4, there are problems with it.
  
The later sections of this page can be used for any system, but the following links and wiki pages offer some system-specific help:
+
Using automake 1.9, 'make install' seems to re-link and re-install all the synfig core modules every time whether they have changed or not.  [http://dooglus.rincevent.net/synfig/automake.html here] is an ugly workaround - it's only worth using if you intend to rebuild synfig repeatedly
  
* Unix (Linux/MacOS X/BSD)
+
The instructions below result in 3 separate subversion working directories being created.  This is inconvenient to work with - you'll need to 'svn commit' in 3 different places to send changes, 'svn update' in 3 different places to get the latest updates, etc.  [[Subversion|This page]] shows how to arrange for the code to be checked out into a single working directory. You can also download a daily updated tarball that uses this from the [[Source code|source code]] page.
** General
+
 
*** Some distros have a pkg-config that doesn't look in /usr/local/lib/pkgconfig by default. So if you are installing in anywhere other than the system pkg-config path, please run "export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig" or similar before building or installing anything.
+
The CVS requirement is only because the autopoint program run by autoreconf needs CVS. You can avoid the need for CVS by disabling the translation/gettext stuff in configure.ac.
*** Don't use automake 1.4, there are problems with it.
+
 
*** Using automake 1.9, 'make install' seems to re-link and re-install all the synfig core modules every time whether they have changed or not.  [http://dooglus.rincevent.net/synfig/automake.html here] is an ugly workaround - it's only worth using if you intend to rebuild synfig repeatedly
+
If you don't want to install to a system-wide directory using sudo, run something like these commands before starting:
*** The instructions below result in 3 separate subversion working directories being created.  This is inconvenient to work with - you'll need to 'svn commit' in 3 different places to send changes, 'svn update' in 3 different places to get the latest updates, etc.  [[Subversion|This page]] shows how to arrange for the code to be checked out into a single working directory.
+
 
*** The CVS requirement is only because the autopoint program run by autoreconf checks for CVS by default. You can avoid the CVS requirement by patching your autopoint script, search for CVS and remove the line that says "cvs program not found"
+
<pre>
** Gentoo: SVN [[Gentoo Ebuilds|ebuilds]] are available
+
export PREFIX="$HOME/opt"
** MacOS X: [[Building_On_Mac_OS_X|instructions for building]] with the GTK+ Aqua port are available.
+
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$PREFIX/lib/pkgconfig"
 +
export PATH="$PATH:$PREFIX/bin"
 +
</pre>
 +
 
 +
And when you run ./configure, run it with --prefix="$PREFIX" and don't use sudo when you do make install.
 +
 
 +
== System-specific instructions ==
 +
 
 +
* Gentoo: SVN [[Gentoo Ebuilds|ebuilds]] are available
 +
* MacOS X: [[Building_On_Mac_OS_X|instructions for building]] with the GTK+ Aqua port are available.
 
* Windows: [[Windows build instructions|instructions for building]] in [[Mingw_installation|mingw]] are available.
 
* Windows: [[Windows build instructions|instructions for building]] in [[Mingw_installation|mingw]] are available.
  

Revision as of 03:51, 30 January 2008


Notes

If you are using the released versions instead of SVN, the first 3 steps for each component are not necessary. For released versions, "./configure && make && sudo make install" should be enough.

If you are using packages for synfig's dependencies, you want the development packages not the main packages. Check below for your distribution's packages.

Please read the source code page, download page and the FAQ to find out about any issues that you may run into along the way.

Some Linux/BSD distros have a pkg-config that doesn't look in /usr/local/lib/pkgconfig by default. So if you are installing in anywhere other than the system pkg-config path, please run "export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig" or similar before building or installing anything.

Don't use automake 1.4, there are problems with it.

Using automake 1.9, 'make install' seems to re-link and re-install all the synfig core modules every time whether they have changed or not. here is an ugly workaround - it's only worth using if you intend to rebuild synfig repeatedly

The instructions below result in 3 separate subversion working directories being created. This is inconvenient to work with - you'll need to 'svn commit' in 3 different places to send changes, 'svn update' in 3 different places to get the latest updates, etc. This page shows how to arrange for the code to be checked out into a single working directory. You can also download a daily updated tarball that uses this from the source code page.

The CVS requirement is only because the autopoint program run by autoreconf needs CVS. You can avoid the need for CVS by disabling the translation/gettext stuff in configure.ac.

If you don't want to install to a system-wide directory using sudo, run something like these commands before starting:

export PREFIX="$HOME/opt"
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$PREFIX/lib/pkgconfig"
export PATH="$PATH:$PREFIX/bin"

And when you run ./configure, run it with --prefix="$PREFIX" and don't use sudo when you do make install.

System-specific instructions

ETL

ETL is a template library, there is nothing to build really, it just needed to be installed.

Requires: autoconf automake

  • Debian: build-essential autoconf automake
  1. svn co http://svn.voria.com/code/ETL/trunk/ etl
  2. cd etl
  3. autoreconf -if
  4. ./configure
  5. sudo make install
  6. cd ..

synfig

Requires: ETL, libxml++, libsigc++, libltdl, libtool, gettext, cvs

  • Debian: etl-dev libxml++2.6-dev libsigc++-2.0-dev libltdl3-dev libtool gettext cvs
  • Gentoo: virtual/ETL dev-cpp/libxmlpp dev-libs/libsigc++

Note: libpng isn't required to build synfig, but if you build synfig without PNG support and go on to build synfigstudio, that step will fail (because the build process for synfigstudio uses synfig to create .png icon files). The package is libpng12-dev on Debian or media-libs/libpng on Gentoo.

Optional: libpng, libmng, libtiff, libjpeg, libfreetype, libfontconfig, libopenexr, libavcodec, libmagick++, vimage (MacOS only, proprietary)

  • Debian: libpng12-dev libmng-dev libtiff4-dev libjpeg62-dev libfreetype6-dev libfontconfig1-dev libopenexr-dev libavcodec-dev libavformat-dev libmagick++9-dev
    • if using debian-multimedia.org debs swap the libav packages with the virtual packages libavformatcvs-dev libavcodeccvs-dev libavutilcvs-dev from debian-multimedia
  • Gentoo: sys-devel/libtool media-libs/libpng media-libs/libmng media-libs/tiff media-libs/jpeg media-libs/freetype media-libs/fontconfig media-libs/openexr media-libs/libavcodec

Runtime: encodedv (from libdv), ffmpeg, convert (from imagemagick)

  • Debian: libdv-bin ffmpeg imagemagick
  • Gentoo: media-libs/libdv media-video/ffmpeg media-gfx/imagemagick
  1. svn co http://svn.voria.com/code/synfig-core/trunk/ synfig-core
  2. cd synfig-core
  3. libtoolize --ltdl --copy -f
  4. autoreconf -if
  5. ./configure
  6. make
  7. sudo make install
  8. cd ..

Notes:

  • Don't use --enable-half, it is slow.

synfigstudio

Requires: ETL, synfig, gtkmm >= 2.4, gtk >= 2.0, glibmm, libsigc++, libltdl, libtool, gettext, cvs

  • Debian: etl-dev libsynfig-dev libgtkmm-2.4-dev libgtk2.0-dev libglibmm-2.4-dev libsigc++-2.0-dev libltdl3-dev libtool gettext cvs
  • Gentoo: virtual/ETL virtual/synfig dev-cpp/gtkmm-2.4 dev-libs/libsigc++ sys-devel/libtool

Optional: fonts (for the images), FMOD (proprietary)

  • Debian: ttf-freefont ttf-dejavu ttf-dustin
  • Gentoo: freefonts dejavu
  1. svn co http://svn.voria.com/code/synfig-studio/trunk/ synfigstudio
  2. cd synfigstudio
  3. autoreconf -if
  4. ./configure
  5. make
  6. sudo make install
  7. cd ..

synfig-docs

(This step isn't required to run synfig or synfigstudio, and the documents it gets you are really quite out of date)

This is basically a copy of what is on this wiki.

Requires: sgml processor, ldp docbook stylesheets, db2ps, db2pdf

  • Debian: openjade ldp-docbook-dsssl docbook-utils
  1. svn co http://svn.voria.com/code/synfig-docs/trunk/ synfig-docs
  2. cd synfig-docs
  3. make multiple-html
  4. make ps
  5. make pdf