= Mac OS X build instructions =

The Mac OS X port is '''not''' yet completed. These instructions are here for those who wish to help out.

== Prerequisites on Mac OS X ==

 * Mac OS X 10.4.x (Tiger), 10.5.x (Leopard) or 10.6.x (Snow Leopard) running on Intel hardware (PowerPC hardware is '''not''' supported).

 * Xcode matching your Mac OS X version (http://developer.apple.com/tools/download/): 
       * 2.4.1 or later for Tiger
       * 3.1.0 or later for Leopard
       * 3.2.0 or later for Snow Leopard

 * Some things from !MacPorts (http://www.macports.org/). [[BR]]
 '''Note''': On Snow Leopard you have to build !MacPorts yourself. The following build the universal version of !MacPorts & ensure that all ports will be installed as universal version as well.
 {{{
 svn checkout http://svn.macports.org/repository/macports/trunk/base MacPorts
 cd MacPorts
 ./configure --with-universal-archs="i386 x86_64"
 make
 sudo make install
 sudo /opt/local/bin/port selfupdate
 }}}
 After that add '+universal' to '/opt/local/etc/macports/variants.conf'.

 After installing !MacPorts, do not forget to add the following two lines to your ~/.profile
{{{
export PATH=/opt/local/bin:/opt/local/sbin:$PATH
export MANPATH=/opt/local/share/man:$MANPATH
}}}
 Then perform the following command (see caveat in the next section):
{{{
sudo port install libidl doxygen
}}}
 Doxygen is optional.

 * SDL 1.2.12 or later 1.2.x release. [[BR]]
   http://libsdl.org/download-1.2.php

 * Qt/Mac 4.3.x upwards. [[BR]] Add {{{--disable-qt}}} as argument to {{{configure}}} if missing. [[BR]]

 * Latex ("sudo port install teTeX") for building the documentation

== Building !VirtualBox ==

 1. Change to the root directory of the sources and execute the configure script: 
{{{
./configure --disable-hardening
}}}
    If it finds everything it needs, it will create a file called '!AutoConfig.kmk' containing paths to the various tools on your system. Also, it will create an environment setup script called env.sh. This step only has to be done once (if something changes in your build tool setup, you might have to repeat it but keep in mind that both output files will be overwritten). 
 1. Whenever you want to build !VirtualBox, you have to open a shell and source the generated environment setup script 'env.sh', i.e. do
{{{
. ./env.sh
}}}

 1. To build type 
{{{
kmk
}}}
    The default is to a release build, should you wish to do a ''debug'' or ''profile'' build add {{{BUILD_TYPE=debug}}} or {{{BUILD_TYPE=profile}}} as argument to ''kmk'' or export it as an environment variable in your shell.


== Running !VirtualBox ==

As mentioned elsewhere, the Mac OS X port of !VirtualBox is work in progress. Things might therefore not work as expected and break at random times.

 1. Load the kernel extension module. This can be found in `out/darwin.x86/release/dist` along with a small script (`load.sh`) to load it. Execute and make sure the module loads successfully. 
 2. Enter {{{out/darwin.x86/release/dist/VirtualBox.app/Contents/MacOS/}}}.
 3. Run {{{./VirtualBox}}}

Alternatively, if you didn't have Qt4 around and there for ./VirtualBox is missing, you can run VBoxBFE like this:
{{{
./VBoxBFE -m 32
}}}

If you have a knoppix ISO or similar hanging around, you can try start it like this:
{{{
./VBoxBFE -m 128 -cdrom /Users/name/Desktop/knoppix-3.7.iso -boot d -natdev1 080286000042
}}}