diff --git a/cmake/modules/InstallationHelper.cmake b/cmake/modules/InstallationHelper.cmake --- a/cmake/modules/InstallationHelper.cmake +++ b/cmake/modules/InstallationHelper.cmake @@ -164,16 +164,39 @@ install_target(${_shared_name} ${FORWARD_EXCLUDE_FROM_ALL}) endfunction() -function(install_manpages) +function(install_manpage TARGET) set(MAN_DESTINATION "${CMAKE_INSTALL_MANDIR}/man1") + set(MAN_PAGE "${CMAKE_BINARY_DIR}/doc/man/${TARGET}.1") + add_custom_command( + OUTPUT "${MAN_PAGE}" + COMMENT "Generating man page for ${TARGET}" + COMMAND + "${CMAKE_SOURCE_DIR}/doc/man/gen-manpages.sh" + "$" + "$" + "${MAN_PAGE}" + DEPENDS + bitcoind + "${TARGET}" + ) + add_custom_target(gen-manpage-${TARGET} + DEPENDS "${MAN_PAGE}" + ) + install( - FILES ${ARGN} + FILES "${MAN_PAGE}" DESTINATION "${MAN_DESTINATION}" - COMPONENT manpages + COMPONENT manpage-${TARGET} + EXCLUDE_FROM_ALL ) - _add_install_target(manpages) + _add_install_target(manpage-${TARGET} + DEPENDS gen-manpage-${TARGET} + ) + _add_install_target(manpages + DEPENDS install-manpage-${TARGET} + ) if(NOT TARGET install-manpages-html) set(INPUT_DIR "${CMAKE_INSTALL_PREFIX}/${MAN_DESTINATION}") diff --git a/contrib/devtools/gen-manpages.sh b/contrib/devtools/gen-manpages.sh deleted file mode 100755 --- a/contrib/devtools/gen-manpages.sh +++ /dev/null @@ -1,38 +0,0 @@ -#!/usr/bin/env bash - -export LC_ALL=C - -set -euxo pipefail - -TOPDIR=${TOPDIR:-$(git rev-parse --show-toplevel)} -BUILDDIR=${BUILDDIR:-$TOPDIR} - -BINDIR=${BINDIR:-$BUILDDIR/src} -MANDIR=${MANDIR:-$TOPDIR/doc/man} - -BITCOIND=${BITCOIND:-$BINDIR/bitcoind} -BITCOINCLI=${BITCOINCLI:-$BINDIR/bitcoin-cli} -BITCOINTX=${BITCOINTX:-$BINDIR/bitcoin-tx} -WALLET_TOOL=${WALLET_TOOL:-$BINDIR/bitcoin-wallet} -BITCOINQT=${BITCOINQT:-$BINDIR/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 -read -r -a 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. -cleanup() { - rm -f footer.h2m -} -trap "cleanup" EXIT -echo "[COPYRIGHT]" > footer.h2m -$BITCOIND --version | sed -n '1!p' >> footer.h2m - -for cmd in $BITCOIND $BITCOINCLI $BITCOINTX $WALLET_TOOL $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 diff --git a/contrib/gitian-descriptors/gitian-osx.yml b/contrib/gitian-descriptors/gitian-osx.yml --- a/contrib/gitian-descriptors/gitian-osx.yml +++ b/contrib/gitian-descriptors/gitian-osx.yml @@ -170,6 +170,7 @@ ninja ninja install/strip + ninja install-manpages export PYTHONPATH="${BASEPREFIX}/${i}/native/lib/python3/dist-packages:${PYTHONPATH}" ninja osx-deploydir diff --git a/contrib/source-control-tools/automated-commits.sh b/contrib/source-control-tools/automated-commits.sh --- a/contrib/source-control-tools/automated-commits.sh +++ b/contrib/source-control-tools/automated-commits.sh @@ -193,47 +193,6 @@ git commit -m "${BOT_PREFIX} Update chainparams" ;; - update-manpages) - # Unfortunately bitcoin-qt requires a handle on the DISPLAY, even for the - # --help option. We can spoof an X window using xvfb. - command -v xvfb-run > /dev/null || (echo "Error: Package 'xvfb' is needed to run bitcoin-qt headlessly." && exit 11) - - "${DEVTOOLS_DIR}"/build_cmake.sh - BUILDDIR="${BUILD_DIR}" xvfb-run "${DEVTOOLS_DIR}"/gen-manpages.sh - - MANPAGES_DIR="${TOPLEVEL}"/doc/man - - # Sanity check that the current bitcoind version is in the manpages. - # Note that this check could be more complex, checking that all version - # instances match the current bitcoind version. But, it's impossible to - # know if some other version number will appear in the help text due to - # deprecation notices or otherwise. - EXPECTED_VERSION=$("${BUILD_DIR}"/src/bitcoind --version | head -1 | grep -oE "v[0-9]+\.[0-9]+\.[0-9]+") - grep "${EXPECTED_VERSION}" "${MANPAGES_DIR}"/*\.1 - - # Sanity check that the version string was not dirty or that something - # unexpected occurred. - grep "${EXPECTED_VERSION}-dirty" "${MANPAGES_DIR}"/*\.1 && { - echo "Error: Unexpected dirty version string." - exit 12 - } - grep "${EXPECTED_VERSION}-unk" "${MANPAGES_DIR}"/*\.1 && { - echo "Error: Unknown error detected in version string." - exit 13 - } - - # If there is no change, we're done. - if [ -z "$(git status --porcelain)" ] - then - echo "No update to perform on the man pages" - exit 0 - fi - - git add "${MANPAGES_DIR}"/*\.1 - - git commit -m "${BOT_PREFIX} Update manpages" - ;; - update-seeds) # Assumes seeder instances are already running on mainnet and testnet pushd "${TOPLEVEL}"/contrib/seeds diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -2,5 +2,4 @@ configure_file(Doxyfile.cmake.in Doxyfile ESCAPE_QUOTES) -add_subdirectory(man) add_subdirectory(rpc) diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt deleted file mode 100644 --- a/doc/man/CMakeLists.txt +++ /dev/null @@ -1,20 +0,0 @@ -# Copyright (c) 2019 The Bitcoin developers -include(InstallationHelper) - -install_manpages(bitcoind.1) - -if(BUILD_BITCOIN_CLI) - install_manpages(bitcoin-cli.1) -endif() - -if(BUILD_BITCOIN_TX) - install_manpages(bitcoin-tx.1) -endif() - -if(BUILD_BITCOIN_QT) - install_manpages(bitcoin-qt.1) -endif() - -if(BUILD_BITCOIN_WALLET) - install_manpages(bitcoin-wallet.1) -endif() diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1 deleted file mode 100644 --- a/doc/man/bitcoin-cli.1 +++ /dev/null @@ -1,120 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8. -.TH BITCOIN-CLI "1" "September 2020" "bitcoin-cli v0.22.2" "User Commands" -.SH NAME -bitcoin-cli \- manual page for bitcoin-cli v0.22.2 -.SH SYNOPSIS -.B bitcoin-cli -[\fI\,options\/\fR] \fI\, \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin ABC\/\fR -.br -.B bitcoin-cli -[\fI\,options\/\fR] \fI\,-named \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Bitcoin ABC (with named arguments)\/\fR -.br -.B bitcoin-cli -[\fI\,options\/\fR] \fI\,help List commands\/\fR -.br -.B bitcoin-cli -[\fI\,options\/\fR] \fI\,help Get help for a command\/\fR -.SH DESCRIPTION -Bitcoin ABC RPC client version v0.22.2 -.SH OPTIONS -.HP -\-? -.IP -This help message -.HP -\fB\-conf=\fR -.IP -Specify configuration file. Relative paths will be prefixed by datadir -location. (default: bitcoin.conf) -.HP -\fB\-datadir=\fR -.IP -Specify data directory -.HP -\fB\-getinfo\fR -.IP -Get general information from the remote server. Note that unlike -server\-side RPC calls, the results of \fB\-getinfo\fR is the result of -multiple non\-atomic requests. Some entries in the result may -represent results from different states (e.g. wallet balance may -be as of a different block from the chain state reported) -.HP -\fB\-named\fR -.IP -Pass named instead of positional arguments (default: false) -.HP -\fB\-rpcclienttimeout=\fR -.IP -Timeout in seconds during HTTP requests, or 0 for no timeout. (default: -900) -.HP -\fB\-rpcconnect=\fR -.IP -Send commands to node running on (default: 127.0.0.1) -.HP -\fB\-rpccookiefile=\fR -.IP -Location of the auth cookie. Relative paths will be prefixed by a -net\-specific datadir location. (default: data dir) -.HP -\fB\-rpcpassword=\fR -.IP -Password for JSON\-RPC connections -.HP -\fB\-rpcport=\fR -.IP -Connect to JSON\-RPC on (default: 8332, testnet: 18332, regtest: -18443) -.HP -\fB\-rpcuser=\fR -.IP -Username for JSON\-RPC connections -.HP -\fB\-rpcwait\fR -.IP -Wait for RPC server to start -.HP -\fB\-rpcwallet=\fR -.IP -Send RPC for non\-default wallet on RPC server (needs to exactly match -corresponding \fB\-wallet\fR option passed to bitcoind) -.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) -.HP -\fB\-stdinrpcpass\fR -.IP -Read RPC password from standard input as a single line. When combined -with \fB\-stdin\fR, the first line from standard input is used for the -RPC password. -.HP -\fB\-version\fR -.IP -Print version and exit -.PP -Chain selection options: -.HP -\fB\-chain=\fR -.IP -Use the chain (default: main). Allowed values: main, test, -regtest -.HP -\fB\-testnet\fR -.IP -Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. -.SH COPYRIGHT -Copyright (C) 2009-2020 The Bitcoin developers - -Please contribute if you find Bitcoin ABC useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or - -This product includes software developed by the OpenSSL Project for use in the -OpenSSL Toolkit and cryptographic software written by -Eric Young and UPnP software written by Thomas Bernard. diff --git a/doc/man/bitcoin-qt.1 b/doc/man/bitcoin-qt.1 deleted file mode 100644 --- a/doc/man/bitcoin-qt.1 +++ /dev/null @@ -1,662 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8. -.TH BITCOIN-QT "1" "September 2020" "bitcoin-qt v0.22.2" "User Commands" -.SH NAME -bitcoin-qt \- manual page for bitcoin-qt v0.22.2 -.SH SYNOPSIS -.B bitcoin-qt -[\fI\,command-line options\/\fR] -.SH DESCRIPTION -Bitcoin ABC version v0.22.2 (64\-bit) -.SH OPTIONS -.HP -\-? -.IP -Print this help message and exit -.HP -\fB\-alertnotify=\fR -.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\-assumevalid=\fR -.IP -If this block is in the chain assume that it and its ancestors are valid -and potentially skip their script verification (0 to verify all, -default: -0000000000000000011fd96aa2f90943cd624e15b78b929c792474980cb5ff8a, -testnet: -00000000000000d2c2d5c102580e1832d60952019823dd83d57f5e77f069efe8) -.HP -\fB\-blockfilterindex=\fR -.IP -Maintain an index of compact filters by block (default: 0, values: -basic). If is not supplied or if = 1, indexes for -all known types are enabled. -.HP -\fB\-blocknotify=\fR -.IP -Execute command when the best block changes (%s in cmd is replaced by -block hash) -.HP -\fB\-blockreconstructionextratxn=\fR -.IP -Extra transactions to keep in memory for compact block reconstructions -(default: 100) -.HP -\fB\-blocksdir=\fR -.IP -Specify directory to hold blocks subdirectory for *.dat files (default: -) -.HP -\fB\-blocksonly\fR -.IP -Whether to reject transactions from network peers. Transactions from the -wallet or RPC are not affected. (default: 0) -.HP -\fB\-conf=\fR -.IP -Specify configuration file. Relative paths will be prefixed by datadir -location. (default: bitcoin.conf) -.HP -\fB\-daemon\fR -.IP -Run in the background as a daemon and accept commands -.HP -\fB\-datadir=\fR -.IP -Specify data directory -.HP -\fB\-dbcache=\fR -.IP -Set database cache size in megabytes (4 to 16384, default: 450) -.HP -\fB\-debuglogfile=\fR -.IP -Specify location of debug log file. Relative paths will be prefixed by a -net\-specific datadir location. (0 to disable; default: debug.log) -.HP -\fB\-finalizationdelay=\fR -.IP -Set the minimum amount of time to wait between a block header reception -and the block finalization. Unit is seconds (default: 7200) -.HP -\fB\-includeconf=\fR -.IP -Specify additional configuration file, relative to the \fB\-datadir\fR path -(only useable from configuration file, not command line) -.HP -\fB\-loadblock=\fR -.IP -Imports blocks from external blk000??.dat file on startup -.HP -\fB\-maxmempool=\fR -.IP -Keep the transaction memory pool below megabytes (default: 300) -.HP -\fB\-maxorphantx=\fR -.IP -Keep at most unconnectable transactions in memory (default: 100) -.HP -\fB\-maxreorgdepth=\fR -.IP -Configure at what depth blocks are considered final (default: 10). Use -\fB\-1\fR to disable. -.HP -\fB\-mempoolexpiry=\fR -.IP -Do not keep transactions in the mempool longer than hours (default: -336) -.HP -\fB\-par=\fR -.IP -Set the number of script verification threads (\fB\-16\fR to 15, 0 = auto, <0 = -leave that many cores free, default: 0) -.HP -\fB\-persistmempool\fR -.IP -Whether to save the mempool on shutdown and load on restart (default: 1) -.HP -\fB\-pid=\fR -.IP -Specify pid file. Relative paths will be prefixed by a net\-specific -datadir location. (default: bitcoind.pid) -.HP -\fB\-prune=\fR -.IP -Reduce storage requirements by enabling pruning (deleting) of old -blocks. This allows the pruneblockchain RPC to be called to -delete specific blocks, and enables automatic pruning of old -blocks if a target size in MiB is provided. 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, 1 = allow manual pruning via RPC, ->=550 = automatically prune block files to stay under the -specified target size in MiB) -.HP -\fB\-reindex\fR -.IP -Rebuild chain state and block index from the blk*.dat files on disk -.HP -\fB\-reindex\-chainstate\fR -.IP -Rebuild chain state from the currently indexed blocks. When in pruning -mode or if blocks on disk might be corrupted, use full \fB\-reindex\fR -instead. -.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) -.HP -\fB\-usecashaddr\fR -.IP -Use Cash Address for destination encoding instead of base58 (activate by -default on Jan, 14) -.HP -\fB\-version\fR -.IP -Print version and exit -.PP -Connection options: -.HP -\fB\-addnode=\fR -.IP -Add a node to connect to and attempt to keep the connection open (see -the `addnode` RPC command help for more info) -.HP -\fB\-banscore=\fR -.IP -Threshold for disconnecting and discouraging misbehaving peers (default: -100) -.HP -\fB\-bantime=\fR -.IP -Default duration (in seconds) of manually configured bans (default: -86400) -.HP -\fB\-bind=\fR -.IP -Bind to given address and always listen on it. Use [host]:port notation -for IPv6 -.HP -\fB\-connect=\fR -.IP -Connect only to the specified node(s); \fB\-connect\fR=\fI\,0\/\fR disables automatic -connections (the rules for this peer are the same as for -\fB\-addnode\fR) -.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 used) -.HP -\fB\-enablebip61\fR -.IP -Send reject messages per BIP61 (default: 0) -.HP -\fB\-externalip=\fR -.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 -.IP -Maintain at most connections to peers (default: 125) -.HP -\fB\-maxreceivebuffer=\fR -.IP -Maximum per\-connection receive buffer, *1000 bytes (default: 5000) -.HP -\fB\-maxsendbuffer=\fR -.IP -Maximum per\-connection send buffer, *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\-maxuploadtarget=\fR -.IP -Tries to keep outbound traffic under the given target (in MiB per 24h), -0 = no limit (default: 0) -.HP -\fB\-onion=\fR -.IP -Use separate SOCKS5 proxy to reach peers via Tor hidden services -(default: \fB\-proxy\fR) -.HP -\fB\-onlynet=\fR -.IP -Make outgoing connections only through network (ipv4, ipv6 or -onion). Incoming connections are not affected by this option. -This option can be specified multiple times to allow multiple -networks. -.HP -\fB\-peerbloomfilters\fR -.IP -Support filtering of blocks and transaction with bloom filters (default: -1) -.HP -\fB\-peertimeout=\fR -.IP -Specify p2p connection timeout in seconds. This option determines the -amount of time a peer may be inactive before the connection to it -is dropped. (minimum: 1, default: 60) -.HP -\fB\-permitbaremultisig\fR -.IP -Relay non\-P2SH multisig (default: 1) -.HP -\fB\-port=\fR -.IP -Listen for connections on (default: 8333, testnet: 18333, -regtest: 18444) -.HP -\fB\-proxy=\fR -.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 -Connect to a node to retrieve peer addresses, and disconnect -.HP -\fB\-timeout=\fR -.IP -Specify connection timeout in milliseconds (minimum: 1, default: 5000) -.HP -\fB\-torcontrol=\fR: -.IP -Tor control port to use if onion listening enabled (default: -127.0.0.1:9051) -.HP -\fB\-torpassword=\fR -.IP -Tor control port password (default: empty) -.HP -\fB\-upnp\fR -.IP -Use UPnP to map the listening port (default: 0) -.HP -\fB\-whitebind=\fR -.IP -Bind to given address and whitelist peers connecting to it. Use -[host]:port notation for IPv6 -.HP -\fB\-whitelist=\fR -.IP -Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or -CIDR notated network (e.g. 1.2.3.0/24). 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 -.PP -Wallet options: -.HP -\fB\-avoidpartialspends\fR -.IP -Group outputs by address, selecting all or none, instead of selecting on -a per\-output basis. Privacy is improved as an address is only -used once (unless someone sends to it after spending from it), -but may result in slightly higher fees as suboptimal coin -selection may result due to the added limitation (default: 0 -(always enabled for wallets with "avoid_reuse" enabled)) -.HP -\fB\-disablewallet\fR -.IP -Do not load the wallet and disable wallet RPC calls -.HP -\fB\-fallbackfee=\fR -.IP -A fee rate (in BCH/kB) that will be used when fee estimation has -insufficient data. 0 to entirely disable the fallbackfee feature. -(default: 0.00) -.HP -\fB\-keypool=\fR -.IP -Set key pool size to (default: 1000) -.HP -\fB\-mintxfee=\fR -.IP -Fees (in BCH/kB) smaller than this are considered zero fee for -transaction creation (default: 0.00001) -.HP -\fB\-paytxfee=\fR -.IP -Fee (in BCH/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\-upgradewallet\fR -.IP -Upgrade wallet to latest format on startup -.HP -\fB\-wallet=\fR -.IP -Specify wallet database path. Can be specified multiple times to load -multiple wallets. Path is interpreted relative to if -it is not absolute, and will be created if it does not exist (as -a directory containing a wallet.dat file and log files). For -backwards compatibility this will also accept names of existing -data files in .) -.HP -\fB\-walletbroadcast\fR -.IP -Make the wallet broadcast transactions (default: 1) -.HP -\fB\-walletdir=\fR -.IP -Specify directory to hold wallets (default: /wallets if it -exists, otherwise ) -.HP -\fB\-walletnotify=\fR -.IP -Execute command when a wallet transaction changes (%s in cmd is replaced -by TxID) -.HP -\fB\-zapwallettxes=\fR -.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. -payment request information, 2 = drop tx meta data) -.PP -ZeroMQ notification options: -.HP -\fB\-zmqpubhashblock=\fR
-.IP -Enable publish hash block in
-.HP -\fB\-zmqpubhashblockhwm=\fR -.IP -Set publish hash block outbound message high water mark (default: 1000) -.HP -\fB\-zmqpubhashtx=\fR
-.IP -Enable publish hash transaction in
-.HP -\fB\-zmqpubhashtxhwm=\fR -.IP -Set publish hash transaction outbound message high water mark (default: -1000) -.HP -\fB\-zmqpubrawblock=\fR
-.IP -Enable publish raw block in
-.HP -\fB\-zmqpubrawblockhwm=\fR -.IP -Set publish raw block outbound message high water mark (default: 1000) -.HP -\fB\-zmqpubrawtx=\fR
-.IP -Enable publish raw transaction in
-.HP -\fB\-zmqpubrawtxhwm=\fR -.IP -Set publish raw transaction outbound message high water mark (default: -1000) -.PP -Debugging/Testing options: -.HP -\fB\-debug=\fR -.IP -Output debugging information (default: 0, supplying is -optional). If is not supplied or if = 1, -output all debugging information. can be: net, tor, -mempool, http, bench, zmq, db, rpc, estimatefee, addrman, -selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, -libevent, coindb, qt, leveldb, validation. -.HP -\fB\-debugexclude=\fR -.IP -Exclude debugging information for a category. Can be used in conjunction -with \fB\-debug\fR=\fI\,1\/\fR to output debug logs for all categories except one -or more specified categories. -.HP -\fB\-help\-debug\fR -.IP -Print help message with debugging options and exit -.HP -\fB\-logips\fR -.IP -Include IP addresses in debug output (default: 0) -.HP -\fB\-logthreadnames\fR -.IP -Prepend debug output with name of the originating thread (only available -on platforms supporting thread_local) (default: 0) -.HP -\fB\-logtimestamps\fR -.IP -Prepend debug output with timestamp (default: 1) -.HP -\fB\-maxtxfee=\fR -.IP -Maximum total fees (in BCH) 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 (default: 1 -when no \fB\-daemon\fR. To disable logging to file, set debuglogfile=0) -.HP -\fB\-shrinkdebugfile\fR -.IP -Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR) -.HP -\fB\-uacomment=\fR -.IP -Append comment to the user agent string -.PP -Chain selection options: -.HP -\fB\-chain=\fR -.IP -Use the chain (default: main). Allowed values: main, test, -regtest -.HP -\fB\-testnet\fR -.IP -Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. -.PP -Node relay options: -.HP -\fB\-bytespersigop\fR -.IP -Equivalent bytes per sigop in transactions for relay and mining -(default: 50) -.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: 223) -.HP -\fB\-minrelaytxfee=\fR -.IP -Fees (in BCH/kB) smaller than this are rejected for relaying, mining and -transaction creation (default: 0.00001) -.HP -\fB\-whitelistforcerelay\fR -.IP -Force relay of transactions from whitelisted peers even if they violate -local relay policy (default: 0) -.HP -\fB\-whitelistrelay\fR -.IP -Accept relayed transactions received from whitelisted peers even when -not relaying transactions (default: 1) -.PP -Block creation options: -.HP -\fB\-blockmaxsize=\fR -.IP -Set maximum block size in bytes (default: 2000000) -.HP -\fB\-blockmintxfee=\fR -.IP -Set lowest fee rate (in BCH/kB) for transactions to be included in block -creation. (default: 0.00001) -.PP -RPC server options: -.HP -\fB\-rest\fR -.IP -Accept public REST requests (default: 0) -.HP -\fB\-rpcallowip=\fR -.IP -Allow JSON\-RPC connections from specified source. Valid for 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\-rpcauth=\fR -.IP -Username and hashed password for JSON\-RPC connections. The field - comes in the format: :$. A -canonical python script is included in share/rpcauth. The client -then connects normally using the -rpcuser=/rpcpassword= pair of arguments. This -option can be specified multiple times -.HP -\fB\-rpcbind=\fR[:port] -.IP -Bind to given address to listen for JSON\-RPC connections. Do not expose -the RPC server to untrusted networks such as the public internet! -This option is ignored unless \fB\-rpcallowip\fR is also passed. Port is -optional and overrides \fB\-rpcport\fR. Use [host]:port notation for -IPv6. This option can be specified multiple times (default: -127.0.0.1 and ::1 i.e., localhost) -.HP -\fB\-rpccookiefile=\fR -.IP -Location of the auth cookie. Relative paths will be prefixed by a -net\-specific datadir location. (default: data dir) -.HP -\fB\-rpccorsdomain\fR=\fI\,value\/\fR -.IP -Domain from which to accept cross origin requests (browser enforced) -.HP -\fB\-rpcpassword=\fR -.IP -Password for JSON\-RPC connections -.HP -\fB\-rpcport=\fR -.IP -Listen for JSON\-RPC connections on (default: 8332, testnet: -18332, regtest: 18443) -.HP -\fB\-rpcthreads=\fR -.IP -Set the number of threads to service RPC calls (default: 4) -.HP -\fB\-rpcuser=\fR -.IP -Username for JSON\-RPC connections -.HP -\fB\-rpcwhitelist=\fR -.IP -Set a whitelist to filter incoming RPC calls for a specific user. The -field comes in the format: :,,...,. If multiple whitelists are set for a given user, -they are set\-intersected. See \fB\-rpcwhitelistdefault\fR documentation -for information on default whitelist behavior. -.HP -\fB\-rpcwhitelistdefault\fR -.IP -Sets default behavior for rpc whitelisting. Unless rpcwhitelistdefault -is set to 0, if any \fB\-rpcwhitelist\fR is set, the rpc server acts as -if all rpc users are subject to empty\-unless\-otherwise\-specified -whitelists. If rpcwhitelistdefault is set to 1 and no -\fB\-rpcwhitelist\fR is set, rpc server acts as if all rpc users are -subject to empty whitelists. -.HP -\fB\-server\fR -.IP -Accept command line and JSON\-RPC commands -.PP -UI Options: -.HP -\fB\-choosedatadir\fR -.IP -Choose data directory on startup (default: 0) -.HP -\fB\-lang=\fR -.IP -Set language, for example "de_DE" (default: system locale) -.HP -\fB\-min\fR -.IP -Start minimized -.HP -\fB\-resetguisettings\fR -.IP -Reset all settings changed in the GUI -.HP -\fB\-rootcertificates=\fR -.IP -Set SSL root certificates for payment request (default: \fB\-system\-\fR) -.HP -\fB\-splash\fR -.IP -Show splash screen on startup (default: 1) -.SH COPYRIGHT -Copyright (C) 2009-2020 The Bitcoin developers - -Please contribute if you find Bitcoin ABC useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or - -This product includes software developed by the OpenSSL Project for use in the -OpenSSL Toolkit and cryptographic software written by -Eric Young and UPnP software written by Thomas Bernard. diff --git a/doc/man/bitcoin-tx.1 b/doc/man/bitcoin-tx.1 deleted file mode 100644 --- a/doc/man/bitcoin-tx.1 +++ /dev/null @@ -1,117 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8. -.TH BITCOIN-TX "1" "September 2020" "bitcoin-tx v0.22.2" "User Commands" -.SH NAME -bitcoin-tx \- manual page for bitcoin-tx v0.22.2 -.SH SYNOPSIS -.B bitcoin-tx -[\fI\,options\/\fR] \fI\, \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded bitcoin transaction\/\fR -.br -.B bitcoin-tx -[\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] \fI\,Create hex-encoded bitcoin transaction\/\fR -.SH DESCRIPTION -Bitcoin ABC bitcoin\-tx utility version v0.22.2 -.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\-chain=\fR -.IP -Use the chain (default: main). Allowed values: main, test, -regtest -.HP -\fB\-testnet\fR -.IP -Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. -.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 -outmultisig=VALUE:REQUIRED:PUBKEYS:PUBKEY1:PUBKEY2:....[:FLAGS] -.IP -Add Pay To n\-of\-m Multi\-sig output to TX. n = REQUIRED, m = PUBKEYS. -Optionally add the "S" flag to wrap the output in a -pay\-to\-script\-hash. -.IP -outpubkey=VALUE:PUBKEY[:FLAGS] -.IP -Add pay\-to\-pubkey output to TX. Optionally add the "S" flag to wrap the -output in a pay\-to\-script\-hash. -.IP -outscript=VALUE:SCRIPT[:FLAGS] -.IP -Add raw script output to TX. Optionally add the "S" flag to wrap the -output in a pay\-to\-script\-hash. -.IP -sign=SIGHASH\-FLAGS -.IP -Add zero or more signatures to transaction. This command requires JSON -registers:prevtxs=JSON object, privatekeys=JSON object. See -signrawtransactionwithkey 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-2020 The Bitcoin developers - -Please contribute if you find Bitcoin ABC useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or - -This product includes software developed by the OpenSSL Project for use in the -OpenSSL Toolkit and cryptographic software written by -Eric Young and UPnP software written by Thomas Bernard. diff --git a/doc/man/bitcoin-wallet.1 b/doc/man/bitcoin-wallet.1 deleted file mode 100644 --- a/doc/man/bitcoin-wallet.1 +++ /dev/null @@ -1,72 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8. -.TH BITCOIN-WALLET "1" "September 2020" "bitcoin-wallet v0.22.2" "User Commands" -.SH NAME -bitcoin-wallet \- manual page for bitcoin-wallet v0.22.2 -.SH DESCRIPTION -Bitcoin ABC bitcoin\-wallet version v0.22.2 -.PP -wallet\-tool is an offline tool for creating and interacting with Bitcoin ABC wallet files. -By default wallet\-tool will act on wallets in the default mainnet wallet directory in the datadir. -To change the target wallet, use the \fB\-datadir\fR, \fB\-wallet\fR and \fB\-testnet\fR/\-regtest arguments. -.SS "Usage:" -.IP -bitcoin\-wallet [options] -.SH OPTIONS -.HP -\-? -.IP -This help message -.HP -\fB\-datadir=\fR -.IP -Specify data directory -.HP -\fB\-wallet=\fR -.IP -Specify wallet name -.PP -Debugging/Testing options: -.HP -\fB\-debug=\fR -.IP -Output debugging information (default: 0). -.HP -\fB\-printtoconsole\fR -.IP -Send trace/debug info to console (default: 1 when no \fB\-debug\fR is true, 0 -otherwise. -.PP -Chain selection options: -.HP -\fB\-chain=\fR -.IP -Use the chain (default: main). Allowed values: main, test, -regtest -.HP -\fB\-testnet\fR -.IP -Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. -.PP -Commands: -.IP -create -.IP -Create new wallet file -.IP -info -.IP -Get wallet info -.SH COPYRIGHT -Copyright (C) 2009-2020 The Bitcoin developers - -Please contribute if you find Bitcoin ABC useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or - -This product includes software developed by the OpenSSL Project for use in the -OpenSSL Toolkit and cryptographic software written by -Eric Young and UPnP software written by Thomas Bernard. diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1 deleted file mode 100644 --- a/doc/man/bitcoind.1 +++ /dev/null @@ -1,636 +0,0 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8. -.TH BITCOIND "1" "September 2020" "bitcoind v0.22.2" "User Commands" -.SH NAME -bitcoind \- manual page for bitcoind v0.22.2 -.SH SYNOPSIS -.B bitcoind -[\fI\,options\/\fR] \fI\,Start Bitcoin ABC Daemon\/\fR -.SH DESCRIPTION -Bitcoin ABC Daemon version v0.22.2 -.SH OPTIONS -.HP -\-? -.IP -Print this help message and exit -.HP -\fB\-alertnotify=\fR -.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\-assumevalid=\fR -.IP -If this block is in the chain assume that it and its ancestors are valid -and potentially skip their script verification (0 to verify all, -default: -0000000000000000011fd96aa2f90943cd624e15b78b929c792474980cb5ff8a, -testnet: -00000000000000d2c2d5c102580e1832d60952019823dd83d57f5e77f069efe8) -.HP -\fB\-blockfilterindex=\fR -.IP -Maintain an index of compact filters by block (default: 0, values: -basic). If is not supplied or if = 1, indexes for -all known types are enabled. -.HP -\fB\-blocknotify=\fR -.IP -Execute command when the best block changes (%s in cmd is replaced by -block hash) -.HP -\fB\-blockreconstructionextratxn=\fR -.IP -Extra transactions to keep in memory for compact block reconstructions -(default: 100) -.HP -\fB\-blocksdir=\fR -.IP -Specify directory to hold blocks subdirectory for *.dat files (default: -) -.HP -\fB\-blocksonly\fR -.IP -Whether to reject transactions from network peers. Transactions from the -wallet or RPC are not affected. (default: 0) -.HP -\fB\-conf=\fR -.IP -Specify configuration file. Relative paths will be prefixed by datadir -location. (default: bitcoin.conf) -.HP -\fB\-daemon\fR -.IP -Run in the background as a daemon and accept commands -.HP -\fB\-datadir=\fR -.IP -Specify data directory -.HP -\fB\-dbcache=\fR -.IP -Set database cache size in megabytes (4 to 16384, default: 450) -.HP -\fB\-debuglogfile=\fR -.IP -Specify location of debug log file. Relative paths will be prefixed by a -net\-specific datadir location. (0 to disable; default: debug.log) -.HP -\fB\-finalizationdelay=\fR -.IP -Set the minimum amount of time to wait between a block header reception -and the block finalization. Unit is seconds (default: 7200) -.HP -\fB\-includeconf=\fR -.IP -Specify additional configuration file, relative to the \fB\-datadir\fR path -(only useable from configuration file, not command line) -.HP -\fB\-loadblock=\fR -.IP -Imports blocks from external blk000??.dat file on startup -.HP -\fB\-maxmempool=\fR -.IP -Keep the transaction memory pool below megabytes (default: 300) -.HP -\fB\-maxorphantx=\fR -.IP -Keep at most unconnectable transactions in memory (default: 100) -.HP -\fB\-maxreorgdepth=\fR -.IP -Configure at what depth blocks are considered final (default: 10). Use -\fB\-1\fR to disable. -.HP -\fB\-mempoolexpiry=\fR -.IP -Do not keep transactions in the mempool longer than hours (default: -336) -.HP -\fB\-par=\fR -.IP -Set the number of script verification threads (\fB\-16\fR to 15, 0 = auto, <0 = -leave that many cores free, default: 0) -.HP -\fB\-persistmempool\fR -.IP -Whether to save the mempool on shutdown and load on restart (default: 1) -.HP -\fB\-pid=\fR -.IP -Specify pid file. Relative paths will be prefixed by a net\-specific -datadir location. (default: bitcoind.pid) -.HP -\fB\-prune=\fR -.IP -Reduce storage requirements by enabling pruning (deleting) of old -blocks. This allows the pruneblockchain RPC to be called to -delete specific blocks, and enables automatic pruning of old -blocks if a target size in MiB is provided. 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, 1 = allow manual pruning via RPC, ->=550 = automatically prune block files to stay under the -specified target size in MiB) -.HP -\fB\-reindex\fR -.IP -Rebuild chain state and block index from the blk*.dat files on disk -.HP -\fB\-reindex\-chainstate\fR -.IP -Rebuild chain state from the currently indexed blocks. When in pruning -mode or if blocks on disk might be corrupted, use full \fB\-reindex\fR -instead. -.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) -.HP -\fB\-usecashaddr\fR -.IP -Use Cash Address for destination encoding instead of base58 (activate by -default on Jan, 14) -.HP -\fB\-version\fR -.IP -Print version and exit -.PP -Connection options: -.HP -\fB\-addnode=\fR -.IP -Add a node to connect to and attempt to keep the connection open (see -the `addnode` RPC command help for more info) -.HP -\fB\-banscore=\fR -.IP -Threshold for disconnecting and discouraging misbehaving peers (default: -100) -.HP -\fB\-bantime=\fR -.IP -Default duration (in seconds) of manually configured bans (default: -86400) -.HP -\fB\-bind=\fR -.IP -Bind to given address and always listen on it. Use [host]:port notation -for IPv6 -.HP -\fB\-connect=\fR -.IP -Connect only to the specified node(s); \fB\-connect\fR=\fI\,0\/\fR disables automatic -connections (the rules for this peer are the same as for -\fB\-addnode\fR) -.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 used) -.HP -\fB\-enablebip61\fR -.IP -Send reject messages per BIP61 (default: 0) -.HP -\fB\-externalip=\fR -.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 -.IP -Maintain at most connections to peers (default: 125) -.HP -\fB\-maxreceivebuffer=\fR -.IP -Maximum per\-connection receive buffer, *1000 bytes (default: 5000) -.HP -\fB\-maxsendbuffer=\fR -.IP -Maximum per\-connection send buffer, *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\-maxuploadtarget=\fR -.IP -Tries to keep outbound traffic under the given target (in MiB per 24h), -0 = no limit (default: 0) -.HP -\fB\-onion=\fR -.IP -Use separate SOCKS5 proxy to reach peers via Tor hidden services -(default: \fB\-proxy\fR) -.HP -\fB\-onlynet=\fR -.IP -Make outgoing connections only through network (ipv4, ipv6 or -onion). Incoming connections are not affected by this option. -This option can be specified multiple times to allow multiple -networks. -.HP -\fB\-peerbloomfilters\fR -.IP -Support filtering of blocks and transaction with bloom filters (default: -1) -.HP -\fB\-peertimeout=\fR -.IP -Specify p2p connection timeout in seconds. This option determines the -amount of time a peer may be inactive before the connection to it -is dropped. (minimum: 1, default: 60) -.HP -\fB\-permitbaremultisig\fR -.IP -Relay non\-P2SH multisig (default: 1) -.HP -\fB\-port=\fR -.IP -Listen for connections on (default: 8333, testnet: 18333, -regtest: 18444) -.HP -\fB\-proxy=\fR -.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 -Connect to a node to retrieve peer addresses, and disconnect -.HP -\fB\-timeout=\fR -.IP -Specify connection timeout in milliseconds (minimum: 1, default: 5000) -.HP -\fB\-torcontrol=\fR: -.IP -Tor control port to use if onion listening enabled (default: -127.0.0.1:9051) -.HP -\fB\-torpassword=\fR -.IP -Tor control port password (default: empty) -.HP -\fB\-upnp\fR -.IP -Use UPnP to map the listening port (default: 0) -.HP -\fB\-whitebind=\fR -.IP -Bind to given address and whitelist peers connecting to it. Use -[host]:port notation for IPv6 -.HP -\fB\-whitelist=\fR -.IP -Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or -CIDR notated network (e.g. 1.2.3.0/24). 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 -.PP -Wallet options: -.HP -\fB\-avoidpartialspends\fR -.IP -Group outputs by address, selecting all or none, instead of selecting on -a per\-output basis. Privacy is improved as an address is only -used once (unless someone sends to it after spending from it), -but may result in slightly higher fees as suboptimal coin -selection may result due to the added limitation (default: 0 -(always enabled for wallets with "avoid_reuse" enabled)) -.HP -\fB\-disablewallet\fR -.IP -Do not load the wallet and disable wallet RPC calls -.HP -\fB\-fallbackfee=\fR -.IP -A fee rate (in BCH/kB) that will be used when fee estimation has -insufficient data. 0 to entirely disable the fallbackfee feature. -(default: 0.00) -.HP -\fB\-keypool=\fR -.IP -Set key pool size to (default: 1000) -.HP -\fB\-mintxfee=\fR -.IP -Fees (in BCH/kB) smaller than this are considered zero fee for -transaction creation (default: 0.00001) -.HP -\fB\-paytxfee=\fR -.IP -Fee (in BCH/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\-upgradewallet\fR -.IP -Upgrade wallet to latest format on startup -.HP -\fB\-wallet=\fR -.IP -Specify wallet database path. Can be specified multiple times to load -multiple wallets. Path is interpreted relative to if -it is not absolute, and will be created if it does not exist (as -a directory containing a wallet.dat file and log files). For -backwards compatibility this will also accept names of existing -data files in .) -.HP -\fB\-walletbroadcast\fR -.IP -Make the wallet broadcast transactions (default: 1) -.HP -\fB\-walletdir=\fR -.IP -Specify directory to hold wallets (default: /wallets if it -exists, otherwise ) -.HP -\fB\-walletnotify=\fR -.IP -Execute command when a wallet transaction changes (%s in cmd is replaced -by TxID) -.HP -\fB\-zapwallettxes=\fR -.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. -payment request information, 2 = drop tx meta data) -.PP -ZeroMQ notification options: -.HP -\fB\-zmqpubhashblock=\fR
-.IP -Enable publish hash block in
-.HP -\fB\-zmqpubhashblockhwm=\fR -.IP -Set publish hash block outbound message high water mark (default: 1000) -.HP -\fB\-zmqpubhashtx=\fR
-.IP -Enable publish hash transaction in
-.HP -\fB\-zmqpubhashtxhwm=\fR -.IP -Set publish hash transaction outbound message high water mark (default: -1000) -.HP -\fB\-zmqpubrawblock=\fR
-.IP -Enable publish raw block in
-.HP -\fB\-zmqpubrawblockhwm=\fR -.IP -Set publish raw block outbound message high water mark (default: 1000) -.HP -\fB\-zmqpubrawtx=\fR
-.IP -Enable publish raw transaction in
-.HP -\fB\-zmqpubrawtxhwm=\fR -.IP -Set publish raw transaction outbound message high water mark (default: -1000) -.PP -Debugging/Testing options: -.HP -\fB\-debug=\fR -.IP -Output debugging information (default: 0, supplying is -optional). If is not supplied or if = 1, -output all debugging information. can be: net, tor, -mempool, http, bench, zmq, db, rpc, estimatefee, addrman, -selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, -libevent, coindb, qt, leveldb, validation. -.HP -\fB\-debugexclude=\fR -.IP -Exclude debugging information for a category. Can be used in conjunction -with \fB\-debug\fR=\fI\,1\/\fR to output debug logs for all categories except one -or more specified categories. -.HP -\fB\-help\-debug\fR -.IP -Print help message with debugging options and exit -.HP -\fB\-logips\fR -.IP -Include IP addresses in debug output (default: 0) -.HP -\fB\-logthreadnames\fR -.IP -Prepend debug output with name of the originating thread (only available -on platforms supporting thread_local) (default: 0) -.HP -\fB\-logtimestamps\fR -.IP -Prepend debug output with timestamp (default: 1) -.HP -\fB\-maxtxfee=\fR -.IP -Maximum total fees (in BCH) 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 (default: 1 -when no \fB\-daemon\fR. To disable logging to file, set debuglogfile=0) -.HP -\fB\-shrinkdebugfile\fR -.IP -Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR) -.HP -\fB\-uacomment=\fR -.IP -Append comment to the user agent string -.PP -Chain selection options: -.HP -\fB\-chain=\fR -.IP -Use the chain (default: main). Allowed values: main, test, -regtest -.HP -\fB\-testnet\fR -.IP -Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. -.PP -Node relay options: -.HP -\fB\-bytespersigop\fR -.IP -Equivalent bytes per sigop in transactions for relay and mining -(default: 50) -.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: 223) -.HP -\fB\-minrelaytxfee=\fR -.IP -Fees (in BCH/kB) smaller than this are rejected for relaying, mining and -transaction creation (default: 0.00001) -.HP -\fB\-whitelistforcerelay\fR -.IP -Force relay of transactions from whitelisted peers even if they violate -local relay policy (default: 0) -.HP -\fB\-whitelistrelay\fR -.IP -Accept relayed transactions received from whitelisted peers even when -not relaying transactions (default: 1) -.PP -Block creation options: -.HP -\fB\-blockmaxsize=\fR -.IP -Set maximum block size in bytes (default: 2000000) -.HP -\fB\-blockmintxfee=\fR -.IP -Set lowest fee rate (in BCH/kB) for transactions to be included in block -creation. (default: 0.00001) -.PP -RPC server options: -.HP -\fB\-rest\fR -.IP -Accept public REST requests (default: 0) -.HP -\fB\-rpcallowip=\fR -.IP -Allow JSON\-RPC connections from specified source. Valid for 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\-rpcauth=\fR -.IP -Username and hashed password for JSON\-RPC connections. The field - comes in the format: :$. A -canonical python script is included in share/rpcauth. The client -then connects normally using the -rpcuser=/rpcpassword= pair of arguments. This -option can be specified multiple times -.HP -\fB\-rpcbind=\fR[:port] -.IP -Bind to given address to listen for JSON\-RPC connections. Do not expose -the RPC server to untrusted networks such as the public internet! -This option is ignored unless \fB\-rpcallowip\fR is also passed. Port is -optional and overrides \fB\-rpcport\fR. Use [host]:port notation for -IPv6. This option can be specified multiple times (default: -127.0.0.1 and ::1 i.e., localhost) -.HP -\fB\-rpccookiefile=\fR -.IP -Location of the auth cookie. Relative paths will be prefixed by a -net\-specific datadir location. (default: data dir) -.HP -\fB\-rpccorsdomain\fR=\fI\,value\/\fR -.IP -Domain from which to accept cross origin requests (browser enforced) -.HP -\fB\-rpcpassword=\fR -.IP -Password for JSON\-RPC connections -.HP -\fB\-rpcport=\fR -.IP -Listen for JSON\-RPC connections on (default: 8332, testnet: -18332, regtest: 18443) -.HP -\fB\-rpcthreads=\fR -.IP -Set the number of threads to service RPC calls (default: 4) -.HP -\fB\-rpcuser=\fR -.IP -Username for JSON\-RPC connections -.HP -\fB\-rpcwhitelist=\fR -.IP -Set a whitelist to filter incoming RPC calls for a specific user. The -field comes in the format: :,,...,. If multiple whitelists are set for a given user, -they are set\-intersected. See \fB\-rpcwhitelistdefault\fR documentation -for information on default whitelist behavior. -.HP -\fB\-rpcwhitelistdefault\fR -.IP -Sets default behavior for rpc whitelisting. Unless rpcwhitelistdefault -is set to 0, if any \fB\-rpcwhitelist\fR is set, the rpc server acts as -if all rpc users are subject to empty\-unless\-otherwise\-specified -whitelists. If rpcwhitelistdefault is set to 1 and no -\fB\-rpcwhitelist\fR is set, rpc server acts as if all rpc users are -subject to empty whitelists. -.HP -\fB\-server\fR -.IP -Accept command line and JSON\-RPC commands -.SH COPYRIGHT -Copyright (C) 2009-2020 The Bitcoin developers - -Please contribute if you find Bitcoin ABC useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or - -This product includes software developed by the OpenSSL Project for use in the -OpenSSL Toolkit and cryptographic software written by -Eric Young and UPnP software written by Thomas Bernard. diff --git a/doc/man/gen-manpages.sh b/doc/man/gen-manpages.sh new file mode 100755 --- /dev/null +++ b/doc/man/gen-manpages.sh @@ -0,0 +1,60 @@ +#!/usr/bin/env bash + +export LC_ALL=C + +set -euxo pipefail + +usage() { + cat << EOF +Usage: $0 bitcoind binary manpage + bitcoind: path to bitcoind executable + binary: path to the binary to generate the man pages from + manpage: output path for the man page +EOF +} + +if [ $# -ne 3 ] +then + usage + exit 1 +fi + +if ! command -v help2man +then + echo "help2man is required to run $0, please install it" + exit 2 +fi + +BITCOIND="$1" +BIN="$2" +MANPAGE="$3" + +if [ ! -x "${BITCOIND}" ] +then + echo "${BITCOIND} not found or not executable." + exit 3 +fi +if [ ! -x "${BIN}" ] +then + echo "${BIN} not found or not executable." + exit 3 +fi + +mkdir -p "$(dirname ${MANPAGE})" + +# The autodetected version git tag can screw up manpage output a little bit +read -r -a VERSION <<< "$(${BITCOIND} --version | head -n1 | awk -F'[ -]' '{ print $5, $6 }')" + +# 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. +FOOTER="$(basename ${BIN})_footer.h2m" +cleanup() { + rm -f "${FOOTER}" +} +trap "cleanup" EXIT +echo "[COPYRIGHT]" > "${FOOTER}" +"${BITCOIND}" --version | sed -n '1!p' >> "${FOOTER}" + +help2man -N --version-string="${VERSION[0]}" --include="${FOOTER}" -o "${MANPAGE}" "${BIN}" +sed -i "s/\\\-${VERSION[1]}//g" "${MANPAGE}" diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -597,6 +597,7 @@ add_to_security_check(bitcoin-wallet) install_target(bitcoin-wallet) + install_manpage(bitcoin-wallet) else() target_sources(server PRIVATE dummywallet.cpp) endif() @@ -629,6 +630,7 @@ add_to_security_check(bitcoin-cli) install_target(bitcoin-cli) + install_manpage(bitcoin-cli) endif() # bitcoin-tx @@ -644,6 +646,7 @@ add_to_security_check(bitcoin-tx) install_target(bitcoin-tx) + install_manpage(bitcoin-tx) endif() # bitcoind @@ -656,6 +659,7 @@ add_to_security_check(bitcoind) install_target(bitcoind) +install_manpage(bitcoind) # Bitcoin-qt if(BUILD_BITCOIN_QT) diff --git a/src/qt/CMakeLists.txt b/src/qt/CMakeLists.txt --- a/src/qt/CMakeLists.txt +++ b/src/qt/CMakeLists.txt @@ -341,6 +341,7 @@ include(InstallationHelper) install_target(bitcoin-qt) +install_manpage(bitcoin-qt) if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin") set(BITCOINQT_BUNDLE_ICON "res/icons/bitcoin.icns")