mirror of
https://github.com/ElementsProject/elements.git
synced 2026-08-18 13:17:55 +02:00
generate manual pages for 22 release
This commit is contained in:
Glenn Willen
parent
ca2d72ae8b
commit
9fb51a2a20
6 changed files with 2719 additions and 42 deletions
|
|
@ -1,5 +1,264 @@
|
||||||
.TH ELEMENTS-CLI "1"
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
|
||||||
|
.TH ELEMENTS-CLI "1" "August 2022" "elements-cli v22.0.0rc2" "User Commands"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
elements-cli \- manual page for elements-cli
|
elements-cli \- manual page for elements-cli v22.0.0rc2
|
||||||
|
.SH SYNOPSIS
|
||||||
This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
|
.B elements-cli
|
||||||
|
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Elements Core\/\fR
|
||||||
|
.br
|
||||||
|
.B elements-cli
|
||||||
|
[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Elements Core (with named arguments)\/\fR
|
||||||
|
.br
|
||||||
|
.B elements-cli
|
||||||
|
[\fI\,options\/\fR] \fI\,help List commands\/\fR
|
||||||
|
.br
|
||||||
|
.B elements-cli
|
||||||
|
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Elements Core RPC client version v22.0.0rc2
|
||||||
|
.SH OPTIONS
|
||||||
|
.HP
|
||||||
|
\-?
|
||||||
|
.IP
|
||||||
|
Print this help message and exit
|
||||||
|
.HP
|
||||||
|
\fB\-addrinfo\fR
|
||||||
|
.IP
|
||||||
|
Get the number of addresses known to the node, per network and total.
|
||||||
|
.HP
|
||||||
|
\fB\-conf=\fR<file>
|
||||||
|
.IP
|
||||||
|
Specify configuration file. Relative paths will be prefixed by datadir
|
||||||
|
location. (default: elements.conf)
|
||||||
|
.HP
|
||||||
|
\fB\-datadir=\fR<dir>
|
||||||
|
.IP
|
||||||
|
Specify data directory
|
||||||
|
.HP
|
||||||
|
\fB\-generate\fR
|
||||||
|
.IP
|
||||||
|
Generate blocks immediately, equivalent to RPC getnewaddress followed by
|
||||||
|
RPC generatetoaddress. Optional positional integer arguments are
|
||||||
|
number of blocks to generate (default: 1) and maximum iterations
|
||||||
|
to try (default: 1000000), equivalent to RPC generatetoaddress
|
||||||
|
nblocks and maxtries arguments. Example: bitcoin\-cli \fB\-generate\fR 4
|
||||||
|
1000
|
||||||
|
.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\-netinfo\fR
|
||||||
|
.IP
|
||||||
|
Get network peer connection information from the remote server. An
|
||||||
|
optional integer argument from 0 to 4 can be passed for different
|
||||||
|
peers listings (default: 0). Pass "help" for detailed help
|
||||||
|
documentation.
|
||||||
|
.HP
|
||||||
|
\fB\-rpcclienttimeout=\fR<n>
|
||||||
|
.IP
|
||||||
|
Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
|
||||||
|
900)
|
||||||
|
.HP
|
||||||
|
\fB\-rpcconnect=\fR<ip>
|
||||||
|
.IP
|
||||||
|
Send commands to node running on <ip> (default: 127.0.0.1)
|
||||||
|
.HP
|
||||||
|
\fB\-rpccookiefile=\fR<loc>
|
||||||
|
.IP
|
||||||
|
Location of the auth cookie. Relative paths will be prefixed by a
|
||||||
|
net\-specific datadir location. (default: data dir)
|
||||||
|
.HP
|
||||||
|
\fB\-rpcpassword=\fR<pw>
|
||||||
|
.IP
|
||||||
|
Password for JSON\-RPC connections
|
||||||
|
.HP
|
||||||
|
\fB\-rpcport=\fR<port>
|
||||||
|
.IP
|
||||||
|
Connect to JSON\-RPC on <port> (default: 7041, testnet: 18332, signet:
|
||||||
|
38332, regtest: 18443)
|
||||||
|
.HP
|
||||||
|
\fB\-rpcuser=\fR<user>
|
||||||
|
.IP
|
||||||
|
Username for JSON\-RPC connections
|
||||||
|
.HP
|
||||||
|
\fB\-rpcwait\fR
|
||||||
|
.IP
|
||||||
|
Wait for RPC server to start
|
||||||
|
.HP
|
||||||
|
\fB\-rpcwaittimeout=\fR<n>
|
||||||
|
.IP
|
||||||
|
Timeout in seconds to wait for the RPC server to start, or 0 for no
|
||||||
|
timeout. (default: 0)
|
||||||
|
.HP
|
||||||
|
\fB\-rpcwallet=\fR<walletname>
|
||||||
|
.IP
|
||||||
|
Send RPC for non\-default wallet on RPC server (needs to exactly match
|
||||||
|
corresponding \fB\-wallet\fR option passed to elementsd). This changes
|
||||||
|
the RPC endpoint used, e.g.
|
||||||
|
http://127.0.0.1:8332/wallet/<walletname>
|
||||||
|
.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). When
|
||||||
|
combined with \fB\-stdinrpcpass\fR, the first line from standard input
|
||||||
|
is used for the RPC password.
|
||||||
|
.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. When combined with \fB\-stdinwalletpassphrase\fR,
|
||||||
|
\fB\-stdinrpcpass\fR consumes the first line, and \fB\-stdinwalletpassphrase\fR
|
||||||
|
consumes the second.
|
||||||
|
.HP
|
||||||
|
\fB\-stdinwalletpassphrase\fR
|
||||||
|
.IP
|
||||||
|
Read wallet passphrase from standard input as a single line. When
|
||||||
|
combined with \fB\-stdin\fR, the first line from standard input is used
|
||||||
|
for the wallet passphrase.
|
||||||
|
.HP
|
||||||
|
\fB\-version\fR
|
||||||
|
.IP
|
||||||
|
Print version and exit
|
||||||
|
.PP
|
||||||
|
Debugging/Testing options:
|
||||||
|
.PP
|
||||||
|
Chain selection options:
|
||||||
|
.HP
|
||||||
|
\fB\-chain=\fR<chain>
|
||||||
|
.IP
|
||||||
|
Use the chain <chain> (default: liquidv1). Reserved values: main, test,
|
||||||
|
signet, regtest, liquidv1, liquidv1test
|
||||||
|
.HP
|
||||||
|
\fB\-con_blockheightinheader\fR
|
||||||
|
.IP
|
||||||
|
Whether the chain includes the block height directly in the header, for
|
||||||
|
easier validation of block height in low\-resource environments.
|
||||||
|
(default: true)
|
||||||
|
.HP
|
||||||
|
\fB\-con_has_parent_chain\fR
|
||||||
|
.IP
|
||||||
|
Whether or not there is a parent chain.
|
||||||
|
.HP
|
||||||
|
\fB\-con_max_block_sig_size\fR
|
||||||
|
.IP
|
||||||
|
Max allowed witness data for the signed block header.
|
||||||
|
.HP
|
||||||
|
\fB\-con_parent_chain_signblockscript\fR
|
||||||
|
.IP
|
||||||
|
Whether parent chain uses pow or signed blocks. If the parent chain uses
|
||||||
|
signed blocks, the challenge (scriptPubKey) script. If not, an
|
||||||
|
empty string. (default: empty script [ie parent uses pow])
|
||||||
|
.HP
|
||||||
|
\fB\-con_parentpowlimit\fR
|
||||||
|
.IP
|
||||||
|
The proof\-of\-work limit value for the parent chain.
|
||||||
|
.HP
|
||||||
|
\fB\-con_signed_blocks\fR
|
||||||
|
.IP
|
||||||
|
Signed blockchain. Uses input of `\-signblockscript` to define what
|
||||||
|
signatures are necessary to solve it.
|
||||||
|
.HP
|
||||||
|
\fB\-fedpegscript\fR
|
||||||
|
.IP
|
||||||
|
The script for the federated peg enforce from genesis block. This script
|
||||||
|
may stop being enforced once dynamic federations activates.
|
||||||
|
.HP
|
||||||
|
\fB\-parentgenesisblockhash\fR
|
||||||
|
.IP
|
||||||
|
The genesis blockhash of the parent chain.
|
||||||
|
.HP
|
||||||
|
\fB\-signblockscript\fR
|
||||||
|
.IP
|
||||||
|
Signed blockchain enumberance. Only active when `\-con_signed_blocks` set
|
||||||
|
to true.
|
||||||
|
.HP
|
||||||
|
\fB\-signet\fR
|
||||||
|
.IP
|
||||||
|
Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network
|
||||||
|
is defined by the \fB\-signetchallenge\fR parameter
|
||||||
|
.HP
|
||||||
|
\fB\-signetchallenge\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
|
||||||
|
\fB\-signetseednode\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
|
||||||
|
\fB\-testnet\fR
|
||||||
|
.IP
|
||||||
|
Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR.
|
||||||
|
.PP
|
||||||
|
Elements Options:
|
||||||
|
.HP
|
||||||
|
\fB\-con_blocksubsidy\fR
|
||||||
|
.IP
|
||||||
|
Defines the amount of block subsidy to start with, at genesis block, in
|
||||||
|
satoshis.
|
||||||
|
.HP
|
||||||
|
\fB\-con_connect_genesis_outputs\fR
|
||||||
|
.IP
|
||||||
|
Connect outputs in genesis block to utxo database.
|
||||||
|
.HP
|
||||||
|
\fB\-con_csv_deploy_start\fR
|
||||||
|
.IP
|
||||||
|
Starting height for CSV deployment. (default: \fB\-1\fR, which means ACTIVE
|
||||||
|
from genesis)
|
||||||
|
.HP
|
||||||
|
\fB\-con_dyna_deploy_signal\fR
|
||||||
|
.IP
|
||||||
|
Whether to signal for the Dynamic Federations deployment (default:
|
||||||
|
true).
|
||||||
|
.HP
|
||||||
|
\fB\-con_elementsmode\fR
|
||||||
|
.TP
|
||||||
|
Use Elements\-like instead of Core\-like witness encoding.
|
||||||
|
This is
|
||||||
|
.IP
|
||||||
|
required for CA/CT. (default: true)
|
||||||
|
.HP
|
||||||
|
\fB\-con_mandatorycoinbase\fR
|
||||||
|
.IP
|
||||||
|
All non\-zero valued coinbase outputs must go to this scriptPubKey, if
|
||||||
|
set.
|
||||||
|
.HP
|
||||||
|
\fB\-dynamic_epoch_length\fR
|
||||||
|
.IP
|
||||||
|
Per\-chain parameter that sets how many blocks dynamic federation voting
|
||||||
|
and enforcement are in effect for.
|
||||||
|
.HP
|
||||||
|
\fB\-enforce_pak\fR
|
||||||
|
.IP
|
||||||
|
Causes standardness checks to enforce Pegout Authorization Key(PAK)
|
||||||
|
validation before dynamic federations, and consensus enforcement
|
||||||
|
after.
|
||||||
|
.HP
|
||||||
|
\fB\-multi_data_permitted\fR
|
||||||
|
.IP
|
||||||
|
Allow relay of multiple OP_RETURN outputs. (default: \fB\-enforce_pak\fR)
|
||||||
|
.HP
|
||||||
|
\fB\-pak\fR
|
||||||
|
.IP
|
||||||
|
Sets the 'first extension space' field to the pak entries ala
|
||||||
|
pre\-dynamic federations. Only used for testing in custom chains.
|
||||||
|
.HP
|
||||||
|
\fB\-total_valid_epochs\fR
|
||||||
|
.IP
|
||||||
|
Per\-chain parameter that sets how long a particular fedpegscript is in
|
||||||
|
effect for.
|
||||||
|
|
|
||||||
1023
doc/man/elements-qt.1
Normal file
1023
doc/man/elements-qt.1
Normal file
File diff suppressed because it is too large
Load diff
|
|
@ -1,20 +1,20 @@
|
||||||
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.10.
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
|
||||||
.TH ELEMENTS-TX "1" "May 2019" "elements-tx v0.17.0.1" "User Commands"
|
.TH ELEMENTS-TX "1" "August 2022" "elements-tx v22.0.0rc2" "User Commands"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
elements-tx \- manual page for elements-tx v0.17.0.1
|
elements-tx \- manual page for elements-tx v22.0.0rc2
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B elements-tx
|
.B elements-tx
|
||||||
[\fI\,options\/\fR] \fI\,<hex-tx> \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded bitcoin transaction\/\fR
|
[\fI\,options\/\fR] \fI\,<hex-tx> \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded Elements transaction\/\fR
|
||||||
.br
|
.br
|
||||||
.B elements-tx
|
.B elements-tx
|
||||||
[\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] \fI\,Create hex-encoded bitcoin transaction\/\fR
|
[\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] \fI\,Create hex-encoded Elements transaction\/\fR
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
Elements Core elements\-tx utility version v0.17.0.1\-dirty
|
Elements Core elements\-tx utility version v22.0.0rc2
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
.HP
|
.HP
|
||||||
\-?
|
\-?
|
||||||
.IP
|
.IP
|
||||||
This help message
|
Print this help message and exit
|
||||||
.HP
|
.HP
|
||||||
\fB\-create\fR
|
\fB\-create\fR
|
||||||
.IP
|
.IP
|
||||||
|
|
@ -27,13 +27,19 @@ Select JSON output
|
||||||
\fB\-txid\fR
|
\fB\-txid\fR
|
||||||
.IP
|
.IP
|
||||||
Output only the hex\-encoded transaction id of the resultant transaction.
|
Output only the hex\-encoded transaction id of the resultant transaction.
|
||||||
|
.HP
|
||||||
|
\fB\-version\fR
|
||||||
|
.IP
|
||||||
|
Print version and exit
|
||||||
|
.PP
|
||||||
|
Debugging/Testing options:
|
||||||
.PP
|
.PP
|
||||||
Chain selection options:
|
Chain selection options:
|
||||||
.HP
|
.HP
|
||||||
\fB\-chain=\fR<chain>
|
\fB\-chain=\fR<chain>
|
||||||
.IP
|
.IP
|
||||||
Use the chain <chain> (default: main). Reserved values: main, test,
|
Use the chain <chain> (default: liquidv1). Reserved values: main, test,
|
||||||
regtest
|
signet, regtest, liquidv1, liquidv1test
|
||||||
.HP
|
.HP
|
||||||
\fB\-con_blockheightinheader\fR
|
\fB\-con_blockheightinheader\fR
|
||||||
.IP
|
.IP
|
||||||
|
|
@ -66,7 +72,8 @@ signatures are necessary to solve it.
|
||||||
.HP
|
.HP
|
||||||
\fB\-fedpegscript\fR
|
\fB\-fedpegscript\fR
|
||||||
.IP
|
.IP
|
||||||
The script for the federated peg.
|
The script for the federated peg enforce from genesis block. This script
|
||||||
|
may stop being enforced once dynamic federations activates.
|
||||||
.HP
|
.HP
|
||||||
\fB\-parentgenesisblockhash\fR
|
\fB\-parentgenesisblockhash\fR
|
||||||
.IP
|
.IP
|
||||||
|
|
@ -77,17 +84,36 @@ The genesis blockhash of the parent chain.
|
||||||
Signed blockchain enumberance. Only active when `\-con_signed_blocks` set
|
Signed blockchain enumberance. Only active when `\-con_signed_blocks` set
|
||||||
to true.
|
to true.
|
||||||
.HP
|
.HP
|
||||||
|
\fB\-signet\fR
|
||||||
|
.IP
|
||||||
|
Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network
|
||||||
|
is defined by the \fB\-signetchallenge\fR parameter
|
||||||
|
.HP
|
||||||
|
\fB\-signetchallenge\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
|
||||||
|
\fB\-signetseednode\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
|
||||||
\fB\-testnet\fR
|
\fB\-testnet\fR
|
||||||
.IP
|
.IP
|
||||||
Use the test chain
|
Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR.
|
||||||
.PP
|
.PP
|
||||||
Elements Options:
|
Elements Options:
|
||||||
.HP
|
.HP
|
||||||
\fB\-con_blocksubsidy\fR
|
\fB\-con_blocksubsidy\fR
|
||||||
.IP
|
.IP
|
||||||
Defines the amount of block subsidy to start with, at genesis block.
|
Defines the amount of block subsidy to start with, at genesis block, in
|
||||||
|
satoshis.
|
||||||
.HP
|
.HP
|
||||||
\fB\-con_connect_coinbase\fR
|
\fB\-con_connect_genesis_outputs\fR
|
||||||
.IP
|
.IP
|
||||||
Connect outputs in genesis block to utxo database.
|
Connect outputs in genesis block to utxo database.
|
||||||
.HP
|
.HP
|
||||||
|
|
@ -96,6 +122,11 @@ Connect outputs in genesis block to utxo database.
|
||||||
Starting height for CSV deployment. (default: \fB\-1\fR, which means ACTIVE
|
Starting height for CSV deployment. (default: \fB\-1\fR, which means ACTIVE
|
||||||
from genesis)
|
from genesis)
|
||||||
.HP
|
.HP
|
||||||
|
\fB\-con_dyna_deploy_signal\fR
|
||||||
|
.IP
|
||||||
|
Whether to signal for the Dynamic Federations deployment (default:
|
||||||
|
true).
|
||||||
|
.HP
|
||||||
\fB\-con_elementsmode\fR
|
\fB\-con_elementsmode\fR
|
||||||
.TP
|
.TP
|
||||||
Use Elements\-like instead of Core\-like witness encoding.
|
Use Elements\-like instead of Core\-like witness encoding.
|
||||||
|
|
@ -108,19 +139,30 @@ required for CA/CT. (default: true)
|
||||||
All non\-zero valued coinbase outputs must go to this scriptPubKey, if
|
All non\-zero valued coinbase outputs must go to this scriptPubKey, if
|
||||||
set.
|
set.
|
||||||
.HP
|
.HP
|
||||||
|
\fB\-dynamic_epoch_length\fR
|
||||||
|
.IP
|
||||||
|
Per\-chain parameter that sets how many blocks dynamic federation voting
|
||||||
|
and enforcement are in effect for.
|
||||||
|
.HP
|
||||||
\fB\-enforce_pak\fR
|
\fB\-enforce_pak\fR
|
||||||
.IP
|
.IP
|
||||||
Causes standardness checks to enforce Pegout Authorization Key(PAK)
|
Causes standardness checks to enforce Pegout Authorization Key(PAK)
|
||||||
validation, and miner to include PAK commitments when configured.
|
validation before dynamic federations, and consensus enforcement
|
||||||
Can not be set when acceptnonstdtx is set to true.
|
after.
|
||||||
.HP
|
.HP
|
||||||
\fB\-multi_data_permitted\fR
|
\fB\-multi_data_permitted\fR
|
||||||
.IP
|
.IP
|
||||||
Allow relay of multiple OP_RETURN outputs. (default: true)
|
Allow relay of multiple OP_RETURN outputs. (default: \fB\-enforce_pak\fR)
|
||||||
.HP
|
.HP
|
||||||
\fB\-pak\fR
|
\fB\-pak\fR
|
||||||
.IP
|
.IP
|
||||||
Entries in the PAK list. Order of entries matter.
|
Sets the 'first extension space' field to the pak entries ala
|
||||||
|
pre\-dynamic federations. Only used for testing in custom chains.
|
||||||
|
.HP
|
||||||
|
\fB\-total_valid_epochs\fR
|
||||||
|
.IP
|
||||||
|
Per\-chain parameter that sets how long a particular fedpegscript is in
|
||||||
|
effect for.
|
||||||
.PP
|
.PP
|
||||||
Commands:
|
Commands:
|
||||||
.IP
|
.IP
|
||||||
|
|
@ -180,7 +222,7 @@ sign=SIGHASH\-FLAGS
|
||||||
.IP
|
.IP
|
||||||
Add zero or more signatures to transaction. This command requires JSON
|
Add zero or more signatures to transaction. This command requires JSON
|
||||||
registers:prevtxs=JSON object, privatekeys=JSON object. See
|
registers:prevtxs=JSON object, privatekeys=JSON object. See
|
||||||
signrawtransaction docs for format of sighash flags, JSON
|
signrawtransactionwithkey docs for format of sighash flags, JSON
|
||||||
objects.
|
objects.
|
||||||
.PP
|
.PP
|
||||||
Register Commands:
|
Register Commands:
|
||||||
|
|
@ -197,15 +239,3 @@ Load JSON file FILENAME into register NAME
|
||||||
set=NAME:JSON\-STRING
|
set=NAME:JSON\-STRING
|
||||||
.IP
|
.IP
|
||||||
Set register NAME to given JSON\-STRING
|
Set register NAME to given JSON\-STRING
|
||||||
.SH COPYRIGHT
|
|
||||||
Copyright (C) 2009-2019 The Elements Project developers
|
|
||||||
Copyright (C) 2009-2019 The Bitcoin Core developers
|
|
||||||
|
|
||||||
Please contribute if you find Elements 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 <https://opensource.org/licenses/MIT>
|
|
||||||
|
|
||||||
|
|
|
||||||
156
doc/man/elements-util.1
Normal file
156
doc/man/elements-util.1
Normal file
|
|
@ -0,0 +1,156 @@
|
||||||
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
|
||||||
|
.TH ELEMENTS-UTIL "1" "August 2022" "elements-util v22.0.0rc2" "User Commands"
|
||||||
|
.SH NAME
|
||||||
|
elements-util \- manual page for elements-util v22.0.0rc2
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B bitcoin-util
|
||||||
|
[\fI\,options\/\fR] [\fI\,commands\/\fR] \fI\,Do stuff\/\fR
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Elements Core bitcoin\-util utility version v22.0.0rc2
|
||||||
|
.SH OPTIONS
|
||||||
|
.HP
|
||||||
|
\-?
|
||||||
|
.IP
|
||||||
|
Print this help message and exit
|
||||||
|
.HP
|
||||||
|
\fB\-version\fR
|
||||||
|
.IP
|
||||||
|
Print version and exit
|
||||||
|
.PP
|
||||||
|
Debugging/Testing options:
|
||||||
|
.PP
|
||||||
|
Chain selection options:
|
||||||
|
.HP
|
||||||
|
\fB\-chain=\fR<chain>
|
||||||
|
.IP
|
||||||
|
Use the chain <chain> (default: liquidv1). Reserved values: main, test,
|
||||||
|
signet, regtest, liquidv1, liquidv1test
|
||||||
|
.HP
|
||||||
|
\fB\-con_blockheightinheader\fR
|
||||||
|
.IP
|
||||||
|
Whether the chain includes the block height directly in the header, for
|
||||||
|
easier validation of block height in low\-resource environments.
|
||||||
|
(default: true)
|
||||||
|
.HP
|
||||||
|
\fB\-con_has_parent_chain\fR
|
||||||
|
.IP
|
||||||
|
Whether or not there is a parent chain.
|
||||||
|
.HP
|
||||||
|
\fB\-con_max_block_sig_size\fR
|
||||||
|
.IP
|
||||||
|
Max allowed witness data for the signed block header.
|
||||||
|
.HP
|
||||||
|
\fB\-con_parent_chain_signblockscript\fR
|
||||||
|
.IP
|
||||||
|
Whether parent chain uses pow or signed blocks. If the parent chain uses
|
||||||
|
signed blocks, the challenge (scriptPubKey) script. If not, an
|
||||||
|
empty string. (default: empty script [ie parent uses pow])
|
||||||
|
.HP
|
||||||
|
\fB\-con_parentpowlimit\fR
|
||||||
|
.IP
|
||||||
|
The proof\-of\-work limit value for the parent chain.
|
||||||
|
.HP
|
||||||
|
\fB\-con_signed_blocks\fR
|
||||||
|
.IP
|
||||||
|
Signed blockchain. Uses input of `\-signblockscript` to define what
|
||||||
|
signatures are necessary to solve it.
|
||||||
|
.HP
|
||||||
|
\fB\-fedpegscript\fR
|
||||||
|
.IP
|
||||||
|
The script for the federated peg enforce from genesis block. This script
|
||||||
|
may stop being enforced once dynamic federations activates.
|
||||||
|
.HP
|
||||||
|
\fB\-parentgenesisblockhash\fR
|
||||||
|
.IP
|
||||||
|
The genesis blockhash of the parent chain.
|
||||||
|
.HP
|
||||||
|
\fB\-signblockscript\fR
|
||||||
|
.IP
|
||||||
|
Signed blockchain enumberance. Only active when `\-con_signed_blocks` set
|
||||||
|
to true.
|
||||||
|
.HP
|
||||||
|
\fB\-signet\fR
|
||||||
|
.IP
|
||||||
|
Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network
|
||||||
|
is defined by the \fB\-signetchallenge\fR parameter
|
||||||
|
.HP
|
||||||
|
\fB\-signetchallenge\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
|
||||||
|
\fB\-signetseednode\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
|
||||||
|
\fB\-testnet\fR
|
||||||
|
.IP
|
||||||
|
Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR.
|
||||||
|
.PP
|
||||||
|
Elements Options:
|
||||||
|
.HP
|
||||||
|
\fB\-con_blocksubsidy\fR
|
||||||
|
.IP
|
||||||
|
Defines the amount of block subsidy to start with, at genesis block, in
|
||||||
|
satoshis.
|
||||||
|
.HP
|
||||||
|
\fB\-con_connect_genesis_outputs\fR
|
||||||
|
.IP
|
||||||
|
Connect outputs in genesis block to utxo database.
|
||||||
|
.HP
|
||||||
|
\fB\-con_csv_deploy_start\fR
|
||||||
|
.IP
|
||||||
|
Starting height for CSV deployment. (default: \fB\-1\fR, which means ACTIVE
|
||||||
|
from genesis)
|
||||||
|
.HP
|
||||||
|
\fB\-con_dyna_deploy_signal\fR
|
||||||
|
.IP
|
||||||
|
Whether to signal for the Dynamic Federations deployment (default:
|
||||||
|
true).
|
||||||
|
.HP
|
||||||
|
\fB\-con_elementsmode\fR
|
||||||
|
.TP
|
||||||
|
Use Elements\-like instead of Core\-like witness encoding.
|
||||||
|
This is
|
||||||
|
.IP
|
||||||
|
required for CA/CT. (default: true)
|
||||||
|
.HP
|
||||||
|
\fB\-con_mandatorycoinbase\fR
|
||||||
|
.IP
|
||||||
|
All non\-zero valued coinbase outputs must go to this scriptPubKey, if
|
||||||
|
set.
|
||||||
|
.HP
|
||||||
|
\fB\-dynamic_epoch_length\fR
|
||||||
|
.IP
|
||||||
|
Per\-chain parameter that sets how many blocks dynamic federation voting
|
||||||
|
and enforcement are in effect for.
|
||||||
|
.HP
|
||||||
|
\fB\-enforce_pak\fR
|
||||||
|
.IP
|
||||||
|
Causes standardness checks to enforce Pegout Authorization Key(PAK)
|
||||||
|
validation before dynamic federations, and consensus enforcement
|
||||||
|
after.
|
||||||
|
.HP
|
||||||
|
\fB\-multi_data_permitted\fR
|
||||||
|
.IP
|
||||||
|
Allow relay of multiple OP_RETURN outputs. (default: \fB\-enforce_pak\fR)
|
||||||
|
.HP
|
||||||
|
\fB\-pak\fR
|
||||||
|
.IP
|
||||||
|
Sets the 'first extension space' field to the pak entries ala
|
||||||
|
pre\-dynamic federations. Only used for testing in custom chains.
|
||||||
|
.HP
|
||||||
|
\fB\-total_valid_epochs\fR
|
||||||
|
.IP
|
||||||
|
Per\-chain parameter that sets how long a particular fedpegscript is in
|
||||||
|
effect for.
|
||||||
|
.PP
|
||||||
|
Commands:
|
||||||
|
.IP
|
||||||
|
grind
|
||||||
|
.IP
|
||||||
|
Perform proof of work on hex header string
|
||||||
|
|
@ -1,5 +1,208 @@
|
||||||
.TH ELEMENTS-WALLET "1"
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
|
||||||
|
.TH ELEMENTS-WALLET "1" "August 2022" "elements-wallet v22.0.0rc2" "User Commands"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
elements-wallet \- manual page for elements-wallet
|
elements-wallet \- manual page for elements-wallet v22.0.0rc2
|
||||||
|
.SH DESCRIPTION
|
||||||
This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
|
Elements Core elements\-wallet version v22.0.0rc2
|
||||||
|
.PP
|
||||||
|
elements\-wallet is an offline tool for creating and interacting with Elements Core wallet files.
|
||||||
|
By default elements\-wallet 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
|
||||||
|
elements\-wallet [options] <command>
|
||||||
|
.SH OPTIONS
|
||||||
|
.HP
|
||||||
|
\-?
|
||||||
|
.IP
|
||||||
|
Print this help message and exit
|
||||||
|
.HP
|
||||||
|
\fB\-datadir=\fR<dir>
|
||||||
|
.IP
|
||||||
|
Specify data directory
|
||||||
|
.HP
|
||||||
|
\fB\-descriptors\fR
|
||||||
|
.IP
|
||||||
|
Create descriptors wallet. Only for 'create'
|
||||||
|
.HP
|
||||||
|
\fB\-dumpfile=\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
|
||||||
|
\fB\-format=\fR<format>
|
||||||
|
.IP
|
||||||
|
The format of the wallet file to create. Either "bdb" or "sqlite". Only
|
||||||
|
used with 'createfromdump'
|
||||||
|
.HP
|
||||||
|
\fB\-version\fR
|
||||||
|
.IP
|
||||||
|
Print version and exit
|
||||||
|
.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\-chain=\fR<chain>
|
||||||
|
.IP
|
||||||
|
Use the chain <chain> (default: liquidv1). Reserved values: main, test,
|
||||||
|
signet, regtest, liquidv1, liquidv1test
|
||||||
|
.HP
|
||||||
|
\fB\-con_blockheightinheader\fR
|
||||||
|
.IP
|
||||||
|
Whether the chain includes the block height directly in the header, for
|
||||||
|
easier validation of block height in low\-resource environments.
|
||||||
|
(default: true)
|
||||||
|
.HP
|
||||||
|
\fB\-con_has_parent_chain\fR
|
||||||
|
.IP
|
||||||
|
Whether or not there is a parent chain.
|
||||||
|
.HP
|
||||||
|
\fB\-con_max_block_sig_size\fR
|
||||||
|
.IP
|
||||||
|
Max allowed witness data for the signed block header.
|
||||||
|
.HP
|
||||||
|
\fB\-con_parent_chain_signblockscript\fR
|
||||||
|
.IP
|
||||||
|
Whether parent chain uses pow or signed blocks. If the parent chain uses
|
||||||
|
signed blocks, the challenge (scriptPubKey) script. If not, an
|
||||||
|
empty string. (default: empty script [ie parent uses pow])
|
||||||
|
.HP
|
||||||
|
\fB\-con_parentpowlimit\fR
|
||||||
|
.IP
|
||||||
|
The proof\-of\-work limit value for the parent chain.
|
||||||
|
.HP
|
||||||
|
\fB\-con_signed_blocks\fR
|
||||||
|
.IP
|
||||||
|
Signed blockchain. Uses input of `\-signblockscript` to define what
|
||||||
|
signatures are necessary to solve it.
|
||||||
|
.HP
|
||||||
|
\fB\-fedpegscript\fR
|
||||||
|
.IP
|
||||||
|
The script for the federated peg enforce from genesis block. This script
|
||||||
|
may stop being enforced once dynamic federations activates.
|
||||||
|
.HP
|
||||||
|
\fB\-parentgenesisblockhash\fR
|
||||||
|
.IP
|
||||||
|
The genesis blockhash of the parent chain.
|
||||||
|
.HP
|
||||||
|
\fB\-signblockscript\fR
|
||||||
|
.IP
|
||||||
|
Signed blockchain enumberance. Only active when `\-con_signed_blocks` set
|
||||||
|
to true.
|
||||||
|
.HP
|
||||||
|
\fB\-signet\fR
|
||||||
|
.IP
|
||||||
|
Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network
|
||||||
|
is defined by the \fB\-signetchallenge\fR parameter
|
||||||
|
.HP
|
||||||
|
\fB\-signetchallenge\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
|
||||||
|
\fB\-signetseednode\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
|
||||||
|
\fB\-testnet\fR
|
||||||
|
.IP
|
||||||
|
Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR.
|
||||||
|
.PP
|
||||||
|
Elements Options:
|
||||||
|
.HP
|
||||||
|
\fB\-con_blocksubsidy\fR
|
||||||
|
.IP
|
||||||
|
Defines the amount of block subsidy to start with, at genesis block, in
|
||||||
|
satoshis.
|
||||||
|
.HP
|
||||||
|
\fB\-con_connect_genesis_outputs\fR
|
||||||
|
.IP
|
||||||
|
Connect outputs in genesis block to utxo database.
|
||||||
|
.HP
|
||||||
|
\fB\-con_csv_deploy_start\fR
|
||||||
|
.IP
|
||||||
|
Starting height for CSV deployment. (default: \fB\-1\fR, which means ACTIVE
|
||||||
|
from genesis)
|
||||||
|
.HP
|
||||||
|
\fB\-con_dyna_deploy_signal\fR
|
||||||
|
.IP
|
||||||
|
Whether to signal for the Dynamic Federations deployment (default:
|
||||||
|
true).
|
||||||
|
.HP
|
||||||
|
\fB\-con_elementsmode\fR
|
||||||
|
.TP
|
||||||
|
Use Elements\-like instead of Core\-like witness encoding.
|
||||||
|
This is
|
||||||
|
.IP
|
||||||
|
required for CA/CT. (default: true)
|
||||||
|
.HP
|
||||||
|
\fB\-con_mandatorycoinbase\fR
|
||||||
|
.IP
|
||||||
|
All non\-zero valued coinbase outputs must go to this scriptPubKey, if
|
||||||
|
set.
|
||||||
|
.HP
|
||||||
|
\fB\-dynamic_epoch_length\fR
|
||||||
|
.IP
|
||||||
|
Per\-chain parameter that sets how many blocks dynamic federation voting
|
||||||
|
and enforcement are in effect for.
|
||||||
|
.HP
|
||||||
|
\fB\-enforce_pak\fR
|
||||||
|
.IP
|
||||||
|
Causes standardness checks to enforce Pegout Authorization Key(PAK)
|
||||||
|
validation before dynamic federations, and consensus enforcement
|
||||||
|
after.
|
||||||
|
.HP
|
||||||
|
\fB\-multi_data_permitted\fR
|
||||||
|
.IP
|
||||||
|
Allow relay of multiple OP_RETURN outputs. (default: \fB\-enforce_pak\fR)
|
||||||
|
.HP
|
||||||
|
\fB\-pak\fR
|
||||||
|
.IP
|
||||||
|
Sets the 'first extension space' field to the pak entries ala
|
||||||
|
pre\-dynamic federations. Only used for testing in custom chains.
|
||||||
|
.HP
|
||||||
|
\fB\-total_valid_epochs\fR
|
||||||
|
.IP
|
||||||
|
Per\-chain parameter that sets how long a particular fedpegscript is in
|
||||||
|
effect for.
|
||||||
|
.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 key\-value records
|
||||||
|
.IP
|
||||||
|
info
|
||||||
|
.IP
|
||||||
|
Get wallet info
|
||||||
|
.IP
|
||||||
|
salvage
|
||||||
|
.IP
|
||||||
|
Attempt to recover private keys from a corrupt wallet. Warning:
|
||||||
|
\&'salvage' is experimental.
|
||||||
|
|
|
||||||
1014
doc/man/elementsd.1
1014
doc/man/elementsd.1
File diff suppressed because it is too large
Load diff
Loading…
Add table
Add a link
Reference in a new issue