BTCP-Rebase/doc
Wladimir J. van der Laan 7a11ba7e01
Merge #11945: Improve BSD compatibility of contrib/install_db4.sh
2712742 doc: Update FreeBSD build instructions to use bdb4 (Wladimir J. van der Laan)
d95c83d contrib: FreeBSD compatibility in install_db4.sh (Wladimir J. van der Laan)
c0298b0 contrib: Make X=Y arguments work in install_db4 (Wladimir J. van der Laan)
b798f9b contrib: New clang patch for install_db4 (Wladimir J. van der Laan)

Pull request description:

  This PR improves the BSD compatibility of the bdb4 installer script.

  See #11921, #11868.

  I've tested this on OpenBSD 6.2 (clang) and Ubuntu 16.04 (gcc).

  This needs testing on OSX at least, ~~and on gcc/Linux to make sure that applying the patch unconditionally doesn't negatively affect gcc~~.

  ~~NB: this is not yet sufficient to make `install_db4.sh` work on FreeBSD, as we need to use yet another `sha256` tool there. But it's a step in the right direction.~~

  ### contrib: New clang patch for install_db4

  Replace the clang patch with a new and improved version that also fixes the build issues with OpenBSD and FreeBSD's clang, and apply it unconditionally.

  Thanks to @fanquake for finding the patch.

  ### contrib: Make X=Y arguments work in install_db4

  Trailing X=Y arguments are supposed to be passed through unchanged to bdb's configure. This was not the case, at least with OpenBSD 6.2's shell.

  Fix this by not storing the arguments in a temporary variable but passing "$@" through directly.

  ### contrib: FreeBSD compatibility in install_db4.sh

  Unfortunately, FreeBSD uses yet another syntax for `sha256`.

  Support FreeBSD's syntax too. Using `uname` is a bit of a hack but it works and I found no way to distinguish the two.

Tree-SHA512: 12461a58dfeb4834701891762efc747c8187d834f41d98c8451edee1402a3958c4842bbc02c61bacbc7b0d90cc6b020a2ca158b65304d9760c9f0d2052ff36d4
2017-12-21 09:30:25 +01:00
..
man doc: Bump manpages to 0.15.99 2017-09-12 09:55:21 +02:00
release-notes doc: Add historical release notes for 0.15.1 2017-11-11 14:40:43 +01:00
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 2017-04-07 16:28:12 +02:00
Doxyfile.in doc: Make build system insert version in Doxyfile 2017-04-05 09:40:56 +02:00
README.md Create dependencies.md, and link dependencies file from README & build docs 2017-09-07 00:34:27 +02:00
README_osx.md Merge #8617: Include instructions to extract Mac OS X SDK on Linux using 7zip and SleuthKit 2016-08-29 16:17:36 +02:00
README_windows.txt doc: Remove version numbers from READMEs 2017-04-05 09:40:48 +02:00
REST-interface.md Merge #10825: net: set regtest JSON-RPC port to 18443 to avoid conflict with testnet 18332 2017-09-06 01:18:35 +02:00
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 2015-09-18 18:14:42 +02:00
benchmarking.md [Doc] Add benchmarking notes 2016-05-29 17:56:34 +08:00
bips.md [Doc] Update bip.md, add support for BIP 159 2017-12-06 21:13:53 -10:00
bitcoin_logo_doxygen.png Lossless image optimization 2013-12-02 10:10:22 +01:00
build-openbsd.md [build] Add a script for installing db4 2017-11-16 11:49:19 -08:00
build-osx.md [Doc] Fix link to installation script 2017-12-20 13:39:16 +01:00
build-unix.md Merge #11945: Improve BSD compatibility of contrib/install_db4.sh 2017-12-21 09:30:25 +01:00
build-windows.md doc: Specify required source location for Windows WSL builds 2017-11-17 14:31:05 +01:00
dependencies.md [depends] ZeroMQ 4.2.2 2017-11-29 19:31:50 +08:00
developer-notes.md Typo fix 2017-12-16 13:29:26 +01:00
dnsseed-policy.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
files.md Update files.md for new wallets/ subdirectory 2017-12-13 23:36:43 +13:00
fuzzing.md [test] Speed up fuzzing by ~200x when using afl-fuzz 2017-05-19 07:28:46 +02:00
gitian-building.md doc: move gitian building to external repo 2017-09-25 15:45:38 +02:00
init.md Update init.md: Fix section numbering. 2017-07-29 00:20:43 +08:00
reduce-traffic.md Remove maxuploadtargets recommended minimum 2016-09-13 18:08:17 +02:00
release-notes.md Merge #11726: Cleanups + nit fixes for walletdir PR 2017-12-20 17:37:57 -05:00
release-process.md Add instructions for multi-processor gitian builds 2017-08-13 12:26:04 +02:00
shared-libraries.md Add NULLDUMMY verify flag in bitcoinconsensus.h 2016-09-30 23:09:19 +08:00
tor.md Clarify `listenonion` 2016-10-24 15:49:46 +08:00
translation_process.md Fix typo and spelling inconsistency in CONTRIBUTING.md 2017-02-09 11:56:44 +09:00
translation_strings_policy.md Init: Cleanup error and warning strings 2015-10-28 22:11:43 +01:00
travis-ci.md [doc] Rework docs 2016-10-04 13:27:38 +02:00
zmq.md Docs: Hash in ZMQ hash is raw bytes, not hex 2017-08-19 11:30:35 +02:00

README.md

Bitcoin Core

Setup

Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Bitcoin transactions (which is currently more than 100 GBs); depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.

To download Bitcoin Core, visit bitcoincore.org.

Running

The following are some helpful notes on how to run Bitcoin on your native platform.

Unix

Unpack the files into a directory and run:

  • bin/bitcoin-qt (GUI) or
  • bin/bitcoind (headless)

Windows

Unpack the files into a directory, and then run bitcoin-qt.exe.

OS X

Drag Bitcoin-Core to your applications folder, and then run Bitcoin-Core.

Need Help?

Building

The following are developer notes on how to build Bitcoin on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.

Development

The Bitcoin repo's root README contains relevant information on the development process and automated testing.

Resources

Miscellaneous

License

Distributed under the MIT software license. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com), and UPnP software written by Thomas Bernard.