Skip to content

Commit

Permalink
Doc: update manpages
Browse files Browse the repository at this point in the history
  • Loading branch information
furszy committed Aug 21, 2021
1 parent bb4c83d commit 245992a
Show file tree
Hide file tree
Showing 4 changed files with 390 additions and 351 deletions.
47 changes: 28 additions & 19 deletions doc/man/pivx-cli.1
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
.\" 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.48.3.
.TH PIVX-CLI "1" "August 2021" "pivx-cli v5.3.0.0" "User Commands"
.SH NAME
pivx-cli \- manual page for pivx-cli v3.1.99.0
pivx-cli \- manual page for pivx-cli v5.3.0.0
.SH DESCRIPTION
PIVX Core RPC client version v3.1.99.0\-11f4a2bba4\-dirty
PIVX Core RPC client version v5.3.0.0\-bb4c83dff\-dirty
.SS "Usage:"
.TP
pivx\-cli [options] <command> [params]
Send command to PIVX Core
.TP
pivx\-cli [options] help
List commands
.TP
pivx\-cli [options] help <command>
Get help for a command
.IP
pivx\-cli [options] \fB\-named\fR <command> [name=value] ... Send command to PIVX Core (with named arguments)
pivx\-cli [options] help List commands
pivx\-cli [options] help <command> Get help for a command
.SH OPTIONS
.HP
\-?
Expand All @@ -27,24 +25,31 @@ Specify configuration file (default: pivx.conf)
\fB\-datadir=\fR<dir>
.IP
Specify data directory
.PP
Chain selection options:
.HP
\fB\-testnet\fR
.IP
Use the test network
Use the test chain
.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)
.HP
\fB\-rpcport=\fR<port>
.IP
Connect to JSON\-RPC on <port> (default: 51473 or testnet: 51475)
Listen for JSON\-RPC connections on <port> (default: 51473 or testnet:
51475)
.HP
\fB\-rpcwait\fR
.IP
Expand All @@ -60,19 +65,23 @@ Password for JSON\-RPC connections
.HP
\fB\-rpcclienttimeout=\fR<n>
.IP
Timeout during HTTP requests (default: 900)
Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
900)
.HP
\fB\-rpcwallet=\fR<walletname>
.IP
Send RPC for non\-default wallet on RPC server (needs to exactly match
corresponding \fB\-wallet\fR option passed to pivxd)
.SH COPYRIGHT
Copyright (C) 2009-2018 The Bitcoin Core Developers
Copyright (C) 2009-2021 The Bitcoin Core Developers

Copyright (C) 2014-2018 The Dash Core Developers
Copyright (C) 2014-2021 The Dash Core Developers

Copyright (C) 2015-2018 The PIVX Core Developers
Copyright (C) 2015-2021 The PIVX Core Developers

This is experimental software.

Distributed under the MIT software license, see the accompanying file COPYING
or <http://www.opensource.org/licenses/mit-license.php>.

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.
This product includes UPnP software written by Thomas Bernard.
Loading

0 comments on commit 245992a

Please sign in to comment.