doc/readme-qt.rst

   1 Bitcoin-Qt: Qt4 GUI for Bitcoin
   2 ===============================
   3
   4 Build instructions
   5 ===================
   6
   7 Debian
   8 -------
   9
  10 First, make sure that the required packages for Qt4 development of your
  11 distribution are installed, for Debian and Ubuntu these are:
  12
  13 ::
  14
  15     apt-get install qt4-qmake libqt4-dev build-essential libboost-dev libboost-system-dev \
  16         libboost-filesystem-dev libboost-program-options-dev libboost-thread-dev \
  17         libssl-dev libdb4.8++-dev
  18
  19 then execute the following:
  20
  21 ::
  22
  23     qmake
  24     make
  25
  26 Alternatively, install `Qt Creator`_ and open the `bitcoin-qt.pro` file.
  27
  28 An executable named `bitcoin-qt` will be built.
  29
  30 .. _`Qt Creator`: http://qt-project.org/downloads/
  31
  32 Windows
  33 --------
  34
  35 Windows build instructions:
  36
  37 - Download the `Qt Windows SDK`_ and install it. You don't need the Symbian stuff, just the desktop Qt.
  38
  39 - Download and extract the `dependencies archive`_  [#]_, or compile openssl, boost and dbcxx yourself.
  40
  41 - Copy the contents of the folder "deps" to "X:\\QtSDK\\mingw", replace X:\\ with the location where you installed the Qt SDK. Make sure that the contents of "deps\\include" end up in the current "include" directory.
  42
  43 - Open the bitcoin-qt.pro file in Qt Creator and build as normal (ctrl-B)
  44
  45 .. _`Qt Windows SDK`: http://qt-project.org/downloads/
  46 .. _`dependencies archive`: https://download.visucore.com/bitcoin/qtgui_deps_1.zip
  47 .. [#] PGP signature: https://download.visucore.com/bitcoin/qtgui_deps_1.zip.sig (signed with RSA key ID `610945D0`_)
  48 .. _`610945D0`: http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x610945D0
  49
  50
  51 Mac OS X
  52 --------
  53
  54 - Download and install the `Qt Mac OS X SDK`_. It is recommended to also install Apple's Xcode with UNIX tools.
  55
  56 - Download and install `MacPorts`_.
  57
  58 - Execute the following commands in a terminal to get the dependencies:
  59
  60 ::
  61
  62         sudo port selfupdate
  63         sudo port install boost db48 miniupnpc
  64
  65 - Open the bitcoin-qt.pro file in Qt Creator and build as normal (cmd-B)
  66
  67 .. _`Qt Mac OS X SDK`: http://qt-project.org/downloads/
  68 .. _`MacPorts`: http://www.macports.org/install.php
  69
  70
  71 Build configuration options
  72 ============================
  73
  74 UPnP port forwarding
  75 ---------------------
  76
  77 To use UPnP for port forwarding behind a NAT router (recommended, as more connections overall allow for a faster and more stable bitcoin experience), pass the following argument to qmake:
  78
  79 ::
  80
  81     qmake "USE_UPNP=1"
  82
  83 (in **Qt Creator**, you can find the setting for additional qmake arguments under "Projects" -> "Build Settings" -> "Build Steps", then click "Details" next to **qmake**)
  84
  85 This requires miniupnpc for UPnP port mapping.  It can be downloaded from
  86 http://miniupnp.tuxfamily.org/files/.  UPnP support is not compiled in by default.
  87
  88 Set USE_UPNP to a different value to control this:
  89
  90 +------------+--------------------------------------------------------------------------+
  91 | USE_UPNP=- | no UPnP support, miniupnpc not required;                                 |
  92 +------------+--------------------------------------------------------------------------+
  93 | USE_UPNP=0 | (the default) built with UPnP, support turned off by default at runtime; |
  94 +------------+--------------------------------------------------------------------------+
  95 | USE_UPNP=1 | build with UPnP support turned on by default at runtime.                 |
  96 +------------+--------------------------------------------------------------------------+
  97
  98 Notification support for recent (k)ubuntu versions
  99 ---------------------------------------------------
 100
 101 To see desktop notifications on (k)ubuntu versions starting from 10.04, enable usage of the
 102 FreeDesktop notification interface through DBUS using the following qmake option:
 103
 104 ::
 105
 106     qmake "USE_DBUS=1"
 107
 108 Generation of QR codes
 109 -----------------------
 110
 111 libqrencode may be used to generate QRCode images for payment requests.
 112 It can be downloaded from http://fukuchi.org/works/qrencode/index.html.en, or installed via your package manager. Pass the USE_QRCODE
 113 flag to qmake to control this:
 114
 115 +--------------+--------------------------------------------------------------------------+
 116 | USE_QRCODE=0 | (the default) No QRCode support - libarcode not required                 |
 117 +--------------+--------------------------------------------------------------------------+
 118 | USE_QRCODE=1 | QRCode support enabled                                                   |
 119 +--------------+--------------------------------------------------------------------------+
 120
 121
 122 Berkely DB version warning
 123 ==========================
 124
 125 A warning for people using the *static binary* version of Bitcoin on a Linux/UNIX-ish system (tl;dr: **Berkely DB databases are not forward compatible**).
 126
 127 The static binary version of Bitcoin is linked against libdb4.8 (see also `this Debian issue`_).
 128
 129 Now the nasty thing is that databases from 5.X are not compatible with 4.X.
 130
 131 If the globally installed development package of Berkely DB installed on your system is 5.X, any source you
 132 build yourself will be linked against that. The first time you run with a 5.X version the database will be upgraded,
 133 and 4.X cannot open the new format. This means that you cannot go back to the old statically linked version without
 134 significant hassle!
 135
 136 .. _`this Debian issue`: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=621425
 137
 138 Ubuntu 11.10 warning
 139 ====================
 140
 141 Ubuntu 11.10 has a package called 'qt-at-spi' installed by default.  At the time of writing, having that package
 142 installed causes bitcoin-qt to crash intermittently.  The issue has been reported as `launchpad bug 857790`_, but
 143 isn't yet fixed.
 144
 145 Until the bug is fixed, you can remove the qt-at-spi package to work around the problem, though this will presumably
 146 disable screen reader functionality for Qt apps:
 147
 148 ::
 149
 150     sudo apt-get remove qt-at-spi
 151
 152 .. _`launchpad bug 857790`: https://bugs.launchpad.net/ubuntu/+source/qt-at-spi/+bug/857790