From faeb4480a10051957c96ef7404946ed444ab9d51 Mon Sep 17 00:00:00 2001 From: Alexander Block Date: Wed, 30 May 2018 14:29:01 +0200 Subject: [PATCH] Update manpages with ./contrib/devtools/gen-manpages.sh (#2088) --- doc/man/dash-cli.1 | 26 ++++++++----- doc/man/dash-qt.1 | 93 ++++++++++++++++++++++++++++++---------------- doc/man/dash-tx.1 | 28 +++++++++++--- doc/man/dashd.1 | 93 ++++++++++++++++++++++++++++++---------------- 4 files changed, 158 insertions(+), 82 deletions(-) diff --git a/doc/man/dash-cli.1 b/doc/man/dash-cli.1 index b645bf91fb..88fe0b0d1d 100644 --- a/doc/man/dash-cli.1 +++ b/doc/man/dash-cli.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH DASH-CLI "1" "January 2018" "dash-cli v0.12.3.0" "User Commands" +.TH DASH-CLI "1" "May 2018" "dash-cli v0.12.3.0" "User Commands" .SH NAME dash-cli \- manual page for dash-cli v0.12.3.0 .SH DESCRIPTION @@ -8,12 +8,10 @@ Dash Core RPC client version v0.12.3.0 .TP dash\-cli [options] [params] Send command to Dash Core -.TP -dash\-cli [options] help -List commands -.TP -dash\-cli [options] help -Get help for a command +.IP +dash\-cli [options] \fB\-named\fR [name=value] ... Send command to Dash Core (with named arguments) +dash\-cli [options] help List commands +dash\-cli [options] help Get help for a command .SH OPTIONS .HP \-? @@ -34,12 +32,20 @@ Chain selection options: .IP Use the test chain .HP +\fB\-devnet=\fR +.IP +Use devnet chain with provided name +.HP \fB\-regtest\fR .IP Enter regression test mode, which uses a special chain in which blocks can be solved instantly. This is intended for regression testing tools and app development. .HP +\fB\-named\fR +.IP +Pass named instead of positional arguments (default: false) +.HP \fB\-rpcconnect=\fR .IP Send commands to node running on (default: 127.0.0.1) @@ -78,8 +84,8 @@ The source code is available from . This is experimental software. Distributed under the MIT software license, see the accompanying file COPYING -or . +or This product includes software developed by the OpenSSL Project for use in the -OpenSSL Toolkit and cryptographic software written -by Eric Young and UPnP software written by Thomas Bernard. +OpenSSL Toolkit and cryptographic software written by +Eric Young and UPnP software written by Thomas Bernard. diff --git a/doc/man/dash-qt.1 b/doc/man/dash-qt.1 index c784835465..2ad3d1c675 100644 --- a/doc/man/dash-qt.1 +++ b/doc/man/dash-qt.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH DASH-QT "1" "January 2018" "dash-qt v0.12.3.0" "User Commands" +.TH DASH-QT "1" "May 2018" "dash-qt v0.12.3.0" "User Commands" .SH NAME dash-qt \- manual page for dash-qt v0.12.3.0 .SH DESCRIPTION @@ -36,9 +36,9 @@ block hash) If this block is in the chain assume that it and its ancestors are valid and potentially skip their script verification (0 to verify all, default: -000000000000001c172f518793c3b9e83f202284615592f87fe3506ce964dcd4, +0000000000000044d888c60cf2a3646f511a66fc35f4abc5f20377a7d658263b, testnet: -0000000004f5aef732d572ff514af99a995702c92e4452c7af10858231668b1f) +0000000003aa53e24b6e60ef97642e4193611f2bcb75ea1fa8105f0b5ffd5242) .HP \fB\-conf=\fR .IP @@ -67,7 +67,12 @@ Keep the transaction memory pool below megabytes (default: 300) \fB\-mempoolexpiry=\fR .IP Do not keep transactions in the mempool longer than hours (default: -72) +336) +.HP +\fB\-blockreconstructionextratxn=\fR +.IP +Extra transactions to keep in memory for compact block reconstructions +(default: 100) .HP \fB\-par=\fR .IP @@ -80,13 +85,15 @@ Specify pid file (default: dashd.pid) .HP \fB\-prune=\fR .IP -Reduce storage requirements by enabling pruning (deleting) of old blocks. -This allows the pruneblockchain RPC to be called to delete specific blocks, -and enables automatic pruning of old blocks if a target size in MiB is -provided. This mode is incompatible with \fB\-txindex\fR and \fB\-rescan\fR. -Warning: Reverting this setting requires re\-downloading the entire blockchain. -(default: 0 = disable pruning blocks, 1 = allow manual pruning via RPC, >945 = -automatically prune block files to stay under the specified target size in MiB) +Reduce storage requirements by enabling pruning (deleting) of old +blocks. This allows the pruneblockchain RPC to be called to +delete specific blocks, and enables automatic pruning of old +blocks if a target size in MiB is provided. This mode is +incompatible with \fB\-txindex\fR and \fB\-rescan\fR. Warning: Reverting this +setting requires re\-downloading the entire blockchain. (default: +0 = disable pruning blocks, 1 = allow manual pruning via RPC, +>945 = automatically prune block files to stay under the +specified target size in MiB) .HP \fB\-reindex\-chainstate\fR .IP @@ -147,7 +154,8 @@ for IPv6 .HP \fB\-connect=\fR .IP -Connect only to the specified node(s) +Connect only to the specified node(s); \fB\-noconnect\fR or \fB\-connect\fR=\fI\,0\/\fR alone to +disable automatic connections .HP \fB\-discover\fR .IP @@ -161,7 +169,7 @@ Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (def \fB\-dnsseed\fR .IP Query for peer addresses via DNS lookup, if low on addresses (default: 1 -unless \fB\-connect\fR) +unless \fB\-connect\fR/\-noconnect) .HP \fB\-externalip=\fR .IP @@ -173,7 +181,8 @@ Always query for peer addresses via DNS lookup (default: 0) .HP \fB\-listen\fR .IP -Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR) +Accept connections from outside (default: 1 if no \fB\-proxy\fR or +\fB\-connect\fR/\-noconnect) .HP \fB\-listenonion\fR .IP @@ -255,12 +264,13 @@ Use UPnP to map the listening port (default: 0) Bind to given address and whitelist peers connecting to it. Use [host]:port notation for IPv6 .HP -\fB\-whitelist=\fR +\fB\-whitelist=\fR .IP -Whitelist peers connecting from the given netmask or IP address. Can be -specified multiple times. Whitelisted peers cannot be DoS banned -and their transactions are always relayed, even if they are -already in the mempool, useful e.g. for a gateway +Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or +CIDR notated network (e.g. 1.2.3.0/24). Can be specified multiple +times. Whitelisted peers cannot be DoS banned and their +transactions are always relayed, even if they are already in the +mempool, useful e.g. for a gateway .HP \fB\-whitelistrelay\fR .IP @@ -269,7 +279,7 @@ not relaying transactions (default: 1) .HP \fB\-whitelistforcerelay\fR .IP -Force relay of transactions from whitelisted peers even they violate +Force relay of transactions from whitelisted peers even if they violate local relay policy (default: 1) .HP \fB\-maxuploadtarget=\fR @@ -316,7 +326,7 @@ Spend unconfirmed change when sending transactions (default: 1) \fB\-txconfirmtarget=\fR .IP If paytxfee is not set, include enough fee so transactions begin -confirmation on average within n blocks (default: 2) +confirmation on average within n blocks (default: 6) .HP \fB\-usehd\fR .IP @@ -432,10 +442,11 @@ Append comment to the user agent string Output debugging information (default: 0, supplying is optional). If is not supplied or if = 1, output all debugging information. can be: addrman, -alert, bench, coindb, db, http, leveldb, libevent, lock, mempool, -mempoolrej, net, proxy, prune, rand, reindex, rpc, selectcoins, -tor, zmq, dash (or specifically: gobject, instantsend, keepass, -masternode, mnpayments, mnsync, privatesend, spork), qt. +alert, bench, cmpctblock, coindb, db, http, leveldb, libevent, +lock, mempool, mempoolrej, net, proxy, prune, rand, reindex, rpc, +selectcoins, tor, zmq, dash (or specifically: gobject, +instantsend, keepass, masternode, mnpayments, mnsync, +privatesend, spork), qt. .HP \fB\-help\-debug\fR .IP @@ -478,10 +489,19 @@ Chain selection options: .IP Use the test chain .HP +\fB\-devnet=\fR +.IP +Use devnet chain with provided name +.HP \fB\-litemode=\fR .IP Disable all Dash specific functionality (Masternodes, PrivateSend, InstantSend, Governance) (0\-1, default: 0) +.HP +\fB\-sporkaddr=\fR +.IP +Override spork address. Only useful for regtest and devnet. Using this +on mainnet or testnet will ban you. .PP Masternode options: .HP @@ -520,7 +540,7 @@ Use N separate masternodes for each denominated input to mix funds .HP \fB\-privatesendamount=\fR .IP -Keep N DASH anonymized (default: 1000) +Keep N DASH anonymized (2\-21000000, default: 1000) .HP \fB\-liquidityprovider=\fR .IP @@ -537,7 +557,7 @@ default: 1) .HP \fB\-instantsenddepth=\fR .IP -Show N confirmations for a successfully locked transaction (0\-9999, +Show N confirmations for a successfully locked transaction (0\-60, default: 5) .HP \fB\-instantsendnotify=\fR @@ -568,12 +588,17 @@ Block creation options: .HP \fB\-blockmaxsize=\fR .IP -Set maximum block size in bytes (default: 750000) +Set maximum block size in bytes (default: 2000000) .HP \fB\-blockprioritysize=\fR .IP Set maximum size of high\-priority/low\-fee transactions in bytes (default: 10000) +.HP +\fB\-blockmintxfee=\fR +.IP +Set lowest fee rate (in DASH/kB) for transactions to be included in +block creation. (default: 0.00001) .PP RPC server options: .HP @@ -607,8 +632,10 @@ Password for JSON\-RPC connections .IP Username and hashed password for JSON\-RPC connections. The field comes in the format: :$. A -canonical python script is included in share/rpcuser. This option -can be specified multiple times +canonical python script is included in share/rpcuser. The client +then connects normally using the +rpcuser=/rpcpassword= pair of arguments. This +option can be specified multiple times .HP \fB\-rpcport=\fR .IP @@ -661,8 +688,8 @@ The source code is available from . This is experimental software. Distributed under the MIT software license, see the accompanying file COPYING -or . +or This product includes software developed by the OpenSSL Project for use in the -OpenSSL Toolkit and cryptographic software written -by Eric Young and UPnP software written by Thomas Bernard. +OpenSSL Toolkit and cryptographic software written by +Eric Young and UPnP software written by Thomas Bernard. diff --git a/doc/man/dash-tx.1 b/doc/man/dash-tx.1 index 9bc75bc885..2ad58f5b94 100644 --- a/doc/man/dash-tx.1 +++ b/doc/man/dash-tx.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH DASH-TX "1" "January 2018" "dash-tx v0.12.3.0" "User Commands" +.TH DASH-TX "1" "May 2018" "dash-tx v0.12.3.0" "User Commands" .SH NAME dash-tx \- manual page for dash-tx v0.12.3.0 .SH DESCRIPTION @@ -35,6 +35,10 @@ Chain selection options: .IP Use the test chain .HP +\fB\-devnet=\fR +.IP +Use devnet chain with provided name +.HP \fB\-regtest\fR .IP Enter regression test mode, which uses a special chain in which blocks @@ -67,13 +71,25 @@ outaddr=VALUE:ADDRESS .IP Add address\-based output to TX .IP +outpubkey=VALUE:PUBKEY[:FLAGS] +.IP +Add pay\-to\-pubkey output to TX. Optionally add the "S" flag to wrap the +output in a pay\-to\-script\-hash. +.IP outdata=[VALUE:]DATA .IP Add data\-based output to TX .IP -outscript=VALUE:SCRIPT +outscript=VALUE:SCRIPT[:FLAGS] .IP -Add raw script output to TX +Add raw script output to TX. Optionally add the "S" flag to wrap the +output in a pay\-to\-script\-hash. +.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 "S" flag to wrap the output in a +pay\-to\-script\-hash. .IP sign=SIGHASH\-FLAGS .IP @@ -101,8 +117,8 @@ The source code is available from . This is experimental software. Distributed under the MIT software license, see the accompanying file COPYING -or . +or This product includes software developed by the OpenSSL Project for use in the -OpenSSL Toolkit and cryptographic software written -by Eric Young and UPnP software written by Thomas Bernard. +OpenSSL Toolkit and cryptographic software written by +Eric Young and UPnP software written by Thomas Bernard. diff --git a/doc/man/dashd.1 b/doc/man/dashd.1 index 39e6dfb43c..430f4803a9 100644 --- a/doc/man/dashd.1 +++ b/doc/man/dashd.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH DASHD "1" "January 2018" "dashd v0.12.3.0" "User Commands" +.TH DASHD "1" "May 2018" "dashd v0.12.3.0" "User Commands" .SH NAME dashd \- manual page for dashd v0.12.3.0 .SH DESCRIPTION @@ -37,9 +37,9 @@ block hash) If this block is in the chain assume that it and its ancestors are valid and potentially skip their script verification (0 to verify all, default: -000000000000001c172f518793c3b9e83f202284615592f87fe3506ce964dcd4, +0000000000000044d888c60cf2a3646f511a66fc35f4abc5f20377a7d658263b, testnet: -0000000004f5aef732d572ff514af99a995702c92e4452c7af10858231668b1f) +0000000003aa53e24b6e60ef97642e4193611f2bcb75ea1fa8105f0b5ffd5242) .HP \fB\-conf=\fR .IP @@ -72,7 +72,12 @@ Keep the transaction memory pool below megabytes (default: 300) \fB\-mempoolexpiry=\fR .IP Do not keep transactions in the mempool longer than hours (default: -72) +336) +.HP +\fB\-blockreconstructionextratxn=\fR +.IP +Extra transactions to keep in memory for compact block reconstructions +(default: 100) .HP \fB\-par=\fR .IP @@ -85,13 +90,15 @@ Specify pid file (default: dashd.pid) .HP \fB\-prune=\fR .IP -Reduce storage requirements by enabling pruning (deleting) of old blocks. -This allows the pruneblockchain RPC to be called to delete specific blocks, -and enables automatic pruning of old blocks if a target size in MiB is -provided. This mode is incompatible with \fB\-txindex\fR and \fB\-rescan\fR. -Warning: Reverting this setting requires re\-downloading the entire blockchain. -(default: 0 = disable pruning blocks, 1 = allow manual pruning via RPC, >945 = -automatically prune block files to stay under the specified target size in MiB) +Reduce storage requirements by enabling pruning (deleting) of old +blocks. This allows the pruneblockchain RPC to be called to +delete specific blocks, and enables automatic pruning of old +blocks if a target size in MiB is provided. This mode is +incompatible with \fB\-txindex\fR and \fB\-rescan\fR. Warning: Reverting this +setting requires re\-downloading the entire blockchain. (default: +0 = disable pruning blocks, 1 = allow manual pruning via RPC, +>945 = automatically prune block files to stay under the +specified target size in MiB) .HP \fB\-reindex\-chainstate\fR .IP @@ -152,7 +159,8 @@ for IPv6 .HP \fB\-connect=\fR .IP -Connect only to the specified node(s) +Connect only to the specified node(s); \fB\-noconnect\fR or \fB\-connect\fR=\fI\,0\/\fR alone to +disable automatic connections .HP \fB\-discover\fR .IP @@ -166,7 +174,7 @@ Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (def \fB\-dnsseed\fR .IP Query for peer addresses via DNS lookup, if low on addresses (default: 1 -unless \fB\-connect\fR) +unless \fB\-connect\fR/\-noconnect) .HP \fB\-externalip=\fR .IP @@ -178,7 +186,8 @@ Always query for peer addresses via DNS lookup (default: 0) .HP \fB\-listen\fR .IP -Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR) +Accept connections from outside (default: 1 if no \fB\-proxy\fR or +\fB\-connect\fR/\-noconnect) .HP \fB\-listenonion\fR .IP @@ -260,12 +269,13 @@ Use UPnP to map the listening port (default: 0) Bind to given address and whitelist peers connecting to it. Use [host]:port notation for IPv6 .HP -\fB\-whitelist=\fR +\fB\-whitelist=\fR .IP -Whitelist peers connecting from the given netmask or IP address. Can be -specified multiple times. Whitelisted peers cannot be DoS banned -and their transactions are always relayed, even if they are -already in the mempool, useful e.g. for a gateway +Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or +CIDR notated network (e.g. 1.2.3.0/24). Can be specified multiple +times. Whitelisted peers cannot be DoS banned and their +transactions are always relayed, even if they are already in the +mempool, useful e.g. for a gateway .HP \fB\-whitelistrelay\fR .IP @@ -274,7 +284,7 @@ not relaying transactions (default: 1) .HP \fB\-whitelistforcerelay\fR .IP -Force relay of transactions from whitelisted peers even they violate +Force relay of transactions from whitelisted peers even if they violate local relay policy (default: 1) .HP \fB\-maxuploadtarget=\fR @@ -321,7 +331,7 @@ Spend unconfirmed change when sending transactions (default: 1) \fB\-txconfirmtarget=\fR .IP If paytxfee is not set, include enough fee so transactions begin -confirmation on average within n blocks (default: 2) +confirmation on average within n blocks (default: 6) .HP \fB\-usehd\fR .IP @@ -433,10 +443,11 @@ Append comment to the user agent string Output debugging information (default: 0, supplying is optional). If is not supplied or if = 1, output all debugging information. can be: addrman, -alert, bench, coindb, db, http, leveldb, libevent, lock, mempool, -mempoolrej, net, proxy, prune, rand, reindex, rpc, selectcoins, -tor, zmq, dash (or specifically: gobject, instantsend, keepass, -masternode, mnpayments, mnsync, privatesend, spork). +alert, bench, cmpctblock, coindb, db, http, leveldb, libevent, +lock, mempool, mempoolrej, net, proxy, prune, rand, reindex, rpc, +selectcoins, tor, zmq, dash (or specifically: gobject, +instantsend, keepass, masternode, mnpayments, mnsync, +privatesend, spork). .HP \fB\-help\-debug\fR .IP @@ -479,10 +490,19 @@ Chain selection options: .IP Use the test chain .HP +\fB\-devnet=\fR +.IP +Use devnet chain with provided name +.HP \fB\-litemode=\fR .IP Disable all Dash specific functionality (Masternodes, PrivateSend, InstantSend, Governance) (0\-1, default: 0) +.HP +\fB\-sporkaddr=\fR +.IP +Override spork address. Only useful for regtest and devnet. Using this +on mainnet or testnet will ban you. .PP Masternode options: .HP @@ -521,7 +541,7 @@ Use N separate masternodes for each denominated input to mix funds .HP \fB\-privatesendamount=\fR .IP -Keep N DASH anonymized (default: 1000) +Keep N DASH anonymized (2\-21000000, default: 1000) .HP \fB\-liquidityprovider=\fR .IP @@ -538,7 +558,7 @@ default: 1) .HP \fB\-instantsenddepth=\fR .IP -Show N confirmations for a successfully locked transaction (0\-9999, +Show N confirmations for a successfully locked transaction (0\-60, default: 5) .HP \fB\-instantsendnotify=\fR @@ -569,12 +589,17 @@ Block creation options: .HP \fB\-blockmaxsize=\fR .IP -Set maximum block size in bytes (default: 750000) +Set maximum block size in bytes (default: 2000000) .HP \fB\-blockprioritysize=\fR .IP Set maximum size of high\-priority/low\-fee transactions in bytes (default: 10000) +.HP +\fB\-blockmintxfee=\fR +.IP +Set lowest fee rate (in DASH/kB) for transactions to be included in +block creation. (default: 0.00001) .PP RPC server options: .HP @@ -608,8 +633,10 @@ Password for JSON\-RPC connections .IP Username and hashed password for JSON\-RPC connections. The field comes in the format: :$. A -canonical python script is included in share/rpcuser. This option -can be specified multiple times +canonical python script is included in share/rpcuser. The client +then connects normally using the +rpcuser=/rpcpassword= pair of arguments. This +option can be specified multiple times .HP \fB\-rpcport=\fR .IP @@ -636,8 +663,8 @@ The source code is available from . This is experimental software. Distributed under the MIT software license, see the accompanying file COPYING -or . +or This product includes software developed by the OpenSSL Project for use in the -OpenSSL Toolkit and cryptographic software written -by Eric Young and UPnP software written by Thomas Bernard. +OpenSSL Toolkit and cryptographic software written by +Eric Young and UPnP software written by Thomas Bernard.