building and installation process for monotone
==============================================

1. prerequisites:

  * hardware prerequisites:

    - g++ consumes a lot of memory building monotone, due to
      monotone's liberal use of C++ features. it may be possible to
      build on a system with 128mb of memory, but not pleasant. we are
      working on making this situation better.

  * software prerequisites:

    - autoconf
    - automake
    - gettext
    - a supported C++ compiler: g++ 3.2 or later
    - boost 1.33.0 or later: either an installed copy or an extracted
      tarball of its unbuilt sources somewhere in the file system are
      supported
    - zlib 1.1.4 or later
    - libiconv if the iconv() function is missing
    - texinfo (to build the documentation)
    - Botan 1.6.3 or later (Botan might require bzip2, OpenSSL and / or
      GnuMP in addition, depending on the package you're using.)
    - PCRE 7.4 or later
    - SQLite 3.3.8 or later
    - Lua 5.1
    - GNU IDN Library

        on Debian and Ubuntu:

           install the following packages:
             autoconf automake gettext g++ libboost-dev libz-dev
             libbotan-dev libsqlite3-dev libpcre3-dev liblua5.1-0-dev
             libidn11-dev libgmp3-dev libbz2-dev texinfo

           (On etch, you may need to use libbotan1.7 from lenny.)

        on FreeBSD:

           install the following packages from the ports collection:
             databases/sqlite3 devel/automake1.9 devel/boost devel/gettext
             devel/gmake devel/pcre lang/lua security/botan

        on Gentoo:

           emerge the following packages:
             autoconf automake boost botan gettext libpcre libidn lua sqlite
             zlib

        on Fedora:

           install the following packages:
             autoconf automake gettext boost boost-devel zlib zlib-devel
             lua lua-devel pcre pcre-devel sqlite sqlite-devel libidn
             libidn-devel gcc-c++ texinfo texinfo-tex botan botan-devel

        on Mac OS X:

           use MacPorts (http://www.macports.org) to install the following
           packages:
             autoconf automake gettext boost zlib lua pcre botan
             sqlite3 libidn libiconv texinfo

           monotone only uses header-only libraries from boost, so if you don't
           like to spend a lot of time building boost via MacPorts, you can also
           download and extract it manually and let CXXFLAGS point to the
           include/ directory of the extracted version.

        on Windows (using MinGW):

           Many tools and packages are available on the SourceForge
           MinGW download site:

           https://sourceforge.net/projects/mingw/files/

           That site is organized into several hierarchical lists of
           files. We give the hierarchy names here, rather than a
           complete download URL, to make it easy to check for new
           versions. The versions given here were used to build the
           current release of monontone.

           Trying a new version of Boost can be dangerous.

           These instructions work on a new computer, with only
           Windows XP installed.

           Package  | Version | location
           --------------------------
           MinGW    | 5.1.4   | Automated MinGW Installer | MinGW-5.1.4.exe
           MSYS     | 1.0.11  | MSYS Base System | Current Release: msys-1.0.10 | MSYS-1.0.10.exe
           msysDTK  | 1.0.1   | MSYS Supplementary Tools | Current Release: msysDTK-1.0.1 | msysDTK-1.0.1.exe
           libiconv | 1.13    | MinGW libiconv | Release 1.13 |
                    |         |  libiconv-1.13-mingw32-bin.tar.gz
                    |         |  libiconv-1.13-mingw32-dev.tar.gz
                    |         |  libiconv-1.13-mingw32-dll-2.tar.gz
           autoconf | 2.63    | MSYS autoconf | autoconf-2.63-1 | autoconf-2.63-1-msys-1.0.11-bin.tar.lzma
           automake | 1.11    | MSYS automake | automake-1.11-1 | automake-1.11-1-msys-1.0.11-bin.tar.lzma
           zlib     | 1.2.3   | MinGW zlib |
                    |         | libz-1.2.3-1-mingw32-dev.tar.gz
                    |         | libz-1.2.3-1-mingw32-dll-1.tar.gz
           gcc dll  |         | GCC Version 4 | gcc-core-4.4.0-mingw32-dll.tar.gz
           gettext  | 0.17    | MinGW gettext |
                    |         | gettext-0.17-1-mingw32-bin.tar.lzma
                    |         | gettext-0.17-1-mingw32-dev.tar.lzma
                    |         | libgettextpo-0.17-1-mingw32-dll-0.tar.lzma
                    |         | libintl-0.17-1-mingw32-dll-8.tar.lzma
           boost    | 1.34.1  | http://prdownloads.sf.net/boost/boost_1_34_1.tar.bz2?download
           Lua      | 5.1.4   | http://www.lua.org/ | lua-5.1.4.tar.gz
           pcre     | 7.8     | http://www.pcre.org/ | pcre-7.8.tar.bz2
           botan    | 1.8.4   | http://botan.randombit.net/news/ | Botan-1.8.4.tbz
           sqlite3  | 3.6.16  | http://www.sqlite.org/download.html | sqlite-amalgamation-3.6.16.tar.gz, with makefile
           libidn   | 1.9     | ftp://ftp.gnu.org/gnu/libidn | libidn-1.9.tar.gz
           Depends.exe|       | http://www.dependencywalker.com/ ; also comes with Visual Studio

           msysDTK installs autoconf, automake, Perl, CVS, crypt, and
           other tools needed by the autoconf tools.

           However, monotone requires a newer autoconf and automake.
           In general, there are two versions of most tools on the
           MinGW site; mingw and msys. MinGW versions are intended to
           be run from a DOS shell, msys versions from an Msys shell.
           monotone configure requires the Msys shell, so we need the
           msys versions of autoconf and automake.

           Other tools will be linked with the monotone MinGW
           executable, so we need the MinGW versions of those.

           1. MinGW - run installer, accept defaults but add g++ on the package selection page (installs to c:/MinGW)
           2. MSYS - run installer, accept defaults (installs to c:/Msys)
           3. msysDTK - run installer, accept defaults (installs to c:/Msys)

           4. libiconv
              start the Msys shell.
              $ cd /mingw
              $ tar zxf libiconv-1.13-mingw32-bin.tar.gz
              $ tar zxf libiconv-1.13-mingw32-dev.tar.gz
              $ tar zxf libiconv-1.13-mingw32-dll-2.tar.gz

           5. autoconf
              $ cd /
              $ tar --lzma -xf autoconf-2.63-1-msys-1.0.11-bin.tar.lzma

           6. automake
              $ cd /
              $ tar --lzma -xf automake-1.11-1-msys-1.0.11-bin.tar.lzma

           7. zlib
              $ cd /mingw
              $ tar zxf libz-1.2.3-1-mingw32-dev.tar.gz
              $ tar zxf libz-1.2.3-1-mingw32-dll-1.tar.gz
              $ cp bin/libz-1.dll bin/zlib1.dll

           8. gettext
              $ cd /mingw
              $ tar --lzma -xf gettext-0.17-1-mingw32-bin.tar.lzma
              $ tar --lzma -xf gettext-0.17-1-mingw32-dev.tar.lzma
              $ tar --lzma -xf libgettextpo-0.17-1-mingw32-dll-0.tar.lzma
              $ tar --lzma -xf libintl-0.17-1-mingw32-dll-8.tar.lzma
              $ tar zxf gcc-core-4.4.0-mingw32-dll.tar.gz

           9. boost; only need headers
              $ cd /usr/src
              $ tar jxf boost_1_34_1.tar.bz2
              $ cd boost_1_34_1
              $ cp -a boost /mingw/include

           10. Lua
               $ cd /usr/src
               $ tar zxf lua-5.1.4.tar.gz
               $ cd lua-5.1.4
               $ make mingw INSTALL_TOP=/mingw
               $ make install INSTALL_TOP=/mingw

           11. pcre
               $ cd /usr/src
               $ tar jxf pcre-7.8.tar.bz2
               $ cd pcre-7.8
               $ ./configure --prefix=/mingw
               $ make install

           12. botan
               12.1 unpack, configure:
                    $ cd /usr/src
                    $ tar jxf Botan-1.8.4.tbz
                    $ cd Botan-1.8.4
                    $ ./configure.pl --with-tr1=none
               12.2 edit Makefile, delete -ansi from LANG_FLAGS
               12.3 install:
                    $ make install

           13. sqlite3
               $ cd /usr/src
               $ tar zxf sqlite-amalgamation-3.6.16.tar.gz
               $ cd sqlite-3.6.16
               $ ./configure --prefix=/mingw
               $ make install

           14. libidn
               $ cd /usr/src
               $ tar zxf libidn-1.9.tar.gz
               $ cd libidn-1.9
               $ ./configure --prefix=/mingw
               $ make install

           15. Depends.exe
               If you have Visual Studio install, you should be able to skip this.
               If you don't, then download the appropriate depends*.zip and
               unpack it someplace in your %PATH%.
               This is only used by the testsuite, in particular the empty_environment test.
               If you just want to build monotone for your own use, you can skip this and
               just ignore that that test fails.

           16. build monotone
               $ cd /c/.../monotone
               $ export PATH=/bin:/mingw/bin
               $ autoreconf -i
               $ touch config.h.in
               $ ./configure sqlite3_LIBS=-lsqlite3
               $ make

        on Windows (using Cygwin):

           Monotone needs the following packages to compile:
           (newer releases are usually ok)

             Runtime requirements:
               cygwin-1.7.0-60
               libgcc1-4.3.2-2
               libidn11-1.9-1
               libintl8-0.17-11
               libpcre0-7.9-1
               libsqlite3_0-3.6.2-1
               libstdc++6-4.3.2-2
               lua-5.1.4-11
               zlib0-1.2.3-10

             Build requirements:
               gcc4-4.3.2
               binutils-2.19.51
               boost-devel-1.33.1
               libsqlite3-devel-3.6.2
               libidn-devel-1.9
               gettext-devel-0.17
               zlib-1.2.3
               perl-5.10.0
               botan-1.8.2

           currently every prerequisite is available as packages except
           lua and botan which are only available in Cygwin 1.7;
           an official Cygwin package for monotone and all its
           dependencies is usually available soon after release.

           The following is needed to succesfully configure:
             CXXFLAGS+="-I/usr/include/boost-1_33_1/"

           Easiest way to create a Cygwin package is using cygport
           (which must be installed separately as a Cygwin package)
           and upgrade the previous version cygport file; you can fetch
           latest version from the maintainer's own repository:

           % mtn pull lapo.it it.lapo.cygwin.ports
           % mtn checkout -b it.lapo.cygwin.ports cygwin
           % cd cygwin
           % mtn mv monotone-$OLD-1.cygport monotone-$NEW-1.cygport
           proceed to change or fix the port and/or the patch as needed
           % cygport monotone-$NEW-1 all

        on other systems:

           check your system package repository, you may need to
           build some of these from source. if your package repository
           does not contain the libraries, see:

                http://gcc.gnu.org/                  for g++
                http://www.boost.org/                for Boost
                http://www.pcre.org/                 for PCRE
                http://www.lua.org/                  for Lua
                http://www.sqlite.org/               for SQLite
                http://botan.randombit.net/          for Botan
                http://www.gnu.org/software/libidn/  for GNU IDN

1.1 using boost in the build process:

  monotone uses the boost libraries in multiple parts of its code.
  fortunately, it only uses the so-called header-only libraries: these
  can be used very easily from other projects, as there is no need to
  build them by hand prior usage.

  therefore you can use an installed version of boost if shipped with your
  distribution but, if you do not want to mess with the Boost.Build build
  system (which is hard to deal with for beginners), you can simply use an
  extracted copy of the boost sources.  the two procedures are detailed
  below:

  * if your system already has the boost development libraries installed,
    you must tell the compiler where to find them.  their location will
    usually be somewhere under /usr/include.  try the following command:

      ls -d /usr/include/boost*

    if the command shows a single directory named 'boost', you do not have
    to take any extra steps.  configure will automatically find the
    necessary files.  instead, if the command shows a directory name of the
    form boost_1_33_1, boost-1.33.1 or similar, you will have to pass that
    to the configure script.  do so as follows:

      ./configure CPPFLAGS="-I/usr/include/boost-1.33.1"

    if no directories are shown, look for prebuilt boost packages for your
    system and install them.  if there aren't any, resort to the procedure
    described in the following point.

  * if you do not have boost already installed, and you cannot easily
    install it from prebuilt packages, fetch a copy of the boost sources
    from their site (see previous section) and unpack them somewhere in
    your system -- for example, your home directory.  once done, tell the
    configure script where the files are:

      ./configure CPPFLAGS="-I${HOME}/boost-1.33.1"

  it is important to note that, once monotone is built, you can get rid of
  all the boost sources or boost development packages from your system.
  the required header-only libraries will have been built into the final
  binary, which will not rely on any binary boost library.  in some sense,
  you can think of it as static linkage.

2. configuring monotone:

  * if there is no ./configure script in your source tree you'll need
    to create one before proceeding to the next step. one of the
    following auto* commands should work:

        $ aclocal-1.9 && autoreconf --install
        $ AUTOMAKE=automake-1.9 ACLOCAL=aclocal-1.9 autoreconf --install

    If this fails early, check that you have gettext packages installed.

  * type "./configure" for a basic configuration of monotone.  several
    configuration options are available; type "configure --help" for a
    list of all of them. some special options are shown here:

     --enable-ipv6[=auto|no|yes]

       specify whether IPv6 support has to be enabled or disabled.  the
       default is to try automatic detection (auto) and use the guessed
       results.  however, you can force IPv6 detection by saying 'yes'
       or completely disable it using 'no'.

     --disable-nls

       build a version of monotone without support for local message
       catalogs. you might like to do this if you do not have a
       working installation of GNU gettext.

     --enable-pch

       this will enable precompiled headers, which should improve compile
       time. some versions of gcc have problems with this option, so
       try disabling it if you run into trouble.

3. building monotone

  * type "make" to invoke GNU make (please notice it might be named
    "gmake" on systems where system make is not GNU make).
    this should produce a mtn binary in your current directory.
    if not, please send a build log to
    monotone-devel@nongnu.org with a description of the failure.

4. testing monotone

  * there is a "make check" target which you can try, if you'd like to
    confirm monotone's functionality on your system.
    Do not run "make check" as root (Unix)!  Doing so will cause the
    failure of some of the tests!
    Also, make sure your testing process has enough memory.  Experience
    has shown that some tests may fail "mysteriously" when there is too
    little memory.  A possible hint is that 128MB was too little on
    FreeBSD 6 on x86 while 256MB was enough.

    You might also like to try fetching monotone's sources from our
    monotone server. this process will transfer the complete development
    history (about 70 megabytes) to your database, and you will then
    be free to share it with others or make changes and submit them to
    us:

        mtn clone monotone.ca net.venge.monotone

5. upgrading

  * if you have an existing monotone installation, you may need to
    perform some additional steps to migrate your data to the newest
    version; see the file UPGRADE for details.

