aboutsummaryrefslogtreecommitdiff
path: root/doc/build-unix.md
diff options
context:
space:
mode:
authorRoss Nicoll <[email protected]>2018-01-20 18:35:31 +0000
committerRoss Nicoll <[email protected]>2019-03-25 05:36:12 +0000
commit731b7a75c2bba4d4ba5a213ca5235ac334a998b0 (patch)
tree99ab6f8e5a3bc0efa17b14fb6d69d623dd2edf12 /doc/build-unix.md
parentRename and update man pages (#1451) (diff)
downloaddiscoin-731b7a75c2bba4d4ba5a213ca5235ac334a998b0.tar.xz
discoin-731b7a75c2bba4d4ba5a213ca5235ac334a998b0.zip
Update documentation to match 1.10 (#1436)
Diffstat (limited to 'doc/build-unix.md')
-rw-r--r--doc/build-unix.md43
1 files changed, 21 insertions, 22 deletions
diff --git a/doc/build-unix.md b/doc/build-unix.md
index c8e885ea7..066aa860a 100644
--- a/doc/build-unix.md
+++ b/doc/build-unix.md
@@ -1,12 +1,12 @@
UNIX BUILD NOTES
====================
-Some notes on how to build Bitcoin Core in Unix.
+Some notes on how to build Dogecoin Core in Unix.
(for OpenBSD specific instructions, see [build-openbsd.md](build-openbsd.md))
Note
---------------------
-Always use absolute paths to configure and compile bitcoin and the dependencies,
+Always use absolute paths to configure and compile Dogecoin and the dependencies,
for example, when specifying the path of the dependency:
../dist/configure --enable-cxx --disable-shared --with-pic --prefix=$BDB_PREFIX
@@ -24,7 +24,7 @@ make
make install # optional
```
-This will build bitcoin-qt as well if the dependencies are met.
+This will build Dogecoin-Qt as well if the dependencies are met.
Dependencies
---------------------
@@ -55,10 +55,9 @@ Memory Requirements
--------------------
C++ compilers are memory-hungry. It is recommended to have at least 1.5 GB of
-memory available when compiling Bitcoin Core. On systems with less, gcc can be
+memory available when compiling Dogecoin Core. On systems with less, gcc can be
tuned to conserve memory with additional CXXFLAGS:
-
./configure CXXFLAGS="--param ggc-min-expand=1 --param ggc-min-heapsize=32768"
Dependency Build Instructions: Ubuntu & Debian
@@ -91,7 +90,7 @@ BerkeleyDB is required for the wallet.
automatically.
-See the section "Disable-wallet mode" to build Bitcoin Core without wallet.
+See the section "Disable-wallet mode" to build Dogecoin Core without wallet.
Optional (see --with-miniupnpc and --enable-upnp-default):
@@ -104,7 +103,7 @@ ZMQ dependencies (provides ZMQ API 4.x):
Dependencies for the GUI: Ubuntu & Debian
-----------------------------------------
-If you want to build Bitcoin-Qt, make sure that the required packages for Qt development
+If you want to build Dogecoin-Qt, make sure that the required packages for Qt development
are installed. Either Qt 5 or Qt 4 are necessary to build the GUI.
If both Qt 4 and Qt 5 are installed, Qt 5 will be used. Pass `--with-gui=qt4` to configure to choose Qt4.
To build without GUI pass `--without-gui`.
@@ -121,7 +120,7 @@ libqrencode (optional) can be installed with:
sudo apt-get install libqrencode-dev
-Once these are installed, they will be found by configure and a bitcoin-qt executable will be
+Once these are installed, they will be found by configure and a dogecoin-qt executable will be
built by default.
Dependency Build Instructions: Fedora
@@ -144,7 +143,7 @@ libqrencode (optional) can be installed with:
Notes
-----
-The release is built with GCC and then "strip bitcoind" to strip the debug
+The release is built with GCC and then "strip dogecoind" to strip the debug
symbols, which reduces the executable size by about 90%.
@@ -167,7 +166,7 @@ It is recommended to use Berkeley DB 5.1. If you have to build it yourself:
```bash
BITCOIN_ROOT=$(pwd)
-# Pick some path to install BDB to, here we create a directory within the bitcoin directory
+# Pick some path to install BDB to, here we create a directory within the dogecoin directory
BDB_PREFIX="${BITCOIN_ROOT}/db5"
mkdir -p $BDB_PREFIX
@@ -183,7 +182,7 @@ cd db-5.1.29.NC/build_unix/
../dist/configure --enable-cxx --disable-shared --with-pic --prefix=$BDB_PREFIX
make install
-# Configure Bitcoin Core to use our own-built instance of BDB
+# Configure Dogecoin Core to use our own-built instance of BDB
cd $BITCOIN_ROOT
./autogen.sh
./configure LDFLAGS="-L${BDB_PREFIX}/lib/" CPPFLAGS="-I${BDB_PREFIX}/include/" # (other args...)
@@ -202,7 +201,7 @@ If you need to build Boost yourself:
Security
--------
-To help make your bitcoin installation more secure by making certain attacks impossible to
+To help make your Dogecoin installation more secure by making certain attacks impossible to
exploit even if a vulnerability is found, binaries are hardened by default.
This can be disabled with:
@@ -226,7 +225,7 @@ Hardening enables the following features:
To test that you have built PIE executable, install scanelf, part of paxutils, and use:
- scanelf -e ./bitcoin
+ scanelf -e ./dogecoin
The output should contain:
@@ -234,24 +233,24 @@ Hardening enables the following features:
ET_DYN
* Non-executable Stack
- If the stack is executable then trivial stack based buffer overflow exploits are possible if
- vulnerable buffers are found. By default, bitcoin should be built with a non-executable stack
+ If the stack is executable, trivial stack-based buffer overflow exploits are possible if
+ vulnerable buffers are found. By default, Dogecoin should be built with a non-executable stack,
but if one of the libraries it uses asks for an executable stack or someone makes a mistake
and uses a compiler extension which requires an executable stack, it will silently build an
executable without the non-executable stack protection.
- To verify that the stack is non-executable after compiling use:
- `scanelf -e ./bitcoin`
+ To verify that the stack is non-executable after compiling, use:
+ `scanelf -e ./dogecoin`
the output should contain:
STK/REL/PTL
RW- R-- RW-
- The STK RW- means that the stack is readable and writeable but not executable.
+ The STK RW- means that the stack is readable and writeable, but not executable.
Disable-wallet mode
--------------------
-When the intention is to run only a P2P node without a wallet, bitcoin may be compiled in
+When the intention is to run only a P2P node without a wallet, Dogecoin may be compiled in
disable-wallet mode with:
./configure --disable-wallet
@@ -259,7 +258,7 @@ disable-wallet mode with:
In this case there is no dependency on Berkeley DB 4.8.
Mining is also possible in disable-wallet mode, but only using the `getblocktemplate` RPC
-call not `getwork`.
+call, not `getwork`.
Additional Configure Flags
--------------------------
@@ -283,7 +282,7 @@ Note:
Enabling wallet support requires either compiling against a Berkeley DB newer than 4.8 (package `db`) using `--with-incompatible-bdb`,
or building and depending on a local version of Berkeley DB 4.8. The readily available Arch Linux packages are currently built using
`--with-incompatible-bdb` according to the [PKGBUILD](https://projects.archlinux.org/svntogit/community.git/tree/bitcoin/trunk/PKGBUILD).
-As mentioned above, when maintaining portability of the wallet between the standard Bitcoin Core distributions and independently built
+As mentioned above, when maintaining portability of the wallet between the standard Dogecoin Core distributions and independently built
node software is desired, Berkeley DB 4.8 must be used.
@@ -331,7 +330,7 @@ For the wallet (optional):
This will give a warning "configure: WARNING: Found Berkeley DB other
than 4.8; wallets opened by this build will not be portable!", but as FreeBSD never
had a binary release, this may not matter. If backwards compatibility
-with 4.8-built Bitcoin Core is needed follow the steps under "Berkeley DB" above.
+with 4.8-built Dogecoin Core is needed follow the steps under "Berkeley DB" above.
Then build using: