Skip to content

Commit faeb448

Browse files
codablockUdjinM6
authored andcommitted
Update manpages with ./contrib/devtools/gen-manpages.sh (#2088)
1 parent cc59361 commit faeb448

File tree

4 files changed

+158
-82
lines changed

4 files changed

+158
-82
lines changed

doc/man/dash-cli.1

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
2-
.TH DASH-CLI "1" "January 2018" "dash-cli v0.12.3.0" "User Commands"
2+
.TH DASH-CLI "1" "May 2018" "dash-cli v0.12.3.0" "User Commands"
33
.SH NAME
44
dash-cli \- manual page for dash-cli v0.12.3.0
55
.SH DESCRIPTION
@@ -8,12 +8,10 @@ Dash Core RPC client version v0.12.3.0
88
.TP
99
dash\-cli [options] <command> [params]
1010
Send command to Dash Core
11-
.TP
12-
dash\-cli [options] help
13-
List commands
14-
.TP
15-
dash\-cli [options] help <command>
16-
Get help for a command
11+
.IP
12+
dash\-cli [options] \fB\-named\fR <command> [name=value] ... Send command to Dash Core (with named arguments)
13+
dash\-cli [options] help List commands
14+
dash\-cli [options] help <command> Get help for a command
1715
.SH OPTIONS
1816
.HP
1917
\-?
@@ -34,12 +32,20 @@ Chain selection options:
3432
.IP
3533
Use the test chain
3634
.HP
35+
\fB\-devnet=\fR<name>
36+
.IP
37+
Use devnet chain with provided name
38+
.HP
3739
\fB\-regtest\fR
3840
.IP
3941
Enter regression test mode, which uses a special chain in which blocks
4042
can be solved instantly. This is intended for regression testing
4143
tools and app development.
4244
.HP
45+
\fB\-named\fR
46+
.IP
47+
Pass named instead of positional arguments (default: false)
48+
.HP
4349
\fB\-rpcconnect=\fR<ip>
4450
.IP
4551
Send commands to node running on <ip> (default: 127.0.0.1)
@@ -78,8 +84,8 @@ The source code is available from <https://github.com/dashpay/dash>.
7884

7985
This is experimental software.
8086
Distributed under the MIT software license, see the accompanying file COPYING
81-
or <http://www.opensource.org/licenses/mit-license.php>.
87+
or <https://opensource.org/licenses/MIT>
8288

8389
This product includes software developed by the OpenSSL Project for use in the
84-
OpenSSL Toolkit <https://www.openssl.org/> and cryptographic software written
85-
by Eric Young and UPnP software written by Thomas Bernard.
90+
OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
91+
Eric Young and UPnP software written by Thomas Bernard.

doc/man/dash-qt.1

Lines changed: 60 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
2-
.TH DASH-QT "1" "January 2018" "dash-qt v0.12.3.0" "User Commands"
2+
.TH DASH-QT "1" "May 2018" "dash-qt v0.12.3.0" "User Commands"
33
.SH NAME
44
dash-qt \- manual page for dash-qt v0.12.3.0
55
.SH DESCRIPTION
@@ -36,9 +36,9 @@ block hash)
3636
If this block is in the chain assume that it and its ancestors are valid
3737
and potentially skip their script verification (0 to verify all,
3838
default:
39-
000000000000001c172f518793c3b9e83f202284615592f87fe3506ce964dcd4,
39+
0000000000000044d888c60cf2a3646f511a66fc35f4abc5f20377a7d658263b,
4040
testnet:
41-
0000000004f5aef732d572ff514af99a995702c92e4452c7af10858231668b1f)
41+
0000000003aa53e24b6e60ef97642e4193611f2bcb75ea1fa8105f0b5ffd5242)
4242
.HP
4343
\fB\-conf=\fR<file>
4444
.IP
@@ -67,7 +67,12 @@ Keep the transaction memory pool below <n> megabytes (default: 300)
6767
\fB\-mempoolexpiry=\fR<n>
6868
.IP
6969
Do not keep transactions in the mempool longer than <n> hours (default:
70-
72)
70+
336)
71+
.HP
72+
\fB\-blockreconstructionextratxn=\fR<n>
73+
.IP
74+
Extra transactions to keep in memory for compact block reconstructions
75+
(default: 100)
7176
.HP
7277
\fB\-par=\fR<n>
7378
.IP
@@ -80,13 +85,15 @@ Specify pid file (default: dashd.pid)
8085
.HP
8186
\fB\-prune=\fR<n>
8287
.IP
83-
Reduce storage requirements by enabling pruning (deleting) of old blocks.
84-
This allows the pruneblockchain RPC to be called to delete specific blocks,
85-
and enables automatic pruning of old blocks if a target size in MiB is
86-
provided. This mode is incompatible with \fB\-txindex\fR and \fB\-rescan\fR.
87-
Warning: Reverting this setting requires re\-downloading the entire blockchain.
88-
(default: 0 = disable pruning blocks, 1 = allow manual pruning via RPC, >945 =
89-
automatically prune block files to stay under the specified target size in MiB)
88+
Reduce storage requirements by enabling pruning (deleting) of old
89+
blocks. This allows the pruneblockchain RPC to be called to
90+
delete specific blocks, and enables automatic pruning of old
91+
blocks if a target size in MiB is provided. This mode is
92+
incompatible with \fB\-txindex\fR and \fB\-rescan\fR. Warning: Reverting this
93+
setting requires re\-downloading the entire blockchain. (default:
94+
0 = disable pruning blocks, 1 = allow manual pruning via RPC,
95+
>945 = automatically prune block files to stay under the
96+
specified target size in MiB)
9097
.HP
9198
\fB\-reindex\-chainstate\fR
9299
.IP
@@ -147,7 +154,8 @@ for IPv6
147154
.HP
148155
\fB\-connect=\fR<ip>
149156
.IP
150-
Connect only to the specified node(s)
157+
Connect only to the specified node(s); \fB\-noconnect\fR or \fB\-connect\fR=\fI\,0\/\fR alone to
158+
disable automatic connections
151159
.HP
152160
\fB\-discover\fR
153161
.IP
@@ -161,7 +169,7 @@ Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (def
161169
\fB\-dnsseed\fR
162170
.IP
163171
Query for peer addresses via DNS lookup, if low on addresses (default: 1
164-
unless \fB\-connect\fR)
172+
unless \fB\-connect\fR/\-noconnect)
165173
.HP
166174
\fB\-externalip=\fR<ip>
167175
.IP
@@ -173,7 +181,8 @@ Always query for peer addresses via DNS lookup (default: 0)
173181
.HP
174182
\fB\-listen\fR
175183
.IP
176-
Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR)
184+
Accept connections from outside (default: 1 if no \fB\-proxy\fR or
185+
\fB\-connect\fR/\-noconnect)
177186
.HP
178187
\fB\-listenonion\fR
179188
.IP
@@ -255,12 +264,13 @@ Use UPnP to map the listening port (default: 0)
255264
Bind to given address and whitelist peers connecting to it. Use
256265
[host]:port notation for IPv6
257266
.HP
258-
\fB\-whitelist=\fR<netmask>
267+
\fB\-whitelist=\fR<IP address or network>
259268
.IP
260-
Whitelist peers connecting from the given netmask or IP address. Can be
261-
specified multiple times. Whitelisted peers cannot be DoS banned
262-
and their transactions are always relayed, even if they are
263-
already in the mempool, useful e.g. for a gateway
269+
Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or
270+
CIDR notated network (e.g. 1.2.3.0/24). Can be specified multiple
271+
times. Whitelisted peers cannot be DoS banned and their
272+
transactions are always relayed, even if they are already in the
273+
mempool, useful e.g. for a gateway
264274
.HP
265275
\fB\-whitelistrelay\fR
266276
.IP
@@ -269,7 +279,7 @@ not relaying transactions (default: 1)
269279
.HP
270280
\fB\-whitelistforcerelay\fR
271281
.IP
272-
Force relay of transactions from whitelisted peers even they violate
282+
Force relay of transactions from whitelisted peers even if they violate
273283
local relay policy (default: 1)
274284
.HP
275285
\fB\-maxuploadtarget=\fR<n>
@@ -316,7 +326,7 @@ Spend unconfirmed change when sending transactions (default: 1)
316326
\fB\-txconfirmtarget=\fR<n>
317327
.IP
318328
If paytxfee is not set, include enough fee so transactions begin
319-
confirmation on average within n blocks (default: 2)
329+
confirmation on average within n blocks (default: 6)
320330
.HP
321331
\fB\-usehd\fR
322332
.IP
@@ -432,10 +442,11 @@ Append comment to the user agent string
432442
Output debugging information (default: 0, supplying <category> is
433443
optional). If <category> is not supplied or if <category> = 1,
434444
output all debugging information.<category> can be: addrman,
435-
alert, bench, coindb, db, http, leveldb, libevent, lock, mempool,
436-
mempoolrej, net, proxy, prune, rand, reindex, rpc, selectcoins,
437-
tor, zmq, dash (or specifically: gobject, instantsend, keepass,
438-
masternode, mnpayments, mnsync, privatesend, spork), qt.
445+
alert, bench, cmpctblock, coindb, db, http, leveldb, libevent,
446+
lock, mempool, mempoolrej, net, proxy, prune, rand, reindex, rpc,
447+
selectcoins, tor, zmq, dash (or specifically: gobject,
448+
instantsend, keepass, masternode, mnpayments, mnsync,
449+
privatesend, spork), qt.
439450
.HP
440451
\fB\-help\-debug\fR
441452
.IP
@@ -478,10 +489,19 @@ Chain selection options:
478489
.IP
479490
Use the test chain
480491
.HP
492+
\fB\-devnet=\fR<name>
493+
.IP
494+
Use devnet chain with provided name
495+
.HP
481496
\fB\-litemode=\fR<n>
482497
.IP
483498
Disable all Dash specific functionality (Masternodes, PrivateSend,
484499
InstantSend, Governance) (0\-1, default: 0)
500+
.HP
501+
\fB\-sporkaddr=\fR<hex>
502+
.IP
503+
Override spork address. Only useful for regtest and devnet. Using this
504+
on mainnet or testnet will ban you.
485505
.PP
486506
Masternode options:
487507
.HP
@@ -520,7 +540,7 @@ Use N separate masternodes for each denominated input to mix funds
520540
.HP
521541
\fB\-privatesendamount=\fR<n>
522542
.IP
523-
Keep N DASH anonymized (default: 1000)
543+
Keep N DASH anonymized (2\-21000000, default: 1000)
524544
.HP
525545
\fB\-liquidityprovider=\fR<n>
526546
.IP
@@ -537,7 +557,7 @@ default: 1)
537557
.HP
538558
\fB\-instantsenddepth=\fR<n>
539559
.IP
540-
Show N confirmations for a successfully locked transaction (0\-9999,
560+
Show N confirmations for a successfully locked transaction (0\-60,
541561
default: 5)
542562
.HP
543563
\fB\-instantsendnotify=\fR<cmd>
@@ -568,12 +588,17 @@ Block creation options:
568588
.HP
569589
\fB\-blockmaxsize=\fR<n>
570590
.IP
571-
Set maximum block size in bytes (default: 750000)
591+
Set maximum block size in bytes (default: 2000000)
572592
.HP
573593
\fB\-blockprioritysize=\fR<n>
574594
.IP
575595
Set maximum size of high\-priority/low\-fee transactions in bytes
576596
(default: 10000)
597+
.HP
598+
\fB\-blockmintxfee=\fR<amt>
599+
.IP
600+
Set lowest fee rate (in DASH/kB) for transactions to be included in
601+
block creation. (default: 0.00001)
577602
.PP
578603
RPC server options:
579604
.HP
@@ -607,8 +632,10 @@ Password for JSON\-RPC connections
607632
.IP
608633
Username and hashed password for JSON\-RPC connections. The field
609634
<userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A
610-
canonical python script is included in share/rpcuser. This option
611-
can be specified multiple times
635+
canonical python script is included in share/rpcuser. The client
636+
then connects normally using the
637+
rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This
638+
option can be specified multiple times
612639
.HP
613640
\fB\-rpcport=\fR<port>
614641
.IP
@@ -661,8 +688,8 @@ The source code is available from <https://github.com/dashpay/dash>.
661688

662689
This is experimental software.
663690
Distributed under the MIT software license, see the accompanying file COPYING
664-
or <http://www.opensource.org/licenses/mit-license.php>.
691+
or <https://opensource.org/licenses/MIT>
665692

666693
This product includes software developed by the OpenSSL Project for use in the
667-
OpenSSL Toolkit <https://www.openssl.org/> and cryptographic software written
668-
by Eric Young and UPnP software written by Thomas Bernard.
694+
OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
695+
Eric Young and UPnP software written by Thomas Bernard.

doc/man/dash-tx.1

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
2-
.TH DASH-TX "1" "January 2018" "dash-tx v0.12.3.0" "User Commands"
2+
.TH DASH-TX "1" "May 2018" "dash-tx v0.12.3.0" "User Commands"
33
.SH NAME
44
dash-tx \- manual page for dash-tx v0.12.3.0
55
.SH DESCRIPTION
@@ -35,6 +35,10 @@ Chain selection options:
3535
.IP
3636
Use the test chain
3737
.HP
38+
\fB\-devnet=\fR<name>
39+
.IP
40+
Use devnet chain with provided name
41+
.HP
3842
\fB\-regtest\fR
3943
.IP
4044
Enter regression test mode, which uses a special chain in which blocks
@@ -67,13 +71,25 @@ outaddr=VALUE:ADDRESS
6771
.IP
6872
Add address\-based output to TX
6973
.IP
74+
outpubkey=VALUE:PUBKEY[:FLAGS]
75+
.IP
76+
Add pay\-to\-pubkey output to TX. Optionally add the "S" flag to wrap the
77+
output in a pay\-to\-script\-hash.
78+
.IP
7079
outdata=[VALUE:]DATA
7180
.IP
7281
Add data\-based output to TX
7382
.IP
74-
outscript=VALUE:SCRIPT
83+
outscript=VALUE:SCRIPT[:FLAGS]
84+
.IP
85+
Add raw script output to TX. Optionally add the "S" flag to wrap the
86+
output in a pay\-to\-script\-hash.
87+
.IP
88+
outmultisig=VALUE:REQUIRED:PUBKEYS:PUBKEY1:PUBKEY2:....[:FLAGS]
7589
.IP
76-
Add raw script output to TX
90+
Add Pay To n\-of\-m Multi\-sig output to TX. n = REQUIRED, m = PUBKEYS.
91+
Optionally add the "S" flag to wrap the output in a
92+
pay\-to\-script\-hash.
7793
.IP
7894
sign=SIGHASH\-FLAGS
7995
.IP
@@ -101,8 +117,8 @@ The source code is available from <https://github.com/dashpay/dash>.
101117

102118
This is experimental software.
103119
Distributed under the MIT software license, see the accompanying file COPYING
104-
or <http://www.opensource.org/licenses/mit-license.php>.
120+
or <https://opensource.org/licenses/MIT>
105121

106122
This product includes software developed by the OpenSSL Project for use in the
107-
OpenSSL Toolkit <https://www.openssl.org/> and cryptographic software written
108-
by Eric Young and UPnP software written by Thomas Bernard.
123+
OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
124+
Eric Young and UPnP software written by Thomas Bernard.

0 commit comments

Comments
 (0)