GlcoinCore/elements
1
0
Fork 0
mirror of https://github.com/ElementsProject/elements.git synced 2026-08-14 12:43:40 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update man pages

Browse source
This commit is contained in:
Steven Roose 2019-03-21 17:06:57 +00:00
parent e1cd00cc6c
commit d1f535176d
No known key found for this signature in database
GPG key ID: 7FC91380BB4CE800
4 changed files with 468 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/man/Makefile.am
View file

@ -1,7 +1,7 @@
dist_man1_MANS=
if BUILD_BITCOIND
dist_man1_MANS+=bitcoind.1
dist_man1_MANS+=elementsd.1
endif
if ENABLE_QT
@ -9,5 +9,5 @@ if ENABLE_QT
endif
if BUILD_BITCOIN_UTILS
dist_man1_MANS+=bitcoin-cli.1 bitcoin-tx.1
dist_man1_MANS+=elements-cli.1 elements-tx.1
endif

118
doc/man/bitcoin-cli.1 → doc/man/elements-cli.1
View file

@ -1,21 +1,21 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH BITCOIN-CLI "1" "September 2018" "bitcoin-cli v0.17.0.0" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8.
.TH ELEMENTS-CLI "1" "March 2019" "elements-cli v0.17.0.0" "User Commands"
.SH NAME
bitcoin-cli \- manual page for bitcoin-cli v0.17.0.0
elements-cli \- manual page for elements-cli v0.17.0.0
.SH SYNOPSIS
.B bitcoin-cli
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR
.B elements-cli
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Elements Core\/\fR
.br
.B bitcoin-cli
[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Bitcoin Core (with named arguments)\/\fR
.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 bitcoin-cli
.B elements-cli
[\fI\,options\/\fR] \fI\,help List commands\/\fR
.br
.B bitcoin-cli
.B elements-cli
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR
.SH DESCRIPTION
Bitcoin Core RPC client version v0.17.0.0
Elements Core RPC client version v0.17.0.0
.SH OPTIONS
.HP
\-?
@ -25,7 +25,7 @@ This help message
\fB\-conf=\fR<file>
.IP
Specify configuration file. Relative paths will be prefixed by datadir
location. (default: bitcoin.conf)
location. (default: elements.conf)
.HP
\fB\-datadir=\fR<dir>
.IP
@ -63,7 +63,8 @@ Password for JSON\-RPC connections
.HP
\fB\-rpcport=\fR<port>
.IP
Connect to JSON\-RPC on <port> (default: 8332 or testnet: 18332)
Connect to JSON\-RPC on <port> (default: 8332, testnet: 18332, regtest:
18443)
.HP
\fB\-rpcuser=\fR<user>
.IP
@ -76,7 +77,7 @@ Wait for RPC server to start
\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 bitcoind)
corresponding \fB\-wallet\fR option passed to the daemon)
.HP
\fB\-stdin\fR
.IP
@ -97,13 +98,102 @@ Print version and exit
.PP
Chain selection options:
.HP
\fB\-chain=\fR<chain>
.IP
Use the chain <chain> (default: main). Reserved values: main, test,
regtest
.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.
.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\-testnet\fR
.IP
Use the test chain
.PP
Elements Options:
.HP
\fB\-con_blocksubsidy\fR
.IP
Defines the amount of block subsidy to start with, at genesis block.
.HP
\fB\-con_connect_coinbase\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_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\-enforce_pak\fR
.IP
Causes standardness checks to enforce Pegout Authorization Key(PAK)
validation, and miner to include PAK commitments when configured.
Can not be set when acceptnonstdtx is set to true.
.HP
\fB\-multi_data_permitted\fR
.IP
Allow relay of multiple OP_RETURN outputs. (default: true)
.HP
\fB\-pak\fR
.IP
Entries in the PAK list. Order of entries matter.
.SH COPYRIGHT
Copyright (C) 2009-2018 The Elements Project developers
Copyright (C) 2009-2018 The Bitcoin Core developers
Please contribute if you find Bitcoin Core useful. Visit
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>.

110
doc/man/bitcoin-tx.1 → doc/man/elements-tx.1
View file

