Skip to content

Commit

Permalink
doc: update manpages
Browse files Browse the repository at this point in the history
  • Loading branch information
Fuzzbawls committed Jul 11, 2020
1 parent bfdc7e0 commit 8279afd
Show file tree
Hide file tree
Showing 4 changed files with 172 additions and 134 deletions.
14 changes: 7 additions & 7 deletions doc/man/pivx-cli.1
Original file line number Diff line number Diff line change
@@ -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.11.
.TH PIVX-CLI "1" "July 2020" "pivx-cli v4.2.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.2.0.0
.SH DESCRIPTION
PIVX Core RPC client version v3.1.99.0\-11f4a2bba4\-dirty
PIVX Core RPC client version v4.2.0.0\-bfdc7e0205
.SS "Usage:"
.TP
pivx\-cli [options] <command> [params]
Expand Down Expand Up @@ -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.

Expand Down
141 changes: 81 additions & 60 deletions doc/man/pivx-qt.1
Original file line number Diff line number Diff line change
@@ -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.11.
.TH PIVX-QT "1" "July 2020" "pivx-qt v4.2.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.2.0.0
.SH DESCRIPTION
PIVX Core version v3.1.99.0\-11f4a2bba4\-dirty (64\-bit)
PIVX Core version v4.2.0.0\-bfdc7e0205 (64\-bit)
Usage:
.IP
pivx\-qt [command\-line options]
Expand All @@ -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<cmd>
.IP
Execute command when the best block changes (%s in cmd is replaced by
Expand All @@ -48,9 +44,14 @@ Specify configuration file (default: pivx.conf)
.IP
Specify data directory
.HP
\fB\-debuglogfile=\fR<file>
.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<n>
.IP
Set database cache size in megabytes (4 to 4096, default: 100)
Set database cache size in megabytes (4 to 16384, default: 100)
.HP
\fB\-loadblock=\fR<file>
.IP
Expand All @@ -64,9 +65,18 @@ Set the Maximum reorg depth (default: 100)
.IP
Keep at most <n> unconnectable transactions in memory (default: 100)
.HP
\fB\-maxmempool=\fR<n>
.IP
Keep the transaction memory pool below <n> megabytes (default: 300)
.HP
\fB\-mempoolexpiry=\fR<n>
.IP
Do not keep transactions in the mempool longer than <n> hours (default:
72)
.HP
\fB\-par=\fR<n>
.IP
Set the number of script verification threads (\fB\-8\fR to 16, 0 = auto, <0 =
Set the number of script verification threads (\fB\-16\fR to 16, 0 = auto, <0 =
leave that many cores free, default: 0)
.HP
\fB\-pid=\fR<file>
Expand All @@ -77,10 +87,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
Expand Down Expand Up @@ -125,7 +131,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 @@ -138,7 +145,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 @@ -150,7 +157,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 @@ -290,6 +298,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
Expand Down Expand Up @@ -341,13 +353,24 @@ Enable publish raw transaction (locked via SwiftX) in <address>
.PP
Debugging/Testing options:
.HP
\fB\-uacomment=\fR<cmt>
.IP
Append comment to the user agent string
.HP
\fB\-debug=\fR<category>
.IP
Output debugging information (default: 0, supplying <category> is
optional). If <category> is not supplied, output all debugging
information.<category> 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.<category> 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<category>
.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
Expand All @@ -370,10 +393,19 @@ 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<n>
.IP
Maximum tip age in seconds to consider node in initial block download
(default: 86400)
.HP
\fB\-minrelaytxfee=\fR<amt>
.IP
Fees (in PIV/Kb) smaller than this are considered zero fee for relaying
(default: 0.0001)
Fees (in PIV/Kb) smaller than this are considered zero fee for relaying,
mining and transaction creation (default: 0.0001)
.HP
\fB\-printtoconsole\fR
.IP
Expand All @@ -398,19 +430,15 @@ Staking options:
.IP
Enable staking functionality (0\-1, default: 1)
.HP
\fB\-pivstake=\fR<n>
\fB\-coldstaking=\fR<n>
.IP
Enable or disable staking functionality for PIV inputs (0\-1, default: 1)
Enable cold staking functionality (0\-1, default: 1). Disabled if
staking=0
.HP
\fB\-zpivstake=\fR<n>
\fB\-minstakesplit=\fR<amt>
.IP
Enable or disable staking functionality for zPIV inputs (0\-1, default:
1)
.HP
\fB\-reservebalance=\fR<amt>
.IP
Keep the specified amount available for spending at all times (default:
0)
Minimum positive amount (in PIV) allowed by GUI and RPC for the stake
split threshold (default: 100.00)
.PP
Masternode options:
.HP
Expand Down Expand Up @@ -443,31 +471,6 @@ default: auto)
.PP
Zerocoin options:
.HP
\fB\-enablezeromint=\fR<n>
.IP
Enable automatic Zerocoin minting (0\-1, default: 1)
.HP
\fB\-zeromintpercentage=\fR<n>
.IP
Percentage of automatically minted Zerocoin (1\-100, default: 10)
.HP
\fB\-preferredDenom=\fR<n>
.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<n>
.IP
Enable automatic wallet backups triggered after each zPIV minting (0\-1,
default: 1)
.HP
\fB\-zpivbackuppath=\fR<dir|file>
.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<n>
.IP
Delete all zerocoin spends and mints that have been recorded to the
Expand Down Expand Up @@ -554,6 +557,20 @@ multiple times
\fB\-rpcthreads=\fR<n>
.IP
Set the number of threads to service RPC calls (default: 4)
.HP
\fB\-blockspamfilter=\fR<n>
.IP
Use block spam filter (default: 1)
.HP
\fB\-blockspamfiltermaxsize=\fR<n>
.IP
Maximum size of the list of indexes in the block spam filter (default:
100)
.HP
\fB\-blockspamfiltermaxavg=\fR<n>
.IP
Maximum average size of an index occurrence in the block spam filter
(default: 10)
.PP
UI Options:
.HP
Expand All @@ -576,12 +593,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.

Expand Down
14 changes: 7 additions & 7 deletions doc/man/pivx-tx.1
Original file line number Diff line number Diff line change
@@ -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.11.
.TH PIVX-TX "1" "July 2020" "pivx-tx v4.2.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.2.0.0
.SH DESCRIPTION
Pivx Core pivx\-tx utility version v3.1.99.0\-11f4a2bba4\-dirty
Pivx Core pivx\-tx utility version v4.2.0.0\-bfdc7e0205
.SS "Usage:"
.TP
pivx\-tx [options] <hex\-tx> [commands]
Expand Down Expand Up @@ -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.

Expand Down
Loading

0 comments on commit 8279afd

Please sign in to comment.