Merge #8608: Install manpages via make install, also add some autogenerated manpages
d19583fimproved gen-manpages.sh, includes bitcoin-tx and strips commit tag, now also runs binaries from build dir by default, added variables for more control (nomnombtc)09546caregenerated all manpages with commit tag stripped, also add bitcoin-tx (nomnombtc)ae6e754change help string --enable-man to --disable-man (nomnombtc)a32c102add conditional for --enable-man, default is yes (nomnombtc)dc84b6fadd doc/man to subdir if configure flag --enable-man is set (nomnombtc)00dba72add doc/man/Makefile.am to include manpages (nomnombtc)eb5643badd autogenerated manpages by help2man (nomnombtc)6edf2fdadd gen-manpages.sh description to README.md (nomnombtc)d2cd9c0add script to generate manpages with help2man (nomnombtc)
This commit is contained in:
Wladimir J. van der Laan
commit
7e9ab9555c
9 changed files with 1244 additions and 1 deletions
|
|
@ -1,5 +1,8 @@
|
||||||
ACLOCAL_AMFLAGS = -I build-aux/m4
|
ACLOCAL_AMFLAGS = -I build-aux/m4
|
||||||
SUBDIRS = src
|
SUBDIRS = src
|
||||||
|
if ENABLE_MAN
|
||||||
|
SUBDIRS += doc/man
|
||||||
|
endif
|
||||||
.PHONY: deploy FORCE
|
.PHONY: deploy FORCE
|
||||||
|
|
||||||
GZIP_ENV="-9n"
|
GZIP_ENV="-9n"
|
||||||
|
|
@ -213,6 +216,8 @@ DISTCLEANFILES = qa/pull-tester/tests_config.pyc
|
||||||
|
|
||||||
.INTERMEDIATE: $(COVERAGE_INFO)
|
.INTERMEDIATE: $(COVERAGE_INFO)
|
||||||
|
|
||||||
|
DISTCHECK_CONFIGURE_FLAGS = --enable-man
|
||||||
|
|
||||||
clean-local:
|
clean-local:
|
||||||
rm -rf coverage_percent.txt test_bitcoin.coverage/ total.coverage/ qa/tmp/ cache/ $(OSX_APP)
|
rm -rf coverage_percent.txt test_bitcoin.coverage/ total.coverage/ qa/tmp/ cache/ $(OSX_APP)
|
||||||
rm -rf qa/pull-tester/__pycache__
|
rm -rf qa/pull-tester/__pycache__
|
||||||
|
|
|
||||||
|
|
@ -171,6 +171,12 @@ AC_ARG_ENABLE([zmq],
|
||||||
|
|
||||||
AC_ARG_WITH([protoc-bindir],[AS_HELP_STRING([--with-protoc-bindir=BIN_DIR],[specify protoc bin path])], [protoc_bin_path=$withval], [])
|
AC_ARG_WITH([protoc-bindir],[AS_HELP_STRING([--with-protoc-bindir=BIN_DIR],[specify protoc bin path])], [protoc_bin_path=$withval], [])
|
||||||
|
|
||||||
|
AC_ARG_ENABLE(man,
|
||||||
|
[AS_HELP_STRING([--disable-man],
|
||||||
|
[do not install man pages (default is to install)])],,
|
||||||
|
enable_man=yes)
|
||||||
|
AM_CONDITIONAL(ENABLE_MAN, test "$enable_man" != no)
|
||||||
|
|
||||||
# Enable debug
|
# Enable debug
|
||||||
AC_ARG_ENABLE([debug],
|
AC_ARG_ENABLE([debug],
|
||||||
[AS_HELP_STRING([--enable-debug],
|
[AS_HELP_STRING([--enable-debug],
|
||||||
|
|
@ -1057,7 +1063,7 @@ AC_SUBST(EVENT_PTHREADS_LIBS)
|
||||||
AC_SUBST(ZMQ_LIBS)
|
AC_SUBST(ZMQ_LIBS)
|
||||||
AC_SUBST(PROTOBUF_LIBS)
|
AC_SUBST(PROTOBUF_LIBS)
|
||||||
AC_SUBST(QR_LIBS)
|
AC_SUBST(QR_LIBS)
|
||||||
AC_CONFIG_FILES([Makefile src/Makefile share/setup.nsi share/qt/Info.plist src/test/buildenv.py])
|
AC_CONFIG_FILES([Makefile src/Makefile doc/man/Makefile share/setup.nsi share/qt/Info.plist src/test/buildenv.py])
|
||||||
AC_CONFIG_FILES([qa/pull-tester/run-bitcoind-for-test.sh],[chmod +x qa/pull-tester/run-bitcoind-for-test.sh])
|
AC_CONFIG_FILES([qa/pull-tester/run-bitcoind-for-test.sh],[chmod +x qa/pull-tester/run-bitcoind-for-test.sh])
|
||||||
AC_CONFIG_FILES([qa/pull-tester/tests_config.py],[chmod +x qa/pull-tester/tests_config.py])
|
AC_CONFIG_FILES([qa/pull-tester/tests_config.py],[chmod +x qa/pull-tester/tests_config.py])
|
||||||
AC_CONFIG_FILES([contrib/devtools/split-debug.sh],[chmod +x contrib/devtools/split-debug.sh])
|
AC_CONFIG_FILES([contrib/devtools/split-debug.sh],[chmod +x contrib/devtools/split-debug.sh])
|
||||||
|
|
|
||||||
|
|
@ -40,6 +40,12 @@ would be changed to:
|
||||||
|
|
||||||
```// Copyright (c) 2009-2015 The Bitcoin Core developers```
|
```// Copyright (c) 2009-2015 The Bitcoin Core developers```
|
||||||
|
|
||||||
|
gen-manpages.sh
|
||||||
|
===============
|
||||||
|
|
||||||
|
A small script to automatically create manpages in ../../doc/man by running the release binaries with the -help option.
|
||||||
|
This requires help2man which can be found at: https://www.gnu.org/software/help2man/
|
||||||
|
|
||||||
git-subtree-check.sh
|
git-subtree-check.sh
|
||||||
====================
|
====================
|
||||||
|
|
||||||
|
|
|
||||||
29
contrib/devtools/gen-manpages.sh
Executable file
29
contrib/devtools/gen-manpages.sh
Executable file
|
|
@ -0,0 +1,29 @@
|
||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
TOPDIR=${TOPDIR:-$(git rev-parse --show-toplevel)}
|
||||||
|
SRCDIR=${SRCDIR:-$TOPDIR/src}
|
||||||
|
MANDIR=${MANDIR:-$TOPDIR/doc/man}
|
||||||
|
|
||||||
|
BITCOIND=${BITCOIND:-$SRCDIR/bitcoind}
|
||||||
|
BITCOINCLI=${BITCOINCLI:-$SRCDIR/bitcoin-cli}
|
||||||
|
BITCOINTX=${BITCOINTX:-$SRCDIR/bitcoin-tx}
|
||||||
|
BITCOINQT=${BITCOINQT:-$SRCDIR/qt/bitcoin-qt}
|
||||||
|
|
||||||
|
[ ! -x $BITCOIND ] && echo "$BITCOIND not found or not executable." && exit 1
|
||||||
|
|
||||||
|
# The autodetected version git tag can screw up manpage output a little bit
|
||||||
|
BTCVER=($($BITCOINCLI --version | head -n1 | awk -F'[ -]' '{ print $6, $7 }'))
|
||||||
|
|
||||||
|
# Create a footer file with copyright content.
|
||||||
|
# This gets autodetected fine for bitcoind if --version-string is not set,
|
||||||
|
# but has different outcomes for bitcoin-qt and bitcoin-cli.
|
||||||
|
echo "[COPYRIGHT]" > footer.h2m
|
||||||
|
$BITCOIND --version | sed -n '1!p' >> footer.h2m
|
||||||
|
|
||||||
|
for cmd in $BITCOIND $BITCOINCLI $BITCOINTX $BITCOINQT; do
|
||||||
|
cmdname="${cmd##*/}"
|
||||||
|
help2man -N --version-string=${BTCVER[0]} --include=footer.h2m -o ${MANDIR}/${cmdname}.1 ${cmd}
|
||||||
|
sed -i "s/\\\-${BTCVER[1]}//g" ${MANDIR}/${cmdname}.1
|
||||||
|
done
|
||||||
|
|
||||||
|
rm -f footer.h2m
|
||||||
1
doc/man/Makefile.am
Normal file
1
doc/man/Makefile.am
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
dist_man1_MANS=bitcoind.1 bitcoin-qt.1 bitcoin-cli.1 bitcoin-tx.1
|
||||||
84
doc/man/bitcoin-cli.1
Normal file
84
doc/man/bitcoin-cli.1
Normal file
|
|
@ -0,0 +1,84 @@
|
||||||
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.5.
|
||||||
|
.TH BITCOIN-CLI "1" "September 2016" "bitcoin-cli v0.13.0.0" "User Commands"
|
||||||
|
.SH NAME
|
||||||
|
bitcoin-cli \- manual page for bitcoin-cli v0.13.0.0
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Bitcoin Core RPC client version v0.13.0.0
|
||||||
|
.SS "Usage:"
|
||||||
|
.TP
|
||||||
|
bitcoin\-cli [options] <command> [params]
|
||||||
|
Send command to Bitcoin Core
|
||||||
|
.TP
|
||||||
|
bitcoin\-cli [options] help
|
||||||
|
List commands
|
||||||
|
.TP
|
||||||
|
bitcoin\-cli [options] help <command>
|
||||||
|
Get help for a command
|
||||||
|
.SH OPTIONS
|
||||||
|
.HP
|
||||||
|
\-?
|
||||||
|
.IP
|
||||||
|
This help message
|
||||||
|
.HP
|
||||||
|
\fB\-conf=\fR<file>
|
||||||
|
.IP
|
||||||
|
Specify configuration file (default: bitcoin.conf)
|
||||||
|
.HP
|
||||||
|
\fB\-datadir=\fR<dir>
|
||||||
|
.IP
|
||||||
|
Specify data directory
|
||||||
|
.PP
|
||||||
|
Chain selection options:
|
||||||
|
.HP
|
||||||
|
\fB\-testnet\fR
|
||||||
|
.IP
|
||||||
|
Use the test chain
|
||||||
|
.HP
|
||||||
|
\fB\-regtest\fR
|
||||||
|
.IP
|
||||||
|
Enter regression test mode, which uses a special chain in which blocks
|
||||||
|
can be solved instantly. This is intended for regression testing
|
||||||
|
tools and app development.
|
||||||
|
.HP
|
||||||
|
\fB\-rpcconnect=\fR<ip>
|
||||||
|
.IP
|
||||||
|
Send commands to node running on <ip> (default: 127.0.0.1)
|
||||||
|
.HP
|
||||||
|
\fB\-rpcport=\fR<port>
|
||||||
|
.IP
|
||||||
|
Connect to JSON\-RPC on <port> (default: 8332 or testnet: 18332)
|
||||||
|
.HP
|
||||||
|
\fB\-rpcwait\fR
|
||||||
|
.IP
|
||||||
|
Wait for RPC server to start
|
||||||
|
.HP
|
||||||
|
\fB\-rpcuser=\fR<user>
|
||||||
|
.IP
|
||||||
|
Username for JSON\-RPC connections
|
||||||
|
.HP
|
||||||
|
\fB\-rpcpassword=\fR<pw>
|
||||||
|
.IP
|
||||||
|
Password for JSON\-RPC connections
|
||||||
|
.HP
|
||||||
|
\fB\-rpcclienttimeout=\fR<n>
|
||||||
|
.IP
|
||||||
|
Timeout during HTTP requests (default: 900)
|
||||||
|
.HP
|
||||||
|
\fB\-stdin\fR
|
||||||
|
.IP
|
||||||
|
Read extra arguments from standard input, one per line until EOF/Ctrl\-D
|
||||||
|
(recommended for sensitive information such as passphrases)
|
||||||
|
.SH COPYRIGHT
|
||||||
|
Copyright (C) 2009-2016 The Bitcoin Core developers
|
||||||
|
|
||||||
|
Please contribute if you find Bitcoin Core useful. Visit
|
||||||
|
<https://bitcoincore.org> for further information about the software.
|
||||||
|
The source code is available from <https://github.com/bitcoin/bitcoin>.
|
||||||
|
|
||||||
|
This is experimental software.
|
||||||
|
Distributed under the MIT software license, see the accompanying file COPYING
|
||||||
|
or <http://www.opensource.org/licenses/mit-license.php>.
|
||||||
|
|
||||||
|
This product includes software developed by the OpenSSL Project for use in the
|
||||||
|
OpenSSL Toolkit <https://www.openssl.org/> and cryptographic software written
|
||||||
|
by Eric Young and UPnP software written by Thomas Bernard.
|
||||||
513
doc/man/bitcoin-qt.1
Normal file
513
doc/man/bitcoin-qt.1
Normal file
|
|
@ -0,0 +1,513 @@
|
||||||
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.5.
|
||||||
|
.TH BITCOIN-QT "1" "September 2016" "bitcoin-qt v0.13.0.0" "User Commands"
|
||||||
|
.SH NAME
|
||||||
|
bitcoin-qt \- manual page for bitcoin-qt v0.13.0.0
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Bitcoin Core version v0.13.0.0 (64\-bit)
|
||||||
|
Usage:
|
||||||
|
.IP
|
||||||
|
bitcoin\-qt [command\-line options]
|
||||||
|
.SH OPTIONS
|
||||||
|
.HP
|
||||||
|
\-?
|
||||||
|
.IP
|
||||||
|
Print this help message and exit
|
||||||
|
.HP
|
||||||
|
\fB\-version\fR
|
||||||
|
.IP
|
||||||
|
Print version and exit
|
||||||
|
.HP
|
||||||
|
\fB\-alertnotify=\fR<cmd>
|
||||||
|
.IP
|
||||||
|
Execute command when a relevant alert is received or we see a really
|
||||||
|
long fork (%s in cmd is replaced by message)
|
||||||
|
.HP
|
||||||
|
\fB\-blocknotify=\fR<cmd>
|
||||||
|
.IP
|
||||||
|
Execute command when the best block changes (%s in cmd is replaced by
|
||||||
|
block hash)
|
||||||
|
.HP
|
||||||
|
\fB\-checkblocks=\fR<n>
|
||||||
|
.IP
|
||||||
|
How many blocks to check at startup (default: 288, 0 = all)
|
||||||
|
.HP
|
||||||
|
\fB\-checklevel=\fR<n>
|
||||||
|
.IP
|
||||||
|
How thorough the block verification of \fB\-checkblocks\fR is (0\-4, default: 3)
|
||||||
|
.HP
|
||||||
|
\fB\-conf=\fR<file>
|
||||||
|
.IP
|
||||||
|
Specify configuration file (default: bitcoin.conf)
|
||||||
|
.HP
|
||||||
|
\fB\-datadir=\fR<dir>
|
||||||
|
.IP
|
||||||
|
Specify data directory
|
||||||
|
.HP
|
||||||
|
\fB\-dbcache=\fR<n>
|
||||||
|
.IP
|
||||||
|
Set database cache size in megabytes (4 to 16384, default: 300)
|
||||||
|
.HP
|
||||||
|
\fB\-loadblock=\fR<file>
|
||||||
|
.IP
|
||||||
|
Imports blocks from external blk000??.dat file on startup
|
||||||
|
.HP
|
||||||
|
\fB\-maxorphantx=\fR<n>
|
||||||
|
.IP
|
||||||
|
Keep at most <n> unconnectable transactions in memory (default: 100)
|
||||||
|
.HP
|
||||||
|
\fB\-maxmempool=\fR<n>
|
||||||
|
.IP
|
||||||
|
Keep the transaction memory pool below <n> megabytes (default: 300)
|
||||||
|
.HP
|
||||||
|
\fB\-mempoolexpiry=\fR<n>
|
||||||
|
.IP
|
||||||
|
Do not keep transactions in the mempool longer than <n> hours (default:
|
||||||
|
72)
|
||||||
|
.HP
|
||||||
|
\fB\-par=\fR<n>
|
||||||
|
.IP
|
||||||
|
Set the number of script verification threads (\fB\-4\fR to 16, 0 = auto, <0 =
|
||||||
|
leave that many cores free, default: 0)
|
||||||
|
.HP
|
||||||
|
\fB\-pid=\fR<file>
|
||||||
|
.IP
|
||||||
|
Specify pid file (default: bitcoind.pid)
|
||||||
|
.HP
|
||||||
|
\fB\-prune=\fR<n>
|
||||||
|
.IP
|
||||||
|
Reduce storage requirements by pruning (deleting) old blocks. This mode
|
||||||
|
is incompatible with \fB\-txindex\fR and \fB\-rescan\fR. Warning: Reverting
|
||||||
|
this setting requires re\-downloading the entire blockchain.
|
||||||
|
(default: 0 = disable pruning blocks, >550 = target size in MiB
|
||||||
|
to use for block files)
|
||||||
|
.HP
|
||||||
|
\fB\-reindex\-chainstate\fR
|
||||||
|
.IP
|
||||||
|
Rebuild chain state from the currently indexed blocks
|
||||||
|
.HP
|
||||||
|
\fB\-reindex\fR
|
||||||
|
.IP
|
||||||
|
Rebuild chain state and block index from the blk*.dat files on disk
|
||||||
|
.HP
|
||||||
|
\fB\-sysperms\fR
|
||||||
|
.IP
|
||||||
|
Create new files with system default permissions, instead of umask 077
|
||||||
|
(only effective with disabled wallet functionality)
|
||||||
|
.HP
|
||||||
|
\fB\-txindex\fR
|
||||||
|
.IP
|
||||||
|
Maintain a full transaction index, used by the getrawtransaction rpc
|
||||||
|
call (default: 0)
|
||||||
|
.PP
|
||||||
|
Connection options:
|
||||||
|
.HP
|
||||||
|
\fB\-addnode=\fR<ip>
|
||||||
|
.IP
|
||||||
|
Add a node to connect to and attempt to keep the connection open
|
||||||
|
.HP
|
||||||
|
\fB\-banscore=\fR<n>
|
||||||
|
.IP
|
||||||
|
Threshold for disconnecting misbehaving peers (default: 100)
|
||||||
|
.HP
|
||||||
|
\fB\-bantime=\fR<n>
|
||||||
|
.IP
|
||||||
|
Number of seconds to keep misbehaving peers from reconnecting (default:
|
||||||
|
86400)
|
||||||
|
.HP
|
||||||
|
\fB\-bind=\fR<addr>
|
||||||
|
.IP
|
||||||
|
Bind to given address and always listen on it. Use [host]:port notation
|
||||||
|
for IPv6
|
||||||
|
.HP
|
||||||
|
\fB\-connect=\fR<ip>
|
||||||
|
.IP
|
||||||
|
Connect only to the specified node(s)
|
||||||
|
.HP
|
||||||
|
\fB\-discover\fR
|
||||||
|
.IP
|
||||||
|
Discover own IP addresses (default: 1 when listening and no \fB\-externalip\fR
|
||||||
|
or \fB\-proxy\fR)
|
||||||
|
.HP
|
||||||
|
\fB\-dns\fR
|
||||||
|
.IP
|
||||||
|
Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-dnsseed\fR
|
||||||
|
.IP
|
||||||
|
Query for peer addresses via DNS lookup, if low on addresses (default: 1
|
||||||
|
unless \fB\-connect\fR)
|
||||||
|
.HP
|
||||||
|
\fB\-externalip=\fR<ip>
|
||||||
|
.IP
|
||||||
|
Specify your own public address
|
||||||
|
.HP
|
||||||
|
\fB\-forcednsseed\fR
|
||||||
|
.IP
|
||||||
|
Always query for peer addresses via DNS lookup (default: 0)
|
||||||
|
.HP
|
||||||
|
\fB\-listen\fR
|
||||||
|
.IP
|
||||||
|
Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR)
|
||||||
|
.HP
|
||||||
|
\fB\-listenonion\fR
|
||||||
|
.IP
|
||||||
|
Automatically create Tor hidden service (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-maxconnections=\fR<n>
|
||||||
|
.IP
|
||||||
|
Maintain at most <n> connections to peers (default: 125)
|
||||||
|
.HP
|
||||||
|
\fB\-maxreceivebuffer=\fR<n>
|
||||||
|
.IP
|
||||||
|
Maximum per\-connection receive buffer, <n>*1000 bytes (default: 5000)
|
||||||
|
.HP
|
||||||
|
\fB\-maxsendbuffer=\fR<n>
|
||||||
|
.IP
|
||||||
|
Maximum per\-connection send buffer, <n>*1000 bytes (default: 1000)
|
||||||
|
.HP
|
||||||
|
\fB\-maxtimeadjustment\fR
|
||||||
|
.IP
|
||||||
|
Maximum allowed median peer time offset adjustment. Local perspective of
|
||||||
|
time may be influenced by peers forward or backward by this
|
||||||
|
amount. (default: 4200 seconds)
|
||||||
|
.HP
|
||||||
|
\fB\-onion=\fR<ip:port>
|
||||||
|
.IP
|
||||||
|
Use separate SOCKS5 proxy to reach peers via Tor hidden services
|
||||||
|
(default: \fB\-proxy\fR)
|
||||||
|
.HP
|
||||||
|
\fB\-onlynet=\fR<net>
|
||||||
|
.IP
|
||||||
|
Only connect to nodes in network <net> (ipv4, ipv6 or onion)
|
||||||
|
.HP
|
||||||
|
\fB\-permitbaremultisig\fR
|
||||||
|
.IP
|
||||||
|
Relay non\-P2SH multisig (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-peerbloomfilters\fR
|
||||||
|
.IP
|
||||||
|
Support filtering of blocks and transaction with bloom filters (default:
|
||||||
|
1)
|
||||||
|
.HP
|
||||||
|
\fB\-port=\fR<port>
|
||||||
|
.IP
|
||||||
|
Listen for connections on <port> (default: 8333 or testnet: 18333)
|
||||||
|
.HP
|
||||||
|
\fB\-proxy=\fR<ip:port>
|
||||||
|
.IP
|
||||||
|
Connect through SOCKS5 proxy
|
||||||
|
.HP
|
||||||
|
\fB\-proxyrandomize\fR
|
||||||
|
.IP
|
||||||
|
Randomize credentials for every proxy connection. This enables Tor
|
||||||
|
stream isolation (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-seednode=\fR<ip>
|
||||||
|
.IP
|
||||||
|
Connect to a node to retrieve peer addresses, and disconnect
|
||||||
|
.HP
|
||||||
|
\fB\-timeout=\fR<n>
|
||||||
|
.IP
|
||||||
|
Specify connection timeout in milliseconds (minimum: 1, default: 5000)
|
||||||
|
.HP
|
||||||
|
\fB\-torcontrol=\fR<ip>:<port>
|
||||||
|
.IP
|
||||||
|
Tor control port to use if onion listening enabled (default:
|
||||||
|
127.0.0.1:9051)
|
||||||
|
.HP
|
||||||
|
\fB\-torpassword=\fR<pass>
|
||||||
|
.IP
|
||||||
|
Tor control port password (default: empty)
|
||||||
|
.HP
|
||||||
|
\fB\-whitebind=\fR<addr>
|
||||||
|
.IP
|
||||||
|
Bind to given address and whitelist peers connecting to it. Use
|
||||||
|
[host]:port notation for IPv6
|
||||||
|
.HP
|
||||||
|
\fB\-whitelist=\fR<netmask>
|
||||||
|
.IP
|
||||||
|
Whitelist peers connecting from the given netmask or IP address. Can be
|
||||||
|
specified multiple times. Whitelisted peers cannot be DoS banned
|
||||||
|
and their transactions are always relayed, even if they are
|
||||||
|
already in the mempool, useful e.g. for a gateway
|
||||||
|
.HP
|
||||||
|
\fB\-whitelistrelay\fR
|
||||||
|
.IP
|
||||||
|
Accept relayed transactions received from whitelisted peers even when
|
||||||
|
not relaying transactions (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-whitelistforcerelay\fR
|
||||||
|
.IP
|
||||||
|
Force relay of transactions from whitelisted peers even they violate
|
||||||
|
local relay policy (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-maxuploadtarget=\fR<n>
|
||||||
|
.IP
|
||||||
|
Tries to keep outbound traffic under the given target (in MiB per 24h),
|
||||||
|
0 = no limit (default: 0)
|
||||||
|
.PP
|
||||||
|
Wallet options:
|
||||||
|
.HP
|
||||||
|
\fB\-disablewallet\fR
|
||||||
|
.IP
|
||||||
|
Do not load the wallet and disable wallet RPC calls
|
||||||
|
.HP
|
||||||
|
\fB\-keypool=\fR<n>
|
||||||
|
.IP
|
||||||
|
Set key pool size to <n> (default: 100)
|
||||||
|
.HP
|
||||||
|
\fB\-fallbackfee=\fR<amt>
|
||||||
|
.IP
|
||||||
|
A fee rate (in BTC/kB) that will be used when fee estimation has
|
||||||
|
insufficient data (default: 0.0002)
|
||||||
|
.HP
|
||||||
|
\fB\-mintxfee=\fR<amt>
|
||||||
|
.IP
|
||||||
|
Fees (in BTC/kB) smaller than this are considered zero fee for
|
||||||
|
transaction creation (default: 0.00001)
|
||||||
|
.HP
|
||||||
|
\fB\-paytxfee=\fR<amt>
|
||||||
|
.IP
|
||||||
|
Fee (in BTC/kB) to add to transactions you send (default: 0.00)
|
||||||
|
.HP
|
||||||
|
\fB\-rescan\fR
|
||||||
|
.IP
|
||||||
|
Rescan the block chain for missing wallet transactions on startup
|
||||||
|
.HP
|
||||||
|
\fB\-salvagewallet\fR
|
||||||
|
.IP
|
||||||
|
Attempt to recover private keys from a corrupt wallet on startup
|
||||||
|
.HP
|
||||||
|
\fB\-spendzeroconfchange\fR
|
||||||
|
.IP
|
||||||
|
Spend unconfirmed change when sending transactions (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-txconfirmtarget=\fR<n>
|
||||||
|
.IP
|
||||||
|
If paytxfee is not set, include enough fee so transactions begin
|
||||||
|
confirmation on average within n blocks (default: 2)
|
||||||
|
.HP
|
||||||
|
\fB\-usehd\fR
|
||||||
|
.IP
|
||||||
|
Use hierarchical deterministic key generation (HD) after BIP32. Only has
|
||||||
|
effect during wallet creation/first start (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-upgradewallet\fR
|
||||||
|
.IP
|
||||||
|
Upgrade wallet to latest format on startup
|
||||||
|
.HP
|
||||||
|
\fB\-wallet=\fR<file>
|
||||||
|
.IP
|
||||||
|
Specify wallet file (within data directory) (default: wallet.dat)
|
||||||
|
.HP
|
||||||
|
\fB\-walletbroadcast\fR
|
||||||
|
.IP
|
||||||
|
Make the wallet broadcast transactions (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-walletnotify=\fR<cmd>
|
||||||
|
.IP
|
||||||
|
Execute command when a wallet transaction changes (%s in cmd is replaced
|
||||||
|
by TxID)
|
||||||
|
.HP
|
||||||
|
\fB\-zapwallettxes=\fR<mode>
|
||||||
|
.IP
|
||||||
|
Delete all wallet transactions and only recover those parts of the
|
||||||
|
blockchain through \fB\-rescan\fR on startup (1 = keep tx meta data e.g.
|
||||||
|
account owner and payment request information, 2 = drop tx meta
|
||||||
|
data)
|
||||||
|
.PP
|
||||||
|
ZeroMQ notification options:
|
||||||
|
.HP
|
||||||
|
\fB\-zmqpubhashblock=\fR<address>
|
||||||
|
.IP
|
||||||
|
Enable publish hash block in <address>
|
||||||
|
.HP
|
||||||
|
\fB\-zmqpubhashtx=\fR<address>
|
||||||
|
.IP
|
||||||
|
Enable publish hash transaction in <address>
|
||||||
|
.HP
|
||||||
|
\fB\-zmqpubrawblock=\fR<address>
|
||||||
|
.IP
|
||||||
|
Enable publish raw block in <address>
|
||||||
|
.HP
|
||||||
|
\fB\-zmqpubrawtx=\fR<address>
|
||||||
|
.IP
|
||||||
|
Enable publish raw transaction in <address>
|
||||||
|
.PP
|
||||||
|
Debugging/Testing options:
|
||||||
|
.HP
|
||||||
|
\fB\-uacomment=\fR<cmt>
|
||||||
|
.IP
|
||||||
|
Append comment to the user agent string
|
||||||
|
.HP
|
||||||
|
\fB\-debug=\fR<category>
|
||||||
|
.IP
|
||||||
|
Output debugging information (default: 0, supplying <category> is
|
||||||
|
optional). If <category> is not supplied or if <category> = 1,
|
||||||
|
output all debugging information.<category> can be: addrman,
|
||||||
|
alert, bench, coindb, db, http, libevent, lock, mempool,
|
||||||
|
mempoolrej, net, proxy, prune, rand, reindex, rpc, selectcoins,
|
||||||
|
tor, zmq, qt.
|
||||||
|
.HP
|
||||||
|
\fB\-help\-debug\fR
|
||||||
|
.IP
|
||||||
|
Show all debugging options (usage: \fB\-\-help\fR \fB\-help\-debug\fR)
|
||||||
|
.HP
|
||||||
|
\fB\-logips\fR
|
||||||
|
.IP
|
||||||
|
Include IP addresses in debug output (default: 0)
|
||||||
|
.HP
|
||||||
|
\fB\-logtimestamps\fR
|
||||||
|
.IP
|
||||||
|
Prepend debug output with timestamp (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-minrelaytxfee=\fR<amt>
|
||||||
|
.IP
|
||||||
|
Fees (in BTC/kB) smaller than this are considered zero fee for relaying,
|
||||||
|
mining and transaction creation (default: 0.00001)
|
||||||
|
.HP
|
||||||
|
\fB\-maxtxfee=\fR<amt>
|
||||||
|
.IP
|
||||||
|
Maximum total fees (in BTC) to use in a single wallet transaction or raw
|
||||||
|
transaction; setting this too low may abort large transactions
|
||||||
|
(default: 0.10)
|
||||||
|
.HP
|
||||||
|
\fB\-printtoconsole\fR
|
||||||
|
.IP
|
||||||
|
Send trace/debug info to console instead of debug.log file
|
||||||
|
.HP
|
||||||
|
\fB\-shrinkdebugfile\fR
|
||||||
|
.IP
|
||||||
|
Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR)
|
||||||
|
.PP
|
||||||
|
Chain selection options:
|
||||||
|
.HP
|
||||||
|
\fB\-testnet\fR
|
||||||
|
.IP
|
||||||
|
Use the test chain
|
||||||
|
.PP
|
||||||
|
Node relay options:
|
||||||
|
.HP
|
||||||
|
\fB\-bytespersigop\fR
|
||||||
|
.IP
|
||||||
|
Equivalent bytes per sigop in transactions for relay and mining
|
||||||
|
(default: 20)
|
||||||
|
.HP
|
||||||
|
\fB\-datacarrier\fR
|
||||||
|
.IP
|
||||||
|
Relay and mine data carrier transactions (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-datacarriersize\fR
|
||||||
|
.IP
|
||||||
|
Maximum size of data in data carrier transactions we relay and mine
|
||||||
|
(default: 83)
|
||||||
|
.HP
|
||||||
|
\fB\-mempoolreplacement\fR
|
||||||
|
.IP
|
||||||
|
Enable transaction replacement in the memory pool (default: 1)
|
||||||
|
.PP
|
||||||
|
Block creation options:
|
||||||
|
.HP
|
||||||
|
\fB\-blockmaxweight=\fR<n>
|
||||||
|
.IP
|
||||||
|
Set maximum BIP141 block weight (default: 3000000)
|
||||||
|
.HP
|
||||||
|
\fB\-blockmaxsize=\fR<n>
|
||||||
|
.IP
|
||||||
|
Set maximum block size in bytes (default: 750000)
|
||||||
|
.HP
|
||||||
|
\fB\-blockprioritysize=\fR<n>
|
||||||
|
.IP
|
||||||
|
Set maximum size of high\-priority/low\-fee transactions in bytes
|
||||||
|
(default: 0)
|
||||||
|
.PP
|
||||||
|
RPC server options:
|
||||||
|
.HP
|
||||||
|
\fB\-server\fR
|
||||||
|
.IP
|
||||||
|
Accept command line and JSON\-RPC commands
|
||||||
|
.HP
|
||||||
|
\fB\-rest\fR
|
||||||
|
.IP
|
||||||
|
Accept public REST requests (default: 0)
|
||||||
|
.HP
|
||||||
|
\fB\-rpcbind=\fR<addr>
|
||||||
|
.IP
|
||||||
|
Bind to given address to listen for JSON\-RPC connections. Use
|
||||||
|
[host]:port notation for IPv6. This option can be specified
|
||||||
|
multiple times (default: bind to all interfaces)
|
||||||
|
.HP
|
||||||
|
\fB\-rpccookiefile=\fR<loc>
|
||||||
|
.IP
|
||||||
|
Location of the auth cookie (default: data dir)
|
||||||
|
.HP
|
||||||
|
\fB\-rpcuser=\fR<user>
|
||||||
|
.IP
|
||||||
|
Username for JSON\-RPC connections
|
||||||
|
.HP
|
||||||
|
\fB\-rpcpassword=\fR<pw>
|
||||||
|
.IP
|
||||||
|
Password for JSON\-RPC connections
|
||||||
|
.HP
|
||||||
|
\fB\-rpcauth=\fR<userpw>
|
||||||
|
.IP
|
||||||
|
Username and hashed password for JSON\-RPC connections. The field
|
||||||
|
<userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A
|
||||||
|
canonical python script is included in share/rpcuser. This option
|
||||||
|
can be specified multiple times
|
||||||
|
.HP
|
||||||
|
\fB\-rpcport=\fR<port>
|
||||||
|
.IP
|
||||||
|
Listen for JSON\-RPC connections on <port> (default: 8332 or testnet:
|
||||||
|
18332)
|
||||||
|
.HP
|
||||||
|
\fB\-rpcallowip=\fR<ip>
|
||||||
|
.IP
|
||||||
|
Allow JSON\-RPC connections from specified source. Valid for <ip> are a
|
||||||
|
single IP (e.g. 1.2.3.4), a network/netmask (e.g.
|
||||||
|
1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This
|
||||||
|
option can be specified multiple times
|
||||||
|
.HP
|
||||||
|
\fB\-rpcthreads=\fR<n>
|
||||||
|
.IP
|
||||||
|
Set the number of threads to service RPC calls (default: 4)
|
||||||
|
.PP
|
||||||
|
UI Options:
|
||||||
|
.HP
|
||||||
|
\fB\-choosedatadir\fR
|
||||||
|
.IP
|
||||||
|
Choose data directory on startup (default: 0)
|
||||||
|
.HP
|
||||||
|
\fB\-lang=\fR<lang>
|
||||||
|
.IP
|
||||||
|
Set language, for example "de_DE" (default: system locale)
|
||||||
|
.HP
|
||||||
|
\fB\-min\fR
|
||||||
|
.IP
|
||||||
|
Start minimized
|
||||||
|
.HP
|
||||||
|
\fB\-rootcertificates=\fR<file>
|
||||||
|
.IP
|
||||||
|
Set SSL root certificates for payment request (default: \fB\-system\-\fR)
|
||||||
|
.HP
|
||||||
|
\fB\-splash\fR
|
||||||
|
.IP
|
||||||
|
Show splash screen on startup (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-resetguisettings\fR
|
||||||
|
.IP
|
||||||
|
Reset all settings changed in the GUI
|
||||||
|
.SH COPYRIGHT
|
||||||
|
Copyright (C) 2009-2016 The Bitcoin Core developers
|
||||||
|
|
||||||
|
Please contribute if you find Bitcoin Core useful. Visit
|
||||||
|
<https://bitcoincore.org> for further information about the software.
|
||||||
|
The source code is available from <https://github.com/bitcoin/bitcoin>.
|
||||||
|
|
||||||
|
This is experimental software.
|
||||||
|
Distributed under the MIT software license, see the accompanying file COPYING
|
||||||
|
or <http://www.opensource.org/licenses/mit-license.php>.
|
||||||
|
|
||||||
|
This product includes software developed by the OpenSSL Project for use in the
|
||||||
|
OpenSSL Toolkit <https://www.openssl.org/> and cryptographic software written
|
||||||
|
by Eric Young and UPnP software written by Thomas Bernard.
|
||||||
107
doc/man/bitcoin-tx.1
Normal file
107
doc/man/bitcoin-tx.1
Normal file
|
|
@ -0,0 +1,107 @@
|
||||||
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.5.
|
||||||
|
.TH BITCOIN-TX "1" "September 2016" "bitcoin-tx v0.13.0.0" "User Commands"
|
||||||
|
.SH NAME
|
||||||
|
bitcoin-tx \- manual page for bitcoin-tx v0.13.0.0
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Bitcoin Core bitcoin\-tx utility version v0.13.0.0
|
||||||
|
.SS "Usage:"
|
||||||
|
.TP
|
||||||
|
bitcoin\-tx [options] <hex\-tx> [commands]
|
||||||
|
Update hex\-encoded bitcoin transaction
|
||||||
|
.TP
|
||||||
|
bitcoin\-tx [options] \fB\-create\fR [commands]
|
||||||
|
Create hex\-encoded bitcoin transaction
|
||||||
|
.SH OPTIONS
|
||||||
|
.HP
|
||||||
|
\-?
|
||||||
|
.IP
|
||||||
|
This help message
|
||||||
|
.HP
|
||||||
|
\fB\-create\fR
|
||||||
|
.IP
|
||||||
|
Create new, empty TX.
|
||||||
|
.HP
|
||||||
|
\fB\-json\fR
|
||||||
|
.IP
|
||||||
|
Select JSON output
|
||||||
|
.HP
|
||||||
|
\fB\-txid\fR
|
||||||
|
.IP
|
||||||
|
Output only the hex\-encoded transaction id of the resultant transaction.
|
||||||
|
.PP
|
||||||
|
Chain selection options:
|
||||||
|
.HP
|
||||||
|
\fB\-testnet\fR
|
||||||
|
.IP
|
||||||
|
Use the test chain
|
||||||
|
.HP
|
||||||
|
\fB\-regtest\fR
|
||||||
|
.IP
|
||||||
|
Enter regression test mode, which uses a special chain in which blocks
|
||||||
|
can be solved instantly. This is intended for regression testing
|
||||||
|
tools and app development.
|
||||||
|
.PP
|
||||||
|
Commands:
|
||||||
|
.IP
|
||||||
|
delin=N
|
||||||
|
.IP
|
||||||
|
Delete input N from TX
|
||||||
|
.IP
|
||||||
|
delout=N
|
||||||
|
.IP
|
||||||
|
Delete output N from TX
|
||||||
|
.IP
|
||||||
|
in=TXID:VOUT(:SEQUENCE_NUMBER)
|
||||||
|
.IP
|
||||||
|
Add input to TX
|
||||||
|
.IP
|
||||||
|
locktime=N
|
||||||
|
.IP
|
||||||
|
Set TX lock time to N
|
||||||
|
.IP
|
||||||
|
nversion=N
|
||||||
|
.IP
|
||||||
|
Set TX version to N
|
||||||
|
.IP
|
||||||
|
outaddr=VALUE:ADDRESS
|
||||||
|
.IP
|
||||||
|
Add address\-based output to TX
|
||||||
|
.IP
|
||||||
|
outdata=[VALUE:]DATA
|
||||||
|
.IP
|
||||||
|
Add data\-based output to TX
|
||||||
|
.IP
|
||||||
|
outscript=VALUE:SCRIPT
|
||||||
|
.IP
|
||||||
|
Add raw script output to TX
|
||||||
|
.IP
|
||||||
|
sign=SIGHASH\-FLAGS
|
||||||
|
.IP
|
||||||
|
Add zero or more signatures to transaction. This command requires JSON
|
||||||
|
registers:prevtxs=JSON object, privatekeys=JSON object. See
|
||||||
|
signrawtransaction docs for format of sighash flags, JSON
|
||||||
|
objects.
|
||||||
|
.PP
|
||||||
|
Register Commands:
|
||||||
|
.IP
|
||||||
|
load=NAME:FILENAME
|
||||||
|
.IP
|
||||||
|
Load JSON file FILENAME into register NAME
|
||||||
|
.IP
|
||||||
|
set=NAME:JSON\-STRING
|
||||||
|
.IP
|
||||||
|
Set register NAME to given JSON\-STRING
|
||||||
|
.SH COPYRIGHT
|
||||||
|
Copyright (C) 2009-2016 The Bitcoin Core developers
|
||||||
|
|
||||||
|
Please contribute if you find Bitcoin Core useful. Visit
|
||||||
|
<https://bitcoincore.org> for further information about the software.
|
||||||
|
The source code is available from <https://github.com/bitcoin/bitcoin>.
|
||||||
|
|
||||||
|
This is experimental software.
|
||||||
|
Distributed under the MIT software license, see the accompanying file COPYING
|
||||||
|
or <http://www.opensource.org/licenses/mit-license.php>.
|
||||||
|
|
||||||
|
This product includes software developed by the OpenSSL Project for use in the
|
||||||
|
OpenSSL Toolkit <https://www.openssl.org/> and cryptographic software written
|
||||||
|
by Eric Young and UPnP software written by Thomas Bernard.
|
||||||
492
doc/man/bitcoind.1
Normal file
492
doc/man/bitcoind.1
Normal file
|
|
@ -0,0 +1,492 @@
|
||||||
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.5.
|
||||||
|
.TH BITCOIND "1" "September 2016" "bitcoind v0.13.0.0" "User Commands"
|
||||||
|
.SH NAME
|
||||||
|
bitcoind \- manual page for bitcoind v0.13.0.0
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Bitcoin Core Daemon version v0.13.0.0
|
||||||
|
.SS "Usage:"
|
||||||
|
.TP
|
||||||
|
bitcoind [options]
|
||||||
|
Start Bitcoin Core Daemon
|
||||||
|
.SH OPTIONS
|
||||||
|
.HP
|
||||||
|
\-?
|
||||||
|
.IP
|
||||||
|
Print this help message and exit
|
||||||
|
.HP
|
||||||
|
\fB\-version\fR
|
||||||
|
.IP
|
||||||
|
Print version and exit
|
||||||
|
.HP
|
||||||
|
\fB\-alertnotify=\fR<cmd>
|
||||||
|
.IP
|
||||||
|
Execute command when a relevant alert is received or we see a really
|
||||||
|
long fork (%s in cmd is replaced by message)
|
||||||
|
.HP
|
||||||
|
\fB\-blocknotify=\fR<cmd>
|
||||||
|
.IP
|
||||||
|
Execute command when the best block changes (%s in cmd is replaced by
|
||||||
|
block hash)
|
||||||
|
.HP
|
||||||
|
\fB\-checkblocks=\fR<n>
|
||||||
|
.IP
|
||||||
|
How many blocks to check at startup (default: 288, 0 = all)
|
||||||
|
.HP
|
||||||
|
\fB\-checklevel=\fR<n>
|
||||||
|
.IP
|
||||||
|
How thorough the block verification of \fB\-checkblocks\fR is (0\-4, default: 3)
|
||||||
|
.HP
|
||||||
|
\fB\-conf=\fR<file>
|
||||||
|
.IP
|
||||||
|
Specify configuration file (default: bitcoin.conf)
|
||||||
|
.HP
|
||||||
|
\fB\-daemon\fR
|
||||||
|
.IP
|
||||||
|
Run in the background as a daemon and accept commands
|
||||||
|
.HP
|
||||||
|
\fB\-datadir=\fR<dir>
|
||||||
|
.IP
|
||||||
|
Specify data directory
|
||||||
|
.HP
|
||||||
|
\fB\-dbcache=\fR<n>
|
||||||
|
.IP
|
||||||
|
Set database cache size in megabytes (4 to 16384, default: 300)
|
||||||
|
.HP
|
||||||
|
\fB\-loadblock=\fR<file>
|
||||||
|
.IP
|
||||||
|
Imports blocks from external blk000??.dat file on startup
|
||||||
|
.HP
|
||||||
|
\fB\-maxorphantx=\fR<n>
|
||||||
|
.IP
|
||||||
|
Keep at most <n> unconnectable transactions in memory (default: 100)
|
||||||
|
.HP
|
||||||
|
\fB\-maxmempool=\fR<n>
|
||||||
|
.IP
|
||||||
|
Keep the transaction memory pool below <n> megabytes (default: 300)
|
||||||
|
.HP
|
||||||
|
\fB\-mempoolexpiry=\fR<n>
|
||||||
|
.IP
|
||||||
|
Do not keep transactions in the mempool longer than <n> hours (default:
|
||||||
|
72)
|
||||||
|
.HP
|
||||||
|
\fB\-par=\fR<n>
|
||||||
|
.IP
|
||||||
|
Set the number of script verification threads (\fB\-4\fR to 16, 0 = auto, <0 =
|
||||||
|
leave that many cores free, default: 0)
|
||||||
|
.HP
|
||||||
|
\fB\-pid=\fR<file>
|
||||||
|
.IP
|
||||||
|
Specify pid file (default: bitcoind.pid)
|
||||||
|
.HP
|
||||||
|
\fB\-prune=\fR<n>
|
||||||
|
.IP
|
||||||
|
Reduce storage requirements by pruning (deleting) old blocks. This mode
|
||||||
|
is incompatible with \fB\-txindex\fR and \fB\-rescan\fR. Warning: Reverting
|
||||||
|
this setting requires re\-downloading the entire blockchain.
|
||||||
|
(default: 0 = disable pruning blocks, >550 = target size in MiB
|
||||||
|
to use for block files)
|
||||||
|
.HP
|
||||||
|
\fB\-reindex\-chainstate\fR
|
||||||
|
.IP
|
||||||
|
Rebuild chain state from the currently indexed blocks
|
||||||
|
.HP
|
||||||
|
\fB\-reindex\fR
|
||||||
|
.IP
|
||||||
|
Rebuild chain state and block index from the blk*.dat files on disk
|
||||||
|
.HP
|
||||||
|
\fB\-sysperms\fR
|
||||||
|
.IP
|
||||||
|
Create new files with system default permissions, instead of umask 077
|
||||||
|
(only effective with disabled wallet functionality)
|
||||||
|
.HP
|
||||||
|
\fB\-txindex\fR
|
||||||
|
.IP
|
||||||
|
Maintain a full transaction index, used by the getrawtransaction rpc
|
||||||
|
call (default: 0)
|
||||||
|
.PP
|
||||||
|
Connection options:
|
||||||
|
.HP
|
||||||
|
\fB\-addnode=\fR<ip>
|
||||||
|
.IP
|
||||||
|
Add a node to connect to and attempt to keep the connection open
|
||||||
|
.HP
|
||||||
|
\fB\-banscore=\fR<n>
|
||||||
|
.IP
|
||||||
|
Threshold for disconnecting misbehaving peers (default: 100)
|
||||||
|
.HP
|
||||||
|
\fB\-bantime=\fR<n>
|
||||||
|
.IP
|
||||||
|
Number of seconds to keep misbehaving peers from reconnecting (default:
|
||||||
|
86400)
|
||||||
|
.HP
|
||||||
|
\fB\-bind=\fR<addr>
|
||||||
|
.IP
|
||||||
|
Bind to given address and always listen on it. Use [host]:port notation
|
||||||
|
for IPv6
|
||||||
|
.HP
|
||||||
|
\fB\-connect=\fR<ip>
|
||||||
|
.IP
|
||||||
|
Connect only to the specified node(s)
|
||||||
|
.HP
|
||||||
|
\fB\-discover\fR
|
||||||
|
.IP
|
||||||
|
Discover own IP addresses (default: 1 when listening and no \fB\-externalip\fR
|
||||||
|
or \fB\-proxy\fR)
|
||||||
|
.HP
|
||||||
|
\fB\-dns\fR
|
||||||
|
.IP
|
||||||
|
Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-dnsseed\fR
|
||||||
|
.IP
|
||||||
|
Query for peer addresses via DNS lookup, if low on addresses (default: 1
|
||||||
|
unless \fB\-connect\fR)
|
||||||
|
.HP
|
||||||
|
\fB\-externalip=\fR<ip>
|
||||||
|
.IP
|
||||||
|
Specify your own public address
|
||||||
|
.HP
|
||||||
|
\fB\-forcednsseed\fR
|
||||||
|
.IP
|
||||||
|
Always query for peer addresses via DNS lookup (default: 0)
|
||||||
|
.HP
|
||||||
|
\fB\-listen\fR
|
||||||
|
.IP
|
||||||
|
Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR)
|
||||||
|
.HP
|
||||||
|
\fB\-listenonion\fR
|
||||||
|
.IP
|
||||||
|
Automatically create Tor hidden service (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-maxconnections=\fR<n>
|
||||||
|
.IP
|
||||||
|
Maintain at most <n> connections to peers (default: 125)
|
||||||
|
.HP
|
||||||
|
\fB\-maxreceivebuffer=\fR<n>
|
||||||
|
.IP
|
||||||
|
Maximum per\-connection receive buffer, <n>*1000 bytes (default: 5000)
|
||||||
|
.HP
|
||||||
|
\fB\-maxsendbuffer=\fR<n>
|
||||||
|
.IP
|
||||||
|
Maximum per\-connection send buffer, <n>*1000 bytes (default: 1000)
|
||||||
|
.HP
|
||||||
|
\fB\-maxtimeadjustment\fR
|
||||||
|
.IP
|
||||||
|
Maximum allowed median peer time offset adjustment. Local perspective of
|
||||||
|
time may be influenced by peers forward or backward by this
|
||||||
|
amount. (default: 4200 seconds)
|
||||||
|
.HP
|
||||||
|
\fB\-onion=\fR<ip:port>
|
||||||
|
.IP
|
||||||
|
Use separate SOCKS5 proxy to reach peers via Tor hidden services
|
||||||
|
(default: \fB\-proxy\fR)
|
||||||
|
.HP
|
||||||
|
\fB\-onlynet=\fR<net>
|
||||||
|
.IP
|
||||||
|
Only connect to nodes in network <net> (ipv4, ipv6 or onion)
|
||||||
|
.HP
|
||||||
|
\fB\-permitbaremultisig\fR
|
||||||
|
.IP
|
||||||
|
Relay non\-P2SH multisig (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-peerbloomfilters\fR
|
||||||
|
.IP
|
||||||
|
Support filtering of blocks and transaction with bloom filters (default:
|
||||||
|
1)
|
||||||
|
.HP
|
||||||
|
\fB\-port=\fR<port>
|
||||||
|
.IP
|
||||||
|
Listen for connections on <port> (default: 8333 or testnet: 18333)
|
||||||
|
.HP
|
||||||
|
\fB\-proxy=\fR<ip:port>
|
||||||
|
.IP
|
||||||
|
Connect through SOCKS5 proxy
|
||||||
|
.HP
|
||||||
|
\fB\-proxyrandomize\fR
|
||||||
|
.IP
|
||||||
|
Randomize credentials for every proxy connection. This enables Tor
|
||||||
|
stream isolation (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-seednode=\fR<ip>
|
||||||
|
.IP
|
||||||
|
Connect to a node to retrieve peer addresses, and disconnect
|
||||||
|
.HP
|
||||||
|
\fB\-timeout=\fR<n>
|
||||||
|
.IP
|
||||||
|
Specify connection timeout in milliseconds (minimum: 1, default: 5000)
|
||||||
|
.HP
|
||||||
|
\fB\-torcontrol=\fR<ip>:<port>
|
||||||
|
.IP
|
||||||
|
Tor control port to use if onion listening enabled (default:
|
||||||
|
127.0.0.1:9051)
|
||||||
|
.HP
|
||||||
|
\fB\-torpassword=\fR<pass>
|
||||||
|
.IP
|
||||||
|
Tor control port password (default: empty)
|
||||||
|
.HP
|
||||||
|
\fB\-whitebind=\fR<addr>
|
||||||
|
.IP
|
||||||
|
Bind to given address and whitelist peers connecting to it. Use
|
||||||
|
[host]:port notation for IPv6
|
||||||
|
.HP
|
||||||
|
\fB\-whitelist=\fR<netmask>
|
||||||
|
.IP
|
||||||
|
Whitelist peers connecting from the given netmask or IP address. Can be
|
||||||
|
specified multiple times. Whitelisted peers cannot be DoS banned
|
||||||
|
and their transactions are always relayed, even if they are
|
||||||
|
already in the mempool, useful e.g. for a gateway
|
||||||
|
.HP
|
||||||
|
\fB\-whitelistrelay\fR
|
||||||
|
.IP
|
||||||
|
Accept relayed transactions received from whitelisted peers even when
|
||||||
|
not relaying transactions (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-whitelistforcerelay\fR
|
||||||
|
.IP
|
||||||
|
Force relay of transactions from whitelisted peers even they violate
|
||||||
|
local relay policy (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-maxuploadtarget=\fR<n>
|
||||||
|
.IP
|
||||||
|
Tries to keep outbound traffic under the given target (in MiB per 24h),
|
||||||
|
0 = no limit (default: 0)
|
||||||
|
.PP
|
||||||
|
Wallet options:
|
||||||
|
.HP
|
||||||
|
\fB\-disablewallet\fR
|
||||||
|
.IP
|
||||||
|
Do not load the wallet and disable wallet RPC calls
|
||||||
|
.HP
|
||||||
|
\fB\-keypool=\fR<n>
|
||||||
|
.IP
|
||||||
|
Set key pool size to <n> (default: 100)
|
||||||
|
.HP
|
||||||
|
\fB\-fallbackfee=\fR<amt>
|
||||||
|
.IP
|
||||||
|
A fee rate (in BTC/kB) that will be used when fee estimation has
|
||||||
|
insufficient data (default: 0.0002)
|
||||||
|
.HP
|
||||||
|
\fB\-mintxfee=\fR<amt>
|
||||||
|
.IP
|
||||||
|
Fees (in BTC/kB) smaller than this are considered zero fee for
|
||||||
|
transaction creation (default: 0.00001)
|
||||||
|
.HP
|
||||||
|
\fB\-paytxfee=\fR<amt>
|
||||||
|
.IP
|
||||||
|
Fee (in BTC/kB) to add to transactions you send (default: 0.00)
|
||||||
|
.HP
|
||||||
|
\fB\-rescan\fR
|
||||||
|
.IP
|
||||||
|
Rescan the block chain for missing wallet transactions on startup
|
||||||
|
.HP
|
||||||
|
\fB\-salvagewallet\fR
|
||||||
|
.IP
|
||||||
|
Attempt to recover private keys from a corrupt wallet on startup
|
||||||
|
.HP
|
||||||
|
\fB\-spendzeroconfchange\fR
|
||||||
|
.IP
|
||||||
|
Spend unconfirmed change when sending transactions (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-txconfirmtarget=\fR<n>
|
||||||
|
.IP
|
||||||
|
If paytxfee is not set, include enough fee so transactions begin
|
||||||
|
confirmation on average within n blocks (default: 2)
|
||||||
|
.HP
|
||||||
|
\fB\-usehd\fR
|
||||||
|
.IP
|
||||||
|
Use hierarchical deterministic key generation (HD) after BIP32. Only has
|
||||||
|
effect during wallet creation/first start (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-upgradewallet\fR
|
||||||
|
.IP
|
||||||
|
Upgrade wallet to latest format on startup
|
||||||
|
.HP
|
||||||
|
\fB\-wallet=\fR<file>
|
||||||
|
.IP
|
||||||
|
Specify wallet file (within data directory) (default: wallet.dat)
|
||||||
|
.HP
|
||||||
|
\fB\-walletbroadcast\fR
|
||||||
|
.IP
|
||||||
|
Make the wallet broadcast transactions (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-walletnotify=\fR<cmd>
|
||||||
|
.IP
|
||||||
|
Execute command when a wallet transaction changes (%s in cmd is replaced
|
||||||
|
by TxID)
|
||||||
|
.HP
|
||||||
|
\fB\-zapwallettxes=\fR<mode>
|
||||||
|
.IP
|
||||||
|
Delete all wallet transactions and only recover those parts of the
|
||||||
|
blockchain through \fB\-rescan\fR on startup (1 = keep tx meta data e.g.
|
||||||
|
account owner and payment request information, 2 = drop tx meta
|
||||||
|
data)
|
||||||
|
.PP
|
||||||
|
ZeroMQ notification options:
|
||||||
|
.HP
|
||||||
|
\fB\-zmqpubhashblock=\fR<address>
|
||||||
|
.IP
|
||||||
|
Enable publish hash block in <address>
|
||||||
|
.HP
|
||||||
|
\fB\-zmqpubhashtx=\fR<address>
|
||||||
|
.IP
|
||||||
|
Enable publish hash transaction in <address>
|
||||||
|
.HP
|
||||||
|
\fB\-zmqpubrawblock=\fR<address>
|
||||||
|
.IP
|
||||||
|
Enable publish raw block in <address>
|
||||||
|
.HP
|
||||||
|
\fB\-zmqpubrawtx=\fR<address>
|
||||||
|
.IP
|
||||||
|
Enable publish raw transaction in <address>
|
||||||
|
.PP
|
||||||
|
Debugging/Testing options:
|
||||||
|
.HP
|
||||||
|
\fB\-uacomment=\fR<cmt>
|
||||||
|
.IP
|
||||||
|
Append comment to the user agent string
|
||||||
|
.HP
|
||||||
|
\fB\-debug=\fR<category>
|
||||||
|
.IP
|
||||||
|
Output debugging information (default: 0, supplying <category> is
|
||||||
|
optional). If <category> is not supplied or if <category> = 1,
|
||||||
|
output all debugging information.<category> can be: addrman,
|
||||||
|
alert, bench, coindb, db, http, libevent, lock, mempool,
|
||||||
|
mempoolrej, net, proxy, prune, rand, reindex, rpc, selectcoins,
|
||||||
|
tor, zmq.
|
||||||
|
.HP
|
||||||
|
\fB\-help\-debug\fR
|
||||||
|
.IP
|
||||||
|
Show all debugging options (usage: \fB\-\-help\fR \fB\-help\-debug\fR)
|
||||||
|
.HP
|
||||||
|
\fB\-logips\fR
|
||||||
|
.IP
|
||||||
|
Include IP addresses in debug output (default: 0)
|
||||||
|
.HP
|
||||||
|
\fB\-logtimestamps\fR
|
||||||
|
.IP
|
||||||
|
Prepend debug output with timestamp (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-minrelaytxfee=\fR<amt>
|
||||||
|
.IP
|
||||||
|
Fees (in BTC/kB) smaller than this are considered zero fee for relaying,
|
||||||
|
mining and transaction creation (default: 0.00001)
|
||||||
|
.HP
|
||||||
|
\fB\-maxtxfee=\fR<amt>
|
||||||
|
.IP
|
||||||
|
Maximum total fees (in BTC) to use in a single wallet transaction or raw
|
||||||
|
transaction; setting this too low may abort large transactions
|
||||||
|
(default: 0.10)
|
||||||
|
.HP
|
||||||
|
\fB\-printtoconsole\fR
|
||||||
|
.IP
|
||||||
|
Send trace/debug info to console instead of debug.log file
|
||||||
|
.HP
|
||||||
|
\fB\-shrinkdebugfile\fR
|
||||||
|
.IP
|
||||||
|
Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR)
|
||||||
|
.PP
|
||||||
|
Chain selection options:
|
||||||
|
.HP
|
||||||
|
\fB\-testnet\fR
|
||||||
|
.IP
|
||||||
|
Use the test chain
|
||||||
|
.PP
|
||||||
|
Node relay options:
|
||||||
|
.HP
|
||||||
|
\fB\-bytespersigop\fR
|
||||||
|
.IP
|
||||||
|
Equivalent bytes per sigop in transactions for relay and mining
|
||||||
|
(default: 20)
|
||||||
|
.HP
|
||||||
|
\fB\-datacarrier\fR
|
||||||
|
.IP
|
||||||
|
Relay and mine data carrier transactions (default: 1)
|
||||||
|
.HP
|
||||||
|
\fB\-datacarriersize\fR
|
||||||
|
.IP
|
||||||
|
Maximum size of data in data carrier transactions we relay and mine
|
||||||
|
(default: 83)
|
||||||
|
.HP
|
||||||
|
\fB\-mempoolreplacement\fR
|
||||||
|
.IP
|
||||||
|
Enable transaction replacement in the memory pool (default: 1)
|
||||||
|
.PP
|
||||||
|
Block creation options:
|
||||||
|
.HP
|
||||||
|
\fB\-blockmaxweight=\fR<n>
|
||||||
|
.IP
|
||||||
|
Set maximum BIP141 block weight (default: 3000000)
|
||||||
|
.HP
|
||||||
|
\fB\-blockmaxsize=\fR<n>
|
||||||
|
.IP
|
||||||
|
Set maximum block size in bytes (default: 750000)
|
||||||
|
.HP
|
||||||
|
\fB\-blockprioritysize=\fR<n>
|
||||||
|
.IP
|
||||||
|
Set maximum size of high\-priority/low\-fee transactions in bytes
|
||||||
|
(default: 0)
|
||||||
|
.PP
|
||||||
|
RPC server options:
|
||||||
|
.HP
|
||||||
|
\fB\-server\fR
|
||||||
|
.IP
|
||||||
|
Accept command line and JSON\-RPC commands
|
||||||
|
.HP
|
||||||
|
\fB\-rest\fR
|
||||||
|
.IP
|
||||||
|
Accept public REST requests (default: 0)
|
||||||
|
.HP
|
||||||
|
\fB\-rpcbind=\fR<addr>
|
||||||
|
.IP
|
||||||
|
Bind to given address to listen for JSON\-RPC connections. Use
|
||||||
|
[host]:port notation for IPv6. This option can be specified
|
||||||
|
multiple times (default: bind to all interfaces)
|
||||||
|
.HP
|
||||||
|
\fB\-rpccookiefile=\fR<loc>
|
||||||
|
.IP
|
||||||
|
Location of the auth cookie (default: data dir)
|
||||||
|
.HP
|
||||||
|
\fB\-rpcuser=\fR<user>
|
||||||
|
.IP
|
||||||
|
Username for JSON\-RPC connections
|
||||||
|
.HP
|
||||||
|
\fB\-rpcpassword=\fR<pw>
|
||||||
|
.IP
|
||||||
|
Password for JSON\-RPC connections
|
||||||
|
.HP
|
||||||
|
\fB\-rpcauth=\fR<userpw>
|
||||||
|
.IP
|
||||||
|
Username and hashed password for JSON\-RPC connections. The field
|
||||||
|
<userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A
|
||||||
|
canonical python script is included in share/rpcuser. This option
|
||||||
|
can be specified multiple times
|
||||||
|
.HP
|
||||||
|
\fB\-rpcport=\fR<port>
|
||||||
|
.IP
|
||||||
|
Listen for JSON\-RPC connections on <port> (default: 8332 or testnet:
|
||||||
|
18332)
|
||||||
|
.HP
|
||||||
|
\fB\-rpcallowip=\fR<ip>
|
||||||
|
.IP
|
||||||
|
Allow JSON\-RPC connections from specified source. Valid for <ip> are a
|
||||||
|
single IP (e.g. 1.2.3.4), a network/netmask (e.g.
|
||||||
|
1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This
|
||||||
|
option can be specified multiple times
|
||||||
|
.HP
|
||||||
|
\fB\-rpcthreads=\fR<n>
|
||||||
|
.IP
|
||||||
|
Set the number of threads to service RPC calls (default: 4)
|
||||||
|
.SH COPYRIGHT
|
||||||
|
Copyright (C) 2009-2016 The Bitcoin Core developers
|
||||||
|
|
||||||
|
Please contribute if you find Bitcoin Core useful. Visit
|
||||||
|
<https://bitcoincore.org> for further information about the software.
|
||||||
|
The source code is available from <https://github.com/bitcoin/bitcoin>.
|
||||||
|
|
||||||
|
This is experimental software.
|
||||||
|
Distributed under the MIT software license, see the accompanying file COPYING
|
||||||
|
or <http://www.opensource.org/licenses/mit-license.php>.
|
||||||
|
|
||||||
|
This product includes software developed by the OpenSSL Project for use in the
|
||||||
|
OpenSSL Toolkit <https://www.openssl.org/> and cryptographic software written
|
||||||
|
by Eric Young and UPnP software written by Thomas Bernard.
|
||||||
Loading…
Reference in a new issue