@ -1,15 +1,15 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH BITCOIN-TX "1" "September 2018" "bitcoin-tx v0.17.0.0" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8.
.TH ELEMENTS-TX "1" "March 2019" "elements-tx v0.17.0.0" "User Commands"
.SH NAME
bitcoin-tx \- manual page for bitcoin-tx v0.17.0.0
elements-tx \- manual page for elements-tx v0.17.0.0
.SH SYNOPSIS
.B bitcoin-tx
.B elements-tx
[\fI\,options\/\fR] \fI\,<hex-tx> \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded bitcoin transaction\/\fR
.br
.B bitcoin-tx
.B elements-tx
[\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] \fI\,Create hex-encoded bitcoin transaction\/\fR
.SH DESCRIPTION
Bitcoin Core bitcoin\-tx utility version v0.17.0.0
Elements Core elements\-tx utility version v0.17.0.0
.SH OPTIONS
.HP
\-?
@ -30,10 +30,98 @@ Output only the hex\-encoded transaction id of the resultant transaction.
.PP
Chain selection options:
.HP
\fB\-chain=\fR<chain>
.IP
Use the chain <chain> (default: main). Reserved values: main, test,
regtest
.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.
.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\-testnet\fR
.IP
Use the test chain
.PP
Elements Options:
.HP
\fB\-con_blocksubsidy\fR
.IP
Defines the amount of block subsidy to start with, at genesis block.
.HP
\fB\-con_connect_coinbase\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_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\-enforce_pak\fR
.IP
Causes standardness checks to enforce Pegout Authorization Key(PAK)
validation, and miner to include PAK commitments when configured.
Can not be set when acceptnonstdtx is set to true.
.HP
\fB\-multi_data_permitted\fR
.IP
Allow relay of multiple OP_RETURN outputs. (default: true)
.HP
\fB\-pak\fR
.IP
Entries in the PAK list. Order of entries matter.
.PP
Commands:
.IP
delin=N
@ -56,7 +144,7 @@ nversion=N
.IP
Set TX version to N
.IP
outaddr=VALUE:ADDRESS
outaddr=VALUE:ADDRESS(:ASSET)
.IP
Add address\-based output to TX
.IP
@ -96,6 +184,11 @@ signrawtransaction docs for format of sighash flags, JSON
objects.
.PP
Register Commands:
.HP
\fB\-serialization\fR=\fI\,TYPE\/\fR
.IP
Sets the serialization of transactions. ELEMENTS or BITCOIN are the two
valid options.
.IP
load=NAME:FILENAME
.IP
@ -105,9 +198,10 @@ set=NAME:JSON\-STRING
.IP
Set register NAME to given JSON\-STRING
.SH COPYRIGHT
Copyright (C) 2009-2018 The Elements Project developers
Copyright (C) 2009-2018 The Bitcoin Core developers
Please contribute if you find Bitcoin Core useful. Visit
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>.

282
doc/man/bitcoind.1 → doc/man/elementsd.1
View file

