2015-09-28 11:24:23 +02:00
OpenBSD build guide
======================
2017-10-03 04:15:55 +02:00
(updated for OpenBSD 6.2)
2015-09-28 11:24:23 +02:00
This guide describes how to build bitcoind and command-line utilities on OpenBSD.
2017-10-03 04:15:55 +02:00
OpenBSD is most commonly used as a server OS, so this guide does not contain instructions for building the GUI.
2015-09-28 11:24:23 +02:00
Preparation
-------------
Run the following as root to install the base dependencies for building:
```bash
2017-10-03 04:15:55 +02:00
pkg_add git gmake libevent libtool
2015-09-28 11:24:23 +02:00
pkg_add autoconf # (select highest version, e.g. 2.69)
pkg_add automake # (select highest version, e.g. 1.15)
2017-10-03 04:15:55 +02:00
pkg_add python # (select highest version, e.g. 3.6)
pkg_add boost
git clone https://github.com/bitcoin/bitcoin.git
2015-09-28 11:24:23 +02:00
```
2017-07-09 13:15:45 +02:00
See [dependencies.md ](dependencies.md ) for a complete overview.
2015-09-28 11:24:23 +02:00
GCC
-------
2017-10-03 04:15:55 +02:00
The default C++ compiler that comes with OpenBSD 6.2 is g++ 4.2.1. This version is old (from 2007), and is not able to compile the current version of Bitcoin Core because it has no C++11 support. We'll install a newer version of GCC:
2015-09-28 11:24:23 +02:00
```bash
2017-10-03 04:15:55 +02:00
pkg_add g++
```
2015-09-28 11:24:23 +02:00
2017-10-03 04:15:55 +02:00
This compiler will not overwrite the system compiler, it will be installed as `egcc` and `eg++` in `/usr/local/bin` .
2015-09-28 11:24:23 +02:00
### Building BerkeleyDB
BerkeleyDB is only necessary for the wallet functionality. To skip this, pass `--disable-wallet` to `./configure` .
2017-11-16 05:26:02 +01:00
It is recommended to use Berkeley DB 4.8. You cannot use the BerkeleyDB library
from ports, for the same reason as boost above (g++/libstd++ incompatibility).
If you have to build it yourself, you can use [the installation script included
in contrib/](contrib/install_db4.sh) like so
2015-09-28 11:24:23 +02:00
2017-11-16 05:26:02 +01:00
```shell
./contrib/install_db4.sh `pwd` CC=egcc CXX=eg++ CPP=ecpp
2015-09-28 11:24:23 +02:00
```
2017-11-16 05:26:02 +01:00
from the root of the repository.
2016-08-26 16:26:09 +02:00
### Resource limits
The standard ulimit restrictions in OpenBSD are very strict:
data(kbytes) 1572864
2017-10-03 04:15:55 +02:00
This, unfortunately, may no longer be enough to compile some `.cpp` files in the project,
at least with GCC 4.9.4 (see issue [#6658 ](https://github.com/bitcoin/bitcoin/issues/6658 )).
2016-08-26 16:26:09 +02:00
If your user is in the `staff` group the limit can be raised with:
ulimit -d 3000000
The change will only affect the current shell and processes spawned by it. To
make the change system-wide, change `datasize-cur` and `datasize-max` in
`/etc/login.conf` , and reboot.
2015-09-28 11:24:23 +02:00
### Building Bitcoin Core
**Important**: use `gmake` , not `make` . The non-GNU `make` will exit with a horrible error.
Preparation:
```bash
export AUTOCONF_VERSION=2.69 # replace this with the autoconf version that you installed
export AUTOMAKE_VERSION=1.15 # replace this with the automake version that you installed
./autogen.sh
```
2017-10-03 04:15:55 +02:00
Make sure `BDB_PREFIX` is set to the appropriate path from the above steps.
2015-09-28 11:24:23 +02:00
To configure with wallet:
```bash
2017-10-03 04:15:55 +02:00
./configure --with-gui=no CC=egcc CXX=eg++ CPP=ecpp \
2017-02-07 10:58:18 +01:00
BDB_LIBS="-L${BDB_PREFIX}/lib -ldb_cxx-4.8" BDB_CFLAGS="-I${BDB_PREFIX}/include"
2015-09-28 11:24:23 +02:00
```
To configure without wallet:
```bash
2017-10-03 04:15:55 +02:00
./configure --disable-wallet --with-gui=no CC=egcc CXX=eg++ CPP=ecpp
2015-09-28 11:24:23 +02:00
```
Build and run the tests:
```bash
2017-10-03 04:15:55 +02:00
gmake # use -jX here for parallelism
2015-09-28 11:24:23 +02:00
gmake check
```
2017-10-03 04:15:55 +02:00
Clang
2015-09-28 11:24:23 +02:00
------------------------------
```bash
2017-10-03 04:15:55 +02:00
pkg_add llvm
2015-09-28 11:24:23 +02:00
2015-10-01 14:46:29 +02:00
./configure --disable-wallet --with-gui=no CC=clang CXX=clang++
2017-10-03 04:15:55 +02:00
gmake # use -jX here for parallelism
gmake check
2015-09-28 11:24:23 +02:00
```