Bluefish Wiki - User contributions [en]

Setting up a Windows Build Environment

2010-07-31T01:10:47Z

Reisio: /* Notes and references */

== Windows Build Status ==

Binary and plugins are running and should be fully functional. If you encounter unexpected behaviour or bugs, please report your problem to [https://bugzilla.gnome.org/enter_bug.cgi?product=bluefish our BTS].

=== Current Known Issues ===

* Socket code doesn't work so files can't be opened externally in a currently running copy of bluefish.
* Launching of external programs doesn't work.
* Editing of UTF files with a BOM headers is not currently supported.

== Setting up your Build Environment ==

The first step is of course to install and setup the MingW and MSYS environments. Start with the [https://sourceforge.net/projects/mingw/files/Automated%20MinGW%20Installer/MinGW%205.1.6/MinGW-5.1.6.exe/download automated MinGW installer]. During installation choose the g++ compiler too ('''do not choose MingW make'''). The preferred location is <tt>C:\MinGW</tt>, but it's not necessary to choose this path. In a second step install the [https://sourceforge.net/projects/mingw/files/MSYS%20Base%20System/Current%20Release_%20MSYS-1.0.11/MSYS-1.0.11.exe/download MSYS base system]. It will ask you for the location of the MingW environment. If you e.g. installed it to <tt>P:\Programs\MinGW</tt>, then type

<pre>p:/programs/mingw</pre>

when you are asked for the location (JFTR: this information will be put into <tt>/etc/fstab</tt> in the MSYS environment).

If you know what you are doing, you might alternatively download and unpack (unzip/untar/...) the packages manually.

=== Recent Build Environment Changes ===

If you are maintaining a build environment for Bluefish please check this subsection occasionally for important changes!

;2009-12-10
:If you build your own installers we now use a unicode version of NSIS, [http://www.scratchpaper.com/home Unicode NSIS], to support UTF-8 encoded translations.

;2009-09-23:
:The GNOME packages have been updated to reflect those versions which are included with Pidgin's GTK+ installer. This is currently being used as our target runtime environment for the Installer version of Bluefish. If you're first setting up your build environment you can skip this section as the information provided below is always up to date. If you already have a build environment setup you will need to update a few packages to the versions provided below. These include atk (1.26.0->1.24.0), glib (2.20.4->2.18.4), gtk+ (2.16.5->2.14.7), and pango (1.24.5->1.22.4).

:If you don't intend to run your builds of Bluefish outside of your MSYS environment this change is not required. However if you do wish to do so and wish to remain with GTK+ 2.16 you can use the [http://gtk-win.sourceforge.net/ GTK-Win] installer. This version is not officially supported by the windows development team as of yet because while it's fine for Bluefish it does break some features in Pidgin so keep this in mind if you use both programs.

=== Updating the Build Environment ===

In a second step all necessary software needs to be updated and/or installed. You can download and extract them manually. Extract them to the location, where MSYS has been installed. This place is usually <tt>C:\Programs\msys\1.0\</tt> (or <tt>C:\MingGW\</tt>). Keep in mind, that this place is equal to the root directory <tt>/</tt> and to <tt>/usr/</tt> (as both are the same) in MSYS. JFTR: Also <tt>/local</tt> and <tt>/usr/local</tt> are equal too.

;''MinGW Packages'' install into MingW root (<tt>C:\MinGW\</tt>)
:[https://sourceforge.net/projects/mingw/files/MinGW%20API%20for%20MS-Windows/Current%20Release_%20w32api-3.13/w32api-3.13-mingw32-dev.tar.gz/download w32api-3.13-mingw32-dev.tar.gz]
:[https://sourceforge.net/projects/mingw/files/MinGW%20Utilities/mingw-utils/mingw-utils-0.3/mingw-utils-0.3.tar.gz/download mingw-utils-0.3.tar.gz]
:[https://sourceforge.net/projects/mingw/files/MinGW%20Runtime/mingwrt-3.16/mingwrt-3.16-mingw32-dev.tar.gz/download mingwrt-3.16-mingw32-dev.tar.gz]
:[https://sourceforge.net/projects/mingw/files/MinGW%20Runtime/mingwrt-3.16/mingwrt-3.16-mingw32-dll.tar.gz/download mingwrt-3.16-mingw32-dll.tar.gz]


;''MSYS Packages'' install into MSYS root directory "<tt>/</tt>" (<tt>C:\Programs\msys\1.0\</tt> or <tt>C:\MinGW\</tt>)
:[https://sourceforge.net/projects/mingw/files/MSYS%20Base%20System/Current%20Release_%20MSYS-1.0.11/msysCORE-1.0.11-bin.tar.gz/download msysCORE-1.0.11-bin.tar.gz]
:[https://sourceforge.net/projects/mingw/files/MSYS%20autoconf/autoconf-2.63-1/autoconf-2.63-1-msys-1.0.11-bin.tar.lzma/download autoconf-2.63-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20automake/automake-1.11-1/automake-1.11-1-msys-1.0.11-bin.tar.lzma/download automake-1.11-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20bison/bison-2.4.1-1/bison-2.4.1-1-msys-1.0.11-bin.tar.lzma/download bison-2.4.1-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20bzip2/bzip2-1.0.5-1/bzip2-1.0.5-1-msys-1.0.11-bin.tar.gz/download bzip2-1.0.5-1-msys-1.0.11-bin.tar.gz]
:[https://sourceforge.net/projects/mingw/files/MSYS%20crypt/crypt-1.1_1-2/crypt-1.1_1-2-msys-1.0.11-bin.tar.lzma/download crypt-1.1_1-2-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20findutils/findutils-4.4.2-1/findutils-4.4.2-1-msys-1.0.11-bin.tar.lzma/download findutils-4.4.2-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20flex/flex-2.5.35-1/flex-2.5.35-1-msys-1.0.11-bin.tar.lzma/download flex-2.5.35-1-msys-1.0.11-bin.tar.lzma ]
:[https://sourceforge.net/projects/mingw/files/MSYS%20gawk/gawk-3.1.7-1/gawk-3.1.7-1-msys-1.0.11-bin.tar.lzma/download gawk-3.1.7-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20gdbm/gdbm-1.8.3-2/gdbm-1.8.3-2-msys-1.0.11-bin.tar.lzma/download gdbm-1.8.3-2-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20gettext/gettext-0.17-1/gettext-0.17-1-msys-1.0.11-bin.tar.lzma/download gettext-0.17-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20grep/grep-2.5.4-1/grep-2.5.4-1-msys-1.0.11-bin.tar.lzma/download grep-2.5.4-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20groff/groff-1.20.1-1/groff-1.20.1-1-msys-1.0.11-bin.tar.lzma/download groff-1.20.1-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20guile/guile-1.8.7-1/guile-1.8.7-1-msys-1.0.11-bin.tar.lzma/download guile-1.8.7-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20gzip/gzip-1.3.12-1/gzip-1.3.12-1-msys-1.0.11-bin.tar.lzma/download gzip-1.3.12-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20bzip2/bzip2-1.0.5-1/libbz2-1.0.5-1-msys-1.0.11-dll-1.tar.gz/download libbz2-1.0.5-1-msys-1.0.11-dll-1.tar.gz]
:[https://sourceforge.net/projects/mingw/files/MSYS%20crypt/crypt-1.1_1-2/libcrypt-1.1_1-2-msys-1.0.11-dll-0.tar.lzma/download libcrypt-1.1_1-2-msys-1.0.11-dll-0.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20gdbm/gdbm-1.8.3-2/libgdbm-1.8.3-2-msys-1.0.11-dll-3.tar.lzma/download libgdbm-1.8.3-2-msys-1.0.11-dll-3.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20guile/guile-1.8.7-1/libguile-1.8.7-1-msys-1.0.11-dll-17.tar.lzma/download libguile-1.8.7-1-msys-1.0.11-dll-17.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20libiconv/libiconv-1.13.1-1/libiconv-1.13.1-1-msys-1.0.11-bin.tar.lzma/download libiconv-1.13.1-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20libtool/libtool-2.2.7a-1/libltdl-2.2.7a-1-msys-1.0.11-dll-7.tar.lzma/download libltdl-2.2.7a-1-msys-1.0.11-dll-7.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20minires/minires-1.02_1-1/libminires-1.02_1-1-msys-1.0.11-dll.tar.lzma/download libminires-1.02_1-1-msys-1.0.11-dll.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20openssl/openssl-0.9.8k-1/libopenssl-0.9.8k-1-msys-1.0.11-dll-098.tar.lzma/download libopenssl-0.9.8k-1-msys-1.0.11-dll-098.tar.lzma ]
:[https://sourceforge.net/projects/mingw/files/MSYS%20regex/regex-1.20090805-1/libregex-1.20090805-1-msys-1.0.11-dll-1.tar.lzma/download libregex-1.20090805-1-msys-1.0.11-dll-1.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20libtool/libtool-2.2.7a-1/libtool-2.2.7a-1-msys-1.0.11-bin.tar.lzma/download libtool-2.2.7a-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20lndir/lndir-1.0.1-1/lndir-1.0.1-1-msys-1.0.11-bin.tar.gz/download lndir-1.0.1-1-msys-1.0.11-bin.tar.gz]
:[https://sourceforge.net/projects/mingw/files/MSYS%20m4/m4-1.4.13-1/m4-1.4.13-1-msys-1.0.11-bin.tar.lzma/download m4-1.4.13-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20man/man-1.6f-1/man-1.6f-1-msys-1.0.11-bin.tar.lzma/download man-1.6f-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20minires/minires-1.02_1-1/minires-1.02_1-1-msys-1.0.11-bin.tar.lzma/download minires-1.02_1-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20openssl/openssl-0.9.8k-1/openssl-0.9.8k-1-msys-1.0.11-bin.tar.lzma/download openssl-0.9.8k-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20patch/patch-2.5.9-1/patch-2.5.9-1-msys-1.0.11-bin.tar.lzma/download patch-2.5.9-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20perl/perl-5.6.1_2-1/perl-5.6.1_2-1-msys-1.0.11-bin.tar.lzma/download perl-5.6.1_2-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20sed/sed-4.2.1-1/sed-4.2.1-1-msys-1.0.11-bin.tar.lzma/download sed-4.2.1-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20tar/tar-1.22-1/tar-1.22-1-msys-1.0.11-bin.tar.lzma/download tar-1.22-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20vim/vim-7.2-1/vim-7.2-1-msys-1.0.11-bin.tar.lzma/download vim-7.2-1-msys-1.0.11-bin.tar.lzma]
:[https://sourceforge.net/projects/mingw/files/MSYS%20zlib/zlib-1.2.3-1/zlib-1.2.3-1-msys-1.0.11-dll.tar.gz/download zlib-1.2.3-1-msys-1.0.11-dll.tar.gz]

;''GNOME Packages'' install into MSYS local directory "<tt>/local</tt>" (<tt>C:\Programs\msys\1.0\local\</tt> or <tt>C:\MinGW\local\</tt>)
:[http://ftp.gnome.org/pub/gnome/binaries/win32/atk/1.24/atk_1.24.0-1_win32.zip atk_1.24.0-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/atk/1.24/atk-dev_1.24.0-1_win32.zip atk-dev_1.24.0-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/cairo_1.8.8-1_win32.zip cairo_1.8.8-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/cairo-dev_1.8.8-1_win32.zip cairo-dev_1.8.8-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/expat_2.0.1-1_win32.zip expat_2.0.1-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/expat-dev_2.0.1-1_win32.zip expat-dev_2.0.1-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/GConf/2.22/GConf_2.22.0-2_win32.zip GConf_2.22.0-2_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/GConf/2.22/GConf-dev_2.22.0-2_win32.zip GConf-dev_2.22.0-2_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/gettext-runtime-0.17.zip gettext-runtime-0.17.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/gettext-runtime-dev-0.17.zip gettext-runtime-dev-0.17.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/gettext-tools-0.17.zip gettext-tools-0.17.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/glib/2.18/glib_2.18.4-1_win32.zip glib_2.18.4-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/glib/2.18/glib-dev_2.18.4-1_win32.zip glib-dev_2.18.4-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/gnome-common/2.11/gnome-common-2.11.0.zip gnome-common-2.11.0.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/gtk+/2.14/gtk+_2.14.7-1_win32.zip gtk+_2.14.7-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/gtk+/2.14/gtk+-dev_2.14.7-1_win32.zip gtk+-dev_2.14.7-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/intltool/0.40/intltool_0.40.4-1_win32.zip intltool_0.40.4-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/intltool/0.40/intltool-dev_0.40.4-1_win32.zip intltool-dev_0.40.4-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/libgnurx-2.5.zip libgnurx-2.5.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/libgnurx-dev-2.5.zip libgnurx-dev-2.5.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/libiconv-1.9.1.bin.woe32.zip libiconv-1.9.1.bin.woe32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/libpng_1.2.38-1_win32.zip libpng_1.2.38-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/libpng-dev_1.2.38-1_win32.zip libpng-dev_1.2.38-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/libxml2_2.7.3-1_win32.zip libxml2_2.7.3-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/libxml2-dev_2.7.3-1_win32.zip libxml2-dev_2.7.3-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/ORBit2/2.14/ORBit2-dev_2.14.16-1_win32.zip ORBit2-dev_2.14.16-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/ORBit2/2.14/ORBit2_2.14.16-1_win32.zip ORBit2_2.14.16-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/pango/1.22/pango_1.22.4-1_win32.zip pango_1.22.4-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/pango/1.22/pango-dev_1.22.4-1_win32.zip pango-dev_1.22.4-1_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config_0.23-3_win32.zip pkg-config_0.23-3_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config-dev_0.23-3_win32.zip pkg-config-dev_0.23-3_win32.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/zlib-1.2.3.zip zlib-1.2.3.zip]
:[http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/zlib-dev-1.2.3.zip zlib-dev-1.2.3.zip]

;''External Packages'' install into MSYS local directory "<tt>/local</tt>" (<tt>C:\Programs\msys\1.0\local\</tt> or <tt>C:\MinGW\local\</tt>)
:[http://subversion.tigris.org/files/documents/15/46518/svn-win32-1.6.5.zip svn-win32-1.6.5.zip]

=== The Perl Issue ===

The last thing you need is Perl. The MSYS version is 5.6.1 which is not new enough to pass the configure script for a lot of programs including Bluefish. I use the MSYS 5.6.1 version for autoconf/automake/autogen.sh and an external version such as [http://www.activestate.com/activeperl/ ActiveState's] for anything that needs a newer version. Install the ActivePerl Perl version. Then edit <tt>/etc/fstab</tt> in your MSYS enviroment (usually <tt></tt>) and add the following line:

<pre>c:/programs/perl /opt/perl</pre>

so Perl is mounted to the MSYS environment.

== Configuring your Build Environment ==

You might set a few environment variables as follows.

<pre>PATH="/bin:/local/bin:/opt/perl/bin"
C_INCLUDE_PATH="/include:/local/include"
LIBRARY_PATH="/lib:/local/lib"</pre>

;Alternatively pass [http://bluefish.svn.sf.net/viewvc/bluefish/trunk/bluefish/config.site/config.msys our config.site script] for MSYS to configure to adjust PATH/CFLAGS/LDFLAGS easily.

Further we need to adjust the macro search path for aclocal:

<pre>echo /local/share/aclocal > /share/aclocal/dirlist</pre>

Because of a linker bug in the <tt>gconftool-2</tt> binary add this symbolic link:

<pre>ln -s /local/bin/libxml2-2.dll /local/bin/libxml2.dll</pre>

== Building External Packages ==

To build bluefish we need some libraries not available from the MinGW/MSYS project.

=== Installing Pre-Compiled Packages ===

Shawn Novak provides pre-compiled tarballs, which you just need to extract to <tt>/local</tt>:

;''Custom Packages'' install into MSYS local directory "<tt>/local</tt>" (<tt>C:\Programs\msys\1.0\local\</tt> or <tt>C:\MinGW\local\</tt>)
:[http://www.muleslow.net/files/mingw/pcre-7.9-bin-MinGW-20090902.tbz2 pcre-7.9-bin-MinGW-20090902.tbz2]
:[http://www.muleslow.net/files/mingw/aspell-0.60.6-bin-MinGW-20090901.tbz2 aspell-0.60.6-bin-MinGW-20090901.tbz2]
:[http://www.muleslow.net/files/mingw/enchant-1.5.0-bin-MinGW-20090901.tbz2 enchant-1.5.0-bin-MinGW-20090901.tbz2]

A full set of dictionaries for Aspell 0.60.6 can be found here: [http://www.muleslow.net/files/aspell/lang/ http://www.muleslow.net/files/aspell/lang/]

=== Building and Installing from the Source ===

If you wish to build your own version of these custom packages, these are the configure parameters used for the ones provided.
<ref>Note by Daniel Leidert: I further pass a short <tt>msys.site</tt> script with the following content to <tt>configure</tt>:

<pre>#!/bin/sh
PATH="/opt/perl/bin:$PATH"
prefix=/local
exec_prefix='${prefix}'
enable_shared=yes
enable_static=no
enable_maintainer_mode=yes
LDFLAGS="-L/local/lib -L/lib"
CFLAGS="-g -Wall -O2 -I/local/include -I/include -mwindows"
CPPFLAGS="-g -Wall -O2 -I/local/include -I/include"</pre>

The configure script is then called as follows together with the switches as shown above:

<pre>./configure CONFIG_SITE=msys.site ...configure options see above...</pre>
</ref>

;[ftp://ftp.gnu.org/gnu/aspell/aspell-0.60.6.tar.gz Aspell 0.60.6]

In the aspell source add

#include "asc_ctype.hpp"

to the includes at '''common/file_util.cpp'''.

./configure --prefix=/local --disable-rpath --enable-win32-relocatable

;[http://www.abisource.com/downloads/enchant/1.5.0/enchant-1.5.0.tar.gz Enchant 1.5.0]

./configure --prefix=/local --enable-aspell --disable-ispell --disable-myspell

;[ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-7.9.tar.bz2 PCRE 7.9] (UTF-8 support is a '''must''')

./configure --prefix=/local --enable-utf8 --enable-unicode-properties

;[http://ftp.gnome.org/pub/GNOME/sources/gucharmap/2.26/gucharmap-2.26.3.tar.bz2 gucharmap 2.26]

Unfortunately gucharmap does not build out-of-the-box. The following instructions were taken from the [http://article.gmane.org/gmane.comp.web.bluefish.devel/2197 mailing list]. First apply the following patch by Daniel Leidert [http://www.muleslow.net/files/mingw/patches/gucharmap26.diff gucharmap26.diff] and then configure with the following commands.

patch -p0 <gucharmap26.diff
intltoolize -f
libtoolize -f
aclocal -I m4/ --force
autoheader -f
automake -f
autoconf -f
./configure --disable-gconf --disable-schemas-install --disable-scrollkeeper

== Building Bluefish ==

Check out the latest code from trunk:

<pre>svn checkout https://bluefish.svn.sourceforge.net/svnroot/bluefish/trunk/bluefish</pre>

Run <tt>autogen.sh</tt> (uses perl 5.6.1). Then run <tt>configure</tt> (make sure, Perl from <tt>/opt/perl/bin</tt> is used; e.g. adjust PATH) and make:

<pre>./autogen.sh
./configure CONFIG_SITE=config.site/config.msys
make
make install</pre>

== Debugging Bluefish ==

For console debugging output, configure bluefish by passing '--enable-debugging-output' to <tt>./configure</tt>. Further CFLAGS should contain '-g' (default, also explicitly set by <tt>config.msys</tt>).

For debugging crashes install the [https://sourceforge.net/projects/mingw/files/GNU%20Source-Level%20Debugger/Current%20Release_%20gdb-5.2.1/gdb-5.2.1-1.exe/download GNU Debugger (GDB)].

== Create the Installer ==
To compile the installer you'll need to have [http://www.scratchpaper.com/home Unicode NSIS] with the [http://nsis.sourceforge.net/UnTGZ_plug-in UnTGZ] plugin installed. You should also have makensis.exe in your path (such as in /opt/nsis).

To build the installer configure and build Bluefish with the following commands.

<pre>
./configure CONFIG_SITE=win32/config.nsis
cd win32
make -f Makefile.mingw installer
</pre>

==Notes and references==
References: <references/>

==See also==
[[Installing_Bluefish#Installing_Bluefish_on_Windows_XP.2FVista.2F7_.2832_bit.29|Existing win32 builds]]

Compiling Under Cygwin

2010-07-31T01:09:53Z

Reisio:

==Existing win32 builds==
[[Installing_Bluefish#Installing_Bluefish_on_Windows_XP.2FVista.2F7_.2832_bit.29|Installing Bluefish on Windows XP/Vista/7 (32 bit)]]

==See also==
[[Setting up a Windows Build Environment]]

== Compile Bluefish for Cygwin==

'''Cygwin does not provide the necessary GTK/Glib versions to compile Bluefish >= 1.3.'''

To make sure, you will not miss anything, we start at the beginning - the package selection during the the [http://www.cygwin.com Cygwin ] installation. If you have a running system, it is possible, that you already have packages installed, we will need.

=== Package selection ===

We need the following packages in addition to the packages, Cygwin wants to install by default. If you select a package, Cygwin sometimes will add some packages automatically because of existing dependencies:

* Admin section
* cygrunsrv (necessary service, we will need to run Bluefish)
* Base section (all packages in this section should be installed by default)
* Devel section
* ORBit2-devel
* atk-devel
* autoconf2.5
* automake1.x (what you prefer, I suggest automake1.7)
* binutils
* bison
* catgets
* cvs (to checkout Bluefish from CVS)
* gcc
* gettext
* gettext-devel
* glib2-devel
* gtk2-x11-devel
* libbonobo2-devel
* libfreetype2-devel
* libxml2-devel (libxml2 contains xmllint)
* make
* minires-devel
* openssl-devel
* pango-devel
* pcre
* pcre-devel
* pkgconfig
* Gnome section
* gnome-vfs2
* libgnome2
* libgnomeui2 (optional)
* Interpreters section
* python (optional)
* Libs section
* popt
* Text section
* aspell-dev
* aspell-LANG (use a package for your language)
* Utils section (should all be optional)
* bzip2 (if you prefer bzipped2 compressed archives)
* desktop-file-utils
* gnome-mime-data
* shared-mime-info
* Web section
* tidy (contains tidy binary)
* wget (to grep a bluefish-source archive)
* X11
* hicolor-icon-theme (optional)
* xorg-x11-devel
* xorg-x11-base, xorg-x11-bin, xorg-x11-bin-dlls, xorg-x11-fenc, xorg-x11-fnts (should be installed by default)
* xorg-x11-fsrv (font-server, really necessary or you will receive errors from fontconfig)
* xorg-x11-f100, xorg-x11-fcyr, xorg-x11-fscl (optional, but recommended)

Confirm your selection and Cygwin will install a base system and your selected packages.

=== Downloading and compiling Bluefish ===

The compilation and installation is done in 3 steps (see the generic information in the [http://bluefish.openoffice.nl/manual/ Bluefish manual ]). Start a Cygwin Bash Shell (START > Programs > CYGWIN > Cygwin Bash Shell '''OR''' the desktop icon) and create a directory, where you want to put the source:

<pre>
$ mkdir bluefish && cd bluefish
</pre>

Now you can use [http://www.gnu.org/software/cvs/]] (see the instructions at [[[[DownloadingFromCVS]] CVS ] about working with CVS)

<pre>
$ cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/bluefish login
$ cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/bluefish checkout bluefish-gtk2
$ cd bluefish-gtk2
</pre>

or [http://www.gnu.org/software/wget/wget.html wget ]

<pre>
$ wget ~http://pkedu.fbt.eitn.wau.nl/~olivier/downloads/bluefish-1.0.1.tar.gz
$ tar -xzf bluefish-1.0.1.tar.gz
$ cd bluefish-1.0.1
</pre>

to get a release or snapshot. Now proceed with the compilation and installation (see the Manual for more info about possible configure options):

<pre>
$ autoconf
$ ./configure ~[[your preferred options]]
$ make
$ make install
</pre>

Now Bluefish is installed.

=== Starting the ''cygserver'' service ===

Maybe you remember, we installed a package ''cygrunsrv'' in step 1. This service is necessary to ... To start it, first run

<pre>
$ /usr/bin/cygserver-config
</pre>

saying '''Yes''' to install ''cygserver'' as service. Then go to the '''START'''-Button of your Windows-box, choose '''Run''' (gives you a command-line), type '''cmd''' (for older Windows use '''...''') and hit '''ENTER'''. Now a Windows-Shell opens. We need to start the service with:

<pre>
C:\WINDOWS\some\path> net start cygserver
</pre>

The output sould tell you, if everything went ok. If you want to stop the service use: <code>net stop cygserver</code> (see also Start > Control Panel > Computer Administration > Services and Applications > Services : CYGWIN cygserver - set the startup-type for this service to ''Automatic'' and the service will be started with windows). Now you can close the Windows shell.

=== Starting Bluefish ===

If everything went ok, you should now be able to start Bluefish. Start the [http://www.x.org/ X-Server ]

<pre>
$ startx
</pre>

and run Bluefish with

<pre>
$ '''CYGWIN=server''' /usr/bin/bluefish.exe
</pre>

The path and the executable-name depend on the configure options you used during compilation. The shown example used <code>./configure --prefix<code>/usr</code> for compilation. To not always have to type <code>CYGWIN</code>server</code>, export the [http://www.cygwin.com/cygwin-ug-net/using-cygwinenv.html CYGWIN environment variable ] with your <code>.bash_profile</code>. Therefor add the line

<pre>
export CYGWIN=server
</pre>

to <code>/home/your''username/.bash''profile</code> (sorry, the tilde sign cannot be shown in this Wiki).

==== Compiling bluefish cvs on cygwin issues ====

Some various answers I've collected so far to get bluefish cvs running
on win32

--------------
From: Todd Fisher <toddf@simosoftware.com>

You're running into a problem resulting in the difference between two
compilers. In linux by default all symbols are public (i.e. exposed) in
win32 it's the opposite, all symbols are private (i.e. hidden). With
msvc compiler you can use the ''''declspec(dllexport) to expose symbols to
the linker. With GCC you can use a combination of ''''attribute''''
((visibility(\"hidden\"))) for hidding symbols and ''''attribute''''
((visibility(\"default\"))) for exposing the symbols. A good starting
place for understanding how this works in GCC since it is a new feature
is to read the wiki here: http://gcc.gnu.org/wiki/Visibility

Now, on to your exact issue. You say the symbols are from the main
application. I assume you mean you have a setup like the following:

main.c (depends on symbols from module.c)
module.c (depends on symbols from main.c)

To fix your problem you'll want to make module.c not have dependencies
on main.c . Or you'll have to force symbols to be exported from main.c
which I believe you can do by using the /DLL flag for msvc... not sure
about gcc in this case.
-----------------

On Sun, 2005-10-30 at 19:24 +0100, David Necas (Yeti) wrote:

>>>> On Sun, Oct 30, 2005 at 05:43:21PM +0100, Tobias Kipfelsberger wrote:
>>>>>>> > I have a plugin which is registered and loaded with the g_module
functions.
>>>>>>> > So far so good everything works find.
>>>>>>> > But how can i let the modul access a function of the coreapplication?
>>>>>>> >
>>>>>>> > Example:
>>>>>>> > in [[CoreApplication]].h:
>>>>>>> >
>>>>>>> > G''MODULE''EXPORT void
>>>>>>> > set[[CoreMenuAppbarText]] (const gchar* text)
>>>>>>> > {}
>>>>>>> >
>>>>>>> > in plugin.c:
>>>>>>> >
>>>>>>> > #include \"[[CoreApplication]].h\"
>>>>>>> > void
>>>>>>> > xyz ()
>>>>>>> > {
>>>>>>> > set[[CoreMenuAppbarText]](\"test\");
>>>>>>> > }
>>>>>>> >
>>>>>>> > as i execute the programm... i always get a undefined symbol error.
>
>>
>
>>>>
>>>> You have to link the program with -export-dynamic (either as
>>>> ld option, or libtool link option if you use libtool).
>>>>

This is needed because by default the symbols defined in the main app
are not made visible to the plugins. And the OP should be warned there
is a good reason for the default.

If badly written plugins can call to the main application code they can
easily make it look to the user as if '''your''' app code is broken. You
should be prepared to handle the resulting support requests. Note, for
example, the way the linux kernel team refuse to support bug reports
from anyone running a \"tainted\" kernel.

If there is a well defined API you do want plugins to access, you can
place the relevant code into a shared object of its own. Then you don't
need to do anything special to protect it from Murphy's Law, since only
the parts deliberately exposed can be accessed easily.

--------------------------
From: Tor Lillqvist <tml@iki.fi>

First, mark the functions in the sources for the main .exe that are to
be used by other modules with G''MODULE''EXPORT.

Then you must decide whether you want to 1) restrict your plugins to
work only with an executable with the '''exact''' name you specify, or
whether you want it to be 2) more flexible and work even if you happen
to rename the main executable.

In case 1), create an import library for the .exe using dlltool, and
link the plugin against that import library.

In case 2), use g''module''open(NULL, 0) to get a GModule handle for the
main executable, and the g''module''find() the function from it, and
call it.
----------------------
From: Tor Lillqvist <tml@iki.fi>
Iago Rubio writes:

>> It seems to me that's using gcc and GNU tools but ...
>> How can it be done with the MSVC compiler ?

Use lib.exe instead of dlltool.

Installing Bluefish

2010-07-30T22:14:58Z

Reisio: /* Installing Bluefish on Gentoo */ 2.0.1 is in, but not "stable" for Gentoo

= Installing Bluefish on Debian GNU/Linux 5.0 (Lenny) =

=== Installing 1.0.x (old stable) ===

use
apt-get install bluefish
aptitude install bluefish
or synaptic or any other package manager

=== Installing 2.0.0 (current stable) ===

add the following line, that fits your Debian version, to /etc/apt/sources.list
deb http://debian.wgdd.de/debian lenny main contrib non-free

'''or''' put a snippet into /etc/apt/sources.list.d/
sudo wget http://debian.wgdd.de/stuff/debian.wgdd.de_lenny.list -N -P /etc/apt/sources.list.d

Then install the repository cryptographic key and Bluefish:
apt-get install wgdd-archive-keyring
apt-get install bluefish

= Installing Bluefish on Debian GNU/Linux Sid or Squeeze =

=== Installing 1.0.x (old stable) ===

use
apt-get install bluefish
aptitude install bluefish
or synaptic or any other package manager

=== Installing 2.0.0 ===

add the following line to /etc/apt/sources.list
deb http://debian.wgdd.de/debian sid main contrib non-free

'''or''' put a snippet into /etc/apt/sources.list.d/
sudo wget http://debian.wgdd.de/stuff/debian.wgdd.de_sid.list -N -P /etc/apt/sources.list.d

Then install the repository cryptographic key and Bluefish:
apt-get install wgdd-archive-keyring
apt-get install bluefish

=== Installing 2.0.1 in Sid (current stable) ===
version 2.0.1 is now in [http://packages.debian.org/sid/bluefish Debian], run:
apt-get install bluefish

= Installing Bluefish on Ubuntu Linux =

=== Installing 1.0.x (old stable) ===

apt-get install bluefish

or any other frontend for the package manager such as aptitude, synaptic or simply "add / remove programs"

=== Installing 2.0.0 (current stable) on Ubuntu 8.04 ===

Binary packages for 8.04 are not in a repository. Download the packages from:
http://www.bennewitz.com/bluefish/stable/binaries/ubuntu_8.04/
and install them with
sudo dpkg -i bluefish*.deb

=== Installing 2.0.0 (current stable) on Ubuntu 9.04 or newer ===

add the following line to /etc/apt/sources.list
deb [http://debian.wgdd.de/debian http://debian.wgdd.de/ubuntu] jaunty main restricted universe multiverse

'''or''' put a snippet into /etc/apt/sources.list.d/
sudo wget http://debian.wgdd.de/stuff/debian.wgdd.de_ubuntu.list -N -P /etc/apt/sources.list.d

Run updates, to pick up the newly available options
apt-get update
You may see errors at this point, because you've not yet installed the cryptographic key, but that's OK as you're about to do that

Then install the repository cryptographic key and Bluefish:
apt-get install wgdd-archive-keyring
apt-get install bluefish

= Installing Bluefish on Fedora Linux =

=== Installing 1.0.x ===

yum install bluefish

=== Installing 2.0.0 or 2.0.1 (current stable) ===
To get latest updates use the provided yum enabled repository...

http://www.bennewitz.com/rpms/endurs_repo_i686-release-1.0-9.noarch.rpm

As an alternative solution you can download the rpm from...
http://www.bennewitz.com/bluefish/stable/binaries/fedora13/
...manually and execute: <tt>sudo yum localinstall <path/to/downloaded/bluefish*.rpm></tt>.

= Installing Bluefish on AltLinux =

=== Installing 1.0 ===
Bluefish can be installed on Alt Linux 3.0, 4.0, 4.1, p5, 5.1 or Sisyphus.

The versions provided by our apt servers are: 
* Alt Linux 3.0 - 1.0
* Alt Linux 4.0 - 1.0.5
* Alt Linux 4.1 - 1.0.7
* Alt Linux p5 - 1.0.7
* Alt Linux 5.1 - 1.0.7
* Alt Linux Sisyphus - 1.0.7 
To install use:
<tt>apt-get install bluefish</tt>
or use synaptic or any other package manager. 
Alt Linux Sisyphus also provides 1.3.8 '''(bluefish-unstable)'''.
To install do:
<tt>apt-get install bluefish-unstable</tt>

=== Installing 2.0.0 (current stable) ===
Bluefish 2.0.0 currently is not in Alt Linux repos, but will soon appear in Sisyphus. 
For the moment, to install it you have to:

wget http://alt.u-nix.eu.org/bluefish/bluefish-2.0.0rc3-alt1.i586.rpm
wget http://alt.u-nix.eu.org/bluefish/bluefish-common-2.0.0rc3-alt1.noarch.rpm
rpm -i bluefish-common-2.0.0rc3-alt1.noarch.rpm bluefish-2.0.0rc3-alt1.i586.rpm

If you want to build it on your system, just do:

wget http://alt.u-nix.eu.org/bluefish/bluefish-2.0.0rc3-alt1.src.rpm
rpm -i bluefish-2.0.0rc3-alt1.src.rpm
cd /usr/src/RPM/SPECS
rpmbuild -bb bluefish-2.0.0rc3.spec
cd /usr/src/RPM/RPMS/noarch
rpm -i bluefish-common-2.0.0rc3-alt1.noarch.rpm
For i586 do:
cd /usr/src/RPM/RPMS/i586
rpm -i bluefish-2.0.0rc3-alt1.i586.rpm
For x86_64 do:
cd x86_64
rpm -i bluefish-2.0.0rc3-alt1.x86_64.rpm

=Installing [http://packages.gentoo.org/package/bluefish Bluefish on Gentoo]=

==Latest Gentoo stable==

emerge bluefish

==Latest available==

echo 'app-editors/bluefish' >> /etc/portage/package.keywords && emerge bluefish

= Installing Bluefish on Slackware =
; Kwick n dirty method
: <tt>$ ./configure && make</tt>
: <tt># make install</tt>
: ''enjoy you are in Slackware ;)''
; But please consider to use a Slackbuild: (you know why)
; Dependencies
: Bluefish depends on Gnome:
: consider to install some ''gnome minimal''.
: Have a look at dependencies file at third party slackbuilders,
: have a look at ./configure issues.

=== Installing 2.0.1 (current stable) ===
Bluefish needs [http://ftp.gnome.org/pub/GNOME/sources/gvfs/ gvfs] if you want to work with remote files.
: GVFS is work in progress in Slackware, you need to have glib 2.18 (Slack 13.0); GSB (2.28.2) uses glib2 2.22.4 and gvfs 1.4.3. 

You can use your bluefish.SlackBuild 1.0 for Bluefish 2.

= Installing Bluefish on OpenSolaris =

=== Installing 1.0.x (old stable) ===
search for bluefish in the package manager, select and click apply.

=== Installing 2.0.1 (current stable) ===
A binary package is not yet available in OpenSolaris, you have to compile from source, see [[Compiling_Bluefish_from_source]].

= Installing Bluefish on Mac OS X =

=== Installing 2.0.1 (current stable) ===
==== Using Macports ====
Install [http://www.macports.org Macports].

Run from Terminal.app

<tt>sudo port install bluefish</tt>
==== Native (no X11) ====
Download Bluefish-2.0.1.dmg from http://www.bennewitz.com/bluefish/stable/binaries/macosx/, open it and drag the bluefish icon onto Applications.

= Installing Bluefish on Windows XP/Vista/7 (32 bit) =

=== Installing 2.0.1 (current stable) ===
download Bluefish-2.0.1-setup.exe from the main download server
http://www.bennewitz.com/bluefish/stable/binaries/win32/

This installer needs internet access because it will download gtk library and the spell checking dictionaries for you.