Skip to content

Commit d1f5351

Browse files
stevenroosestevenroose
committed
Update man pages
1 parent e1cd00c commit d1f5351

File tree

4 files changed

+468
-46
lines changed

4 files changed

+468
-46
lines changed

‎doc/man/Makefile.am‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
dist_man1_MANS=
22

33
if BUILD_BITCOIND
4-
dist_man1_MANS+=bitcoind.1
4+
dist_man1_MANS+=elementsd.1
55
endif
66

77
if ENABLE_QT
88
dist_man1_MANS+=bitcoin-qt.1
99
endif
1010

1111
if BUILD_BITCOIN_UTILS
12-
dist_man1_MANS+=bitcoin-cli.1 bitcoin-tx.1
12+
dist_man1_MANS+=elements-cli.1 elements-tx.1
1313
endif

doc/man/bitcoin-cli.1 renamed to doc/man/elements-cli.1

Lines changed: 104 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
2-
.TH BITCOIN-CLI "1" "September 2018" "bitcoin-cli v0.17.0.0" "User Commands"
1+
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8.
2+
.TH ELEMENTS-CLI "1" "March 2019" "elements-cli v0.17.0.0" "User Commands"
33
.SH NAME
4-
bitcoin-cli \- manual page for bitcoin-cli v0.17.0.0
4+
elements-cli \- manual page for elements-cli v0.17.0.0
55
.SH SYNOPSIS
6-
.B bitcoin-cli
7-
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR
6+
.B elements-cli
7+
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Elements Core\/\fR
88
.br
9-
.B bitcoin-cli
10-
[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Bitcoin Core (with named arguments)\/\fR
9+
.B elements-cli
10+
[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Elements Core (with named arguments)\/\fR
1111
.br
12-
.B bitcoin-cli
12+
.B elements-cli
1313
[\fI\,options\/\fR] \fI\,help List commands\/\fR
1414
.br
15-
.B bitcoin-cli
15+
.B elements-cli
1616
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR
1717
.SH DESCRIPTION
18-
Bitcoin Core RPC client version v0.17.0.0
18+
Elements Core RPC client version v0.17.0.0
1919
.SH OPTIONS
2020
.HP
2121
\-?
@@ -25,7 +25,7 @@ This help message
2525
\fB\-conf=\fR<file>
2626
.IP
2727
Specify configuration file. Relative paths will be prefixed by datadir
28-
location. (default: bitcoin.conf)
28+
location. (default: elements.conf)
2929
.HP
3030
\fB\-datadir=\fR<dir>
3131
.IP
@@ -63,7 +63,8 @@ Password for JSON\-RPC connections
6363
.HP
6464
\fB\-rpcport=\fR<port>
6565
.IP
66-
Connect to JSON\-RPC on <port> (default: 8332 or testnet: 18332)
66+
Connect to JSON\-RPC on <port> (default: 8332, testnet: 18332, regtest:
67+
18443)
6768
.HP
6869
\fB\-rpcuser=\fR<user>
6970
.IP
@@ -76,7 +77,7 @@ Wait for RPC server to start
7677
\fB\-rpcwallet=\fR<walletname>
7778
.IP
7879
Send RPC for non\-default wallet on RPC server (needs to exactly match
79-
corresponding \fB\-wallet\fR option passed to bitcoind)
80+
corresponding \fB\-wallet\fR option passed to the daemon)
8081
.HP
8182
\fB\-stdin\fR
8283
.IP
@@ -97,13 +98,102 @@ Print version and exit
9798
.PP
9899
Chain selection options:
99100
.HP
101+
\fB\-chain=\fR<chain>
102+
.IP
103+
Use the chain <chain> (default: main). Reserved values: main, test,
104+
regtest
105+
.HP
106+
\fB\-con_blockheightinheader\fR
107+
.IP
108+
Whether the chain includes the block height directly in the header, for
109+
easier validation of block height in low\-resource environments.
110+
(default: true)
111+
.HP
112+
\fB\-con_has_parent_chain\fR
113+
.IP
114+
Whether or not there is a parent chain.
115+
.HP
116+
\fB\-con_max_block_sig_size\fR
117+
.IP
118+
Max allowed witness data for the signed block header.
119+
.HP
120+
\fB\-con_parent_chain_signblockscript\fR
121+
.IP
122+
Whether parent chain uses pow or signed blocks. If the parent chain uses
123+
signed blocks, the challenge (scriptPubKey) script. If not, an
124+
empty string. (default: empty script [ie parent uses pow])
125+
.HP
126+
\fB\-con_parentpowlimit\fR
127+
.IP
128+
The proof\-of\-work limit value for the parent chain.
129+
.HP
130+
\fB\-con_signed_blocks\fR
131+
.IP
132+
Signed blockchain. Uses input of `\-signblockscript` to define what
133+
signatures are necessary to solve it.
134+
.HP
135+
\fB\-fedpegscript\fR
136+
.IP
137+
The script for the federated peg.
138+
.HP
139+
\fB\-parentgenesisblockhash\fR
140+
.IP
141+
The genesis blockhash of the parent chain.
142+
.HP
143+
\fB\-signblockscript\fR
144+
.IP
145+
Signed blockchain enumberance. Only active when `\-con_signed_blocks` set
146+
to true.
147+
.HP
100148
\fB\-testnet\fR
101149
.IP
102150
Use the test chain
151+
.PP
152+
Elements Options:
153+
.HP
154+
\fB\-con_blocksubsidy\fR
155+
.IP
156+
Defines the amount of block subsidy to start with, at genesis block.
157+
.HP
158+
\fB\-con_connect_coinbase\fR
159+
.IP
160+
Connect outputs in genesis block to utxo database.
161+
.HP
162+
\fB\-con_csv_deploy_start\fR
163+
.IP
164+
Starting height for CSV deployment. (default: \fB\-1\fR, which means ACTIVE
165+
from genesis)
166+
.HP
167+
\fB\-con_elementsmode\fR
168+
.TP
169+
Use Elements\-like instead of Core\-like witness encoding.
170+
This is
171+
.IP
172+
required for CA/CT. (default: true)
173+
.HP
174+
\fB\-con_mandatorycoinbase\fR
175+
.IP
176+
All non\-zero valued coinbase outputs must go to this scriptPubKey, if
177+
set.
178+
.HP
179+
\fB\-enforce_pak\fR
180+
.IP
181+
Causes standardness checks to enforce Pegout Authorization Key(PAK)
182+
validation, and miner to include PAK commitments when configured.
183+
Can not be set when acceptnonstdtx is set to true.
184+
.HP
185+
\fB\-multi_data_permitted\fR
186+
.IP
187+
Allow relay of multiple OP_RETURN outputs. (default: true)
188+
.HP
189+
\fB\-pak\fR
190+
.IP
191+
Entries in the PAK list. Order of entries matter.
103192
.SH COPYRIGHT
193+
Copyright (C) 2009-2018 The Elements Project developers
104194
Copyright (C) 2009-2018 The Bitcoin Core developers
105195

106-
Please contribute if you find Bitcoin Core useful. Visit
196+
Please contribute if you find Elements Core useful. Visit
107197
<https://bitcoincore.org> for further information about the software.
108198
The source code is available from <https://github.com/bitcoin/bitcoin>.
109199

doc/man/bitcoin-tx.1 renamed to doc/man/elements-tx.1

Lines changed: 102 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
2-
.TH BITCOIN-TX "1" "September 2018" "bitcoin-tx v0.17.0.0" "User Commands"
1+
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8.
2+
.TH ELEMENTS-TX "1" "March 2019" "elements-tx v0.17.0.0" "User Commands"
33
.SH NAME
4-
bitcoin-tx \- manual page for bitcoin-tx v0.17.0.0
4+
elements-tx \- manual page for elements-tx v0.17.0.0
55
.SH SYNOPSIS
6-
.B bitcoin-tx
6+
.B elements-tx
77
[\fI\,options\/\fR] \fI\,<hex-tx> \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded bitcoin transaction\/\fR
88
.br
9-
.B bitcoin-tx
9+
.B elements-tx
1010
[\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] \fI\,Create hex-encoded bitcoin transaction\/\fR
1111
.SH DESCRIPTION
12-
Bitcoin Core bitcoin\-tx utility version v0.17.0.0
12+
Elements Core elements\-tx utility version v0.17.0.0
1313
.SH OPTIONS
1414
.HP
1515
\-?
@@ -30,10 +30,98 @@ Output only the hex\-encoded transaction id of the resultant transaction.
3030
.PP
3131
Chain selection options:
3232
.HP
33+
\fB\-chain=\fR<chain>
34+
.IP
35+
Use the chain <chain> (default: main). Reserved values: main, test,
36+
regtest
37+
.HP
38+
\fB\-con_blockheightinheader\fR
39+
.IP
40+
Whether the chain includes the block height directly in the header, for
41+
easier validation of block height in low\-resource environments.
42+
(default: true)
43+
.HP
44+
\fB\-con_has_parent_chain\fR
45+
.IP
46+
Whether or not there is a parent chain.
47+
.HP
48+
\fB\-con_max_block_sig_size\fR
49+
.IP
50+
Max allowed witness data for the signed block header.
51+
.HP
52+
\fB\-con_parent_chain_signblockscript\fR
53+
.IP
54+
Whether parent chain uses pow or signed blocks. If the parent chain uses
55+
signed blocks, the challenge (scriptPubKey) script. If not, an
56+
empty string. (default: empty script [ie parent uses pow])
57+
.HP
58+
\fB\-con_parentpowlimit\fR
59+
.IP
60+
The proof\-of\-work limit value for the parent chain.
61+
.HP
62+
\fB\-con_signed_blocks\fR
63+
.IP
64+
Signed blockchain. Uses input of `\-signblockscript` to define what
65+
signatures are necessary to solve it.
66+
.HP
67+
\fB\-fedpegscript\fR
68+
.IP
69+
The script for the federated peg.
70+
.HP
71+
\fB\-parentgenesisblockhash\fR
72+
.IP
73+
The genesis blockhash of the parent chain.
74+
.HP
75+
\fB\-signblockscript\fR
76+
.IP
77+
Signed blockchain enumberance. Only active when `\-con_signed_blocks` set
78+
to true.
79+
.HP
3380
\fB\-testnet\fR
3481
.IP
3582
Use the test chain
3683
.PP
84+
Elements Options:
85+
.HP
86+
\fB\-con_blocksubsidy\fR
87+
.IP
88+
Defines the amount of block subsidy to start with, at genesis block.
89+
.HP
90+
\fB\-con_connect_coinbase\fR
91+
.IP
92+
Connect outputs in genesis block to utxo database.
93+
.HP
94+
\fB\-con_csv_deploy_start\fR
95+
.IP
96+
Starting height for CSV deployment. (default: \fB\-1\fR, which means ACTIVE
97+
from genesis)
98+
.HP
99+
\fB\-con_elementsmode\fR
100+
.TP
101+
Use Elements\-like instead of Core\-like witness encoding.
102+
This is
103+
.IP
104+
required for CA/CT. (default: true)
105+
.HP
106+
\fB\-con_mandatorycoinbase\fR
107+
.IP
108+
All non\-zero valued coinbase outputs must go to this scriptPubKey, if
109+
set.
110+
.HP
111+
\fB\-enforce_pak\fR
112+
.IP
113+
Causes standardness checks to enforce Pegout Authorization Key(PAK)
114+
validation, and miner to include PAK commitments when configured.
115+
Can not be set when acceptnonstdtx is set to true.
116+
.HP
117+
\fB\-multi_data_permitted\fR
118+
.IP
119+
Allow relay of multiple OP_RETURN outputs. (default: true)
120+
.HP
121+
\fB\-pak\fR
122+
.IP
123+
Entries in the PAK list. Order of entries matter.
124+
.PP
37125
Commands:
38126
.IP
39127
delin=N
@@ -56,7 +144,7 @@ nversion=N
56144
.IP
57145
Set TX version to N
58146
.IP
59-
outaddr=VALUE:ADDRESS
147+
outaddr=VALUE:ADDRESS(:ASSET)
60148
.IP
61149
Add address\-based output to TX
62150
.IP
@@ -96,6 +184,11 @@ signrawtransaction docs for format of sighash flags, JSON
96184
objects.
97185
.PP
98186
Register Commands:
187+
.HP
188+
\fB\-serialization\fR=\fI\,TYPE\/\fR
189+
.IP
190+
Sets the serialization of transactions. ELEMENTS or BITCOIN are the two
191+
valid options.
99192
.IP
100193
load=NAME:FILENAME
101194
.IP
@@ -105,9 +198,10 @@ set=NAME:JSON\-STRING
105198
.IP
106199
Set register NAME to given JSON\-STRING
107200
.SH COPYRIGHT
201+
Copyright (C) 2009-2018 The Elements Project developers
108202
Copyright (C) 2009-2018 The Bitcoin Core developers
109203

110-
Please contribute if you find Bitcoin Core useful. Visit
204+
Please contribute if you find Elements Core useful. Visit
111205
<https://bitcoincore.org> for further information about the software.
112206
The source code is available from <https://github.com/bitcoin/bitcoin>.
113207

0 commit comments

Comments
 (0)