Difference between revisions of "CompilingMacOsX"

From Inkscape Wiki
Jump to navigation Jump to search
(→‎Installing dependencies: Don't need boost anymore)
(→‎Compiling Inkscape: changed the organisation of the page, updated the DarwinPorts part)
Line 1: Line 1:
== Compiling Inkscape ==
== Requirements ==
 
=== Requirements ===
To compile Inkscape from source you will need:
To compile Inkscape from source you will need:
*Mac OS X 10.3 (Power PC) or higher
*Mac OS X 10.4 (10.3 support is on the way, you are welcome to help if you still have a machine running 10.3)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://www.inkscape.org/cvs-snap/ SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*XCode 2.3 on OS X 10.4 (i.e. with gcc 4.0.1)
*XCode 2.3 on OS X 10.4 (i.e. with gcc 4.0.1)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies, for example glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.


To install Inkscape dependencies you can use either:
== Compiling Inkscape using Mac/DarwinPorts ==
*Fink with an [http://fink.sourceforge.net/faq/usage-fink.php?phpLang=en#unstable unstable installation]. But notice that Fink does not provide a loudmouth package, the librarie that Inkboard uses, therefore you won't be able to use Inkboard and that GTK versions are old.
*[http://darwinports.opendarwin.org/ DarwinPorts]. This is the preferred method though there are still problems when bundling Inkscape compiled with DarwinPorts. Please help us investigate this.
 
=== Preparing the build using Fink ===
 
====Installing dependencies====
Fink provides an Inkscape pacakage. Therefore, as for any other package, Fink provides you with a list of its dependencies:
<pre>fink show-deps inkscape</pre>
 
Some are mandatory and you must install them:
<pre>fink install gtkmm2.4-dev  gconf2-dev gnome-vfs2-dev\
  gtkspell2-dev intltool lcms libbonobo2-dev libxslt gc</pre>
 
Some provide additional functionality in Inkscape
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>gnome-print</code>
<pre>fink install aspell-dev boost gnome-print-dev</pre>
 
If you use [http://en.wikipedia.org/wiki/MMX MMX optimization] (available on Intel processors) you need version 1.8.5 of automake (and not 1.9.6 which is the latest in Fink). Otherwise you will need suppress the check on the version of automake (see the Configuring section).
<pre>fink install automake1.8</pre>
 
====Setting the build environment====
Fink's hierarchy is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here. You can create a file named <code>set_env_variables.sh</code> and copy/paste this inside:
<pre>
#!/bin/bash
LIBPREFIX="/sw"
#  automake seach path
export CPATH="$LIBPREFIX/include"
#  configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
#  compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>
 
In addition, you must make sure that Inkscape is compiled with the compiler version that Fink uses, otherwise Inkscape will not link properly. To determine which compiler to use type:
<pre>head -n 5 $FINK/etc/fink.conf | grep "Distribution"</pre>
If your fink distribution is 10.4 add:
<pre>
export CC="gcc-4.0"
export CXX="g++-4.0"
</pre>
to <code>set_env_variables.sh</code>, else (10.3, 10.4-transitional) add:
<pre>
export CC="gcc-3.3"
export CXX="g++-3.3"
</pre>
 
You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>fink install ccache</code>) to speed up the compilation a bit. To do so, modify the compiler lines accordingly:
<pre>
export CC="ccache gcc-??"
export CXX="ccache g++-??"
</pre>
 
Eventually, open a Terminal and, in the directory where you created the file <code>set_env_variables.sh</code>, type:
<pre>source set_env_variables.sh</pre>


You are ready to configure, compile and install Inkscape. Go to the section 'Configuring' now.
=== Installing dependencies ===
 
=== Preparing the build using DarwinPorts ===
====Installing dependencies====
You can use DarwinPorts to list Inkscape dependencies:
You can use DarwinPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>
<pre>port deps inkscape</pre>
Some are mandatory and you can install them with the command:
Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gnome-vfs intltool libxslt lcms popt</pre>
<pre>sudo port install boehmgc gtkmm gnome-vfs intltool libxslt lcms popt</pre>
Line 82: Line 22:
<pre>sudo port install aspell boost libgnomeprintui loudmouth</pre>
<pre>sudo port install aspell boost libgnomeprintui loudmouth</pre>


Using [http://en.wikipedia.org/wiki/MMX MMX optimization] (available on Intel processors only) requires that you use automake 1.8 but only automake 1.9.6 is available in DarwinPorts. Therefore, unless you install version 1.8.5 by hand ([http://ftp.gnu.org/gnu/automake/automake-1.8.5.tar.gz]) you will need to disable MMX optimization and to disable the check on automake version during the configure step.


Automake in DarwinPorts is currently 1.10, which currently does not work for our build. However Automake 1.7 does work, and is in DarwinPorts as 'automake17'.
=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has builtin help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>


====Setting the build environment====
Basically to configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh conf build install -s package</pre>
or more simply
<pre>./osx-build.sh c b i -s p</pre>


=== Step by step instructions ===
If you want to know what you do or to understand how the build script works, please read the following paragraphs.


==== Setting the build environment ====
DarwinPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
#  automake seach path
export CPATH="$LIBPREFIX/include"
#  configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
#  compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>


You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>


=== Configuring ===
=== Configuring ===
 
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
First, if you have and Intel processor, you need to decide if you use [http://en.wikipedia.org/wiki/MMX MMX optimization] or not. If you have a G3/G4/G5 processor you cannot use it anyway.
[Note: please someone confirm that MMX optimization is available on Mac Intel processors]
If you do not use MMX optimization, you can use automake 1.9 and you need to disable the check on automake version in <code>autogen.sh</code> by commenting the lines (around line 110):
<pre>    # Exclude automake 1.9.[0-6]
    if expr $VER \>= 1.9.0 >/dev/null && expr $VER \<= 1.9.6 >/dev/null ; then
        echo
        echo "  You must have automake less than 1.9.0 or newer than 1.9.6"
        echo "  Get ftp://ftp.gnu.org/pub/gnu/automake/automake-1.8.5.tar.gz"
        echo "  (or a newer version of 1.8 if it is available)"
        DIE=1
    fi
</pre>
 
If you need to use automake17 from DarwinPorts, the following will need to be added to <code>autogen.sh</code> around line 92:
<pre>
if (automake-1.7 --version) < /dev/null > /dev/null 2>&1; then
    AUTOMAKE=automake-1.7
    ACLOCAL=aclocal-1.7
+elif (automake-17 --version) < /dev/null > /dev/null 2>&1; then
+  AUTOMAKE=automake-17
+  ACLOCAL=aclocal-17
elif (automake-1.8 --version) < /dev/null > /dev/null 2>&1; then
    AUTOMAKE=automake-1.8
    ACLOCAL=aclocal-1.8
</pre>
 
(The lines with '+' signs are the new ones. Don't actually add literal '+' characters -- [[JonCruz]])
 
Then, you might need to build the configure script (if you compile Inkscape for the first time for example). Cd to Inkscape's source directory and run:
<pre>./autogen.sh</pre>
<pre>./autogen.sh</pre>


Then run the configure script with the options <code>--disable-static --enable-shared</code> and  <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
Then run configure with the options <code>--disable-static --enable-shared</code> and  <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>


If you decided to disable MMX optimization on Intel procesors, add the <code>--disable-mmx</code> option.
I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
 
<pre>./configure {...} --enable-osxapp</pre>
I you want to package Inkscape into an <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code> [Note: this is currently broken when using DarwinPorts]:
<pre>./configure --prefix=/path/to/build/products/ --enable-osxapp</pre>


If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.
If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.


Other configuration options can be set, check the list of options by using:
Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>
<pre>./configure --help</pre>


=== Building and Installing ===
=== Building and Installing ===
Just run:
Just run:
<pre>
<pre>make
make
make install</pre>
make install
</pre>


=== Creating an .app bundle ===


===Automated compilation===
== Compiling a universal binary of Inkscape using the all-in-one build script ==
You can try downloading a bash script which automates the processes of updating Inkscape from the svn repository, setting the build environment, building and producing a package of Inkscape. Modify it with your favorite text editor in order to set a correct installation prefix and to change configuration options according to your needs.
Michael's text to go here
Two scripts are prodived, depending on wether you use Fink [http://jo.irisson.free.fr/dropbox/inkscape/osxmake_fink.sh] or DarwinPorts [http://jo.irisson.free.fr/dropbox/inkscape/osxmake_dp.sh].


To use one of these scripts, place it in the directory where Inkscape source code is and make it executable
== Compiling Inkscape as a native application (no X11) ==
<pre>chmod +x osxmake_???.sh</pre>
Derek Hinchliffe's text to go here
To obtain help on how to use it run it with the <code>-h</code> option:
<pre>./osxmake_???.sh -h</pre>
To run the whole process use the command:
<pre>./osxmake_???.sh -s -a -c -b -i -p</pre>


== Packaging Inkscape into an .app bundle and distributing a .dmg==
== Packaging Inkscape into an .app bundle and distributing a .dmg==

Revision as of 22:21, 23 March 2007

Requirements

To compile Inkscape from source you will need:

  • Mac OS X 10.4 (10.3 support is on the way, you are welcome to help if you still have a machine running 10.3)
  • XCode 2.3 on OS X 10.4 (i.e. with gcc 4.0.1)
  • Inkscape's source code. You can get the official release source code, a SVN snapshot or a copy of the SVN repository.
  • Inkscape's dependencies, for example glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system (Fink or MacPorts, formerly known as DarwinPorts) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

Compiling Inkscape using Mac/DarwinPorts

Installing dependencies

You can use DarwinPorts to list Inkscape dependencies: 

port deps inkscape

Some are mandatory and you can install them with the command: 

sudo port install boehmgc gtkmm gnome-vfs intltool libxslt lcms popt

Others provide additional functionality to Inkscape:

  • aspell : check spelling of text elements [Note: I have never seen it working on OS X]
  • boost : auto-organisation of connectors [Note: is boost still needed?]
  • libgnomeprintui
  • loudmouth : jabber library used by InkBoard
sudo port install aspell boost libgnomeprintui loudmouth


For the impatient

There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has builtin help: 

 cd packaging/macosx/
./osx-build.sh help

Basically to configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command 

./osx-build.sh conf build install -s package

or more simply 

./osx-build.sh c b i -s p

Step by step instructions

If you want to know what you do or to understand how the build script works, please read the following paragraphs.

Setting the build environment

DarwinPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here. 

export LIBPREFIX="/opt/local"
#  automake seach path
export CPATH="$LIBPREFIX/include"
#  configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
#  compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"

You can also use ccache (sudo port install ccache) to speed up the compilation a bit. To do so, add compiler variables: 

export CC="ccache gcc"
export CXX="ccache g++"

Configuring

If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run: 

./autogen.sh

Then run configure with the options --disable-static --enable-shared and --prefix which sets the directory where the build products are placed. It must be somewhere you have write access to. 

./configure --disable-static --enable-shared --prefix=/path/to/build/products/

I you want to package Inkscape into a double-clickable .app bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option --enable-osxapp: 

./configure {...} --enable-osxapp

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add --enable-inkboard.

Other configuration options can be set, check the list of options by issuing: 

./configure --help


Building and Installing

Just run: 

make
make install

Creating an .app bundle

Compiling a universal binary of Inkscape using the all-in-one build script

Michael's text to go here

Compiling Inkscape as a native application (no X11)

Derek Hinchliffe's text to go here

Packaging Inkscape into an .app bundle and distributing a .dmg

Assuming that you have used the --enable-osxapp option during configure, the process is fully automatized. You just have to open a Terminal, cd to Inkscape's sources directory and type: 

cd packaging
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx

The -s options produces an app bundle stripped of debugging information (which is therefore smaller). Omit this option if you want to keep debugging info.

Either way, this creates two files in current directory: Inkscape.app that you can copy to your Applications directory and Inkscape.dmg for distribution.

Enabling python effects

Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but not with pyXML which is needed by Inkscape effects. You can install a binary version downloadable with the developement builds of Inkscape:

http://inkscape.modevia.com/macosx-snap/?M=D

Or you can install it from source:

  1. download the source code from sourceforge
  2. unpack the .tar.gz file
  3. cd into the newly created directory
  4. set the variable MACOSX_DEPLOYMENT_TARGET to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:
    export MACOSX_DEPLOYMENT_TARGET=10.?
  5. move the python files and build C extensions by just typing 
    python setup.py build
  6. install (the install is system wide so you need administrator rights)
    sudo python setup.py install
    and type your password.

Links

Apple Documentation

  • Introduction to Runtime Configuration Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

Packaging

  • Sveinbjorn Thordarson's Website The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
  • Creating OS X application bundles step by step Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
  • Bringing your Java Application to Mac OS X I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
  • The Gimp .app Howto This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.
Retrieved from "https://wiki.inkscape.org/wiki/index.php?title=CompilingMacOsX&oldid=14019"