= Pidgin for Windows Build Instructions =

Note: The instructions for versions prior to 2.7.0 are found [wiki:BuildingWinPidgin/Pre2.7.0 here].

== Set up your build environment ==

{{{
#!comment
=== The easy way === 
'''Note''': Currently out of date! Use [#Themanualway the manual instructions].

  1. Install the [http://cygwin.com Cygwin] Bash shell. Make sure to select Unix file mode during setup.
     Also make sure you install bash, bzip2, '''ca-certificates''', coreutils,  gawk, '''gnupg''', grep, gzip, '''libiconv''', '''make''', '''patch''', sed, tar, '''unzip''', '''wget''', and '''zip''' (several of these are selected by default, those in bold are not). Be sure to add Cygwin versions of any programs you may use that require Cygwin path names (for example, if you want to use vim to edit monotone commit messages, you need to install the Cygwin version of vim -- native Win32 vim will be unable to read Cygwin-style paths). [[BR]]
     You may prefer to use [http://sourceforge.net/projects/mingw/files/MSYS/Base/msys-core/msys-1.0.11/MSYS-1.0.11.exe/download MSYS] instead of Cygwin.

  2. Download the [http://gaim-extprefs.sourceforge.net/bef.shtml Build Environment Fetcher] script. Follow the instructions on the website to fetch and install most of the needed build dependencies. The script can fetch Pidgin's source code distribution; you will be prompted to choose which version you'd like to use.[[BR]]
     Note that this script is occasionally out of date, especially immediately following releases, in which case you will need to perform some of the manual steps in addition.  The ChangeLog may clue you into which dependencies have changed.

  3. Skip the [#Themanualway The manual way], [#InstallPidginsbuilddependencies Install Pidgin's build dependencies], and [#GetthePidginsourcecode Get the Pidgin source code] sections and go straight to [#BuildPidgin Build Pidgin].

=== The manual way ===
}}}
  1. Install the [http://cygwin.com Cygwin] Bash shell.
     Also make sure you install bash, bzip2, '''ca-certificates''', coreutils, gawk, '''gnupg''', grep, gzip, '''libiconv''', '''make''', '''patch''', sed, tar, '''unzip''', '''wget''', and '''zip''' (several of these are selected by default, those in bold are not).[[BR]]
     You may prefer to use [http://sourceforge.net/projects/mingw/files/MSYS%20Base%20System/msys-1.0.11/MSYS-1.0.11.exe/download MSYS] instead of Cygwin, but if you do so, you may need to tweak the instructions.

  2. The following instructions were written under the assumption that [#GetthePidginsourcecode the Pidgin source] will be extracted or checked out into `$PIDGIN_DEV_ROOT/pidgin-<version>` and that you install all of Pidgin's build dependencies under `$PIDGIN_DEV_ROOT/win32-dev` (the point being that the pidgin source root and `win32-dev` directories should be on the same level).
     Some users may find the [#CustomizingtheBuildEnvironment instructions for customizing their build environment] useful.

  You don't have to actually define an environment variable called `PIDGIN_DEV_ROOT`, it is simply used here as a placeholder.

  ** Note: You should avoid using a `$PIDGIN_DEV_ROOT` path that contains spaces as that can cause unnecessary complications.

  People are sometimes confused about the directory structure, so here is an example structure after all the dependencies have been installed (`$PIDGIN_DEV_ROOT` is `c:\devel\pidgin-devel` in this example):
{{{
c:\devel\pidgin-devel
(The following is the source tree root, containing config.h.mingw and libpurple.)
c:\devel\pidgin-devel\pidgin-<version>
c:\devel\pidgin-devel\win32-dev
(If the following file is present, your structure is probably correct.)
c:\devel\pidgin-devel\win32-dev\gtk_2_0-2.14\include\libintl.h
}}}

  3. Install the MinGW "GCC Version 4.4.0" packages from the [http://www.mingw.org MinGW site].
  * There isn't an installer for these; the following instructions have distilled from the MinGW manual instructions
   * There are known issues with newer gcc versions; be sure to use the version as described below
  * Create a `win32-dev/mingw` directory and download the following into it:
   * [http://sourceforge.net/projects/mingw/files/MinGW/Base/binutils/binutils-2.20/binutils-2.20-1-mingw32-bin.tar.gz/download binutils-2.20]
   * mingw-runtime 3.17 ([http://sourceforge.net/projects/mingw/files/MinGW/Base/mingw-rt/mingwrt-3.17/mingwrt-3.17-mingw32-dev.tar.gz/download dev] and [http://sourceforge.net/projects/mingw/files/MinGW/Base/mingw-rt/mingwrt-3.17/mingwrt-3.17-mingw32-dll.tar.gz/download dll])
   * [http://sourceforge.net/projects/mingw/files/MinGW/Base/w32api/w32api-3.14/w32api-3.14-mingw32-dev.tar.gz/download w32-api 3.14]
   * Required runtime libraries for GCC ([http://sourceforge.net/projects/mingw/files/MinGW/Base/gcc/Version4/Previous%20Release%20gcc-4.4.0/gmp-4.2.4-mingw32-dll.tar.gz/download gmp 4.2.4], [http://sourceforge.net/projects/mingw/files/MinGW/Base/libiconv/libiconv-1.13.1-1/libiconv-1.13.1-1-mingw32-dll-2.tar.lzma/download libiconv 1.13.1], [http://sourceforge.net/projects/mingw/files/MinGW/Base/gcc/Version4/Previous%20Release%20gcc-4.4.0/mpfr-2.4.1-mingw32-dll.tar.gz/download MPFR 2.4.1] and [http://sourceforge.net/projects/mingw/files/MinGW/Base/gcc/Version4/Previous%20Release%20gcc-4.4.0/pthreads-w32-2.8.0-mingw32-dll.tar.gz/download pthreads 2.8.0])
   * gcc-core 4.4.0 ([http://sourceforge.net/projects/mingw/files/MinGW/Base/gcc/Version4/Previous%20Release%20gcc-4.4.0/gcc-core-4.4.0-mingw32-bin.tar.gz/download bin] and [http://sourceforge.net/projects/mingw/files/MinGW/Base/gcc/Version4/Previous%20Release%20gcc-4.4.0/gcc-core-4.4.0-mingw32-dll.tar.gz/download dll])
  * Extract all of the above downloaded files directly into the `win32-dev/mingw` directory.
  * You will need to set MinGW's bin directory before Cygwin's in your `PATH`.[[BR]]
   For Example (You should add the following to your `~/.bashrc` file, which is found in `C:\cygwin\home\YourUsername\` by default):
{{{
#!sh
  export PATH=/cygdrive/c/devel/pidgin-devel/win32-dev/mingw/bin:$PATH
}}}
   If your Pidgin folder is inside Cygwin's, it should look more like this:
{{{
#!sh
  export PATH=/pidgin-devel/win32-dev/mingw/bin:$PATH
}}}


== Install Pidgin's build dependencies ==

=== GTK+ ===
  Pidgin depends on GTK+ 2.14.7 (newer runtime versions can be used).
  The GTK+ All-in-one bundle contains all of GTK+'s dependencies in one zip file.
  Download [http://ftp.gnome.org/pub/gnome/binaries/win32/gtk+/2.14/gtk+-bundle_2.14.7-20090119_win32.zip gtk+-bundle_2.14.7-20090119_win32.zip] and extract to `$PIDGIN_DEV_ROOT/win32-dev/gtk_2_0-2.14` (you'll need to create this directory).[[BR]]
  Visit the [http://www.gtk.org/download-windows.html GTK+ website] for official binary and source releases.

=== gettext ===
  You'll need gettext to compile translations. Download [http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/gettext-tools-0.17.zip gettext-tools-0.17.zip] and [http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/gettext-runtime-0.17-1.zip gettext-runtime-0.17-1.zip]. Extract both to `$PIDGIN_DEV_ROOT/win32-dev/gettext-0.17` (you'll need to create this directory).

=== Libxml2 ===
  Download [http://ftp.gnome.org/pub/GNOME/binaries/win32/dependencies/libxml2-dev_2.9.0-1_win32.zip libxml2-dev_2.9.0-1_win32.zip] and [http://ftp.gnome.org/pub/GNOME/binaries/win32/dependencies/libxml2_2.9.0-1_win32.zip libxml2_2.9.0-1_win32.zip].  Extract both to `$PIDGIN_DEV_ROOT/win32-dev/libxml2-2.9.0` (you'll need to create this directory). [[BR]](Pidgin 2.10.6 and older use: [http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/libxml2_2.7.4-1_win32.zip 2.7.4], [http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/libxml2-dev_2.7.4-1_win32.zip 2.7.4-dev])

=== Perl 5.10 ===
  Install Perl 5.10 (I use [http://www.activestate.com/Products/ActivePerl/ ActivePerl]), and make sure it is in your `PATH`.  If 'perl' isn't in your `PATH` then you will need to override the `PERL` variable in `pidgin/local.mak`.
  You will also need to download [/static/win32/perl_5-10-0.tar.gz perl_5-10-0.tar.gz] and extract to `$PIDGIN_DEV_ROOT/win32-dev` (it creates its own directory).  This contains headers and an import lib for mingw gcc.

  * Note: If using MSYS and you installed the `mingw-developer-toolkit`, keep in mind that it installs `msys-perl-bin` (Perl 5.6) which takes precedence over the (5.10 or newer) perl in your path, and that will cause problems!  You will need to do one of the following:
   * Remove the mingw-developer-toolkit supplied (older) perl (but MAKE SURE you have mingw-get-0.2-mingw32-alpha-3 or later as previous version had issue with unlink'ing/deleting files):
{{{
#!sh
mingw-get remove msys-perl-bin
}}}
   * ''or'' Set your !ActivePerl 5.10 installation location at the beginning of the Cygwin-specific `PATH`.  Assuming it is installed in `c:\Perl`, put something like this in your `~/.bashrc`:
{{{
#!sh
export PATH=/cygdrive/c/Perl/bin:$PATH
}}}

=== Tcl 8.4.5 ===
  Download and extract [/static/win32/tcl-8.4.5.tar.gz tcl-8.4.5.tar.gz] to `$PIDGIN_DEV_ROOT/win32-dev`

=== !GtkSpell ===
    * Download and extract [/static/win32/gtkspell-2.0.16.tar.bz2 gtkspell-2.0.16.tar.bz2] to `$PIDGIN_DEV_ROOT/win32-dev`

=== Enchant ===
    * Download and extract [/static/win32/enchant_1.6.0_win32.zip enchant_1.6.0_win32.zip] to `$PIDGIN_DEV_ROOT/win32-dev/` (older versions: [http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/enchant_1.5.0-2_win32.zip 1.5.0])

=== Mozilla NSS ===
  * Download and extract [/static/win32/nss-3.13.6-nspr-4.9.2.tar.gz nss-3.13.6-nspr-4.9.2.tar.gz] under `$PIDGIN_DEV_ROOT/win32-dev` [[BR]](Pidgin 2.10.6 and older use [/static/win32/nss-3.12.5-nspr-4.8.2.tar.gz 3.12.5]).
    * Note: NSS/NSPR are built from the upstream sources using [wiki:BuildingWinNSS these instructions].

=== SILC Toolkit ===
  Download and extract [/static/win32/silc-toolkit-1.1.10.tar.gz silc-toolkit-1.1.10.tar.gz] to `$PIDGIN_DEV_ROOT/win32-dev` [[BR]](Pidgin 2.10.6 and older use [/static/win32/silc-toolkit-1.1.8.tar.gz 1.1.8]).
  
=== Meanwhile ===
  Download and extract [/static/win32/meanwhile-1.0.2_daa3-win32.zip meanwhile-1.0.2_daa3-win32.zip] to `$PIDGIN_DEV_ROOT/win32-dev` [[BR]](Pidgin 2.10.6 and older use [/static/win32/meanwhile-1.0.2_daa2-win32.zip 1.0.2_daa2]).

=== Bonjour SDK ===
  Download the `Bonjour SDK for Windows` from [http://developer.apple.com/networking/bonjour/download/ the Apple developer website] and install it to `$PIDGIN_DEV_ROOT/win32-dev/Bonjour_SDK`.
  
  Note: Bonjour SDK version 2.0.0 or newer is needed as of Pidgin 2.7.4

  Note2: The Bonjour SDK may install to its default location (`Program Files\Bonjour SDK`) regardless what you have specified during installation. In that case, simply copy everything from `Program Files\Bonjour SDK` to `$PIDGIN_DEV_ROOT/win32-dev/Bonjour_SDK`.

=== Cyrus SASL ===
  Download and extract [/static/win32/cyrus-sasl-2.1.25.tar.gz cyrus-sasl-2.1.25.tar.gz] to `$PIDGIN_DEV_ROOT/win32-dev` (Pidgin 2.10.6 and older use [/static/win32/cyrus-sasl-2.1.22-daa1.zip 2.1.22]).
  [[BR]](this also contains the MIT GSSAPI module)

=== Intltool ===
  Download and extract [http://ftp.acc.umu.se/pub/GNOME/binaries/win32/intltool/0.40/intltool_0.40.4-1_win32.zip intltool_0.40.4-1_win32.zip] to `$PIDGIN_DEV_ROOT/win32-dev/intltool_0.40.4-1_win32`

=== Crash Reporting Library ===
  Download and extract [/static/pidgin-inst-deps-20120910.tar.gz pidgin-inst-deps-20120910.tar.gz] to `$PIDGIN_DEV_ROOT/win32-dev`. (Pidgin 2.10.6 and older use [/static/win32/pidgin-inst-deps-20100315.tar.gz 20100315]).

=== GCC Stack-Smashing Protection Library ===
  Download and extract [http://sourceforge.net/projects/mingw/files/MinGW/Base/gcc/Version4/Previous%20Release%20gcc-4.4.0/gcc-core-4.4.0-mingw32-dll.tar.gz/download gcc-core-4.4.0-mingw32-dll.tar.gz] to `$PIDGIN_DEV_ROOT/win32-dev/gcc-core-4.4.0-mingw32-dll`.

== Get the Pidgin source code ==
  The source for Pidgin 2.10.6 is available [http://prdownloads.sourceforge.net/pidgin/pidgin-2.10.6.tar.bz2 here] (use the latest release if this isn't updated yet).[[BR]][[BR]]
  The development source is available via mercurial. See [wiki:UsingPidginMercurial] for more information.

== Build Pidgin ==

  Run the following:
{{{
#!sh
cd $PIDGIN_DEV_ROOT/pidgin-<version>
make -f Makefile.mingw install
}}}
  Now just wait and let your compiler do its thing.  When finished, Pidgin will be in `$PIDGIN_DEV_ROOT/pidgin-<version>/win32-install-dir`.

== Build the Pidgin Installer ==

  * If you want to build the Pidgin installer, do the following (skip to the `make` command below if you chose to use the Build Environment Fetcher):
    * Download and install [http://nsis.sourceforge.net/Download NSIS]. Include NSIS to Cygwin's `PATH`.
     *  For information on the NSIS installer, visit the [http://nsis.sourceforge.net NSIS website].[[BR]]
    * Download the [http://nsis.sourceforge.net/Nsisunz_plug-in nsisunz plugin], and extract `nsisunz.dll` into the `Plugins` directory of your NSIS installation.
    * Copy `$PIDGIN_DEV_ROOT/win32-dev/pidgin-inst-deps-20120910/SHA1Plugin.dll` into the `Plugins` directory of your NSIS installation.
    * Now you'll need to decide if you want to sign the executables (not necessary for personal use)
     * If you do, you'll need to get an appropriate code signing certificate, generate a GPG key if you don't already have one, then download and install [http://www.mono-project.com/Download Mono]. In your `local.mak` file (see [wiki:"BuildingWinPidgin#CustomizingtheBuildEnvironment" below]), define the `MONO_SIGNCODE` variable to the fully qualified path to the `signcode` batch file in the Mono `bin` directory, and the `SIGNCODE_SPC` and `SIGNCODE_PVK` variables to the appropriate files from your certificate.
     * Otherwise, in your `local.mak` file (see [wiki:"BuildingWinPidgin#CustomizingtheBuildEnvironment" below]), define the `MONO_SIGNCODE` variable to `"echo ***Bypassing signcode"` and the `GPG_SIGN` variable to `"echo ***Bypassing gpg"` to bypass the signing process
  * Now you can actually build the installer.[[BR]]
    There are 2 different installers, an "Offline" installer that includes all dependencies (except spellchecking dictionaries) and the debug symbols and an "Online" installer that includes only Pidgin itself and will download the various dependencies if necessary.
    The `Makefile.mingw` targets for these are `installer_offline`, and `installer` respectively.  To build both, use the `installers` target.
{{{
#!sh
cd $PIDGIN_DEV_ROOT/pidgin-<version>
make -f Makefile.mingw installers
}}}
    When it finishes, your installer(s) should be in `$PIDGIN_DEV_ROOT/pidgin-<version>/`.

== Customizing the Build Environment ==
  Most people will find that the standard build environment directory is completely adequate.
  It is, however, possible to override the locations of the various dependencies and target directories.
  This is often useful to test against a development version of a library dependency or to override compiler flags.

  This done is by overriding the various Makefile variables in a `local.mak` file in the `$PIDGIN_DEV_ROOT/pidgin-<version>` directory.
  This file does not exist by default.

  Most of the variables that can be overridden with this method are defined in the [http://hg.pidgin.im/pidgin/main/file/default/libpurple/win32/global.mak libpurple/win32/global.mak] file.
  For example, to install Pidgin over `c:\Program Files\Pidgin` instead of `$PIDGIN_DEV_ROOT/pidgin/win32-install-dir`, create a `$PIDGIN_DEV_ROOT/pidgin/local.mak` containing:
{{{
 #Override the install location
 PIDGIN_INSTALL_DIR = /cygdrive/c/Program\ Files/Pidgin
 PURPLE_INSTALL_DIR = /cygdrive/c/Program\ Files/Pidgin
}}}

  One nice use of the `local.mak` file is for cross compiling, there is an additional example in the [#CrossCompiling section below]. 

== Debugging ==
  There is a quite good '''Just In Time''' debugger for MinGW: [http://jrfonseca.planetaclix.pt/projects/gnu-win32/software/drmingw/index.html drmingw].
  You can download it [/static/win32/drmingw.exe here].[[BR]]
  There is also a version of `gdb` available from MinGW, if you prefer.

== Cross Compiling ==
  It is quite easy to cross compile Pidgin for Windows on a Linux machine.

  To begin, you'll need to install MinGW. On !Debian/Ubuntu, this involves installing packages `mingw32`, `mingw32-binutils`, and `mingw32-runtime`. On other distributions, the packages may be named differently.

  Set up a build environment as described [#Themanualway above], skipping steps 1 and 3.

  Create a `local.mak` file in the source directory root to override the Makefile variables - mine looks like this:
{{{
SHELL := /bin/bash
CC := /usr/bin/i586-mingw32msvc-cc
GMSGFMT := msgfmt
MAKENSIS := /usr/bin/makensis
WINDRES := /usr/bin/i586-mingw32msvc-windres
STRIP := /usr/bin/i586-mingw32msvc-strip
INTLTOOL_MERGE := /usr/bin/intltool-merge

INCLUDE_PATHS := -I$(PIDGIN_TREE_TOP)/../win32-dev/w32api/include
LIB_PATHS := -L$(PIDGIN_TREE_TOP)/../win32-dev/w32api/lib
}}}

  If your distribution doesn't include a recent enough win32api, you can download it from the [http://www.mingw.org/ MinGW site], extract it into your `win32-dev` directory, and override the `INCLUDE_PATHS` and `LIB_PATHS` variables in your `local.mak` as I have done.

      NSIS version 2.46 or greater is required to cross-compile.  If compiling NSIS from source, the [http://www.scons.org/ scons] package is a dependency.  This can usually be installed through your linux distribution's package archive.  An example of how to install the NSIS package is given below (Assuming use of the NSIS 2.46 version):

      `.tar.bz2` file contains latest source[[BR]]
      `.zip` file contains libraries
{{{
#!sh
mkdir nsis; cd nsis
wget http://prdownloads.sourceforge.net/nsis/nsis-2.46-src.tar.bz2?download 
wget http://prdownloads.sourceforge.net/nsis/nsis-2.46.zip?download
tar -jxvf nsis-2.46-src.tar.bz2
cd nsis-2.46
scons SKIPSTUBS=all SKIPPLUGINS=all SKIPUTILS=all SKIPMISC=all NSIS_CONFIG_CONST_DATA_PATH=no
sudo scons install-compiler
cd ..
sudo unzip nsis-2.46 -d /usr/local/share
sudo mv /usr/local/share/nsis-2.46/ /usr/local/share/nsis 
}}}
      If following the above instructions, the local.mak file ([#CrossCompiling listed above]) should be modified[[BR]]
{{{
MAKENSIS := /usr/local/bin/makensis
}}}


  Once this is all set up, you should be able to follow the [#BuildPidgin building instructions above].