From aca5eda3cc2c28f14246a82f1292ce73837788e6 Mon Sep 17 00:00:00 2001 From: random-zebra Date: Tue, 14 Apr 2020 18:02:08 +0200 Subject: [PATCH] update manpages --- doc/man/pivx-cli.1 | 14 +++--- doc/man/pivx-qt.1 | 111 +++++++++++++++++++++++++-------------------- doc/man/pivx-tx.1 | 14 +++--- doc/man/pivxd.1 | 107 +++++++++++++++++++++++-------------------- 4 files changed, 136 insertions(+), 110 deletions(-) diff --git a/doc/man/pivx-cli.1 b/doc/man/pivx-cli.1 index c24168cbd099c..de9582e1723ab 100644 --- a/doc/man/pivx-cli.1 +++ b/doc/man/pivx-cli.1 @@ -1,9 +1,9 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH PIVX-CLI "1" "July 2018" "pivx-cli v3.1.99.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH PIVX-CLI "1" "April 2020" "pivx-cli v4.1.0.0" "User Commands" .SH NAME -pivx-cli \- manual page for pivx-cli v3.1.99.0 +pivx-cli \- manual page for pivx-cli v4.1.0.0 .SH DESCRIPTION -PIVX Core RPC client version v3.1.99.0\-11f4a2bba4\-dirty +PIVX Core RPC client version v4.1.0.0 .SS "Usage:" .TP pivx\-cli [options] [params] @@ -62,11 +62,11 @@ Password for JSON\-RPC connections .IP Timeout during HTTP requests (default: 900) .SH COPYRIGHT -Copyright (C) 2009-2018 The Bitcoin Core Developers +Copyright (C) 2009-2020 The Bitcoin Core Developers -Copyright (C) 2014-2018 The Dash Core Developers +Copyright (C) 2014-2020 The Dash Core Developers -Copyright (C) 2015-2018 The PIVX Core Developers +Copyright (C) 2015-2020 The PIVX Core Developers This is experimental software. diff --git a/doc/man/pivx-qt.1 b/doc/man/pivx-qt.1 index 20759992943a2..e4960a6768bb7 100644 --- a/doc/man/pivx-qt.1 +++ b/doc/man/pivx-qt.1 @@ -1,9 +1,9 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH PIVX-QT "1" "July 2018" "pivx-qt v3.1.99.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH PIVX-QT "1" "April 2020" "pivx-qt v4.1.0.0" "User Commands" .SH NAME -pivx-qt \- manual page for pivx-qt v3.1.99.0 +pivx-qt \- manual page for pivx-qt v4.1.0.0 .SH DESCRIPTION -PIVX Core version v3.1.99.0\-11f4a2bba4\-dirty (64\-bit) +PIVX Core version v4.1.0.0 (64\-bit) Usage: .IP pivx\-qt [command\-line options] @@ -22,10 +22,6 @@ Print version and exit Execute command when a relevant alert is received or we see a really long fork (%s in cmd is replaced by message) .HP -\fB\-alerts\fR -.IP -Receive and display P2P network alerts (default: 1) -.HP \fB\-blocknotify=\fR .IP Execute command when the best block changes (%s in cmd is replaced by @@ -48,6 +44,11 @@ Specify configuration file (default: pivx.conf) .IP Specify data directory .HP +\fB\-debuglogfile=\fR +.IP +Specify location of debug log file: this can be an absolute path or a +path relative to the data directory (default: debug.log) +.HP \fB\-dbcache=\fR .IP Set database cache size in megabytes (4 to 4096, default: 100) @@ -66,7 +67,7 @@ Keep at most unconnectable transactions in memory (default: 100) .HP \fB\-par=\fR .IP -Set the number of script verification threads (\fB\-8\fR to 16, 0 = auto, <0 = +Set the number of script verification threads (\fB\-24\fR to 16, 0 = auto, <0 = leave that many cores free, default: 0) .HP \fB\-pid=\fR @@ -77,10 +78,6 @@ Specify pid file (default: pivxd.pid) .IP Rebuild block chain index from current blk000??.dat files on startup .HP -\fB\-reindexaccumulators\fR -.IP -Reindex the accumulator database on startup -.HP \fB\-reindexmoneysupply\fR .IP Reindex the PIV and zPIV money supply statistics on startup @@ -216,10 +213,6 @@ Tor control port to use if onion listening enabled (default: .IP Tor control port password (default: empty) .HP -\fB\-upnp\fR -.IP -Use UPnP to map the listening port (default: 0) -.HP \fB\-whitebind=\fR .IP Bind to given address and whitelist peers connecting to it. Use @@ -290,6 +283,10 @@ confirmation on average within n blocks (default: 1) Maximum total fees to use in a single wallet transaction, setting too low may abort large transactions (default: 1.00) .HP +\fB\-legacywallet\fR +.IP +On first run, create a legacy wallet instead of a HD wallet +.HP \fB\-upgradewallet\fR .IP Upgrade wallet to latest format on startup @@ -341,13 +338,24 @@ Enable publish raw transaction (locked via SwiftX) in
.PP Debugging/Testing options: .HP +\fB\-uacomment=\fR +.IP +Append comment to the user agent string +.HP \fB\-debug=\fR .IP Output debugging information (default: 0, supplying is optional). If is not supplied, output all debugging -information. can be: addrman, alert, bench, coindb, db, lock, -rand, rpc, selectcoins, tor, mempool, net, proxy, http, libevent, pivx, -(obfuscation, swiftx, masternode, mnpayments, mnbudget, zero), qt. +information. can be: net, tor, mempool, http, bench, zmq, db, +rpc, estimatefee, addrman, selectcoins, reindex, cmpctblock, rand, +prune, proxy, mempoolrej, libevent, coindb, qt, leveldb, staking, +masternode, mnbudget, zero. +.HP +\fB\-debugexclude=\fR +.IP +Exclude debugging information for a category. Can be used in conjunction +with \fB\-debug\fR=\fI\,1\/\fR to output debug logs for all categories except one or more +specified categories. .HP \fB\-gen\fR .IP @@ -370,6 +378,15 @@ Include IP addresses in debug output (default: 0) .IP Prepend debug output with timestamp (default: 1) .HP +\fB\-logtimemicros\fR +.IP +Add microsecond precision to debug timestamps (default: 0) +.HP +\fB\-maxtipage=\fR +.IP +Maximum tip age in seconds to consider node in initial block download +(default: 86400) +.HP \fB\-minrelaytxfee=\fR .IP Fees (in PIV/Kb) smaller than this are considered zero fee for relaying @@ -398,6 +415,11 @@ Staking options: .IP Enable staking functionality (0\-1, default: 1) .HP +\fB\-coldstaking=\fR +.IP +Enable cold staking functionality (0\-1, default: 1). Disabled if +staking=0 +.HP \fB\-pivstake=\fR .IP Enable or disable staking functionality for PIV inputs (0\-1, default: 1) @@ -443,31 +465,6 @@ default: auto) .PP Zerocoin options: .HP -\fB\-enablezeromint=\fR -.IP -Enable automatic Zerocoin minting (0\-1, default: 1) -.HP -\fB\-zeromintpercentage=\fR -.IP -Percentage of automatically minted Zerocoin (1\-100, default: 10) -.HP -\fB\-preferredDenom=\fR -.IP -Preferred Denomination for automatically minted Zerocoin -(1/5/10/50/100/500/1000/5000), 0 for no preference. default: 0) -.HP -\fB\-backupzpiv=\fR -.IP -Enable automatic wallet backups triggered after each zPIV minting (0\-1, -default: 1) -.HP -\fB\-zpivbackuppath=\fR -.IP -Specify custom backup path to add a copy of any automatic zPIV backup. -If set as dir, every backup generates a timestamped file. If set as -file, will rewrite to that file every backup. If backuppath is set as -well, 4 backups will happen -.HP \fB\-reindexzerocoin=\fR .IP Delete all zerocoin spends and mints that have been recorded to the @@ -554,6 +551,20 @@ multiple times \fB\-rpcthreads=\fR .IP Set the number of threads to service RPC calls (default: 4) +.HP +\fB\-blockspamfilter=\fR +.IP +Use block spam filter (default: 1) +.HP +\fB\-blockspamfiltermaxsize=\fR +.IP +Maximum size of the list of indexes in the block spam filter (default: +100) +.HP +\fB\-blockspamfiltermaxavg=\fR +.IP +Maximum average size of an index occurrence in the block spam filter +(default: 10) .PP UI Options: .HP @@ -576,12 +587,16 @@ Set SSL root certificates for payment request (default: \fB\-system\-\fR) \fB\-splash\fR .IP Show splash screen on startup (default: 1) +.HP +\fB\-hidecharts\fR +.IP +Hide QT staking charts on startup (default: 0) .SH COPYRIGHT -Copyright (C) 2009-2018 The Bitcoin Core Developers +Copyright (C) 2009-2020 The Bitcoin Core Developers -Copyright (C) 2014-2018 The Dash Core Developers +Copyright (C) 2014-2020 The Dash Core Developers -Copyright (C) 2015-2018 The PIVX Core Developers +Copyright (C) 2015-2020 The PIVX Core Developers This is experimental software. diff --git a/doc/man/pivx-tx.1 b/doc/man/pivx-tx.1 index 473c691e97d40..6d44ae64643e3 100644 --- a/doc/man/pivx-tx.1 +++ b/doc/man/pivx-tx.1 @@ -1,9 +1,9 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH PIVX-TX "1" "July 2018" "pivx-tx v3.1.99.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH PIVX-TX "1" "April 2020" "pivx-tx v4.1.0.0" "User Commands" .SH NAME -pivx-tx \- manual page for pivx-tx v3.1.99.0 +pivx-tx \- manual page for pivx-tx v4.1.0.0 .SH DESCRIPTION -Pivx Core pivx\-tx utility version v3.1.99.0\-11f4a2bba4\-dirty +Pivx Core pivx\-tx utility version v4.1.0.0 .SS "Usage:" .TP pivx\-tx [options] [commands] @@ -84,11 +84,11 @@ set=NAME:JSON\-STRING .IP Set register NAME to given JSON\-STRING .SH COPYRIGHT -Copyright (C) 2009-2018 The Bitcoin Core Developers +Copyright (C) 2009-2020 The Bitcoin Core Developers -Copyright (C) 2014-2018 The Dash Core Developers +Copyright (C) 2014-2020 The Dash Core Developers -Copyright (C) 2015-2018 The PIVX Core Developers +Copyright (C) 2015-2020 The PIVX Core Developers This is experimental software. diff --git a/doc/man/pivxd.1 b/doc/man/pivxd.1 index 89a76ebe7d6e6..d2d05bd469089 100644 --- a/doc/man/pivxd.1 +++ b/doc/man/pivxd.1 @@ -1,9 +1,9 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH PIVXD "1" "July 2018" "pivxd v3.1.99.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH PIVXD "1" "April 2020" "pivxd v4.1.0.0" "User Commands" .SH NAME -pivxd \- manual page for pivxd v3.1.99.0 +pivxd \- manual page for pivxd v4.1.0.0 .SH DESCRIPTION -Pivx Core Daemon version v3.1.99.0\-11f4a2bba4\-dirty +Pivx Core Daemon version v4.1.0.0 .SS "Usage:" .TP pivxd [options] @@ -23,10 +23,6 @@ Print version and exit Execute command when a relevant alert is received or we see a really long fork (%s in cmd is replaced by message) .HP -\fB\-alerts\fR -.IP -Receive and display P2P network alerts (default: 1) -.HP \fB\-blocknotify=\fR .IP Execute command when the best block changes (%s in cmd is replaced by @@ -53,6 +49,11 @@ Run in the background as a daemon and accept commands .IP Specify data directory .HP +\fB\-debuglogfile=\fR +.IP +Specify location of debug log file: this can be an absolute path or a +path relative to the data directory (default: debug.log) +.HP \fB\-dbcache=\fR .IP Set database cache size in megabytes (4 to 4096, default: 100) @@ -71,7 +72,7 @@ Keep at most unconnectable transactions in memory (default: 100) .HP \fB\-par=\fR .IP -Set the number of script verification threads (\fB\-8\fR to 16, 0 = auto, <0 = +Set the number of script verification threads (\fB\-24\fR to 16, 0 = auto, <0 = leave that many cores free, default: 0) .HP \fB\-pid=\fR @@ -82,10 +83,6 @@ Specify pid file (default: pivxd.pid) .IP Rebuild block chain index from current blk000??.dat files on startup .HP -\fB\-reindexaccumulators\fR -.IP -Reindex the accumulator database on startup -.HP \fB\-reindexmoneysupply\fR .IP Reindex the PIV and zPIV money supply statistics on startup @@ -221,10 +218,6 @@ Tor control port to use if onion listening enabled (default: .IP Tor control port password (default: empty) .HP -\fB\-upnp\fR -.IP -Use UPnP to map the listening port (default: 0) -.HP \fB\-whitebind=\fR .IP Bind to given address and whitelist peers connecting to it. Use @@ -295,6 +288,10 @@ confirmation on average within n blocks (default: 1) Maximum total fees to use in a single wallet transaction, setting too low may abort large transactions (default: 1.00) .HP +\fB\-legacywallet\fR +.IP +On first run, create a legacy wallet instead of a HD wallet +.HP \fB\-upgradewallet\fR .IP Upgrade wallet to latest format on startup @@ -342,13 +339,24 @@ Enable publish raw transaction (locked via SwiftX) in
.PP Debugging/Testing options: .HP +\fB\-uacomment=\fR +.IP +Append comment to the user agent string +.HP \fB\-debug=\fR .IP Output debugging information (default: 0, supplying is optional). If is not supplied, output all debugging -information. can be: addrman, alert, bench, coindb, db, lock, -rand, rpc, selectcoins, tor, mempool, net, proxy, http, libevent, pivx, -(obfuscation, swiftx, masternode, mnpayments, mnbudget, zero). +information. can be: net, tor, mempool, http, bench, zmq, db, +rpc, estimatefee, addrman, selectcoins, reindex, cmpctblock, rand, +prune, proxy, mempoolrej, libevent, coindb, qt, leveldb, staking, +masternode, mnbudget, zero. +.HP +\fB\-debugexclude=\fR +.IP +Exclude debugging information for a category. Can be used in conjunction +with \fB\-debug\fR=\fI\,1\/\fR to output debug logs for all categories except one or more +specified categories. .HP \fB\-gen\fR .IP @@ -371,6 +379,15 @@ Include IP addresses in debug output (default: 0) .IP Prepend debug output with timestamp (default: 1) .HP +\fB\-logtimemicros\fR +.IP +Add microsecond precision to debug timestamps (default: 0) +.HP +\fB\-maxtipage=\fR +.IP +Maximum tip age in seconds to consider node in initial block download +(default: 86400) +.HP \fB\-minrelaytxfee=\fR .IP Fees (in PIV/Kb) smaller than this are considered zero fee for relaying @@ -399,6 +416,11 @@ Staking options: .IP Enable staking functionality (0\-1, default: 1) .HP +\fB\-coldstaking=\fR +.IP +Enable cold staking functionality (0\-1, default: 1). Disabled if +staking=0 +.HP \fB\-pivstake=\fR .IP Enable or disable staking functionality for PIV inputs (0\-1, default: 1) @@ -444,31 +466,6 @@ default: auto) .PP Zerocoin options: .HP -\fB\-enablezeromint=\fR -.IP -Enable automatic Zerocoin minting (0\-1, default: 1) -.HP -\fB\-zeromintpercentage=\fR -.IP -Percentage of automatically minted Zerocoin (1\-100, default: 10) -.HP -\fB\-preferredDenom=\fR -.IP -Preferred Denomination for automatically minted Zerocoin -(1/5/10/50/100/500/1000/5000), 0 for no preference. default: 0) -.HP -\fB\-backupzpiv=\fR -.IP -Enable automatic wallet backups triggered after each zPIV minting (0\-1, -default: 1) -.HP -\fB\-zpivbackuppath=\fR -.IP -Specify custom backup path to add a copy of any automatic zPIV backup. -If set as dir, every backup generates a timestamped file. If set as -file, will rewrite to that file every backup. If backuppath is set as -well, 4 backups will happen -.HP \fB\-reindexzerocoin=\fR .IP Delete all zerocoin spends and mints that have been recorded to the @@ -555,12 +552,26 @@ multiple times \fB\-rpcthreads=\fR .IP Set the number of threads to service RPC calls (default: 4) +.HP +\fB\-blockspamfilter=\fR +.IP +Use block spam filter (default: 1) +.HP +\fB\-blockspamfiltermaxsize=\fR +.IP +Maximum size of the list of indexes in the block spam filter (default: +100) +.HP +\fB\-blockspamfiltermaxavg=\fR +.IP +Maximum average size of an index occurrence in the block spam filter +(default: 10) .SH COPYRIGHT -Copyright (C) 2009-2018 The Bitcoin Core Developers +Copyright (C) 2009-2020 The Bitcoin Core Developers -Copyright (C) 2014-2018 The Dash Core Developers +Copyright (C) 2014-2020 The Dash Core Developers -Copyright (C) 2015-2018 The PIVX Core Developers +Copyright (C) 2015-2020 The PIVX Core Developers This is experimental software.