Skip to content

Commit

Permalink
update man pages for the daemon and cli utilty
Browse files Browse the repository at this point in the history
  • Loading branch information
peerchemist committed Feb 20, 2019
1 parent 2a51de5 commit b207ad6
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 106 deletions.
32 changes: 15 additions & 17 deletions doc/man/peercoin-cli.1
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH PEERCOIN-CLI "1" "September 2018" "peercoin-cli v0.8.0" "User Commands"
.TH PEERCOIN "1" "February 2019" "Peercoin Core RPC client version v0.8.0" "User Commands"
.SH NAME
peercoin-cli \- manual page for peercoin-cli v0.8.0
Peercoin \- peercoin-cli
.SH DESCRIPTION
Peercoin Core RPC client version v0.8.0
.SS "Usage:"
Expand Down Expand Up @@ -56,7 +56,7 @@ Send commands to node running on <ip> (default: 127.0.0.1)
.HP
\fB\-rpcport=\fR<port>
.IP
Connect to JSON\-RPC on <port> (default: 8332 or testnet: 18332)
Connect to JSON\-RPC on <port> (default: 9902 or testnet: 9904)
.HP
\fB\-rpcwait\fR
.IP
Expand Down Expand Up @@ -95,17 +95,15 @@ input is used for the RPC password.
Send RPC for non\-default wallet on RPC server (argument is wallet
filename in peercoind directory, required if peercoind/\-Qt runs
with multiple wallets)
.SH COPYRIGHT
Copyright (C) 2009-2018 The Bitcoin Core developers

Please contribute if you find Peercoin Core useful. Visit
<https://peercoincore.org> for further information about the software.
The source code is available from <https://github.com/peercoin/peercoin>.

