aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/build-osx.txt173
-rw-r--r--doc/build-unix.txt63
-rw-r--r--doc/release-process.txt22
3 files changed, 74 insertions, 184 deletions
diff --git a/doc/build-osx.txt b/doc/build-osx.txt
index ac67080c3a..a13f8d3ada 100644
--- a/doc/build-osx.txt
+++ b/doc/build-osx.txt
@@ -1,5 +1,4 @@
-Copyright (c) 2010 Laszlo Hanyecz
-Portions Copyright (c) 2011 Douglas Huff
+Copyright (c) 2011 Bitcoin Developers
Distributed under the MIT/X11 software license, see the accompanying file
license.txt or http://www.opensource.org/licenses/mit-license.php. This
product includes software developed by the OpenSSL Project for use in the
@@ -26,163 +25,29 @@ everything is available in /usr not just /Developer I think it comes on the DVD
but you can get the current version from http://developer.apple.com
-1. Pick a directory to work inside.. something like ~/bitcoin works. The
-structure I use looks like this:
+1. Clone the github tree to get the source code:
-(~ is your home directory)
+git clone git@github.com:bitcoin/bitcoin.git bitcoin
-~/bitcoin
-~/bitcoin/bitcoin # Upstream source tree
-~/bitcoin/src # source code (symlink to ~/bitcoin/bitcoin/src)
-~/bitcoin/deps # dependencies.. like libraries and headers needed to compile
+2. Download and install MacPorts from http://www.macports.org/
-Just execute: mkdir ~/bitcoin
-This will create the top dir for you..
+3. Install dependencies from MacPorts
-WARNING: do not use the ~ notation with the configure scripts.. use the full
-name of the directory, for example /Users/james/bitcoin/deps for a user named
-'james'. In my examples I am using 'macosuser' so make sure you change that.
+sudo port install boost db48 openssl
-2. Check out the bitcoin code from github:
+Install the right version of miniupnpc:
+pushd bitcoin/contrib/minipupnpc; sudo port install; popd
+(this will be unnecessary soon, you will just port install miniupnpc
+along with the rest of the dependencies).
-cd ~/bitcoin
-git clone https://github.com/bitcoin/bitcoin.git
-ln -s bitcoin/src src
+4. Now you should be able to build bitcoind:
-This will make ~/bitcoin/bitcoin for you with all the files from git. This puts
-the actual sources in ~/bitcoin/bitcoin/src and create a symlink src in
-~/bitcoin to this location.
+cd bitcoin/src
+make -f makefile.osx
-3. Get and build the dependencies
-
-
-Boost
------
-
-Download from http://www.boost.org/users/download/
-I'm assuming it ended up in ~/Downloads..
-
-mkdir ~/bitcoin/deps
-cd ~/bitcoin/deps
-tar xvjf ~/Downloads/boost_1_42_0.tar.bz2
-cd boost_1_42_0
-./bootstrap.sh
-./bjam architecture=combined address-model=32_64 macosx-version=10.5 macosx-version-min=10.5 link=static runtime-link=static --toolset=darwin --prefix=/Users/macosuser/bitcoin/deps install
-
-If you're using Snow Leopard, you will need to specify 10.6 as your Mac OS X
-version instead of 10.5.
-
-This part takes a while.. use your judgement and fix it if something doesn't
-build for some reason.
-
-Change the prefix to whatever your directory is (my username in this example
-is macosuser). I'm also running on 10.6 so i have macosx-version=10.6 change
-to 10.5 if you're using leopard.
-
-This is what my output looked like at the end:
-...failed updating 2 targets...
-...skipped 144 targets...
-...updated 8074 targets...
-
-
-OpenSSL
--------
-
-(System or MacPorts openssl will work fine. Optional.)
-
-Download from http://www.openssl.org/source/
-
-We would like to build this as a 32 bit/64 bit library so we actually build it
-2 times and join it together here.. If you downloaded with safari it already
-uncompressed it so it will just be a tar not a tar.gz
-
-cd ~/bitcoin/deps
-tar xvf ~/Downloads/openssl-1.0.0.tar
-mv openssl-1.0.0 openssl-1.0.0-i386
-tar xvf ~/Downloads/openssl-1.0.0.tar
-mv openssl-1.0.0 openssl-1.0.0-x86_64
-# build i386 (32 bit intel) binary
-cd openssl-1.0.0-i386
-./Configure --prefix=/Users/macosuser/bitcoin/deps --openssldir=/Users/macosuser/bitcoin/deps/openssl darwin-i386-cc && make
-make install # only do this on one of the architectures, to install the headers
-cd ..
-# build x86_64 (64 bit intel) binary
-cd openssl-1.0.0-x86_64
-./Configure --prefix=/Users/macosuser/bitcoin/deps --openssldir=/Users/macosuser/bitcoin/deps/openssl darwin64-x86_64-cc && make
-cd ..
-
-# combine the libs
-cd ~/bitcoin/deps
-lipo -arch i386 openssl-1.0.0-i386/libcrypto.a -arch x86_64 openssl-1.0.0-x86_64/libcrypto.a -o lib/libcrypto.a -create
-lipo -arch i386 openssl-1.0.0-i386/libssl.a -arch x86_64 openssl-1.0.0-x86_64/libssl.a -o lib/libssl.a -create
-
-Verify your binaries
-
-file lib/libcrypto.a
-
-output should look like this:
-
-lib/libcrypto.a: Mach-O universal binary with 2 architectures
-lib/libcrypto.a (for architecture i386): current ar archive random library
-lib/libcrypto.a (for architecture x86_64): current ar archive random library
-
-
-miniupnpc
----------
-
-(MacPorts miniupnpc package works fine. You will need to modify makefile.)
-
-The process for miniupnpc (optional) is similar to that of OpenSSL.
-
-Download from http://miniupnp.tuxfamily.org/files/.
-
-cd ~/bitcoin/deps
-tar xvf ~/Downloads/miniupnpc-1.6.tar
-mv miniupnpc-1.6 miniupnpc-1.6-x86_64
-tar xvf ~/Downloads/miniupnpc-1.6.tar
-mv miniupnpc-1.6 miniupnpc-1.6-i386
-# build x86_64 (64 bit intel) binary
-cd miniupnpc-1.6-x86_64
-export CFLAGS="-arch x86_64"
-export LDFLAGS="-arch x86_64"
-export PREFIX="/Users/macuser/bitcoin/deps"
-make && make install
-# build i386 (32 bit intel) binary
-cd miniupnpc-1.6-i386
-export CFLAGS="-arch i386"
-export LDFLAGS="-arch i386"
-export PREFIX="/Users/macuser/bitcoin/deps"
-make
-
-# combine the libs
-cd ~/bitcoin/deps
-lipo -arch i386 miniupnpc-1.6-i386/libminiupnpc.a -arch x86_64 miniupnpc-1.6-x86_64/libminiupnpc.a -o lib/libminiupnpc.a -create
-
-Verify your binaries
-
-file lib/libminiupnpc.a
-
-output should look like this:
-
-lib/libminiupnpc.a: Mach-O universal binary with 2 architectures
-lib/libminiupnpc.a (for architecture i386): current ar archive random library
-lib/libminiupnpc.a (for architecture x86_64): current ar archive random library
-
-
-Berkeley DB
------------
-
-(System or MacPorts version work fine.)
-
-Download from http://freshmeat.net/projects/berkeleydb/
-
-cd ~/bitcoin/deps
-tar xvf ~/Downloads/db-4.8.30.tar
-cd db-4.8.30/build_unix
-../dist/configure --prefix=/Users/macosuser/bitcoin/deps --enable-cxx && make && make install
-
-
-Now you should be able to build bitcoind:
-
-cd ~/bitcoin/src
-make -f makefile.osx bitcoind
+Run:
+ ./bitcoind --help # for a list of command-line options.
+Run
+ ./bitcoind -daemon # to start the bitcoin daemon.
+Run
+ ./bitcoind help # When the daemon is running, to get a list of RPC commands
diff --git a/doc/build-unix.txt b/doc/build-unix.txt
index b7aa7112b4..e47dbf710c 100644
--- a/doc/build-unix.txt
+++ b/doc/build-unix.txt
@@ -22,38 +22,63 @@ the graphical bitcoin.
Dependencies
------------
+
+ Library Purpose Description
+ ------- ------- -----------
+ libssl SSL Support Secure communications
+ libdb4.8 Berkeley DB Blockchain & wallet storage
+ libboost Boost C++ Library
+ miniupnpc UPnP Support Optional firewall-jumping support
+
+miniupnpc may be used for UPnP port mapping. It can be downloaded from
+http://miniupnp.tuxfamily.org/files/. UPnP support is compiled in and
+turned off by default. Set USE_UPNP to a different value to control this:
+ USE_UPNP= No UPnP support - miniupnp not required
+ USE_UPNP=0 (the default) UPnP support turned off by default at runtime
+ USE_UPNP=1 UPnP support turned on by default at runtime
+
+Licenses of statically linked libraries:
+ Berkeley DB New BSD license with additional requirement that linked
+ software must be free open source
+ Boost MIT-like license
+ miniupnpc New (3-clause) BSD license
+
+Versions used in this release:
+ GCC 4.3.3
+ OpenSSL 0.9.8g
+ Berkeley DB 4.8.30.NC
+ Boost 1.37
+ miniupnpc 1.6
+
+
+Dependency Build Instructions: Ubuntu & Debian
+----------------------------------------------
sudo apt-get install build-essential
sudo apt-get install libssl-dev
sudo apt-get install libdb4.8-dev
sudo apt-get install libdb4.8++-dev
-Boost 1.40+: sudo apt-get install libboost-all-dev
-or Boost 1.37: sudo apt-get install libboost1.37-dev
+ Boost 1.40+: sudo apt-get install libboost-all-dev
+ or Boost 1.37: sudo apt-get install libboost1.37-dev
If using Boost 1.37, append -mt to the boost libraries in the makefile.
-Requires miniupnpc for UPnP port mapping. It can be downloaded from
-http://miniupnp.tuxfamily.org/files/. UPnP support is compiled in and
-turned off by default. Set USE_UPNP to a different value to control this:
-USE_UPNP= no UPnP support, miniupnp not required;
-USE_UPNP=0 (the default) UPnP support turned off by default at runtime;
-USE_UPNP=1 UPnP support turned on by default at runtime.
-Licenses of statically linked libraries:
-Berkeley DB New BSD license with additional requirement that linked software must be free open source
-Boost MIT-like license
-miniupnpc New (3-clause) BSD license
+Dependency Build Instructions: Gentoo
+-------------------------------------
+emerge -av boost openssl sys-libs/db
-Versions used in this release:
-GCC 4.3.3
-OpenSSL 0.9.8g
-Berkeley DB 4.8.30.NC
-Boost 1.37
-miniupnpc 1.6
+Take the following steps to build (no UPnP support):
+ cd ${BITCOIN_DIR}/src
+ sed -i 's/<db_cxx.h>/<db4.8\/db_cxx.h>/' *.h # path fix
+ sed -i 's/-Bstatic/-Bdynamic/' makefile.unix # dynamic linking
+ sed -i 's/^USE_UPNP:=0$/USE_UPNP:=/' makefile.unix # disable UPnP
+ make -f makefile.unix
+ strip bitcoind
Notes
-----
-The release is built with GCC and then "strip bitcoin" to strip the debug
+The release is built with GCC and then "strip bitcoind" to strip the debug
symbols, which reduces the executable size by about 90%.
diff --git a/doc/release-process.txt b/doc/release-process.txt
index ff00b121fc..4d06627006 100644
--- a/doc/release-process.txt
+++ b/doc/release-process.txt
@@ -23,16 +23,16 @@
* perform gitian builds
- * From a directory containing the bitcoin source, gitian-builder and bitcoin-gitian-sigs
+ * From a directory containing the bitcoin source, gitian-builder and gitian.sigs
$ export VERSION=0.3.23
$ cd ./gitian-builder
$ ./bin/gbuild --commit bitcoin=v$VERSION ../bitcoin/contrib/gitian-descriptors/gitian.yml
- $ ./bin/gsign --signer (your gitian key, ie bluematt, sipa, etc) --release $VERSION --destination ../bitcoin-gitian-sigs/ ../bitcoin/contrib/gitian-descriptors/gitian.yml
+ $ ./bin/gsign --signer (your gitian key, ie bluematt, sipa, etc) --release $VERSION --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian.yml
$ cd build/out
$ zip bitcoin-$VERSION-linux-gitian.zip *
$ mv bitcoin-$VERSION-linux-gitian.zip ../../
$ ./bin/gbuild --commit bitcoin=v$VERSION ../bitcoin/contrib/gitian-descriptors/gitian-win32.yml
- $ ./bin/gsign --signer (your gitian key, ie bluematt, sipa, etc) --release $VERSION-win32 --destination ../bitcoin-gitian-sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win32.yml
+ $ ./bin/gsign --signer (your gitian key, ie bluematt, sipa, etc) --release $VERSION-win32 --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win32.yml
$ cd build/out
$ zip bitcoin-$VERSION-win32-gitian.zip *
$ mv bitcoin-$VERSION-win32-gitian.zip ../../
@@ -40,7 +40,7 @@
Build output expected:
1. linux 32-bit and 64-bit binaries + source (bitcoin-$VERSION-linux-gitian.zip)
2. windows 32-bit binary, installer + source (bitcoin-$VERSION-win32-gitian.zip)
- 3. Gitian signatures (in bitcoin-gitian-sigs/$VERSION[-win32]/(your gitian key)/
+ 3. Gitian signatures (in gitian.sigs/$VERSION[-win32]/(your gitian key)/
* repackage gitian builds for release as stand-alone zip/tar/installer exe
@@ -79,15 +79,15 @@
* Collect enough gitian signatures to meet minimum_weight (see contrib/gitian-downloader/*-download-config)
- * From a directory containing bitcoin source, bitcoin-gitian-sigs and gitian zips
+ * From a directory containing bitcoin source, gitian.sigs and gitian zips
$ export VERSION=0.3.23
$ mkdir bitcoin-$VERSION-win32-gitian; cd bitcoin-$VERSION-win32-gitian
$ unzip ../bitcoin-$VERSION-win32-gitian.zip
$ mkdir gitian
$ cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/
- $ for file in `ls ../bitcoin-gitian-sigs/$VERSION-win32/`; do
- $ cp ../bitcoin-gitian-sigs/$VERSION-win32/$file/bitcoin-build.assert ./gitian/$file-build.assert
- $ cp ../bitcoin-gitian-sigs/$VERSION-win32/$file/bitcoin-build.assert.sig ./gitian/$file-build.assert.sig
+ $ for file in `ls ../gitian.sigs/$VERSION-win32/`; do
+ $ cp ../gitian.sigs/$VERSION-win32/$file/bitcoin-build.assert ./gitian/$file-build.assert
+ $ cp ../gitian.sigs/$VERSION-win32/$file/bitcoin-build.assert.sig ./gitian/$file-build.assert.sig
$ done
$ zip bitcoin-$VERSION-win32-gitian.zip *
$ cp bitcoin-$VERSION-win32-gitian.zip ../
@@ -96,9 +96,9 @@
$ unzip ../bitcoin-$VERSION-linux-gitian.zip
$ mkdir gitian
$ cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/
- $ for file in `ls ../bitcoin-gitian-sigs/$VERSION/`; do
- $ cp ../bitcoin-gitian-sigs/$VERSION/$file/bitcoin-build.assert ./gitian/$file-build.assert
- $ cp ../bitcoin-gitian-sigs/$VERSION/$file/bitcoin-build.assert.sig ./gitian/$file-build.assert.sig
+ $ for file in `ls ../gitian.sigs/$VERSION/`; do
+ $ cp ../gitian.sigs/$VERSION/$file/bitcoin-build.assert ./gitian/$file-build.assert
+ $ cp ../gitian.sigs/$VERSION/$file/bitcoin-build.assert.sig ./gitian/$file-build.assert.sig
$ done
$ zip bitcoin-$VERSION-linux-gitian.zip *
$ cp bitcoin-$VERSION-linux-gitian.zip ../