mirror of
https://github.com/ElementsProject/elements.git
synced 2026-08-13 12:33:42 +02:00
Merge pull request #1264 from psgreco/master-manpages
Fix Makefile and placeholders for manpages
This commit is contained in:
James Dorfman
GitHub
commit
a582ffd39e
4 changed files with 12 additions and 214 deletions
|
|
@ -5,8 +5,7 @@ if BUILD_BITCOIND
|
|||
endif
|
||||
|
||||
if ENABLE_QT
|
||||
#TODO(stevenroose) uncomment and fix
|
||||
# dist_man1_MANS+=elements-qt.1
|
||||
dist_man1_MANS+=elements-qt.1
|
||||
endif
|
||||
|
||||
if BUILD_BITCOIN_CLI
|
||||
|
|
@ -18,7 +17,7 @@ if BUILD_BITCOIN_TX
|
|||
endif
|
||||
|
||||
if BUILD_BITCOIN_UTIL
|
||||
dist_man1_MANS+=bitcoin-util.1
|
||||
dist_man1_MANS+=elements-util.1
|
||||
endif
|
||||
|
||||
if ENABLE_WALLET
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
.TH BITCOIN-UTIL "1"
|
||||
.TH ELEMENTS-QT "1"
|
||||
.SH NAME
|
||||
bitcoin-util \- manual page for bitcoin-util
|
||||
elements-qt \- manual page for elements-qt
|
||||
|
||||
This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
|
||||
|
|
@ -1,211 +1,5 @@
|
|||
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.10.
|
||||
.TH ELEMENTS-TX "1" "May 2019" "elements-tx v0.17.0.1" "User Commands"
|
||||
.TH ELEMENTS-TX "1"
|
||||
.SH NAME
|
||||
elements-tx \- manual page for elements-tx v0.17.0.1
|
||||
.SH SYNOPSIS
|
||||
.B elements-tx
|
||||
[\fI\,options\/\fR] \fI\,<hex-tx> \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded bitcoin transaction\/\fR
|
||||
.br
|
||||
.B elements-tx
|
||||
[\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] \fI\,Create hex-encoded bitcoin transaction\/\fR
|
||||
.SH DESCRIPTION
|
||||
Elements Core elements\-tx utility version v0.17.0.1\-dirty
|
||||
.SH OPTIONS
|
||||
.HP
|
||||
\-?
|
||||
.IP
|
||||
This help message
|
||||
.HP
|
||||
\fB\-create\fR
|
||||
.IP
|
||||
Create new, empty TX.
|
||||
.HP
|
||||
\fB\-json\fR
|
||||
.IP
|
||||
Select JSON output
|
||||
.HP
|
||||
\fB\-txid\fR
|
||||
.IP
|
||||
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
|
||||
.IP
|
||||
Delete input N from TX
|
||||
.IP
|
||||
delout=N
|
||||
.IP
|
||||
Delete output N from TX
|
||||
.IP
|
||||
in=TXID:VOUT(:SEQUENCE_NUMBER)
|
||||
.IP
|
||||
Add input to TX
|
||||
.IP
|
||||
locktime=N
|
||||
.IP
|
||||
Set TX lock time to N
|
||||
.IP
|
||||
nversion=N
|
||||
.IP
|
||||
Set TX version to N
|
||||
.IP
|
||||
outaddr=VALUE:ADDRESS(:ASSET)
|
||||
.IP
|
||||
Add address\-based output to TX
|
||||
.IP
|
||||
outdata=[VALUE:]DATA
|
||||
.IP
|
||||
Add data\-based output to TX
|
||||
.IP
|
||||
outmultisig=VALUE:REQUIRED:PUBKEYS:PUBKEY1:PUBKEY2:....[:FLAGS]
|
||||
.IP
|
||||
Add Pay To n\-of\-m Multi\-sig output to TX. n = REQUIRED, m = PUBKEYS.
|
||||
Optionally add the "W" flag to produce a
|
||||
pay\-to\-witness\-script\-hash output. Optionally add the "S" flag to
|
||||
wrap the output in a pay\-to\-script\-hash.
|
||||
.IP
|
||||
outpubkey=VALUE:PUBKEY[:FLAGS]
|
||||
.IP
|
||||
Add pay\-to\-pubkey output to TX. Optionally add the "W" flag to produce a
|
||||
pay\-to\-witness\-pubkey\-hash output. Optionally add the "S" flag to
|
||||
wrap the output in a pay\-to\-script\-hash.
|
||||
.IP
|
||||
outscript=VALUE:SCRIPT[:FLAGS]
|
||||
.IP
|
||||
Add raw script output to TX. Optionally add the "W" flag to produce a
|
||||
pay\-to\-witness\-script\-hash output. Optionally add the "S" flag to
|
||||
wrap the output in a pay\-to\-script\-hash.
|
||||
.IP
|
||||
replaceable(=N)
|
||||
.IP
|
||||
Set RBF opt\-in sequence number for input N (if not provided, opt\-in all
|
||||
available inputs)
|
||||
.IP
|
||||
sign=SIGHASH\-FLAGS
|
||||
.IP
|
||||
Add zero or more signatures to transaction. This command requires JSON
|
||||
registers:prevtxs=JSON object, privatekeys=JSON object. See
|
||||
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
|
||||
Load JSON file FILENAME into register NAME
|
||||
.IP
|
||||
set=NAME:JSON\-STRING
|
||||
.IP
|
||||
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>
|
||||
elements-tx \- manual page for elements-tx
|
||||
|
||||
This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
|
||||
|
|
|
|||
5
doc/man/elements-util.1
Normal file
5
doc/man/elements-util.1
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
.TH ELEMENTS-UTIL "1"
|
||||
.SH NAME
|
||||
elements-util \- manual page for elements-util
|
||||
|
||||
This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
|
||||
Loading…
Add table
Add a link
Reference in a new issue