This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING
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.
.SH "SEE ALSO"
The full documentation for
.B Peercoin
is maintained as a Texinfo manual. If the
.B info
and
.B Peercoin
programs are properly installed at your site, the command
.IP
.B info Peercoin
.PP
should give you access to the complete manual.
120 changes: 31 additions & 89 deletions doc/man/peercoind.1
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH PEERCOIND "1" "September 2018" "peercoind v0.8.0" "User Commands"
.TH PEERCOIN "1" "February 2019" "Peercoin Daemon version v0.8.0" "User Commands"
.SH NAME
peercoind \- manual page for peercoind v0.8.0
Peercoin \- peercoind
.SH DESCRIPTION
Peercoin Core Daemon version v0.8.0
.SS "Usage:"
Expand Down Expand Up @@ -86,25 +86,13 @@ Extra transactions to keep in memory for compact block reconstructions
.HP
\fB\-par=\fR<n>
.IP
Set the number of script verification threads (\fB\-6\fR to 16, 0 = auto, <0 =
Set the number of script verification threads (\fB\-2\fR to 16, 0 = auto, <0 =
leave that many cores free, default: 0)
.HP
\fB\-pid=\fR<file>
.IP
Specify pid file (default: peercoind.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,
>=550 = automatically prune block files to stay under the
specified target size in MiB)
.HP
\fB\-reindex\-chainstate\fR
.IP
Rebuild chain state from the currently indexed blocks
Expand All @@ -121,7 +109,7 @@ Create new files with system default permissions, instead of umask 077
\fB\-txindex\fR
.IP
Maintain a full transaction index, used by the getrawtransaction rpc
call (default: 0)
call (default: 1)
.PP
Connection options:
.HP
Expand Down Expand Up @@ -218,7 +206,7 @@ Support filtering of blocks and transaction with bloom filters (default:
.HP
\fB\-port=\fR<port>
.IP
Listen for connections on <port> (default: 8333 or testnet: 18333)
Listen for connections on <port> (default: 9901 or testnet: 9903)
.HP
\fB\-proxy=\fR<ip:port>
.IP
Expand Down Expand Up @@ -290,28 +278,6 @@ Do not load the wallet and disable wallet RPC calls
.IP
Set key pool size to <n> (default: 1000)
.HP
\fB\-fallbackfee=\fR<amt>
.IP
A fee rate (in BTC/kB) that will be used when fee estimation has
insufficient data (default: 0.0002)
.HP
\fB\-discardfee=\fR<amt>
.IP
The fee rate (in BTC/kB) that indicates your tolerance for discarding
change by adding it to the fee (default: 0.0001). Note: An output
is discarded if it is dust at this rate, but we will always
discard up to the dust relay fee and a discard fee above that is
limited by the fee estimate for the longest target
.HP
\fB\-mintxfee=\fR<amt>
.IP
Fees (in BTC/kB) smaller than this are considered zero fee for
transaction creation (default: 0.00001)
.HP
\fB\-paytxfee=\fR<amt>
.IP
Fee (in BTC/kB) to add to transactions you send (default: 0.00)
.HP
\fB\-rescan\fR
.IP
Rescan the block chain for missing wallet transactions on startup
Expand All @@ -329,10 +295,6 @@ Spend unconfirmed change when sending transactions (default: 1)
If paytxfee is not set, include enough fee so transactions begin
confirmation on average within n blocks (default: 6)
.HP
\fB\-walletrbf\fR
.IP
Send transactions with full\-RBF opt\-in enabled (RPC only, default: 0)
.HP
\fB\-upgradewallet\fR
.IP
Upgrade wallet to latest format on startup
Expand Down Expand Up @@ -362,24 +324,6 @@ blockchain through \fB\-rescan\fR on startup (1 = keep tx meta data e.g.
account owner and payment request information, 2 = drop tx meta
data)
.PP
ZeroMQ notification options:
.HP
\fB\-zmqpubhashblock=\fR<address>
.IP
Enable publish hash block in <address>
.HP
\fB\-zmqpubhashtx=\fR<address>
.IP
Enable publish hash transaction in <address>
.HP
\fB\-zmqpubrawblock=\fR<address>
.IP
Enable publish raw block in <address>
.HP
\fB\-zmqpubrawtx=\fR<address>
.IP
Enable publish raw transaction in <address>
.PP
Debugging/Testing options:
.HP
\fB\-uacomment=\fR<cmt>
Expand Down Expand Up @@ -413,12 +357,6 @@ Include IP addresses in debug output (default: 0)
.IP
Prepend debug output with timestamp (default: 1)
.HP
\fB\-maxtxfee=\fR<amt>
.IP
Maximum total fees (in BTC) to use in a single wallet transaction or raw
transaction; setting this too low may abort large transactions
(default: 0.10)
.HP
\fB\-printtoconsole\fR
.IP
Send trace/debug info to console instead of debug.log file
Expand Down Expand Up @@ -449,15 +387,6 @@ Relay and mine data carrier transactions (default: 1)
Maximum size of data in data carrier transactions we relay and mine
(default: 83)
.HP
\fB\-mempoolreplacement\fR
.IP
Enable transaction replacement in the memory pool (default: 1)
.HP
\fB\-minrelaytxfee=\fR<amt>
.IP
Fees (in BTC/kB) smaller than this are considered zero fee for relaying,
mining and transaction creation (default: 0.00001)
.HP
\fB\-whitelistrelay\fR
.IP
Accept relayed transactions received from whitelisted peers even when
Expand All @@ -473,11 +402,6 @@ Block creation options:
\fB\-blockmaxweight=\fR<n>
.IP
Set maximum BIP141 block weight (default: 3996000)
.HP
\fB\-blockmintxfee=\fR<amt>
.IP
Set lowest fee rate (in BTC/kB) for transactions to be included in block
creation. (default: 0.00001)
.PP
RPC server options:
.HP
Expand Down Expand Up @@ -521,8 +445,8 @@ option can be specified multiple times
.HP
\fB\-rpcport=\fR<port>
.IP
Listen for JSON\-RPC connections on <port> (default: 8332 or testnet:
18332)
Listen for JSON\-RPC connections on <port> (default: 9902 or testnet:
9904)
.HP
\fB\-rpcallowip=\fR<ip>
.IP
Expand All @@ -539,17 +463,35 @@ non\-verbose mode, non\-segwit(0) or segwit(1) (default: 1)
\fB\-rpcthreads=\fR<n>
.IP
Set the number of threads to service RPC calls (default: 4)
.HP
\fB\-nominting\fR
.IP
Disable minting of POS blocks
.SH COPYRIGHT
Copyright (C) 2009-2018 The Bitcoin Core developers

Please contribute if you find Peercoin Core useful. Visit
<https://peercoincore.org> for further information about the software.
Copyright \(co 2009\-2012 The Bitcoin Core developers
.br
Copyright \(co 20012\-2019 The Peercoin developers
.PP
Please contribute if you find Peercoin useful. Visit
<https://peercoin.net/> for further information about the software.
The source code is available from <https://github.com/peercoin/peercoin>.

.PP
This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING
or <https://opensource.org/licenses/MIT>

.PP
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.
.SH "SEE ALSO"
The full documentation for
.B Peercoin
is maintained as a Texinfo manual. If the
.B info
and
.B Peercoin
programs are properly installed at your site, the command
.IP
.B info Peercoin
.PP
should give you access to the complete manual.

0 comments on commit b207ad6

Please sign in to comment.