Skip to content

Commit 1a60369

Browse files
author
MarcoFalke
committed
Merge #15354: doc: Add missing bitcoin-wallet tool manpages
fa1e281 doc: Add missing wallet-tool manpages (MarcoFalke) fa0fe3b contrib: Add missing wallet tool to gen-manpages.sh (MarcoFalke) Pull request description: Tree-SHA512: 8c5c7e98f634cb1c8b43ecc9a15f22df2f572f5d752fb20f09910fb0d31e74df8144c1833f54bb44ad53cb5ca166f7e896317951899d4b0aa05bd3262f66835c
2 parents 12a910c + fa1e281 commit 1a60369

File tree

6 files changed

+82
-14
lines changed

6 files changed

+82
-14
lines changed

‎contrib/devtools/gen-manpages.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ MANDIR=${MANDIR:-$TOPDIR/doc/man}
1010
BITCOIND=${BITCOIND:-$BINDIR/bitcoind}
1111
BITCOINCLI=${BITCOINCLI:-$BINDIR/bitcoin-cli}
1212
BITCOINTX=${BITCOINTX:-$BINDIR/bitcoin-tx}
13+
WALLET_TOOL=${WALLET_TOOL:-$BINDIR/bitcoin-wallet}
1314
BITCOINQT=${BITCOINQT:-$BINDIR/qt/bitcoin-qt}
1415

1516
[ ! -x $BITCOIND ] && echo "$BITCOIND not found or not executable." && exit 1
@@ -23,7 +24,7 @@ BTCVER=($($BITCOINCLI --version | head -n1 | awk -F'[ -]' '{ print $6, $7 }'))
2324
echo "[COPYRIGHT]" > footer.h2m
2425
$BITCOIND --version | sed -n '1!p' >> footer.h2m
2526

26-
for cmd in $BITCOIND $BITCOINCLI $BITCOINTX $BITCOINQT; do
27+
for cmd in $BITCOIND $BITCOINCLI $BITCOINTX $WALLET_TOOL $BITCOINQT; do
2728
cmdname="${cmd##*/}"
2829
help2man -N --version-string=${BTCVER[0]} --include=footer.h2m -o ${MANDIR}/${cmdname}.1 ${cmd}
2930
sed -i "s/\\\-${BTCVER[1]}//g" ${MANDIR}/${cmdname}.1

‎doc/man/bitcoin-cli.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
2-
.TH BITCOIN-CLI "1" "December 2018" "bitcoin-cli v0.17.99.0" "User Commands"
2+
.TH BITCOIN-CLI "1" "February 2019" "bitcoin-cli v0.17.99.0" "User Commands"
33
.SH NAME
44
bitcoin-cli \- manual page for bitcoin-cli v0.17.99.0
55
.SH SYNOPSIS
@@ -104,7 +104,7 @@ Chain selection options:
104104
.IP
105105
Use the test chain
106106
.SH COPYRIGHT
107-
Copyright (C) 2009-2018 The Bitcoin Core developers
107+
Copyright (C) 2009-2019 The Bitcoin Core developers
108108

109109
Please contribute if you find Bitcoin Core useful. Visit
110110
<https://bitcoincore.org> for further information about the software.

‎doc/man/bitcoin-qt.1

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
2-
.TH BITCOIN-QT "1" "December 2018" "bitcoin-qt v0.17.99.0" "User Commands"
2+
.TH BITCOIN-QT "1" "February 2019" "bitcoin-qt v0.17.99.0" "User Commands"
33
.SH NAME
44
bitcoin-qt \- manual page for bitcoin-qt v0.17.99.0
55
.SH SYNOPSIS
@@ -56,7 +56,7 @@ Specify data directory
5656
.HP
5757
\fB\-dbcache=\fR<n>
5858
.IP
59-
Set database cache size in megabytes (4 to 16384, default: 450)
59+
Set database cache size in MiB (4 to 16384, default: 450)
6060
.HP
6161
\fB\-debuglogfile=\fR<file>
6262
.IP
@@ -500,7 +500,7 @@ mining and transaction creation (default: 0.00001)
500500
\fB\-whitelistforcerelay\fR
501501
.IP
502502
Force relay of transactions from whitelisted peers even if they violate
503-
local relay policy (default: 1)
503+
local relay policy (default: 0)
504504
.HP
505505
\fB\-whitelistrelay\fR
506506
.IP
@@ -606,7 +606,7 @@ Set SSL root certificates for payment request (default: \fB\-system\-\fR)
606606
.IP
607607
Show splash screen on startup (default: 1)
608608
.SH COPYRIGHT
609-
Copyright (C) 2009-2018 The Bitcoin Core developers
609+
Copyright (C) 2009-2019 The Bitcoin Core developers
610610

611611
Please contribute if you find Bitcoin Core useful. Visit
612612
<https://bitcoincore.org> for further information about the software.

