Skip to content

Update manpages with ./contrib/devtools/gen-manpages.sh #2088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 30, 2018
Merged

Update manpages with ./contrib/devtools/gen-manpages.sh #2088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions doc/man/dash-cli.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -8,12 +8,10 @@ Dash Core RPC client version v0.12.3.0
.TP
dash\-cli [options] <command> [params]
Send command to Dash Core
.TP
dash\-cli [options] help
List commands
.TP
dash\-cli [options] help <command>
Get help for a command
.IP
dash\-cli [options] \fB\-named\fR <command> [name=value] ... Send command to Dash Core (with named arguments)
dash\-cli [options] help List commands
dash\-cli [options] help <command> Get help for a command
.SH OPTIONS
.HP
\-?
Expand All @@ -34,12 +32,20 @@ Chain selection options:
.IP
Use the test chain
.HP
\fB\-devnet=\fR<name>
.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>
.IP
Send commands to node running on <ip> (default: 127.0.0.1)
Expand Down Expand Up @@ -78,8 +84,8 @@ The source code is available from <https://github.com/dashpay/dash>.

This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING
or <http://www.opensource.org/licenses/mit-license.php>.
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.
OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
Eric Young and UPnP software written by Thomas Bernard.
93 changes: 60 additions & 33 deletions doc/man/dash-qt.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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<file>
.IP
Expand Down Expand Up @@ -67,7 +67,12 @@ Keep the transaction memory pool below <n> megabytes (default: 300)
\fB\-mempoolexpiry=\fR<n>
.IP
Do not keep transactions in the mempool longer than <n> hours (default:
72)
336)
.HP
\fB\-blockreconstructionextratxn=\fR<n>
.IP
Extra transactions to keep in memory for compact block reconstructions
(default: 100)
.HP
\fB\-par=\fR<n>
.IP
Expand All @@ -80,13 +85,15 @@ Specify pid file (default: dashd.pid)
.HP
\fB\-prune=\fR<n>
.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
Expand Down Expand Up @@ -147,7 +154,8 @@ for IPv6
.HP
\fB\-connect=\fR<ip>
.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
Expand All @@ -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>
.IP
Expand All @@ -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
Expand Down Expand Up @@ -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<netmask>
\fB\-whitelist=\fR<IP address or network>
.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
Expand All @@ -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<n>
Expand Down Expand Up @@ -316,7 +326,7 @@ Spend unconfirmed change when sending transactions (default: 1)
\fB\-txconfirmtarget=\fR<n>
.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
Expand Down Expand Up @@ -432,10 +442,11 @@ Append comment to the user agent string
Output debugging information (default: 0, supplying <category> is
optional). If <category> is not supplied or if <category> = 1,
output all debugging information.<category> 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
Expand Down Expand Up @@ -478,10 +489,19 @@ Chain selection options:
.IP
Use the test chain
.HP
\fB\-devnet=\fR<name>
.IP
Use devnet chain with provided name
.HP
\fB\-litemode=\fR<n>
.IP
Disable all Dash specific functionality (Masternodes, PrivateSend,
InstantSend, Governance) (0\-1, default: 0)
.HP
\fB\-sporkaddr=\fR<hex>
.IP
Override spork address. Only useful for regtest and devnet. Using this
on mainnet or testnet will ban you.
.PP
Masternode options:
.HP
Expand Down Expand Up @@ -520,7 +540,7 @@ Use N separate masternodes for each denominated input to mix funds
.HP
\fB\-privatesendamount=\fR<n>
.IP
Keep N DASH anonymized (default: 1000)
Keep N DASH anonymized (2\-21000000, default: 1000)
.HP
\fB\-liquidityprovider=\fR<n>
.IP
Expand All @@ -537,7 +557,7 @@ default: 1)
.HP
\fB\-instantsenddepth=\fR<n>
.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<cmd>
Expand Down Expand Up @@ -568,12 +588,17 @@ Block creation options:
.HP
\fB\-blockmaxsize=\fR<n>
.IP
Set maximum block size in bytes (default: 750000)
Set maximum block size in bytes (default: 2000000)
.HP
\fB\-blockprioritysize=\fR<n>
.IP
Set maximum size of high\-priority/low\-fee transactions in bytes
(default: 10000)
.HP
\fB\-blockmintxfee=\fR<amt>
.IP
Set lowest fee rate (in DASH/kB) for transactions to be included in
block creation. (default: 0.00001)
.PP
RPC server options:
.HP
Expand Down Expand Up @@ -607,8 +632,10 @@ Password for JSON\-RPC connections
.IP
Username and hashed password for JSON\-RPC connections. The field
<userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. 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=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This
option can be specified multiple times
.HP
\fB\-rpcport=\fR<port>
.IP
Expand Down Expand Up @@ -661,8 +688,8 @@ The source code is available from <https://github.com/dashpay/dash>.

This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING
or <http://www.opensource.org/licenses/mit-license.php>.
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.
OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
Eric Young and UPnP software written by Thomas Bernard.
28 changes: 22 additions & 6 deletions doc/man/dash-tx.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -35,6 +35,10 @@ Chain selection options:
.IP
Use the test chain
.HP
\fB\-devnet=\fR<name>
.IP
Use devnet chain with provided name
.HP
\fB\-regtest\fR
.IP
Enter regression test mode, which uses a special chain in which blocks
Expand Down Expand Up @@ -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. 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 raw script output to TX
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
Expand Down Expand Up @@ -101,8 +117,8 @@ The source code is available from <https://github.com/dashpay/dash>.

This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING
or <http://www.opensource.org/licenses/mit-license.php>.
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.
OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
Eric Young and UPnP software written by Thomas Bernard.
Loading