Skip to content

Commit

Permalink
Merge #15354: doc: Add missing bitcoin-wallet tool manpages
Browse files Browse the repository at this point in the history
Summary:
Merge #15354: doc: Add missing bitcoin-wallet tool manpages

Backport of Core [[bitcoin/bitcoin#15354 | PR15354]]

Note that this generates the manpages only. A followup backport will install the new manpages.

Test Plan: Generate the manpages according to `doc/release-process.md` (the results are also part of this patch)

Reviewers: #bitcoin_abc, deadalnix

Reviewed By: #bitcoin_abc, deadalnix

Differential Revision: https://reviews.bitcoinabc.org/D5855
  • Loading branch information
jasonbcox committed Apr 27, 2020
1 parent 167d2e6 commit eef109b
Show file tree
Hide file tree
Showing 6 changed files with 93 additions and 13 deletions.
3 changes: 2 additions & 1 deletion contrib/devtools/gen-manpages.sh
Expand Up @@ -13,6 +13,7 @@ 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
Expand All @@ -30,7 +31,7 @@ trap "cleanup" EXIT
echo "[COPYRIGHT]" > footer.h2m
$BITCOIND --version | sed -n '1!p' >> footer.h2m

for cmd in $BITCOIND $BITCOINCLI $BITCOINTX $BITCOINQT; do
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
Expand Down
6 changes: 3 additions & 3 deletions doc/man/bitcoin-cli.1
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8.
.TH BITCOIN-CLI "1" "April 2020" "bitcoin-cli v0.21.5" "User Commands"
.TH BITCOIN-CLI "1" "April 2020" "bitcoin-cli v0.21.6" "User Commands"
.SH NAME
bitcoin-cli \- manual page for bitcoin-cli v0.21.5
bitcoin-cli \- manual page for bitcoin-cli v0.21.6
.SH SYNOPSIS
.B bitcoin-cli
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin ABC\/\fR
Expand All @@ -15,7 +15,7 @@ bitcoin-cli \- manual page for bitcoin-cli v0.21.5
.B bitcoin-cli
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR
.SH DESCRIPTION
Bitcoin ABC RPC client version v0.21.5
Bitcoin ABC RPC client version v0.21.6
.SH OPTIONS
.HP
\-?
Expand Down
12 changes: 9 additions & 3 deletions doc/man/bitcoin-qt.1
@@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8.
.TH BITCOIN-QT "1" "April 2020" "bitcoin-qt v0.21.5" "User Commands"
.TH BITCOIN-QT "1" "April 2020" "bitcoin-qt v0.21.6" "User Commands"
.SH NAME
bitcoin-qt \- manual page for bitcoin-qt v0.21.5
bitcoin-qt \- manual page for bitcoin-qt v0.21.6
.SH SYNOPSIS
.B bitcoin-qt
[\fI\,command-line options\/\fR]
.SH DESCRIPTION
Bitcoin ABC version v0.21.5 (64\-bit)
Bitcoin ABC version v0.21.6 (64\-bit)
.SH OPTIONS
.HP
\-?
Expand Down Expand Up @@ -249,6 +249,12 @@ Only connect to nodes in network <net> (ipv4, ipv6 or onion)
Support filtering of blocks and transaction with bloom filters (default:
1)
.HP
\fB\-peertimeout=\fR<n>
.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)
Expand Down
6 changes: 3 additions & 3 deletions doc/man/bitcoin-tx.1
@@ -1,15 +1,15 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8.
.TH BITCOIN-TX "1" "April 2020" "bitcoin-tx v0.21.5" "User Commands"
.TH BITCOIN-TX "1" "April 2020" "bitcoin-tx v0.21.6" "User Commands"
.SH NAME
bitcoin-tx \- manual page for bitcoin-tx v0.21.5
bitcoin-tx \- manual page for bitcoin-tx v0.21.6
.SH SYNOPSIS
.B bitcoin-tx
[\fI\,options\/\fR] \fI\,<hex-tx> \/\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.21.5
Bitcoin ABC bitcoin\-tx utility version v0.21.6
.SH OPTIONS
.HP
\-?
Expand Down
67 changes: 67 additions & 0 deletions doc/man/bitcoin-wallet.1
@@ -0,0 +1,67 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8.
.TH BITCOIN-WALLET "1" "April 2020" "bitcoin-wallet v0.21.6" "User Commands"
.SH NAME
bitcoin-wallet \- manual page for bitcoin-wallet v0.21.6
.SH DESCRIPTION
Bitcoin ABC bitcoin\-wallet version v0.21.6
.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] <command>
.SH OPTIONS
.HP
\-?
.IP
This help message
.HP
\fB\-datadir=\fR<dir>
.IP
Specify data directory
.HP
\fB\-wallet=\fR<wallet\-name>
.IP
Specify wallet name
.PP
Debugging/Testing options:
.HP
\fB\-debug=\fR<category>
.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\-testnet\fR
.IP
Use the test chain
.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
<https://www.bitcoinabc.org> for further information about the software.
The source code is available from <https://github.com/Bitcoin-ABC/bitcoin-abc>.

This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING
or <https://opensource.org/licenses/MIT>

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.
12 changes: 9 additions & 3 deletions doc/man/bitcoind.1
@@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8.
.TH BITCOIND "1" "April 2020" "bitcoind v0.21.5" "User Commands"
.TH BITCOIND "1" "April 2020" "bitcoind v0.21.6" "User Commands"
.SH NAME
bitcoind \- manual page for bitcoind v0.21.5
bitcoind \- manual page for bitcoind v0.21.6
.SH SYNOPSIS
.B bitcoind
[\fI\,options\/\fR] \fI\,Start Bitcoin ABC Daemon\/\fR
.SH DESCRIPTION
Bitcoin ABC Daemon version v0.21.5
Bitcoin ABC Daemon version v0.21.6
.SH OPTIONS
.HP
\-?
Expand Down Expand Up @@ -249,6 +249,12 @@ Only connect to nodes in network <net> (ipv4, ipv6 or onion)
Support filtering of blocks and transaction with bloom filters (default:
1)
.HP
\fB\-peertimeout=\fR<n>
.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)
Expand Down

0 comments on commit eef109b

Please sign in to comment.