@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH BITCOIND "1" "September 2018" "bitcoind v0.17.0.0" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8.
.TH ELEMENTSD "1" "March 2019" "elementsd v0.17.0.0" "User Commands"
.SH NAME
bitcoind \- manual page for bitcoind v0.17.0.0
elementsd \- manual page for elementsd v0.17.0.0
.SH SYNOPSIS
.B bitcoind
[\fI\,options\/\fR] \fI\,Start Bitcoin Core Daemon\/\fR
.B elementsd
[\fI\,options\/\fR] \fI\,Start Elements Core Daemon\/\fR
.SH DESCRIPTION
Bitcoin Core Daemon version v0.17.0.0
Elements Core Daemon version v0.17.0.0
.SH OPTIONS
.HP
\-?
@ -44,7 +44,7 @@ Specify blocks directory (default: <datadir>/blocks)
\fB\-conf=\fR<file>
.IP
Specify configuration file. Relative paths will be prefixed by datadir
location. (default: bitcoin.conf)
location. (default: elements.conf)
.HP
\fB\-daemon\fR
.IP
@ -98,7 +98,7 @@ Whether to save the mempool on shutdown and load on restart (default: 1)
\fB\-pid=\fR<file>
.IP
Specify pid file. Relative paths will be prefixed by a net\-specific
datadir location. (default: bitcoind.pid)
datadir location. (default: elementsd.pid)
.HP
\fB\-prune=\fR<n>
.IP
@ -118,7 +118,9 @@ 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
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
@ -179,7 +181,7 @@ unless \fB\-connect\fR used)
.HP
\fB\-enablebip61\fR
.IP
Send reject messages per BIP61 (default: 1)
Send reject messages per BIP61 (default: 0)
.HP
\fB\-externalip=\fR<ip>
.IP
@ -243,7 +245,8 @@ Relay non\-P2SH multisig (default: 1)
.HP
\fB\-port=\fR<port>
.IP
Listen for connections on <port> (default: 8333 or testnet: 18333)
Listen for connections on <port> (default: 8333, testnet: 18333,
regtest: 18444)
.HP
\fB\-proxy=\fR<ip:port>
.IP
@ -274,10 +277,6 @@ Tor control port to use if onion listening enabled (default:
.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<addr>
.IP
Bind to given address and whitelist peers connecting to it. Use
@ -389,14 +388,13 @@ by TxID)
.HP
\fB\-walletrbf\fR
.IP
Send transactions with full\-RBF opt\-in enabled (RPC only, default: 0)
Send transactions with full\-RBF opt\-in enabled (RPC only, default: 1)
.HP
\fB\-zapwallettxes=\fR<mode>
.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.
account owner and payment request information, 2 = drop tx meta
data)
payment request information, 2 = drop tx meta data)
.PP
ZeroMQ notification options:
.HP
@ -435,7 +433,7 @@ or more specified categories.
.HP
\fB\-help\-debug\fR
.IP
Show all debugging options (usage: \fB\-\-help\fR \fB\-help\-debug\fR)
Print help message with debugging options and exit
.HP
\fB\-logips\fR
.IP
@ -466,6 +464,136 @@ Append comment to the user agent string
.PP
Chain selection options:
.HP
\fB\-bech32_hrp\fR
.IP
The human\-readable part of the chain's bech32 encoding. (default: bc)
.HP
\fB\-blech32_hrp\fR
.IP
The human\-readable part of the chain's blech32 encoding. Used in
confidential addresses.(default: )
.HP
\fB\-chain=\fR<chain>
.IP
Use the chain <chain> (default: main). Reserved values: main, test,
regtest
.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_parent_pegged_asset=\fR<hex>
.IP
Asset ID (hex) for pegged asset for when parent chain has CA. (default:
0x00)
.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\-ct_bits\fR
.IP
The default number of hiding bits in a rangeproof. Will be exceeded to
cover amounts exceeding the maximum hiding value. (default: 36)
.HP
\fB\-ct_exponent\fR
.IP
The hiding exponent. (default: 0)
.HP
\fB\-extprvkeyprefix\fR
.IP
The 4\-byte prefix, in hex, of the chain's base58 extended private key
encoding. (default: 0488ade4)
.HP
\fB\-extpubkeyprefix\fR
.IP
The 4\-byte prefix, in hex, of the chain's base58 extended public key
encoding. (default: 0488b21e)
.HP
\fB\-fedpegscript\fR
.IP
The script for the federated peg.
.HP
\fB\-feeasset=\fR<hex>
.IP
Asset ID (hex) for mempool/relay fees (default:
0000000000000000000000000000000000000000000000000000000000000000)
.HP
\fB\-initialreissuancetokens=\fR<n>
.IP
The amount of reissuance tokens created in the genesis block. (default:
0)
.HP
\fB\-parent_bech32_hrp\fR
.IP
The human\-readable part of the parent chain's bech32 encoding. (default:
bc)
.HP
\fB\-parent_blech32_hrp\fR
.IP
The human\-readable part of the parent chain's blech32 encoding.
(default: bc)
.HP
\fB\-parentgenesisblockhash\fR
.IP
The genesis blockhash of the parent chain.
.HP
\fB\-parentpubkeyprefix\fR
.IP
The byte prefix, in decimal, of the parent chain's base58 pubkey
address. (default: 111)
.HP
\fB\-parentscriptprefix\fR
.IP
The byte prefix, in decimal, of the parent chain's base58 script
address. (default: 196)
.HP
\fB\-pubkeyprefix\fR
.IP
The byte prefix, in decimal, of the chain's base58 pubkey address.
(default: 0)
.HP
\fB\-scriptprefix\fR
.IP
The byte prefix, in decimal, of the chain's base58 script address.
(default: 5)
.HP
\fB\-secretprefix\fR
.IP
The byte prefix, in decimal, of the chain's base58 secret key encoding.
(default: 128)
.HP
\fB\-signblockscript\fR
.IP
Signed blockchain enumberance. Only active when `\-con_signed_blocks` set
to true.
.HP
\fB\-subsidyasset=\fR<hex>
.IP
Asset ID (hex) for the block subsidy (default:
0000000000000000000000000000000000000000000000000000000000000000)
.HP
\fB\-testnet\fR
.IP
Use the test chain
@ -558,8 +686,8 @@ Password for JSON\-RPC connections
.HP
\fB\-rpcport=\fR<port>
.IP
Listen for JSON\-RPC connections on <port> (default: 8332 or testnet:
18332)
Listen for JSON\-RPC connections on <port> (default: 8332, testnet:
18332, regtest: 18443)
.HP
\fB\-rpcserialversion\fR
.IP
@ -577,10 +705,120 @@ Username for JSON\-RPC connections
\fB\-server\fR
.IP
Accept command line and JSON\-RPC commands
.PP
Elements Options:
.HP
\fB\-assetdir\fR
.IP
Entries of pet names of assets, in this format:asset=<hex>:<label>.
There can be any number of entries.
.HP
\fB\-blindedaddresses\fR
.IP
Give blind addresses by default via getnewaddress and
getrawchangeaddress. (default: \fB\-con_elementsmode\fR value)
.HP
\fB\-blindedprefix\fR
.IP
The byte prefix, in decimal, of blinded addresses. (default: 4)
.HP
\fB\-con_blocksubsidy\fR
.IP
Defines the amount of block subsidy to start with, at genesis block.
.HP
\fB\-con_connect_coinbase\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_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\-defaultpeggedassetname\fR
.IP
Default name of the pegged asset. (default: bitcoin)
.HP
\fB\-enforce_pak\fR
.IP
Causes standardness checks to enforce Pegout Authorization Key(PAK)
validation, and miner to include PAK commitments when configured.
Can not be set when acceptnonstdtx is set to true.
.HP
\fB\-mainchainrpccookiefile=\fR<file>
.IP
The mainchain daemon cookie auth path which the daemon will use to
connect to the trusted mainchain daemon to validate peg\-ins.
(default: `<datadir>/regtest/.cookie`)
.HP
\fB\-mainchainrpchost=\fR<host>
.IP
The address which the daemon will try to connect to the trusted
mainchain daemon to validate peg\-ins, if enabled. (default:
127.0.0.1)
.HP
\fB\-mainchainrpcpassword=\fR<pwd>
.IP
The rpc password which the daemon will use to connect to the trusted
mainchain daemon to validate peg\-ins, if enabled. (default:
cookie auth)
.HP
\fB\-mainchainrpcport=\fR<n>
.IP
The port which the daemon will try to connect to the trusted mainchain
daemon to validate peg\-ins, if enabled. (default: 18332)
.HP
\fB\-mainchainrpctimeout=\fR<n>
.IP
Timeout in seconds during mainchain RPC requests, or 0 for no timeout.
(default: 900)
.HP
\fB\-mainchainrpcuser=\fR<user>
.IP
The rpc username that the daemon will use to connect to the trusted
mainchain daemon to validate peg\-ins, if enabled. (default:
cookie auth)
.HP
\fB\-multi_data_permitted\fR
.IP
Allow relay of multiple OP_RETURN outputs. (default: true)
.HP
\fB\-pak\fR
.IP
Entries in the PAK list. Order of entries matter.
.HP
\fB\-peginconfirmationdepth=\fR<n>
.IP
Pegin claims must be this deep to be considered valid. (default: 8)
.HP
\fB\-recheckpeginblockinterval=\fR<n>
.IP
The interval in seconds at which a peg\-in witness failing block is
re\-evaluated in case of intermittent peg\-in witness failure. 0
means never. (default: 120)
.HP
\fB\-validatepegin\fR
.IP
Validate peg\-in claims. An RPC connection will be attempted to the
trusted mainchain daemon using the `mainchain*` settings below.
All functionaries must run this enabled. (default: 0)
.SH COPYRIGHT
Copyright (C) 2009-2018 The Elements Project developers
Copyright (C) 2009-2018 The Bitcoin Core developers
Please contribute if you find Bitcoin Core useful. Visit
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>.