mirror of
https://github.com/ElementsProject/elements.git
synced 2026-08-13 12:33:42 +02:00
209 lines
5.6 KiB
Groff
209 lines
5.6 KiB
Groff
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.10.
|
|
.TH ELEMENTS-CLI "1" "August 2019" "elements-cli v0.18.1.0" "User Commands"
|
|
.SH NAME
|
|
elements-cli \- manual page for elements-cli v0.18.1.0
|
|
.SH SYNOPSIS
|
|
.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 v0.18.1.0\-dirty
|
|
.SH OPTIONS
|
|
.HP
|
|
\-?
|
|
.IP
|
|
Print this help message and exit
|
|
.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\-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\-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: 8332, testnet: 18332, 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\-rpcwallet=\fR<walletname>
|
|
.IP
|
|
Send RPC for non\-default wallet on RPC server (needs to exactly match
|
|
corresponding \fB\-wallet\fR option passed to the daemon). 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.
|
|
.HP
|
|
\fB\-version\fR
|
|
.IP
|
|
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, 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_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-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>
|
|
|
|
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.
|