‎doc/man/bitcoin-tx.1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
2-
.TH BITCOIN-TX "1" "December 2018" "bitcoin-tx v0.17.99.0" "User Commands"
2+
.TH BITCOIN-TX "1" "February 2019" "bitcoin-tx v0.17.99.0" "User Commands"
33
.SH NAME
44
bitcoin-tx \- manual page for bitcoin-tx v0.17.99.0
55
.SH SYNOPSIS
@@ -92,7 +92,7 @@ sign=SIGHASH\-FLAGS
9292
.IP
9393
Add zero or more signatures to transaction. This command requires JSON
9494
registers:prevtxs=JSON object, privatekeys=JSON object. See
95-
signrawtransaction docs for format of sighash flags, JSON
95+
signrawtransactionwithkey docs for format of sighash flags, JSON
9696
objects.
9797
.PP
9898
Register Commands:
@@ -105,7 +105,7 @@ set=NAME:JSON\-STRING
105105
.IP
106106
Set register NAME to given JSON\-STRING
107107
.SH COPYRIGHT
108-
Copyright (C) 2009-2018 The Bitcoin Core developers
108+
Copyright (C) 2009-2019 The Bitcoin Core developers
109109

110110
Please contribute if you find Bitcoin Core useful. Visit
111111
<https://bitcoincore.org> for further information about the software.

‎doc/man/bitcoin-wallet.1

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
2+
.TH BITCOIN-WALLET "1" "February 2019" "bitcoin-wallet v0.17.99.0" "User Commands"
3+
.SH NAME
4+
bitcoin-wallet \- manual page for bitcoin-wallet v0.17.99.0
5+
.SH DESCRIPTION
6+
Bitcoin Core bitcoin\-wallet version v0.17.99.0
7+
.PP
8+
wallet\-tool is an offline tool for creating and interacting with Bitcoin Core wallet files.
9+
By default wallet\-tool will act on wallets in the default mainnet wallet directory in the datadir.
10+
To change the target wallet, use the \fB\-datadir\fR, \fB\-wallet\fR and \fB\-testnet\fR/\-regtest arguments.
11+
.SS "Usage:"
12+
.IP
13+
bitcoin\-wallet [options] <command>
14+
.SH OPTIONS
15+
.HP
16+
\-?
17+
.IP
18+
This help message
19+
.HP
20+
\fB\-datadir=\fR<dir>
21+
.IP
22+
Specify data directory
23+
.HP
24+
\fB\-wallet=\fR<wallet\-name>
25+
.IP
26+
Specify wallet name
27+
.PP
28+
Debugging/Testing options:
29+
.HP
30+
\fB\-debug=\fR<category>
31+
.IP
32+
Output debugging information (default: 0).
33+
.HP
34+
\fB\-printtoconsole\fR
35+
.IP
36+
Send trace/debug info to console (default: 1 when no \fB\-debug\fR is true, 0
37+
otherwise.
38+
.PP
39+
Chain selection options:
40+
.HP
41+
\fB\-testnet\fR
42+
.IP
43+
Use the test chain
44+
.PP
45+
Commands:
46+
.IP
47+
create
48+
.IP
49+
Create new wallet file
50+
.IP
51+
info
52+
.IP
53+
Get wallet info
54+
.SH COPYRIGHT
55+
Copyright (C) 2009-2019 The Bitcoin Core developers
56+
57+
Please contribute if you find Bitcoin Core useful. Visit
58+
<https://bitcoincore.org> for further information about the software.
59+
The source code is available from <https://github.com/bitcoin/bitcoin>.
60+
61+
This is experimental software.
62+
Distributed under the MIT software license, see the accompanying file COPYING
63+
or <https://opensource.org/licenses/MIT>
64+
65+
This product includes software developed by the OpenSSL Project for use in the
66+
OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
67+
Eric Young and UPnP software written by Thomas Bernard.

‎doc/man/bitcoind.1

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
2-
.TH BITCOIND "1" "December 2018" "bitcoind v0.17.99.0" "User Commands"
2+
.TH BITCOIND "1" "February 2019" "bitcoind v0.17.99.0" "User Commands"
33
.SH NAME
44
bitcoind \- manual page for bitcoind v0.17.99.0
55
.SH SYNOPSIS
@@ -56,7 +56,7 @@ Specify data directory
5656
.HP
5757
\fB\-dbcache=\fR<n>
5858
.IP
59-
Set database cache size in megabytes (4 to 16384, default: 450)
59+
Set database cache size in MiB (4 to 16384, default: 450)
6060
.HP
6161
\fB\-debuglogfile=\fR<file>
6262
.IP
@@ -500,7 +500,7 @@ mining and transaction creation (default: 0.00001)
500500
\fB\-whitelistforcerelay\fR
501501
.IP
502502
Force relay of transactions from whitelisted peers even if they violate
503-
local relay policy (default: 1)
503+
local relay policy (default: 0)
504504
.HP
505505
\fB\-whitelistrelay\fR
506506
.IP
@@ -580,7 +580,7 @@ Username for JSON\-RPC connections
580580
.IP
581581
Accept command line and JSON\-RPC commands
582582
.SH COPYRIGHT
583-
Copyright (C) 2009-2018 The Bitcoin Core developers
583+
Copyright (C) 2009-2019 The Bitcoin Core developers
584584

585585
Please contribute if you find Bitcoin Core useful. Visit
586586
<https://bitcoincore.org> for further information about the software.

0 commit comments

Comments
 (0)