Small fixes to the cross-compilation howto.
[wiki] / examples / cross-compiling-windows-binary.mdwn
1 [[!meta title="cross-compiling tinc for Windows under Linux using MinGW"]]
2
3 ## Howto: cross-compiling tinc for Windows under Linux using MinGW
4
5 This howto describes how to create a Windows binary of tinc. Although it is
6 possible to compile tinc under Windows itself, cross-compiling it under Linux
7 is much faster. It is also much easier to get all the dependencies in a modern
8 distribution. Therefore, this howto deals with cross-compiling tinc with MinGW
9 under Linux on a Debian distribution.
10
11 ### Overview
12
13 The idea is simple:
14
15 * Install MinGW and Wine.
16 * Create a directory where we will perform all cross-compilations.
17 * Get all the necessary sources.
18 * Cross-compile everything.
19
20 ### Installing the prerequisites for cross-compilation
21
22 There are only a few packages that need to be installed as root to get started:
23
24 >     sudo apt-get install mingw32 wine git-core
25 >     sudo apt-get build-dep tinc
26
27 ### Setting up the build directory and getting the sources
28
29 We will create a directory called `mingw/` in the home directory.  We use
30 apt-get to get the required libraries necessary for tinc, and use `git` to get
31 the latest development version of tinc.
32
33 >     mkdir $HOME/mingw
34 >     cd $HOME/mingw
35 >     apt-get source openssl liblzo2-dev zlib1g-dev
36 >     git clone git://tinc-vpn.org/tinc
37
38 ### Making cross-compilation easy
39
40 To make cross-compiling easy, we create a script called `mingw` that will set
41 up the necessary environment variables so configure scripts and Makefiles will
42 use the MinGW version of GCC and binutils:
43
44 >     mkdir $HOME/bin
45 >     cat >$HOME/bin/mingw << EOF
46 >     #!/bin/sh
47 >     export CC=i586-mingw32msvc-gcc
48 >     export CXX=i586-mingw32msvc-g++
49 >     export CPP=i586-mingw32msvc-cpp
50 >     export RANLIB=i586-mingw32msvc-ranlib
51 >     export PATH="/usr/i586-mingw32msvc/bin:$PATH"
52 >     exec "$@"
53 >     EOF
54
55 If `$HOME/bin` is not already part of your `$PATH`, you need to add it:
56
57 >     export PATH="$HOME/bin:$PATH"
58
59 We use this script to call `./configure` and `make` with the right environment
60 variables.  You can also run the export commands from the `mingw` script by
61 hand instead of calling the mingw script for every `./configure` or `make`
62 command, or execute `$HOME/bin/mingw $SHELL` to get a shell with these
63 environment variables set, but in this howto we will call it explicitly every
64 time it is needed.
65
66 ### Compiling LZO
67
68 Cross-compiling LZO is easy:
69
70 >     cd $HOME/lzo2-2.03
71 >     mingw ./configure --host=mingw32
72 >     mingw make
73 >     DESTDIR=$HOME/mingw mingw make install
74
75 ### Compiling Zlib
76
77 Cross-compiling Zlib is also easy, but a plain `make` failed to compile the
78 tests, so we only build the static library here:
79
80 >     cd $HOME/mingw/zlib-1.2.3.3.dfsg
81 >     mingw ./configure
82 >     mingw make libz.a
83 >     DESTDIR=$HOME/mingw mingw make install
84
85 ### Compiling OpenSSL
86
87 OpenSSL is always a bit hard to compile, because they have their own
88 `Configure` script that needs some tweaking. There is also a small bug in
89 e_os2.h that breaks compilation with recent versions of GCC. First download
90 this [[openssl-cross-compilation.diff]] to your home directory, then patch
91 OpenSSL, and then compile as usual.  Do not use the `-j` option when compiling
92 OpenSSL, it will break.
93
94 >     cd $HOME/mingw/openssl-0.9.8k
95 >     patch < $HOME/openssl-cross-compilation.diff
96 >     mingw ./Configure --openssldir=$HOME/mingw/usr/local mingw
97 >     mingw make
98 >     mingw make install
99
100 ### Compiling tinc
101
102 Now that all the dependencies have been cross-compiled, we can cross-compile
103 tinc.  Since we use a clone of the git repository here, we need to run
104 `autoreconf` first. If you want to cross-compile tinc from a released tarball,
105 this is not necessary.
106
107 >     cd $HOME/mingw/tinc
108 >     autoreconf -fsi
109 >     mingw ./configure --host=mingw32 --with-openssl=$HOME/mingw/usr/local
110 >     mingw make
111
112 ### Testing tinc
113
114 Since Wine was installed, you can execute the resulting binary even on Linux.
115 You cannot do much however, since tinc requires a TAP-Win32 device, which is
116 not available in Wine. Still, the following command should work:
117
118 >     $HOME/mingw/tinc/src/tincd.exe --help
119