aboutsummaryrefslogtreecommitdiff
path: root/doc/man/bitcoin-wallet.1
diff options
context:
space:
mode:
authorW. J. van der Laan <laanwj@protonmail.com>2021-08-11 13:42:53 +0200
committerW. J. van der Laan <laanwj@protonmail.com>2021-08-11 13:43:13 +0200
commitd3bd5410f64e96d106486643e3d4300a9fb0ee71 (patch)
treece2f171272754319f12a33650b12742b0f4eff35 /doc/man/bitcoin-wallet.1
parent873fbc745d037ad43570f81e58334c397bc95477 (diff)
downloadbitcoin-d3bd5410f64e96d106486643e3d4300a9fb0ee71.tar.xz
doc: Manual pages update for 22.0rc2
Tree-SHA512: 361c6efdd21396ebf4358195e91bde81e7f7414e7022efc4d4a10da7cf3df7ce8cdadd277237921fdde9bae4b811d69d95fec56c010b823324ca69b40b966d41
Diffstat (limited to 'doc/man/bitcoin-wallet.1')
-rw-r--r--doc/man/bitcoin-wallet.1110
1 files changed, 106 insertions, 4 deletions
diff --git a/doc/man/bitcoin-wallet.1 b/doc/man/bitcoin-wallet.1
index 2da43dec66..1a01718c20 100644
--- a/doc/man/bitcoin-wallet.1
+++ b/doc/man/bitcoin-wallet.1
@@ -1,5 +1,107 @@
-.TH BITCOIN-WALLET "1"
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
+.TH BITCOIN-WALLET "1" "August 2021" "bitcoin-wallet v22.0rc2" "User Commands"
.SH NAME
-bitcoin-wallet \- manual page for bitcoin-wallet
-
-This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
+bitcoin-wallet manual page for bitcoin-wallet v22.0rc2
+.SH DESCRIPTION
+Bitcoin Core bitcoinwallet version v22.0rc2
+.PP
+bitcoinwallet is an offline tool for creating and interacting with Bitcoin Core wallet files.
+By default bitcoinwallet will act on wallets in the default mainnet wallet directory in the datadir.
+To change the target wallet, use the \fBdatadir\fR, \fBwallet\fR and \fBtestnet\fR/regtest arguments.
+.SS "Usage:"
+.IP
+bitcoinwallet [options] <command>
+.SH OPTIONS
+.HP
+?
+.IP
+Print this help message and exit
+.HP
+\fBdatadir=\fR<dir>
+.IP
+Specify data directory
+.HP
+\fBdescriptors\fR
+.IP
+Create descriptors wallet. Only for 'create'
+.HP
+\fBdumpfile=\fR<file name>
+.IP
+When used with 'dump', writes out the records to this file. When used
+with 'createfromdump', loads the records into a new wallet.
+.HP
+\fBformat=\fR<format>
+.IP
+The format of the wallet file to create. Either "bdb" or "sqlite". Only
+used with 'createfromdump'
+.HP
+\fBversion\fR
+.IP
+Print version and exit
+.HP
+\fBwallet=\fR<walletname>
+.IP
+Specify wallet name
+.PP
+Debugging/Testing options:
+.HP
+\fBdebug=\fR<category>
+.IP
+Output debugging information (default: 0).
+.HP
+\fBprinttoconsole\fR
+.IP
+Send trace/debug info to console (default: 1 when no \fBdebug\fR is true, 0
+otherwise).
+.PP
+Chain selection options:
+.HP
+\fBchain=\fR<chain>
+.IP
+Use the chain <chain> (default: main). Allowed values: main, test,
+signet, regtest
+.HP
+\fBsignet\fR
+.IP
+Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network
+is defined by the \fBsignetchallenge\fR parameter
+.HP
+\fBsignetchallenge\fR
+.IP
+Blocks must satisfy the given script to be considered valid (only for
+signet networks; defaults to the global default signet test
+network challenge)
+.HP
+\fBsignetseednode\fR
+.IP
+Specify a seed node for the signet network, in the hostname[:port]
+format, e.g. sig.net:1234 (may be used multiple times to specify
+multiple seed nodes; defaults to the global default signet test
+network seed node(s))
+.HP
+\fBtestnet\fR
+.IP
+Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR.
+.PP
+Commands:
+.IP
+create
+.IP
+Create new wallet file
+.IP
+createfromdump
+.IP
+Create new wallet file from dumped records
+.IP
+dump
+.IP
+Print out all of the wallet keyvalue records
+.IP
+info
+.IP
+Get wallet info
+.IP
+salvage
+.IP
+Attempt to recover private keys from a corrupt wallet. Warning:
+\&'salvage' is experimental.