WELCOME TO HARBOUR
==================
Harbour is the Free Open Source Software implementation
of a multi-platform, multi-threading, object-oriented, scriptable
programming language, backward compatible with Clipper/xBase.
Harbour consists of a compiler and runtime libraries with multiple
UI and database backends, its own make system and a large
collection of libraries and interfaces to many popular APIs.
http://harbour-project.org/
TABLE OF CONTENT
================
0. GUARANTEES AND LIABILITY
1. HOW TO BUILD AND INSTALL HARBOUR FROM SOURCE
2. HOW TO DO A PARTIAL [RE]BUILD
3. HOW TO CREATE DISTRIBUTABLE PACKAGES
4. HOW TO ENABLE OPTIONAL COMPONENTS BEFORE BUILD
5. SUPPORTED PLATFORMS AND C COMPILERS
6. OPTIONS AVAILABLE WHEN BUILDING HARBOUR
7. DEBUGGING OPTIONS
8. EXAMPLES
9. HOW TO GET HARBOUR
10. TROUBLESHOOTING
11. QUICK START TO BUILD YOUR OWN HARBOUR APPLICATIONS
12. BUILD HOST-PLATFORM/SHELL - TARGET-PLATFORM/COMPILER COMPATIBILITY MATRIX
13. LINKS TO EXTERNAL COMPONENTS
14. HOW TO PARTICIPATE
15. FOR MORE INFORMATION
0. GUARANTEES AND LIABILITY
===========================
This document and all other parts of Harbour are distributed in the
hope they will be useful, but there is NO GUARANTEE that they are
complete, accurate, non-infringing or usable for any purpose whatsoever.
Contributors are NOT LIABLE for any damages that result from using
Harbour in any ways. For more legal details, see COPYING.txt.
If you think you can make Harbour better, start to contribute.
See this section: 'HOW TO PARTICIPATE'
The information this document is subject to change without notice
and does not represent any future commitment by the participants
of the project.
1. HOW TO BUILD AND INSTALL HARBOUR FROM SOURCE
===============================================
==========================================================================
NOTE: Before reporting a problem to developers, make sure to read the
'TROUBLESHOOTING' section in this document and try the suggestions
you find there.
==========================================================================
For all platforms you'll need:
* Supported ANSI C compiler
* GNU Make (3.81 recommended, minimum 3.79 required, see also platform details)
* Harbour sources (2.0.0 or upper)
on Windows hosts
----------------
(possible cross-build targets: Windows CE, MS-DOS, OS/2, Linux)
Platform specific prerequisites:
1.) Windows XP or upper system is recommended to build Harbour.
2.) Make sure to have your C compiler of choice properly installed
in PATH. Refer to your C compiler installation and setup
instructions for details. It's recommended to make sure no tools
in your PATH belonging to other C compilers are interfering with
your setup. It's also highly discouraged to keep multiple copies
of the same compiler, or different versions of the same compiler
in PATH at the same time. For the list of supported compilers,
look up 'SUPPORTED PLATFORMS AND C COMPILERS' section.
3.) GNU Make 3.81 or upper is required. A copy of this tool
is included in all Harbour packages, so you don't have to do
anything.
If you want to get it separately, you can find it here:
http://sourceforge.net/projects/mingw/files/MinGW/Extension/make/
Unpack it to your PATH or Harbour source root directory,
and run it as 'mingw32-make'.
> win-make [install]
To test it, type:
> cd tests
> ..\bin\hbmk2 hello.prg
> hello
You should see 'Hello world!' on screen.
on Windows hosts with POSIX shells (MSYS/Cygwin)
----------------------------------
You can also use these shells to build Harbour on Windows.
Generally it's recommended to use native shell though.
> sh -c make [install]
To test it, type:
> cd tests
> ..\bin\hbmk2 hello.prg
> hello
You should see 'Hello world!' on screen.
NOTE: When building for Borland C++ make sure that GNU Make
is executed when typing 'make', Borland Make has the same name.
on MS-DOS hosts
---------------
(possible cross-build targets: Windows, OS/2, Linux)
1.) Make sure to have your C compiler of choice properly installed
(in PATH).
2.) You need to get GNU Make. We recommend this link:
ftp://ftp.delorie.com/pub/djgpp/beta/v2gnu/mak381b.zip
Unpack it to your PATH or Harbour source root directory.
You can also use included copy named dos-make.exe instead.
> make [install]
To test it, type:
> cd tests
> ..\bin\hbmk2 hello.prg
> hello
You should see 'Hello world!' on screen.
on OS/2 hosts
-------------
(possible cross-build targets: MS-DOS, OS/2, Linux)
1.) You need to get GNU Make. If you use OS/2 host, 3.81r3 or upper
version is required. We recommend this link:
ftp://hobbes.nmsu.edu/pub/os2/dev/util/make-3.81-r3-bin-static.zip
If you use other host, refer to other platform instructions in
this section.
You can also use included copy named os2-make.exe instead.
> make [install]
To test it, type:
> cd tests
> ..\bin\hbmk2 hello.prg
> hello
You should see 'Hello world!' on screen.
on Linux hosts
--------------
(possible cross-build targets: Windows, Windows CE, MS-DOS, OS/2)
$ make [install] [HB_PLATFORM=<...>]
To test it, type:
$ cd tests
$ hbmk2 hello.prg
$ ./hello
You should see 'Hello world!' on screen.
on Darwin (OS X) hosts
----------------------
(possible cross-build targets: Windows, Windows CE, MS-DOS)
Platform specific prerequisite:
Xcode or Command Line Tools for Xcode installed
$ make [install] [HB_PLATFORM=<...>]
To test it, type:
$ cd tests
$ hbmk2 hello.prg
$ ./hello
You should see 'Hello world!' on screen.
NOTE: You can override default (host) architecture by adding
values below to HB_USER_CFLAGS, HB_USER_LDFLAGS envvars,
you can use multiple values:
Intel 32-bit: "-arch i386"
Intel 64-bit: "-arch x86_64"
PPC 32-bit: "-arch ppc"
PPC 64-bit: "-arch ppc64"
on FreeBSD hosts
----------------
Platform specific prerequisites:
1.) You'll need to have the developer tools installed.
2.) Then you'll need to install gmake and optionally bison.
If you installed the ports collection, then all you need
to do to install bison and gmake is to run the following
commands, which may require that you run su root first to
get the correct permissions:
$ cd /usr/ports/devel/gmake
$ make
$ make install
$ make clean
$ cd /usr/ports/devel/bison
$ make
$ make install
$ make clean
$ gmake install
To test it, type:
$ cd tests
$ hbmk2 hello.prg
$ ./hello
You should see 'Hello world!' on screen.
on Minix hosts
--------------
Install GNU make from the Minix pkgsrc repository; for details see
http://wiki.minix3.org/en/UsersGuide/InstallingBinaryPackages
Optionally, GCC may also be installed if you wish to use that instead
of Clang, the Minix system compiler.
on BSD/HP-UX/Solaris/BeOS/Haiku/QNX/*nix hosts
----------------------------------------------
(possible cross-build targets: Windows, Windows CE, MS-DOS)
$ gmake [install] [HB_PLATFORM=<...>]
OR
$ make [install] [HB_PLATFORM=<...>]
To test it, type:
$ cd tests
$ hbmk2 hello.prg
$ ./hello
You should see 'Hello world!' on screen.
NOTE for sunpro on Solaris:
---------------------------
If you have any GNU binutils stuff installed, do make sure
/usr/ccs/bin (the location of the native Sun C compilation
system tools) come *before* the GNU binutils components in
your $PATH.
2. HOW TO DO A PARTIAL [RE]BUILD
================================
If you want to [re]build only a specific part of Harbour, like
one core library or all core libraries, or all contrib packages,
you have to do everything the same way as for a full build, the
only difference is that you first have to go into the specific
source directory you want to [re]build. When starting GNU Make,
all components under that dir will be [re]built:
cd src/rtl
<make> [clean] [install]
If you want to rebuild one specific contrib package, use this:
cd contrib/<name>
../../bin/<plat>/<comp>/hbmk2 ../make.hb [clean] [custom hbmk2 options]
3. HOW TO CREATE DISTRIBUTABLE PACKAGES
=======================================
Source .tgz on *nixes
---------------------
$ package/mpkg_src.sh
Binary .tgz on *nixes
---------------------
$ export HB_BUILD_PKG=yes
$ make clean install
Binary .deb on Linux
--------------------
$ fakeroot debian/rules binary
Binary .rpm on Linux
--------------------
$ package/mpkg_rpm.sh
You can fine-tune the build with these options:
--with static - link all binaries with static libs
--with ads - build components dependent on ads (rddads)
--with allegro - build components dependent on allegro (gtalleg)
--with cups - build components dependent on cups (hbcups)
--with cairo - build components dependent on cairo (hbcairo)
--with curl - build components dependent on libcurl (hbcurl)
--with firebird - build components dependent on firebird (hbfbird, sddfb)
--with freeimage - build components dependent on freeimage (hbfimage)
--with gd - build components dependent on gd (hbgd)
--with mysql - build components dependent on mysql (hbmysql, sddmy)
--with odbc - build components dependent on odbc (hbodbc, sddodbc)
--with pgsql - build components dependent on pgsql (hbpgsql, sddpg)
--with localzlib - build local copy of zlib library
--with localpcre - build local copy of pcre library
--without x11 - do not build components dependent on x11 (gtxwc)
--without curses - do not build components dependent on curses (gtcrs)
--without slang - do not build components dependent on slang (gtsln)
--without gpllib - do not build components dependent on GPL 3rd party code
--without gpm - build components without gpm support (gttrm, gtsln, gtcrs)
Binary .rpm on Linux (cross-builds)
-----------------------------------
for Windows:
$ package/mpkg_rpm_win.sh
for Windows CE:
$ package/mpkg_rpm_wce.sh
Binary .zip + .exe on Windows for all targets (except Linux)
------------------------------------------------------------
> set HB_DIR_NSIS=%ProgramFiles%\NSIS\
> set HB_DIR_ZIP=C:\info-zip\
> set HB_BUILD_PKG=yes
Then run build as usual with 'clean install' options.
See: HOW TO BUILD AND INSTALL HARBOUR FROM SOURCE
Binary .zip on MS-DOS for all targets (except Linux)
----------------------------------------------------
> set HB_DIR_ZIP=C:\info-zip\
> set HB_BUILD_PKG=yes
Then run build as usual with 'clean install' options.
See: HOW TO BUILD AND INSTALL HARBOUR FROM SOURCE
Unified .7z + .exe installer for Windows
----------------------------------------
> package\winuni\mpkg_win_uni.bat
NOTE: Carefully read in-file instructions and do the necessary
steps before calling the script.
4. HOW TO ENABLE OPTIONAL COMPONENTS BEFORE BUILD
=================================================
Certain Harbour parts (typically contrib packages) depend on 3rd
party components. To make these Harbour parts built, you need
to tell Harbour where to find the headers for these 3rd party
components.
On *nix systems most of these 3rd party components will
automatically be picked up if installed on well-known standard
system locations.
You only need to use manual setup if the dependency isn't available
on your platform on a system location, or you wish to use
a non-standard location. Typically you need to do this on non-*nix
(Windows, MS-DOS, OS/2) systems for all packages and for a few packages
on *nix which aren't available through official package managers
(f.e. ADS Client).
Note that Harbour is tuned to use 3rd party binary packages in their
default, unmodified ("vanilla") install layout created by their
official/mainstream install kits. If you manually move, rename,
delete or add files under the 3rd party packages' root directory,
the default Harbour build process (especially Windows implib
generation) might not work as expected.
You can set these environment variables before starting
the build. Make sure to adjust them to your own directories:
HB_WITH_ADS=C:\ads\acesdk
HB_WITH_ALLEGRO=C:\allegro\include
HB_WITH_BLAT=C:\blat\full\source
HB_WITH_BZIP2=C:\bzip2 (defaults to locally hosted version if not found)
HB_WITH_CAIRO=C:\cairo\include\cairo
HB_WITH_CUPS= (on *nix only)
HB_WITH_CURL=C:\curl\include
HB_WITH_CURSES= (on *nix systems and DJGPP, where it's autodetected)
HB_WITH_EXPAT=C:\expat\lib (defaults to locally hosted version)
HB_WITH_FIREBIRD=C:\Firebird\include
HB_WITH_FREEIMAGE=C:\FreeImage\Dist
HB_WITH_GD=C:\gd\include
HB_WITH_GPM= (on Linux only)
HB_WITH_GS=C:\ghostscript-9.01\psi
HB_WITH_GS_BIN=C:\ghostscript-9.01\bin (on Windows)
HB_WITH_JPEG=C:\jpeglib (defaults to locally hosted version if not found)
HB_WITH_LIBHARU=C:\libharu\include (defaults to locally hosted version)
HB_WITH_LIBMAGIC= (currently on *nix systems)
HB_WITH_LZF=C:\liblzf (defaults to locally hosted version if not found)
HB_WITH_MINILZO=C:\minilzo\ (defaults to locally hosted version if not found)
HB_WITH_MINIZIP=C:\zlib\contrib\minizip (defaults to locally hosted version if not found)
HB_WITH_MXML=C:\minixml (defaults to locally hosted version if not found)
HB_WITH_MYSQL=C:\mysql\include
HB_WITH_OCILIB=C:\ocilib\include
HB_WITH_ODBC= (may only be needed on non-Windows systems)
HB_WITH_OPENSSL=C:\openssl\inc32 OR C:\openssl\include
HB_WITH_PCRE=C:\pcre (defaults to locally hosted version if not found)
HB_WITH_PGSQL=C:\pgsql\include
HB_WITH_PNG=C:\libpng (defaults to locally hosted version if not found)
HB_WITH_SLANG= (on *nix systems)
HB_WITH_SQLITE3=C:\sqlite3 (defaults to locally hosted version if not found)
HB_WITH_TIFF=C:\libtiff (defaults to locally hosted version if not found)
HB_WITH_TINYMT=C:\tinymt\tinymt (defaults to locally hosted version)
HB_WITH_WATT= (on MS-DOS systems)
HB_WITH_X11= (on *nix systems)
HB_WITH_XDIFF=C:\libxdiff-0.23\xdiff (defaults to locally hosted version if not found)
HB_WITH_ZLIB=C:\zlib (defaults to locally hosted version if not found)
To explicitly disable any given components, use the value 'no' (without
quotes). This may be useful to avoid autodetection of installed packages
on *nix systems. You may also use the value 'local' to force using the
locally hosted copy (inside Harbour source repository) of these packages,
where applicable. 'nolocal' will explicitly disable using locally hosted
copy.
Certain contribs can be instructed (when using .hbc files) to link
against static build of their 3rd party lib dependencies (for
advanced users only):
HB_STATIC_ALLEGRO=yes
HB_STATIC_CURL=yes
HB_STATIC_OPENSSL=yes
NOTES: - You need to use native path format to your shell/OS.
- Spaces in directory names aren't currently supported.
(You can use 8.3 name alias on Windows platform, though)
- Don't put directory names inside double quotes.
- Use absolute paths.
Darwin (OS X)
-------------
1.) Install Homebrew, follow their instructions:
http://mxcl.github.com/homebrew/
2.) $ brew install pcre slang cairo freeimage libgd mysql postgresql
$ brew install upx uncrustify
Linux (generic)
---------------
For contrib/rddads lib:
Download and install 'Advantage Client Engine API for Linux' package
(f.e. aceapi-10.00.0.3.tar.gz)
For contrib/hbhpdf lib, if you don't wish to use locally hosted version:
Download libharu from http://libharu.org/ -> './configure' -> 'make install'
Linux (.deb based distros: Debian, Ubuntu)
------------------------------------------
You'll need these base packages to build/package/test/use Harbour:
$ sudo apt-get install bash git gcc binutils fakeroot debhelper valgrind upx uncrustify
You'll need these packages to compile certain contribs and optional Harbour features:
for gtcrs terminal lib: $ sudo apt-get install libncurses-dev
for gtsln terminal lib: $ sudo apt-get install libslang2-dev OR
$ sudo apt-get install libslang1-dev
for gtxwc terminal lib: $ sudo apt-get install libx11-dev
for console mouse support: $ sudo apt-get install libgpm-dev OR
$ sudo apt-get install libgpmg1-dev
for contrib/gtalleg lib: $ sudo apt-get install liballegro4.2-dev
for contrib/hbcairo lib: $ sudo apt-get install libcairo2-dev
for contrib/hbcups lib: $ sudo apt-get install libcups2-dev
for contrib/hbcurl lib: $ sudo apt-get install libcurl4-openssl-dev OR
$ sudo apt-get install libcurl4-gnutls-dev
for contrib/hbexpat lib: $ sudo apt-get install libexpat1-dev
for contrib/hbfbird lib: $ sudo apt-get install firebird2.1-dev OR
$ sudo apt-get install libfirebird2.0-dev
for contrib/hbfimage lib: $ sudo apt-get install libfreeimage-dev
for contrib/hbgd lib: $ sudo apt-get install libgd2-xpm-dev OR
$ sudo apt-get install libgd-xpm-dev
for contrib/hbgs lib: $ sudo apt-get install libgs-dev
for contrib/hbmagic lib: $ sudo apt-get install libmagic-dev
for contrib/hbmysql lib: $ sudo apt-get install libmysqlclient15-dev
for contrib/hbodbc lib: $ sudo apt-get install unixodbc-dev
for contrib/hbpgsql lib: $ sudo apt-get install libpq-dev
Optional, to override locally hosted sources:
for bzip2 support: $ sudo apt-get install libbz2-dev
for zlib support: $ sudo apt-get install zlib1g-dev
for pcre (regex) support: $ sudo apt-get install libpcre3-dev
for contrib/hbsqlit3 lib: $ sudo apt-get install libsqlite3-dev
Linux (.rpm based distros: openSUSE, Fedora, CentOS, Mandriva)
--------------------------------------------------------------
You'll need these base packages to build/package/test/use Harbour:
bash git gcc make glibc-devel rpm valgrind upx uncrustify
You'll need these packages to compile certain contribs and optional Harbour features:
for gtcrs terminal lib: ncurses-devel ncurses
for gtsln terminal lib: slang-devel slang
for gtxwc terminal lib: xorg-x11-devel
XFree86-devel
for console mouse support: gpm-devel OR
gpm
for contrib/gtalleg lib: allegro-devel
for contrib/hbcairo lib: cairo-devel
for contrib/hbcups lib: libcups2-devel
for contrib/hbcurl lib: curl-devel
for contrib/hbexpat lib: libexpat-devel
for contrib/hbfbird lib: firebird-devel
for contrib/hbfimage lib: freeimage-devel
for contrib/hbgd lib: gd-devel
for contrib/hbmysql lib: libmysqlclient-devel OR
mysql-devel OR
MySQL-devel
for contrib/hbodbc lib: unixodbc-devel OR
unixODBC-devel
for contrib/hbpgsql lib: postgresql-devel
NOTES: - You can use following commands on different distros to install packages:
openSUSE: $ sudo zypper install <pkg>
Fedora, CentOS: $ sudo yum install <pkg>
Mandriva: $ sudo urpmi <pkg>
Check this link for more:
http://distrowatch.com/dwres.php?resource=package-management
- On openSUSE, if you want to build 32-bit Harbour on a 64-bit host, install
above packages with '-32bit' appended to their names, f.e. 'slang-devel-32bit'
OpenSolaris
-----------
- $ pkg install SUNWgit SUNWgcc SUNWgmake
FreeBSD
-------
If you want to use the gtsln library instead of gtstd or gtcrs,
then you also need to install libslang. If you installed the ports
collection, then all you need to do to install libslang is to run
the following commands, which may require that you run su first to
get the correct permissions:
$ cd /usr/ports/devel/libslang
$ make
$ make install
$ make clean
5. SUPPORTED PLATFORMS AND C COMPILERS
======================================
You can override target platform autodetection with these HB_PLATFORM values:
linux - Linux
darwin - OS X
bsd - FreeBSD / OpenBSD / NetBSD / DragonFly BSD / *BSD
beos - BeOS / Haiku
hpux - HP-UX
sunos - Sun Solaris / OpenSolaris
qnx - QNX
android - Android
vxworks - VxWorks
symbian - Symbian OS (experimental)
minix - Minix 3 (tested on 3.2.1; earlier releases will not work)
aix - IBM AIX
win - MS Windows (all flavors)
(see 'LINKS' section for Win9x requirements)
wce - MS Windows CE
dos - MS-DOS (32-bit protected mode only)
(MS-DOS compatible systems also work, like dosemu)
os2 - OS/2 Warp 4 / eComStation
You can override C compiler autodetection with these HB_COMPILER values:
linux
-----
gcc - GNU C
clang - Clang
watcom - Open Watcom C/C++
icc - Intel(R) C/C++
sunpro - Sun Studio C/C++
open64 - Open64 C/C++
darwin
------
gcc - GNU C
clang - Clang
icc - Intel(R) C/C++
bsd
---
gcc - GNU C
clang - Clang
pcc - Portable C Compiler (experimental)
hpux
----
gcc - GNU C
beos
----
gcc - GNU C
qnx
---
gcc - GNU C
android
-------
gcc - GNU C x86
gccarm - GNU C ARM
vxworks
-------
gcc - GNU C
diab - Wind River Compiler
symbian
-------
gcc - GNU C
minix
-----
clang - Clang
gcc - GNU C
aix
---
gcc - GNU C
cygwin
------
gcc - GNU C
sunos
-----
gcc - GNU C
sunpro - Sun Studio C/C++
win
---
mingw - MinGW GNU C 3.4.2 and above
mingw64 - MinGW GNU C x86-64
msvc - Microsoft Visual C++
msvc64 - Microsoft Visual C++ x86-64
msvcia64 - Microsoft Visual C++ IA-64 (Itanium)
Also supported, some features may be missing:
clang - Clang
watcom - Open Watcom C/C++
bcc - Borland/CodeGear/Embarcadero C++ 4.x and above
bcc64 - Embarcadero C++ 6.5 and above
icc - Intel(R) C/C++
iccia64 - Intel(R) C/C++ IA-64 (Itanium)
pocc - Pelles C 4.5 and above
pocc64 - Pelles C x86-64 5.0 and above
xcc - Pelles C for xhb
wce
---
mingw - MinGW GNU C x86
mingwarm - MinGW GNU C ARM (CEGCC 0.55 and above)
msvcarm - Microsoft Visual C++ ARM
poccarm - Pelles C ARM 5.0 and above
dos
---
djgpp - Delorie GNU C
watcom - Open Watcom C/C++
os2
---
gcc - EMX GNU C 3.3.5 or lower
gccomf - EMX GNU C 3.3.5 or upper
watcom - Open Watcom C/C++
6. OPTIONS AVAILABLE WHEN BUILDING HARBOUR
==========================================
You can fine-tune Harbour builds with below listed
environment variables. You can add most of these via the
GNU Make command line also, using 'make VARNAME=value' syntax.
All of these settings are optional and all settings are case
sensitive.
General
-------
- HB_INSTALL_PREFIX Target root directory to install Harbour files.
On *nix systems the default is set to /usr/local/
or $(PREFIX) if specified, and
/usr/local/harbour-<arch>-<comp> for cross-builds.
It's always set to ./pkg/<arch>/<comp> when
HB_BUILD_PKG is set to 'yes'. On non-*nix systems,
you must set it to a valid directory when using
'install'. Use absolute paths only. For a peace of
mind, avoid using spaces and quotes in the name.
You have to use path format native to your shell.
F.e. to specify C:\dir on Windows, with Cygwin
you should use /cygdrive/c/dir, with MSYS /c/dir.
- HB_USER_PRGFLAGS User Harbour compiler options
- HB_USER_CFLAGS User C compiler options
- HB_USER_RESFLAGS User resource compiler options (on win, wce, os2)
- HB_USER_LDFLAGS User linker options for executables
- HB_USER_AFLAGS User linker options for libraries
- HB_USER_DFLAGS User linker options for dynamic libraries
Set these only if autodetection doesn't suit your purpose:
- HB_PLATFORM Override platform autodetection
- HB_COMPILER Override C compiler autodetection
See this section for possible values:
'SUPPORTED PLATFORMS AND C COMPILERS'
See also: HB_CC* settings.
Special
-------
- HB_BUILD_NAME=[<name>] Create named build. This allows to keep
multiple builds in parallel for any given
platform/compiler. F.e. debug / release.
NOTE: In current implementation it's
appended to compiler directory name, so all
filesystem/platform name rules and limits
apply. (Back)slashes will be stripped from
the name though.
- HB_BUILD_PKG=yes Create release package. Default: no
Requires 'clean install' in root source dir.
- HB_BUILD_DYN=no Create Harbour dynamic libraries. Default: yes
- HB_BUILD_CONTRIB_DYN=yes Create contrib dynamic libraries. Default: no,
except Windows platform, where it's yes.
- HB_BUILD_SHARED=yes Create Harbour executables in shared mode.
Default: yes when HB_INSTALL_PREFIX points
to a *nix system location, otherwise no.
- HB_BUILD_DEBUG=yes Create a debug build. Default: no
- HB_BUILD_STRIP=
[all|bin|lib|no] Strip symbols and debug information from binaries.
Default: no
- HB_BUILD_OPTIM=no Enable C compiler optimizations. Default: yes
- HB_BUILD_MODE=[cpp|c] Change default build mode to C++ or C.
Default: c, except for msvc* compilers, where it's cpp.
- HB_BUILD_PARTS=
[all|compiler|lib] Build only specific part of Harbour.
- HB_BUILD_NOGPLLIB=yes Disable components dependent on GPL 3rd party code,
to allow Harbour for commercial (closed-source)
projects. Default: no
- HB_BUILD_3RDEXT=no Enable autodetection of 3rd party components
on default system locations. Default: yes
- HB_BUILD_CONTRIBS=no [<l>] Don't build any (or space separated <l> list of)
contrib packages. Please note it won't prevent
building packages which are dependencies of other
(enabled) packages.
- HB_BUILD_CONTRIBS=[<l>] Build space separated <l> list of contrib
libraries. Build all if left empty (default).
- HB_BUILD_ADDONS=<l> Build space separated <l> list of additional .hbp
projects.
- HB_COMPILER_VER=[<ver>] Set C compiler version. This is used with win/msvc,
win/mingw and cygwin/gcc targets currently.
<ver> format:
<15><0>[<0>] = <major><minor>[.<revision>]
Default: filled by compiler autodetection or empty
- HB_USER_LIBS=[<list>] Add space separated <list> of libs to link process.
Lib names should be without extension and path.
You only need this in special cases, like CodeGuard
build with win/bcc.
- HB_INSTALL_IMPLIB=no Copy import libraries created for external .dll
dependencies to the library install directory in
'install' build phase. Default: yes
(for Windows/OS/2 targets only. Please note
that this feature doesn't work with all possible
binary distributions of 3rd party packages.
We test only the official/mainstream ones. Also
note that the generated implibs will require .dlls
compatible with the ones used at build time.)
- HB_INSTALL_3RDDYN=yes Copy dynamic libraries of external .dll dependencies
to the dynamic library directory in 'install' build
phase. Default: no
- HB_SRC_ROOTPATH=<dir> When using GNU Make older than 3.81, you shall set
the root directory of Harbour source tree as an
absolute path. If not set, some build functionality
may fail, like detection of 3rd party packages with
locally hosted sources.
With newer make versions, this variable is ignored.
- HB_REBUILD_EXTERN=yes Rebuild extern headers. This is typically used by
developers after code modifications or before
release. Default: no
- HB_REBUILD_PARSER=yes Rebuild language parser sources. Typically
you only need this if your are Harbour core
developer modifying grammar rules (.y).
Requires GNU Bison 1.28 or upper in PATH.
Default: no
- HB_CCPATH=[<dir>/] Used with non-*nix gcc family compilers (and
sunpro) to specify path to compiler/linker/archive
tool to help them run from *nix hosts as cross-build
tools. Ending slash must be added.
- HB_CCPREFIX=[<prefix>] Used with gcc compiler family to specify
compiler/linker/archive tool name prefix.
- HB_CCSUFFIX=[<suffix>] Used with gcc compiler family to specify
compiler/linker tool name suffix
(usually version number).
Cross-building
--------------
You can build Harbour for target platforms different than host
platform. F.e. you can create Windows build on *nix systems, Linux
builds on Windows systems, etc. It's also possible to build targets
for different than host CPU architectures. F.e. you can create
Windows 64-bit build on 32-bit Windows platform, or Linux x86-64
build on x86 hosts, or Linux MIPS build on x86 host, etc.
Point this envvar to the directory where native Harbour executables
for your host platform can be found:
HB_HOST_BIN=<HARBOUR_NATIVE_BUILD_DIR>\bin
If you leave this value empty, the make system will try to autodetect it,
so in practice all you have to do is to create a native build first (no
'install' required), then create the cross-build. If you set this value
manually, it may be useful to know that harbour, hbpp and hbmk2
executables are required for a cross-build process to succeed.
7. DEBUGGING OPTIONS
====================
Tracing
-------
Build Harbour with:
HB_BUILD_DEBUG=yes
Run app with:
HB_TR_LEVEL=debug
HB_TR_OUTPUT=<filename> (to override default stderr output)
HB_TR_SYSOUT=yes (to enable additional system specific logging output: OutputDebugString() on Windows, syslog() on *nix systems)
Memory statistics/tracking
--------------------------
Build Harbour with:
HB_USER_CFLAGS=-DHB_FM_STATISTICS
Valgrind (on linux and darwin targets)
--------
Build Harbour with:
HB_BUILD_DEBUG=yes
Build app with:
$ hbmk2 myapp -debug
Run app with:
$ valgrind --tool=memcheck --leak-check=yes --num-callers=16 -v ./myapp 2> myapp.log
CodeGuard (on win/bcc target only)
---------
Build Harbour with:
HB_USER_CFLAGS=-vG
HB_USER_LIBS=cg32
8. EXAMPLES
===========
for Windows (x86, 32-bit) hosts
-------------------------------
NOTES: - All code below should be copied to batch files or typed at command
line.
- Naturally, you'll need to adapt dirs to valid ones on your system.
Don't use spaces in dirs.
- You can use additional 'clean', 'install' or 'clean install'
(without quotes) make parameters depending on what you want to do.
- To redirect all output to a log file, append this after the make
command: '> log.txt 2>&1' (without quotes)
--- MSVC 2012
call "%ProgramFiles%\Microsoft Visual Studio 11.0\VC\vcvarsall.bat"
win-make
---
--- MSVC 2012 for Windows x86-64 (requires preceding build for native target)
call "%ProgramFiles%\Microsoft Visual Studio 11.0\VC\vcvarsall.bat" x86_amd64
win-make
---
--- MSVC 2010 and Windows SDK 7.1
call "%ProgramFiles%\Microsoft Visual Studio 10.0\VC\vcvarsall.bat"
win-make
---
--- MSVC 2010 (Professional or above) and Windows SDK 7.1 for Windows x86-64 (requires preceding build for native target)
call "%ProgramFiles%\Microsoft Visual Studio 10.0\VC\vcvarsall.bat" x86_amd64
win-make
---
--- Windows SDK 7
call "%ProgramFiles%\Microsoft Visual Studio 9.0\VC\bin\vcvars32.bat"
win-make
---
--- Windows SDK 7 for Windows x86-64 (requires preceding build for native target)
call "%ProgramFiles%\Microsoft Visual Studio 9.0\VC\bin\vcvarsx86_amd64.bat"
win-make
---
--- MSVC 2008 + SDK
set WindowsSDKDir=%ProgramFiles%\Microsoft SDKs\Windows\v6.0A\
call "%ProgramFiles%\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"
win-make
---
--- MSVC 2008
call "%ProgramFiles%\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"
win-make
---
--- MSVC 2008 (Standard or above) for Windows x86-64 (requires preceding build for native target)
call "%ProgramFiles%\Microsoft Visual Studio 9.0\VC\vcvarsall.bat" x86_amd64
win-make
---
--- MSVC 2008 (Team Suite) for Windows IA-64 Itanium (requires preceding build for native target)
call "%ProgramFiles%\Microsoft Visual Studio 9.0\VC\vcvarsall.bat" x86_ia64
win-make
---
--- MSVC 2008 for Windows CE ARM (requires preceding build for native target)
set INCLUDE=%ProgramFiles%\Microsoft Visual Studio 9.0\VC\ce\include;%ProgramFiles%\Windows Mobile 5.0 SDK R2\PocketPC\Include\Armv4i
set LIB=%ProgramFiles%\Microsoft Visual Studio 9.0\VC\ce\lib\armv4i;%ProgramFiles%\Windows Mobile 5.0 SDK R2\PocketPC\Lib\ARMV4I
set PATH=%ProgramFiles%\Microsoft Visual Studio 9.0\VC\ce\bin\x86_arm;%ProgramFiles%\Microsoft Visual Studio 9.0\Common7\IDE;%PATH%
win-make
---
--- MSVC 2005
call "%ProgramFiles%\Microsoft Visual Studio 8\VC\vcvarsall.bat"
win-make
---
--- MSVC 2005 for Windows CE ARM (requires preceding build for native target)
set INCLUDE=%ProgramFiles%\Microsoft Visual Studio 8\VC\ce\include;%ProgramFiles%\Windows Mobile 5.0 SDK R2\PocketPC\Include\Armv4i
set LIB=%ProgramFiles%\Microsoft Visual Studio 8\VC\ce\lib\armv4i;%ProgramFiles%\Windows Mobile 5.0 SDK R2\PocketPC\Lib\ARMV4I
set PATH=%ProgramFiles%\Microsoft Visual Studio 8\VC\ce\bin\x86_arm;%ProgramFiles%\Microsoft Visual Studio 8\Common7\IDE;%PATH%
win-make
---
--- MSVC .NET 2003 (untested)
call "%ProgramFiles%\Microsoft Visual Studio .NET 2003\VC7\vcvarsall.bat"
win-make
---
--- MinGW GCC
set PATH=C:\mingw\bin;%PATH%
win-make
---
--- MinGW GCC using MSYS shell
set PATH=C:\msys\1.0.11\bin;C:\mingw\bin;%PATH%
sh -c make
---
--- MinGW GCC for Windows x86-64 (requires preceding build for native target)
set PATH=C:\mingw64\bin;%PATH%
win-make
---
--- MinGW GCC for Windows CE ARM (requires Cygwin + preceding build for native target)
set PATH=C:\mingwce\opt\mingw32ce\bin;C:\cygwin\bin;%PATH%
rem ; optional
set CYGWIN=nodosfilewarning
win-make
---
--- Intel(R) C++
call "%ProgramFiles%\Intel\Compiler\C++\10.1.014\IA32\Bin\iclvars.bat"
win-make
---
--- Intel(R) C++ for Windows IA-64 Itanium (requires preceding build for native target)
call "%ProgramFiles%\Intel\Compiler\C++\10.1.025\Itanium\Bin\iclvars.bat"
win-make
---
--- Borland C++ 5.5.1
set PATH=C:\Borland\BCC55\Bin;%PATH%
win-make
---
--- Pelles C
set PATH=%ProgramFiles%\PellesC\Bin;%PATH%
set INCLUDE=%ProgramFiles%\PellesC\Include;%ProgramFiles%\PellesC\Include\Win;%INCLUDE%
set LIB=%ProgramFiles%\PellesC\Lib;%ProgramFiles%\PellesC\Lib\Win;%LIB%
win-make
---
--- Pelles C for Windows x86-64 (requires preceding build for native target)
set PATH=%ProgramFiles%\PellesC\Bin;%PATH%
set INCLUDE=%ProgramFiles%\PellesC\Include;%ProgramFiles%\PellesC\Include\Win;%INCLUDE%
set LIB=%ProgramFiles%\PellesC\Lib;%ProgramFiles%\PellesC\Lib\Win64;%LIB%
win-make
---
--- Pelles C for Windows CE ARM (requires preceding build for native target)
set PATH=%ProgramFiles%\PellesC\Bin;%PATH%
set INCLUDE=%ProgramFiles%\PellesC\Include\WinCE;%ProgramFiles%\PellesC\Include;%INCLUDE%
set LIB=%ProgramFiles%\PellesC\Lib;%ProgramFiles%\PellesC\Lib\WinCE;%LIB%
win-make
---
--- Delorie GNU C for MS-DOS (on Intel 32-bit Windows hosts only)
set DJGPP=C:\djgpp\djgpp.env
set PATH=C:\djgpp\bin;%PATH%
win-make
---
--- Open Watcom C/C++
SET WATCOM=C:\watcom
SET PATH=%WATCOM%\BINNT;%WATCOM%\BINW;%PATH%
SET EDPATH=%WATCOM%\EDDAT
SET INCLUDE=%WATCOM%\H;%WATCOM%\H\NT
win-make
---
--- Open Watcom C/C++ for MS-DOS
SET WATCOM=C:\watcom
SET PATH=%WATCOM%\BINNT;%PATH%
SET EDPATH=%WATCOM%\EDDAT
SET INCLUDE=%WATCOM%\H
win-make
---
--- Open Watcom C/C++ for OS/2 (requires preceding build for Windows target)
SET WATCOM=C:\watcom
SET PATH=%WATCOM%\BINNT;%WATCOM%\BINW;%PATH%
SET BEGINLIBPATH=%WATCOM%\BINP\DLL
SET EDPATH=%WATCOM%\EDDAT
SET INCLUDE=%WATCOM%\H;%WATCOM%\H\OS2
win-make
---
--- Open Watcom C/C++ for Linux (requires preceding build for Windows target)
SET WATCOM=C:\watcom
SET PATH=%WATCOM%\BINNT;%WATCOM%\BINW;%PATH%
SET EDPATH=%WATCOM%\EDDAT
SET INCLUDE=%WATCOM%\LH
win-make
---
--- VxWorks GCC x86 (requires preceding build for Windows target)
wrenv -p vxworks-6.8
set HB_COMPILER=gcc
win-make
---
--- VxWorks GCC ARM (requires preceding build for Windows target)
wrenv -p vxworks-6.8
set HB_COMPILER=gcc
set HB_CPU=arm
set HB_BUILD_NAME=arm
win-make
---
--- VxWorks Wind River Compiler x86 (requires preceding build for Windows target)
wrenv -p vxworks-6.8
set HB_COMPILER=diab
win-make
---
--- Symbian OS (requires preceding build for Windows target)
set PATH=C:\Symbian\CSL Arm Toolchain\bin;%PATH%
set HB_PLATFORM=symbian
set HB_COMPILER=gcc
set HB_CCPREFIX=arm-none-symbianelf-
set HB_USER_CFLAGS=-IC:\Symbian\SDK\S60\devices\S60_5th_Edition_SDK_v1.0\epoc32\include\stdapis -IC:\Symbian\SDK\S60\devices\S60_5th_Edition_SDK_v1.0\epoc32\include -D__GCC32__ -D__SYMBIAN32__
win-make
---
--- Cygwin GCC using Cygwin shell
set PATH=C:\cygwin\bin
sh -c make
---
--8<--
rem ; Add these *before* above sample scripts to configure 3rd party dependencies.
rem When using MSYS or Cygwin shell you'll have to use forward slashes and
rem also Cygwin drive notation for Cygwin.
set HB_WITH_ADS=C:\ads\acesdk
set HB_WITH_ALLEGRO=C:\allegro\include
set HB_WITH_BLAT=C:\blat\full\source
set HB_WITH_CAIRO=C:\cairo\include\cairo
set HB_WITH_CURL=C:\curl\include
set HB_WITH_FIREBIRD=C:\Firebird\include
set HB_WITH_FREEIMAGE=C:\FreeImage\Dist
set HB_WITH_GD=C:\gd\include
set HB_WITH_MYSQL=C:\mysql\include
set HB_WITH_OCILIB=C:\ocilib\include
set HB_WITH_OPENSSL=C:\openssl\inc32
set HB_WITH_PGSQL=C:\pgsql\include
-->8--
for Windows x64 (x86-64) hosts
------------------------------
Same as 32-bit Windows, but, you'll have to change %ProgramFiles% to
%ProgramFiles(x86)% for 32-bit and mixed tools, you can build for
both x86 and x64 without building a native target first, and potential
differences with some compilers in order to use native binaries if
they are available.
--- MinGW GCC for Windows x86-64
set PATH=C:\mingw64\bin;%PATH%
win-make
---
--- MSVC 2012 for Windows x86
call "%ProgramFiles(x86)%\Microsoft Visual Studio 11.0\VC\vcvarsall.bat"
win-make
---
--- MSVC 2012 for Windows x86-64 (requires preceding build for native target)
call "%ProgramFiles(x86)%\Microsoft Visual Studio 11.0\VC\vcvarsall.bat" x86_amd64
win-make
---
--- MSVC 2010 and Windows SDK 7.1 for Windows x86
call "%ProgramFiles(x86)%\Microsoft Visual Studio 10.0\VC\vcvarsall.bat"
win-make
---
--- MSVC 2010 (Professional or above) and Windows SDK 7.1 for Windows x86-64
call "%ProgramFiles(x86)%\Microsoft Visual Studio 10.0\VC\vcvarsall.bat" amd64
win-make
---
--- Windows SDK 7 for Windows x86
call "%ProgramFiles(x86)%\Microsoft Visual Studio 9.0\VC\bin\vcvars32.bat"
win-make
---
--- Windows SDK 7 for Windows x86-64
call "%ProgramFiles(x86)%\Microsoft Visual Studio 9.0\VC\bin\vcvars64.bat"
win-make
---
--- MSVC 2008 for Windows x86
call "%ProgramFiles(x86)%\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"
win-make
---
--- MSVC 2008 (Standard or above) for Windows x86-64
call "%ProgramFiles(x86)%\Microsoft Visual Studio 9.0\VC\vcvarsall.bat" amd64
win-make
---
--- MSVC 2008 (Team Suite) for Windows IA-64 Itanium (requires preceding build for native target)
call "%ProgramFiles(x86)%\Microsoft Visual Studio 9.0\VC\vcvarsall.bat" x86_ia64
win-make
---
for MS-DOS hosts
----------------
--- Delorie GNU C
set DJGPP=C:\djgpp\djgpp.env
set PATH=C:\djgpp\bin;%PATH%
dos-make
---
--- Open Watcom C/C++
SET WATCOM=C:\watcom
SET PATH=%WATCOM%\BINW;%PATH%
SET EDPATH=%WATCOM%\EDDAT
SET INCLUDE=%WATCOM%\H
dos-make
---
--8<--
rem ; Add these *before* above sample scripts to configure 3rd party dependencies.
rem You have to use 8.3 path notation.
set HB_WITH_ALLEGRO=C:\ALLEGR~1.2\include
set HB_WITH_FIREBIRD=C:\FIREBI~1.4\include
set HB_WITH_GD=C:\GD-20~1.34\include
set HB_WITH_MYSQL=C:\MYSQL-~1.67\include
set HB_WITH_PGSQL=C:\PGSQL-~1.3\include
set HB_WITH_WATT=C:\WATT\inc
-->8--
for OS/2 hosts
--------------
--- GCC 3.3.4 and GCC 3.3.5
C:\usr\bin\gccenv.cmd
os2-make
---
--- GCC 4.x
C:\usr\local433\gcc440.cmd
set HB_COMPILER=gccomf
os2-make
---
--- Open Watcom C/C++
SET WATCOM=C:\watcom
SET PATH=%WATCOM%\BINP;%WATCOM%\BINW;%PATH%
SET BEGINLIBPATH=%WATCOM%\BINP\DLL
SET EDPATH=%WATCOM%\EDDAT
SET INCLUDE=%WATCOM%\H;%WATCOM%\H\OS2
SET HELP=%WATCOM%\BINP\HELP;%HELP%
SET BOOKSHELF=%WATCOM%\BINP\HELP;%BOOKSHELF%
os2-make
---
for Linux hosts
---------------
--- Open Watcom C/C++ for OS/2 (requires preceding build for Linux target)
export WATCOM="/opt/lng/watcom"
export INCLUDE="${WATCOM}/h:${WATCOM}/h/os2"
export PATH="${WATCOM}/binl:$PATH"
export HB_BUILD_3RDEXT=no
# ;
export HB_INSTALL_PREFIX="$(pwd)/hb-os2/watcom"
make "$@"
---
--- Borland C++ 5.5.1
export PATH=~/.wine/drive_c/Borland/BCC55/Bin:$PATH
export HB_PLATFORM=win
export HB_COMPILER=bcc
export HB_BUILD_3RDEXT=no
make
---
for Darwin (OS X) hosts
---------------------------
--- To create "Universal" binaries, compatible with pre-Snow Leopard PowerPC and Intel systems
export HB_USER_LDFLAGS="-arch i386 -arch ppc"
export HB_USER_CFLAGS="$HB_USER_LDFLAGS"
export HB_COMPILER=gcc
make
---
for *nix hosts in general
-------------------------
--- GCC
gmake OR make
---
--- MinGW GCC for Windows x86
gmake OR make HB_PLATFORM=win
---
--- MinGW GCC for Windows CE ARM
gmake OR make HB_PLATFORM=wce
---
9. HOW TO GET HARBOUR
=====================
Stable versions
---------------
1.) Harbour stable binary download
Download binary archive from this page and unpack or install:
http://sourceforge.net/projects/harbour-project/files/
(choose highest version number)
2.) Harbour stable source download
Download source archive from this page and unpack:
http://sourceforge.net/projects/harbour-project/files/source/
(choose highest version number)
Unstable versions
-----------------
WARNING: Recommended for users contributing to Harbour development,
following the development mailing list, commits and reading
ChangeLog.txt.
1.) Harbour live source repository
You'll need Git version control software installed on your system,
and issue this command:
git clone https://github.com/harbour/core.git harbour
You can get subsequent updates using this command:
git pull
2.) Harbour unstable sources
Download source archive from any of these links and unpack:
https://github.com/harbour/core/archive/master.zip
https://github.com/harbour/core/archive/master.tar.gz
3.) Harbour unstable binaries (updated once a day from live source repository)
Windows (unified):
http://sourceforge.net/projects/harbour-project/files/binaries-windows/nightly/harbour-nightly-win.exe/download
http://sourceforge.net/projects/harbour-project/files/binaries-windows/nightly/harbour-nightly-win.7z/download
10. TROUBLESHOOTING
===================
Always evaluate these points before reporting an issue on the developers'
mailing list.
1. Make sure to have carefully read this document.
2. Make sure to do a 'make clean' before doing a build after refreshing
the sources.
3. If that still fails, make sure to install fresh source tree in a new
local directory and start over. See 'HOW TO GET HARBOUR' section for
instructions to get the source.
In case you installed Harbour into system locations (this used to be
the case with some *nix users, albeit mostly completely unnecessarily
or wrongly - f.e. for unstable versions), you will need to remember
cleaning off Harbour from all of these locations, too.
Advice: Never install unstable Harbour versions to system locations.
4. If you are doing a cross-build, make sure to have rebuilt the native
Harbour executables for your host platform. See 'HB_HOST_BIN'
build messages to find their location.
5. Keep your PATH clean from old, mixed compiler tools or other Harbour
versions when building Harbour. The surest way to achieve this is to
leave only C compiler directory in PATH:
set PATH=C:\<compilerdir>
If you use Harbour official binary distro on Windows, even above is
unnecessary and not recommended.
6. Remove all old, unnecessary environment variables (for both Harbour
and C compiler) from your environment. Also remove any custom settings
for your C compiler.
Use only those documented in this file.
Follows some environment variable settings which are commonly believed
by users to be useful, but which in reality are either not needed or
not even used by Harbour build process and hbmk2.
You should delete them:
set HB_DIR=<Harbour root dir>
set HB_PATH=<Harbour root dir>
set HRB_DIR=<Some Harbour dir>
set INCLUDE=<Harbour include dir>
set LIB=<Harbour lib dir>
set HB_GT_LIB=
set HB_*_INSTALL=
set HB_INSTALL_???=
set HB_INC_*=
set HB_DIR_*=
set HB_LEX=
7. Remove any Harbour build settings documented in 'OPTIONS AVAILABLE WHEN
BUILDING HARBOUR' section.
8. Try to do no or only small modifications at once to command examples
included in 'EXAMPLES' section of this document. If it doesn't work,
fall back to documented examples _as is_.
9. If everything fails and you are to report a build problem to Harbour
developers, make sure to include your OS version/language/CPU architecture,
Harbour revision, C compiler name/release and version, environment
variables and verbose log output containing _both stderr and stdout in
one combined stream_ (use 'make > log.txt 2>&1'). Enable verbose
mode using 'HB_BUILD_VERBOSE=yes'.
Complete log output is rarely necessary, but always make sure to include
the top of the output (lines starting with '!') and the area where
problematic behavior occurred _first_. Make sure to not only include
a link failure or a make tool failure, as it's most of the time not
enough information. Compress your log using zip if it is larger
than 25KB. (use the extension '.zip')
With these, you have much better chance to get useful or any response.
10. Do not alter the directory layout and files in Harbour and 3rd party
packages.
11. If you are to report a build problem with a Harbour application,
all of the above points apply, plus make sure to use '-trace'
command line option when running hbmk2 and redirect the result to
a file (see above how).
It's good idea to first remove all manual references to Harbour
core components from makefiles and custom environment. F.e. it's
commom mistake to add C compiler header and/or lib dirs, Harbour core
header and/or lib dirs, built-in constants to makefiles or environment.
No such thing is necessary as all of these are automatically handled
by hbmk2. IOW start simple and don't be overbusy with "fine-tuning"
your configuration. If you need to, the problem is most probably
elsewhere. It's also good idea to try with Harbour nightly binary or
official stable release first.
12. If you are to report a problem with Harbour itself, always provide
self-contained, minimal source code example. Do not use xhb contrib
library, or any 3rd party Harbour libraries. The example shall reproduce
the problem using official stable or nightly Harbour build.
Do not post executables and other binary files. If your source contains
non-ASCII (national, accented, special) chars, clearly mark the
codepage/encoding used (UTF-8 recommended) and attach the files
compressed with zip. (use the extension '.zip')
See more on self-contained examples:
http://sscce.org/
13. If your example involves compatibility components, make sure to test
it against original implementation (for example, test legacy Clipper
core language elements against real CA-Clipper 5.2e or 5.3b, or hbct
functions against CT3 library, etc.)
11. QUICK START TO BUILD YOUR OWN HARBOUR APPLICATIONS
======================================================
For all platforms you'll need two things:
* Harbour binaries
Either a Harbour binary distribution or a local Harbour
build will be okay. If you're reading this text, it's
very likely you have one of these already.
* Supported ANSI C compiler
Your compiler of choice has to be placed in the PATH
(and configured appropriately according to instructions).
If you use official Harbour binary distribution on Windows,
you already have MinGW compiler embedded in the installation,
which will automatically be used, so you don't have to
make any extra steps here.
It's recommended (but not required) to put hbmk2 into the PATH
(f.e. by using 'set PATH=C:\harbour\bin;%PATH%' on Windows).
Then see hbmk2 documentation, with examples:
https://github.com/harbour/core/blob/master/utils/hbmk2/hbmk2.md
12. BUILD HOST-PLATFORM/SHELL - TARGET-PLATFORM/COMPILER COMPATIBILITY MATRIX
=============================================================================
| host<br />plat | target<br />plat/comp | target<br />cpu
:---- | :------------- | :-------------------- | :---------------------------------------
| win | win/bcc | x86
| win | win/bcc64 | x86-64
| win | win/gcc | x86
| win | win/global | x86
| win | win/icc | x86
| win | win/icc64 | x86-64 (not supported yet)
| win | win/iccia64 | ia64
| win | win/mingw | x86
| win | win/mingw64 | x86-64
| win | win/msvc | x86
| win | win/msvc64 | x86-64
| win | win/msvcia64 | ia64
| win | win/pocc | x86
| win | win/pocc64 | x86-64
| win | win/watcom | x86
| win | win/xcc | x86
x | win | wce/mingwarm | arm
x | win | wce/mingw | x86 (not fully supported yet)
x | win | wce/poccarm | arm
x | win | wce/msvcarm | arm
x | win | wce/msvcmips | mips (not supported yet)
x | win | wce/msvcsh | sh (not supported yet)
x | win | wce/msvc | x86 (not supported yet)
x | win | dos/djgpp | x86 (on Windows x86 hosts only)
x | win | dos/watcom | x86
x | win | os2/watcom | x86
x | win | linux/watcom | x86
x | win | android/gcc | x86
x | win | android/gccarm | arm
x | win | vxworks/gcc | (CPU cross-builds possible: x86, arm, mips, ppc)
x | win | vxworks/diab | (CPU cross-builds possible: x86, arm, mips, ppc, sparc)
x | win | symbian/gcc | arm
x | win | cygwin/gcc | x86
| dos | dos/djgpp | x86
| dos | dos/watcom | x86
x | dos | win/watcom | x86
x | dos | os2/watcom | x86
x | dos | linux/watcom | x86
| os2 | os2/gcc | x86
| os2 | os2/watcom | x86
x | os2 | win/watcom | x86
x | os2 | dos/watcom | x86
x | os2 | linux/watcom | x86
| linux | linux/gcc | (CPU cross-builds possible)
| linux | linux/clang | (CPU cross-builds possible)
| linux | linux/icc | (CPU cross-builds possible: x86, x86-64, ia64)
| linux | linux/sunpro | (CPU cross-builds possible: x86, x86-64)
| linux | linux/open64 | (CPU cross-builds possible: x86-64, ia64, ...)
x | linux | wce/mingwarm | arm
x | linux | wce/mingw | x86
x | linux | win/mingw | x86
x | linux | win/mingw64 | x86-64
x | linux | win/watcom | x86
x | linux | win/bcc | x86 (requires WINE)
x | linux | win/bcc64 | x86-64 (requires WINE)
x | linux | os2/watcom | x86
x | linux | dos/watcom | x86
x | linux | dos/djgpp | x86
x | linux | android/gcc | x86
x | linux | android/gccarm | arm
x | linux | vxworks/gcc | (CPU cross-builds possible: x86, arm, mips, ppc)
x | linux | vxworks/diab | (CPU cross-builds possible: x86, arm, mips, ppc, sparc)
| bsd | bsd/gcc | (CPU cross-builds possible)
| bsd | bsd/clang | (CPU cross-builds possible)
| bsd | bsd/pcc | (experimental)
x | bsd | wce/mingwarm | arm
x | bsd | wce/mingw | x86
x | bsd | win/mingw | x86
x | bsd | dos/djgpp | x86
| darwin | darwin/clang | (CPU cross-builds possible: x86, x86-64, unibin)
| darwin | darwin/gcc | (CPU cross-builds possible: x86, x86-64, ppc, ppc64, unibin)
| darwin | darwin/icc | (CPU cross-builds possible: x86, x86-64)
x | darwin | wce/mingwarm | arm
x | darwin | wce/mingw | x86
x | darwin | win/mingw | x86
x | darwin | win/mingw64 | x86-64
x | darwin | dos/djgpp | x86
x | darwin | android/gcc | x86
x | darwin | android/gccarm | arm
| hpux | hpux/gcc | (CPU cross-builds possible)
| qnx | qnx/gcc | (CPU cross-builds possible - no tested)
| beos | beos/gcc | x86
x | hpux | wce/mingwarm | arm
x | hpux | wce/mingw | x86
x | hpux | win/mingw | x86
x | hpux | dos/djgpp | x86
| minix | minix/clang | x86
| minix | minix/gcc | x86
| aix | aix/gcc | (CPU cross-builds possible: ppc, ppc64)
| sunos | sunos/gcc | (CPU cross-builds possible)
| sunos | sunos/sunpro | (CPU cross-builds possible: x86, x86-64, sparc32, sparc64)
x | sunos | wce/mingwarm | arm
x | sunos | wce/mingw | x86
x | sunos | win/mingw | x86
x | sunos | dos/djgpp | x86
x | sunos | vxworks/gcc | (CPU cross-builds possible: x86, arm, mips, ppc)
x | sunos | vxworks/diab | (CPU cross-builds possible: x86, arm, mips, ppc, sparc)
Leading 'x' marks cross-platform scenarios.
Supported shells per host platforms:
win / NT shell (cmd.exe)
win / POSIX shell (MSYS or Cygwin sh.exe)
win / MS-DOS shell (command.com)
dos / MS-DOS shell (command.com)
dos / POSIX shell (bash.exe)
os/2 / OS/2 shell (cmd.exe)
os/2 / POSIX shell (bash.exe)
*nix / POSIX shell
13. LINKS TO EXTERNAL COMPONENTS
================================
C/C++ Compilers/Shells:
MinGW/MinGW-64 [win, *nix, free, open-source]
http://sourceforge.net/projects/mingwbuilds/ (unofficial, recommended)
http://tdm-gcc.tdragon.net/, http://sourceforge.net/projects/tdm-gcc/ (unofficial) [NOTE: 4.5.1 is broken, 4.5.2, 4.6.1 x86 OK, for x64 use the official release]
http://www.mingw.org/, http://sourceforge.net/projects/mingw/ (official 32-bit, MSYS home, broken as of 4.5.0-1)
http://mingw-w64.sourceforge.net/, http://sourceforge.net/projects/mingw-w64/ (official 64-bit, MSYS home)
http://nuwen.net/mingw.html (unofficial)
MinGW CEGCC [win, *nix, free, open-source]
http://cegcc.sourceforge.net/
Cygwin [win, free, open-source]
http://www.cygwin.com/
OS/2 GCC [os2, free, open-source]
ftp://ftp.netlabs.org/pub/gcc/
ftp://ftp.netlabs.org/pub/gcc/GCC-3.3.5-csd3.zip
ftp://ftp.netlabs.org/pub/gcc/libc-0_6_3-csd3.exe
http://os2ports.smedley.info/index.php?page=gcc
http://os2ports.smedley.info/index.php?page=gcc44
http://download.smedley.info/gcc-4.4.5-os2-20101004.zip
DJGPP [dos, *nix, free, open-source]
http://www.delorie.com/djgpp/
Open Watcom [win, dos, os2, linux, free, open-source]
http://www.openwatcom.org/
Xcode / Command Line Tools for Xcode [darwin, free, hybrid-source]
Mac App Store
http://developer.apple.com/downloads/
MS Windows SDK [win, free, closed-source]
http://msdn.microsoft.com/en-us/windowsserver/bb980924.aspx
(7.0 and above contains compilers for x86, x86_64 and IA-64)
MS Windows Mobile SDK [wce, free]
http://www.microsoft.com/downloads/details.aspx?familyid=83A52AF2-F524-4EC5-9155-717CBE5D25ED
MS Visual Studio Express [win, free, closed-source]
http://www.microsoft.com/express/
MS Visual Studio [win, commercial, closed-source]
http://www.microsoft.com/visualstudio/
Pelles C [win, wce, free, closed-source]
http://www.smorgasbordet.com/pellesc/
Borland/CodeGear/Embarcadero Compiler [win, free, closed-source]
https://downloads.embarcadero.com/free/c_builder
Intel Compiler [win, linux, darwin, commercial, closed-source]
http://software.intel.com/en-us/intel-compilers/
Libraries:
HB_WITH_ADS - Advantage Client Engine API [win, linux, free, closed-source]
http://www.sybase.com/products/databasemanagement/advantagedatabaseserver/client-engine-api
HB_WITH_ALLEGRO - Allegro (GUI) [multiplatform, free, open-source]
http://alleg.sourceforge.net/
HB_WITH_BLAT - Blat (SMTP client) [win, free, open-source]
http://www.blat.net/
HB_WITH_BZIP2 - libbzip2 [multiplatform, free, open-source]
http://www.bzip.org/
HB_WITH_CAIRO - Cairo [multiplatform, open-source]
http://www.gtk.org/download-windows.html
Direct links, look for these components on page above:
http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/cairo-dev_1.8.8-2_win32.zip
http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/cairo_1.8.8-2_win32.zip
http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/libpng_1.2.39-1_win32.zip
HB_WITH_CUPS - libcups (printing) [*nix, free, open-source]
http://www.cups.org/
HB_WITH_CURL - libcurl (file transfer) [multiplatform, free, open-source]
http://curl.haxx.se/
HB_WITH_EXPAT - Expat (XML parser) [multiplatform, free, open-source]
http://expat.sourceforge.net/
HB_WITH_FIREBIRD - firebird SQL [multiplatform, free, open-source]
http://www.firebirdsql.org/
HB_WITH_FREEIMAGE - FreeImage [multiplatform, free, open-source]
http://freeimage.sourceforge.net/
HB_WITH_GD - GD Graphics Library [multiplatform, free, open-source]
http://www.boutell.com/gd/
HB_WITH_GS - Ghostscript [multiplatform, free, open-source]
http://www.ghostscript.com/
http://pages.cs.wisc.edu/~ghost/
HB_WITH_JPEG - jpeglib [multiplatform, free, open-source]
http://www.ijg.org/
HB_WITH_LIBHARU - libharu (PDF creation) [multiplatform, free, open-source]
http://libharu.org/
HB_WITH_LIBMAGIC - libmagic, file recognition [multiplatform, free, open-source]
ftp://ftp.astron.com/pub/file/
HB_WITH_LZF - lzf library (RT data compression) [multiplatform, free, open-source]
http://liblzf.plan9.de/
HB_WITH_MINILZO - miniLZO library (RT data compression) [multiplatform, free, open-source]
http://www.oberhumer.com/opensource/minilzo/
HB_WITH_MINIZIP - minizip library [multiplatform, free, open-source]
http://www.winimage.com/zLibDll/minizip.html
HB_WITH_MXML - miniXML library (small XML library) [multiplatform, free, open-source]
http://www.minixml.org
HB_WITH_MYSQL - MySQL [multiplatform, free, open-source]
http://dev.mysql.com/downloads/
HB_WITH_OCILIB - OCILIB (C Driver for Oracle) [multiplatform, free, open-source]
http://orclib.sourceforge.net/
http://www.oracle.com/technology/tech/oci/instantclient/index.html
HB_WITH_OPENSSL - OpenSSL [multiplatform, free, open-source]
http://www.openssl.org/
http://www.openssl.org/related/binaries.html
HB_WITH_PCRE - Perl Compatible Regular Expressions [multiplatform, free, open-source]
http://www.pcre.org/
HB_WITH_PGSQL - PostgreSQL [multiplatform, free, open-source]
http://www.postgresql.org/
HB_WITH_PNG - libpng [multiplatform, free, open-source]
http://www.libpng.org/pub/png/libpng.html
HB_WITH_SQLITE3 - sqlite3 [multiplatform, free, open-source]
http://www.sqlite.org/
HB_WITH_TIFF - libtiff [multiplatform, free, open-source]
http://www.libtiff.org/
HB_WITH_TINYMT - TinyMT (Mersenne Twister) [multiplatform, free, open-source]
http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/TINYMT/
HB_WITH_WATT - Watt-32 (TCP/IP sockets) [dos, free, open-source]
http://home.broadpark.no/~gvanem/
HB_WITH_ZLIB - zlib [multiplatform, free, open-source]
http://www.zlib.net/
HB_WITH_XDIFF - libxdiff (file differences/patches) [multiplatform, free, open-source]
http://www.xmailserver.org/xdiff-lib.html
Windows 95 Winsock2 [win, free, closed-source]
Information: http://support.microsoft.com/kb/182108/EN-US/
Direct link: http://download.microsoft.com/download/0/e/0/0e05231b-6bd1-4def-a216-c656fbd22b4e/w95ws2setup.exe
(required for Win95 support to run applications built with Harbour)
Windows UNICOWS .dll [win, free, closed-source]
http://go.microsoft.com/fwlink/?LinkId=14851
(required for Win9x/ME support to run applications built with Harbour in UNICODE mode)
Windows UNICOWS runtime/import library [win, free, open-source]
http://libunicows.sourceforge.net/
(required for Win9x/ME support at application built-time)
Tools:
Git (Version Control System) [multiplatform, free, open-source]
http://git-scm.com/
https://code.google.com/p/msysgit/downloads/list?q=full+installer+official+git (Windows binaries)
GitHub Client [multiplatform, free]
http://windows.github.com/
http://mac.github.com/
GNU Bison (grammer paser generator) [multiplatform, free, open-source]
Windows binary:
http://gnuwin32.sourceforge.net/packages/bison.htm
(not verified with current Harbour version)
Valgrind (dynamic executable analysis tool) [linux, darwin-x86, free, open-source]
http://valgrind.org/
Uncrustify (source formatter) [multiplatform, free, open-source]
http://uncrustify.sourceforge.net/
UPX (executable compressor) [win, dos, *nix, free, open-source]
http://upx.sourceforge.net/
Nullsoft Installer [win, free, open-source]
http://nsis.sourceforge.net/
7-Zip [multiplatform, free, open-source]
http://www.7-zip.org/
Info-ZIP [multiplatform, free, open-source]
http://www.info-zip.org/
bzip2 [multiplatform, free, open-source]
Windows binary:
http://www.bzip.org/downloads.html
GNU Make
Windows binary + source:
http://sourceforge.net/projects/mingw/files/MinGW/Extension/make/
http://sourceforge.net/projects/mingw/files/MinGW/Extension/make/make-3.82-mingw32/make-3.82-5-mingw32-bin.tar.lzma/download
http://sourceforge.net/projects/mingw/files/MinGW/Extension/make/make-3.82-mingw32/make-3.82-5-mingw32-src.tar.lzma/download
cvs -z3 -d:pserver:anonymous@cvs.savannah.gnu.org:/sources/make co make
(included in Harbour as win-make.exe)
MS-DOS binary + source:
ftp://ftp.delorie.com/pub/djgpp/beta/v2gnu/
ftp://ftp.delorie.com/pub/djgpp/beta/v2gnu/mak381b.zip
ftp://ftp.delorie.com/pub/djgpp/beta/v2gnu/mak381s.zip
(included in Harbour as dos-make.exe)
OS/2 binary + source:
http://www.os2site.com/sw/dev/make/index.html
http://www.os2site.com/sw/dev/make/make-3.81-r3-bin-static.zip
http://www.os2site.com/sw/dev/make/make-3.81-r3.zip
http://www.os2site.com/sw/dev/make/make-3.81-r2.zip
(included in Harbour as os2-make.exe)
GNU core utils (mkdir, rm, cp, echo)
MS-DOS binary + source:
ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/
ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/fil41b.zip
ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/fil41s.zip
ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/shl2011b.zip
ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/shtl208s.zip
ftp://ftp.delorie.com/pub/djgpp/current/v2/djdev203.zip
ftp://ftp.delorie.com/pub/djgpp/current/v2/djlsr203.zip
(included in Harbour as dosmkdir.exe, dosrm.exe, doscp.exe, dosecho.exe)
OS/2 binary:
http://os2ports.smedley.info/index.php?page=build-environment
http://download.smedley.info/buildenv_20071022.zip
(included in Harbour as os2mkdir.exe, os2rm.exe, os2cp.exe)
Documentation:
Netiquette Guidelines
http://tools.ietf.org/html/rfc1855
Setting up Git:
https://help.github.com/articles/set-up-git
Git book [free]
http://git-scm.com/book
Git crash course for Subversion users:
http://git.or.cz/course/svn.html
14. HOW TO PARTICIPATE
======================
There are several ways to help making Harbour better:
- You can give feedback/suggestions to developers on available
channels.
- You can submit patches or source code on above channels.
Patches are accepted in 'git diff' (or 'diff -u') format,
created from root directory of the repository sandbox.
Zip your patch file before attaching it. Use the extension '.zip'.
Always use the same coding/formatting style as you find in
the files you're patching. The easiest way to achieve this
is to use these commands to format your sources:
$ uncrustify -c <harbour_dir>/bin/harbour.ucf <file.c|.h>
$ <harbour_dir>/bin/hbformat <file.prg|.hb|.ch>
- Text editor setting for Harbour files
- Encoding is either 7-bit ASCII or UTF-8.
- Always add spaces, never tabs
- Never convert spaces to tabs
- Remove trailing spaces from lines
- Always keep one (not zero or multiple) newline at the end of file
- Use platform native newline (CRLF or LF)
- In the rare case you need to send something large (> 100KB),
use this free service: http://dropcanvas.com
- Given a good history of valuable contributions, you can get
write access to the source repository.
- Of course there is more into Harbour contribution than writing
code, so you're welcome to do so in other areas like documentation,
helping fellow users, giving input on decisions, testing in
various environments, etc.
15. FOR MORE INFORMATION
========================
Homepage:
http://harbour-project.org/
Harbour Users' Mailing List (English language):
https://groups.google.com/group/harbour-users/
Harbour Development Mailing List (English language):
https://groups.google.com/group/harbour-devel/
Source:
https://github.com/harbour/core
Issues:
https://github.com/harbour/core/issues
CA-Cl*pper 5.3 online documentation:
http://x-hacker.org/ng/53guide/
Miscellaneous documents:
https://github.com/harbour/core/tree/master/doc
Particularly:
Comparing Harbour to xHarbour:
https://github.com/harbour/core/raw/master/doc/xhb-diff.txt
ChangeLog:
https://github.com/harbour/core/raw/master/ChangeLog.txt
hbmk2 documentation:
https://github.com/harbour/core/blob/master/utils/hbmk2/hbmk2.md
hbrun documentation:
https://github.com/harbour/core/blob/master/contrib/hbrun/hbrun.md
Wikipedia:
https://en.wikipedia.org/wiki/Harbour_compiler
[ Copyright (c) 2009-2013 Viktor Szakats (harbour syenar.net)
Licensed under Creative Commons Attribution-ShareAlike 3.0:
http://creativecommons.org/licenses/by-sa/3.0/
See COPYING.txt. ]