Skip to content

Commit a582ffd

Browse files
authored
Merge pull request #1264 from psgreco/master-manpages
Fix Makefile and placeholders for manpages
2 parents 33f2f6b + 0a1b02a commit a582ffd

4 files changed

Lines changed: 12 additions & 214 deletions

File tree

doc/man/Makefile.am

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ if BUILD_BITCOIND
55
endif
66

77
if ENABLE_QT
8-
#TODO(stevenroose) uncomment and fix
9-
# dist_man1_MANS+=elements-qt.1
8+
dist_man1_MANS+=elements-qt.1
109
endif
1110

1211
if BUILD_BITCOIN_CLI
@@ -18,7 +17,7 @@ if BUILD_BITCOIN_TX
1817
endif
1918

2019
if BUILD_BITCOIN_UTIL
21-
dist_man1_MANS+=bitcoin-util.1
20+
dist_man1_MANS+=elements-util.1
2221
endif
2322

2423
if ENABLE_WALLET
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
.TH BITCOIN-UTIL "1"
1+
.TH ELEMENTS-QT "1"
22
.SH NAME
3-
bitcoin-util \- manual page for bitcoin-util
3+
elements-qt \- manual page for elements-qt
44

55
This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.

doc/man/elements-tx.1

Lines changed: 3 additions & 209 deletions
Original file line numberDiff line numberDiff line change
@@ -1,211 +1,5 @@
1-
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.10.
2-
.TH ELEMENTS-TX "1" "May 2019" "elements-tx v0.17.0.1" "User Commands"
1+
.TH ELEMENTS-TX "1"
32
.SH NAME
4-
elements-tx \- manual page for elements-tx v0.17.0.1
5-
.SH SYNOPSIS
6-
.B elements-tx
7-
[\fI\,options\/\fR] \fI\,<hex-tx> \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded bitcoin transaction\/\fR
8-
.br
9-
.B elements-tx
10-
[\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] \fI\,Create hex-encoded bitcoin transaction\/\fR
11-
.SH DESCRIPTION
12-
Elements Core elements\-tx utility version v0.17.0.1\-dirty
13-
.SH OPTIONS
14-
.HP
15-
\-?
16-
.IP
17-
This help message
18-
.HP
19-
\fB\-create\fR
20-
.IP
21-
Create new, empty TX.
22-
.HP
23-
\fB\-json\fR
24-
.IP
25-
Select JSON output
26-
.HP
27-
\fB\-txid\fR
28-
.IP
29-
Output only the hex\-encoded transaction id of the resultant transaction.
30-
.PP
31-
Chain selection options:
32-
.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
80-
\fB\-testnet\fR
81-
.IP
82-
Use the test chain
83-
.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
125-
Commands:
126-
.IP
127-
delin=N
128-
.IP
129-
Delete input N from TX
130-
.IP
131-
delout=N
132-
.IP
133-
Delete output N from TX
134-
.IP
135-
in=TXID:VOUT(:SEQUENCE_NUMBER)
136-
.IP
137-
Add input to TX
138-
.IP
139-
locktime=N
140-
.IP
141-
Set TX lock time to N
142-
.IP
143-
nversion=N
144-
.IP
145-
Set TX version to N
146-
.IP
147-
outaddr=VALUE:ADDRESS(:ASSET)
148-
.IP
149-
Add address\-based output to TX
150-
.IP
151-
outdata=[VALUE:]DATA
152-
.IP
153-
Add data\-based output to TX
154-
.IP
155-
outmultisig=VALUE:REQUIRED:PUBKEYS:PUBKEY1:PUBKEY2:....[:FLAGS]
156-
.IP
157-
Add Pay To n\-of\-m Multi\-sig output to TX. n = REQUIRED, m = PUBKEYS.
158-
Optionally add the "W" flag to produce a
159-
pay\-to\-witness\-script\-hash output. Optionally add the "S" flag to
160-
wrap the output in a pay\-to\-script\-hash.
161-
.IP
162-
outpubkey=VALUE:PUBKEY[:FLAGS]
163-
.IP
164-
Add pay\-to\-pubkey output to TX. Optionally add the "W" flag to produce a
165-
pay\-to\-witness\-pubkey\-hash output. Optionally add the "S" flag to
166-
wrap the output in a pay\-to\-script\-hash.
167-
.IP
168-
outscript=VALUE:SCRIPT[:FLAGS]
169-
.IP
170-
Add raw script output to TX. Optionally add the "W" flag to produce a
171-
pay\-to\-witness\-script\-hash output. Optionally add the "S" flag to
172-
wrap the output in a pay\-to\-script\-hash.
173-
.IP
174-
replaceable(=N)
175-
.IP
176-
Set RBF opt\-in sequence number for input N (if not provided, opt\-in all
177-
available inputs)
178-
.IP
179-
sign=SIGHASH\-FLAGS
180-
.IP
181-
Add zero or more signatures to transaction. This command requires JSON
182-
registers:prevtxs=JSON object, privatekeys=JSON object. See
183-
signrawtransaction docs for format of sighash flags, JSON
184-
objects.
185-
.PP
186-
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.
192-
.IP
193-
load=NAME:FILENAME
194-
.IP
195-
Load JSON file FILENAME into register NAME
196-
.IP
197-
set=NAME:JSON\-STRING
198-
.IP
199-
Set register NAME to given JSON\-STRING
200-
.SH COPYRIGHT
201-
Copyright (C) 2009-2019 The Elements Project developers
202-
Copyright (C) 2009-2019 The Bitcoin Core developers
203-
204-
Please contribute if you find Elements Core useful. Visit
205-
<https://bitcoincore.org> for further information about the software.
206-
The source code is available from <https://github.com/bitcoin/bitcoin>.
207-
208-
This is experimental software.
209-
Distributed under the MIT software license, see the accompanying file COPYING
210-
or <https://opensource.org/licenses/MIT>
3+
elements-tx \- manual page for elements-tx
2114

5+
This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.

doc/man/elements-util.1

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.TH ELEMENTS-UTIL "1"
2+
.SH NAME
3+
elements-util \- manual page for elements-util
4+
5+
This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.

0 commit comments

Comments
 (0)