Changes between Initial Version and Version 1 of BuildingWinPidgin/Pre2.7.0

Timestamp:

Feb 18, 2010, 11:12:39 PM (14 years ago)

Author:

datallah

Comment:

Copy BuildingWinPidgin before 2.7.0 changes

BuildingWinPidgin/Pre2.7.0

@@ +1 @@
+= Pidgin for Windows Build Instructions =
+
+== Set up your build environment ==
+
+=== The easy way === 
+
+  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, coreutils, gawk, grep, gzip, '''make''', '''monotone''', '''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 the native Windows monotone binary available [http://www.monotone.ca here]. 
+
+  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, coreutils, gawk, grep, gzip, '''make''', '''monotone''', '''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 the native Windows monotone binary available [http://www.monotone.ca here].
+
+  2. Install the MinGW "current" packages from the [http://www.mingw.org MinGW site].[[BR]]
+     The easiest way to install these is to use the [http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=240780 Automated MinGW Installer].[[BR]]
+     Specifically, you will need `gcc-core 3.4.2`, `binutils 2.15.91`, `mingw-runtime 3.9` and `win32api 3.9` (or newer).[[BR]]
+     You will need to set MinGW's bin directory before Cygwin's in your PATH.[[BR]]
+     For Example (You can add the following to your `~/.bashrc` file (create the file if it doesn't exist yet)):
+{{{
+  export PATH=/cygdrive/c/MinGW/bin:$PATH
+}}}
+     You do not want to use any of Cygwin's build tools, with one exception; you need to use Cygwin's make utility. If typing `which make` produces MinGW's make utility, then just rename the `make.exe` in the MinGW bin directory to something else so that cygwin's make utility will be used instead. This shouldn't be a problem with recent versions of MinGW.
+
+  3. 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:/development/pidgin_dev` in this example):
+{{{
+C:\development\pidgin_dev
+(The following is the source tree root, containing config.h.mingw and libpurple.)
+C:\development\pidgin_dev\pidgin-<version>
+C:\development\pidgin_dev\win32-dev
+(If the following file is present, your structure is probably correct.)
+C:\development\pidgin_dev\win32-dev\gtk_2_0\include\libintl.h
+}}}
+
+== Install Pidgin's build dependencies ==
+
+=== GTK+ ===
+
+  Pidgin depends on GTK+ 2.6.10 (newer runtime versions can be used, but building against newer headers will prevent Win98/ME compatibility).
+  For your convenience, we have included all of GTK's dependencies in one tarball.
+  Extract [http://prdownloads.sourceforge.net/pidgin/gtk-dev-2.6.10-rev-a.tar.gz?download gtk-dev-2.6.10-rev-a.tar.gz] within `$PIDGIN_DEV_ROOT/win32-dev`.[[BR]]
+  If you wish to run Pidgin from the `win32-install-dir` directory once it is built, you will need to make sure that you have installed the GTK+ runtime, and make sure that its bin dir is in your PATH.[[BR]]
+  Visit the [http://www.gtk.org GTK+ website] for official binary and source releases.
+
+=== Libxml2 ===
+  Download and extract [/static/win32/libxml2-2.6.30.tar.gz libxml2-2.6.30.tar.gz] to `win32-dev`. (older version: [/static/win32/libxml2-2.6.24.tar.gz 2.6.24])
+
+=== Perl 5.10 ===
+  Install Perl 5.10 for Windows (I use [http://www.activestate.com/Products/ActivePerl/ ActivePerl]), to `C:\Perl`.
+  If you install Perl anywhere else, you will need to override the `PERL` and `EXTUTILS` variables in your `pidgin/local.mak` file.
+  You will also need to install [/static/win32/perl_5-10-0.tar.gz perl_5-10-0.tar.gz] under `$PIDGIN_DEV_ROOT/win32-dev` (Containing headers and import lib for mingw gcc).  (Pidgin 2.4.3 and prior require an older version: [/static/win32/perl582.tar.gz perl582.tar.gz])
+
+=== Tcl 8.4.5 ===
+  Download and extract [/static/win32/tcl-8.4.5.tar.gz tcl-8.4.5.tar.gz] to `win32-dev`
+
+=== !GtkSpell / Aspell ===
+  * Download the following development packages for !GtkSpell and Aspell, and extract them under `win32-dev`:
+    * [ftp://ftp.gnu.org/gnu/aspell/w32/aspell-dev-0-50-3-3.zip aspell-dev-0-50-3-3.zip]
+    * [/static/win32/gtkspell-2.0.11-daa1.tar.gz gtkspell-2.0.11-daa1.tar.gz] (older versions: [/static/win32/gtkspell-2.0.11.tar.gz 2.0.11], [/static/win32/gtkspell-2.0.6.tar.gz 2.0.6])
+
+=== Mozilla NSS ===
+  * Download and unzip the following under `$PIDGIN_DEV_ROOT/win32-dev`:
+    * [ftp://ftp.mozilla.org/pub/mozilla.org/security/nss/releases/NSS_3_11_4_RTM/msvc6.0/WIN954.0_OPT.OBJ/nss-3.11.4.zip Network Security Services (NSS)]
+    * [ftp://ftp.mozilla.org/pub/mozilla.org/nspr/releases/v4.6.4/msvc6.0/WIN954.0_OPT.OBJ/nspr-4.6.4.zip Netscape Portable Runtime (NSPR)]
+
+=== SILC Toolkit ===
+  Download and extract [/static/win32/silc-toolkit-1.1.8.tar.gz silc-toolkit-1.1.8.tar.gz] to `win32-dev`. (older versions: [/static/win32/silc-toolkit-1.0.2.tar.gz 1.0.2], [/static/win32/silc-toolkit-1.1.2.tar.gz 1.1.2], [/static/win32/silc-toolkit-1.1.5.tar.gz 1.1.5], [/static/win32/silc-toolkit-1.1.7.tar.gz 1.1.7])
+  
+=== Meanwhile ===
+  Download and extract [/static/win32/meanwhile-1.0.2_daa2-win32.zip meanwhile-1.0.2_daa2-win32.zip] to `win32-dev`. (older versions: [http://prdownloads.sourceforge.net/meanwhile/meanwhile-1.0.2-win32.zip?download 1.0.2], [/static/win32/meanwhile-1.0.2_daa1-win32.zip 1.0.2_daa1])
+
+=== Bonjour SDK ===
+
+  Download the `Bonjour SDK for Windows` from [http://developer.apple.com/networking/bonjour/download/ the Apple developer website] and install it to `win32-dev/Bonjour_SDK`.
+
+=== Cyrus SASL ===
+
+  Download and extract [/static/win32/cyrus-sasl-2.1.22-daa1.zip cyrus-sasl-2.1.22-daa1.zip] to `win32-dev`. (older version: [/static/win32/cyrus-sasl-2.1.22.zip cyrus-sasl-2.1.22.zip])
+  [[BR]](this also contains the MIT GSSAPI module)
+  
+
+== Get the Pidgin source code ==
+  The source for Pidgin 2.6.3 is available [http://prdownloads.sourceforge.net/pidgin/pidgin-2.6.3.tar.bz2 here] (use the latest release if this isn't updated yet).[[BR]][[BR]]
+  The development source is available via monotone. See [wiki:UsingPidginMonotone] for more information.
+
+== Build Pidgin ==
+  Run the following:
+{{{
+$ 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 your PATH.
+      For information on the NSIS installer, visit the [http://nsis.sourceforge.net NSIS website].[[BR]]
+      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
+{{{
+$ 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 below]) should be modified[[BR]]
+      MAKENSIS := /usr/local/bin/makensis  
+
+    * Download [http://prdownloads.sourceforge.net/pidgin/gtk-2.14.7-rev-a-installer.tar.gz?download gtk-2.14.7-rev-a-installer.tar.gz]
+      and extract it to `$PIDGIN_DEV_ROOT/`. From within the new `gtk_installer directory`, run `. build.sh` (this builds the GTK+ runtime installer, which the Pidgin installer will include). **Please see [#CrossCompiling note below] if building on Ubuntu/Debian about modification of the build.sh file.
+    * Download [/static/win32/pidgin-inst-deps.tar.gz pidgin-inst-deps.tar.gz] and extract under `$PIDGIN_DEV_ROOT/win32-dev`.
+  * Now you can actually build the installer.[[BR]]
+    There are 3 different installers: "Normal" (with GTK+), "No GTK+" and "Debug".
+    The Makefile targets for these are `installer`, `installer_nogtk`, and `installer_debug` respectively.  To build all 3, use the `installers` target.
+{{{
+$ 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 evironment 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 overridding 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 [/viewmtn/revision/file/8c0ef1cb63204eeb0e5cda5501300c62d11bf89e/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.  Note that cross-compiling does '''''not''''' work properly on Debian Sid on amd64 (also called x86_64 or x64) systems--the most common failure is that the linker will die with a segmentation fault at various points.  You may have differing success or failure on other 64-bit Linux distributions.
+
+  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 2.
+
+  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
+MAKENSISOPT := -
+PERL := /usr/bin/perl
+EXTUTILS := /usr/share/perl/5.8/ExtUtils
+WINDRES := /usr/bin/i586-mingw32msvc-windres
+STRIP := /usr/bin/i586-mingw32msvc-strip
+
+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.
+
+  If you want to build the installers, you'll need to install [#BuildthePidginInstaller NSIS].  On Debian and Ubuntu, the package name is `nsis`; this will likely be different elsewhere.  In order to build the GTK+ installer as mentioned above, the `build.sh` script referenced above needs to be changed.  The line starting with `makensis.exe` needs to be changed to read:
+{{{
+makensis -V3 -DGTK_VERSION=$gtk_version -DGTK_REVISION=$gtk_revision gtk-installer.nsi
+}}}
+
+  Once this is all set up, you should be able to follow the [#BuildPidgin building instructions above].