Skip to content

Commit 245992a

Browse files
committed
Doc: update manpages
1 parent bb4c83d commit 245992a

File tree

4 files changed

+390
-351
lines changed

4 files changed

+390
-351
lines changed

doc/man/pivx-cli.1

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
1-
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
2-
.TH PIVX-CLI "1" "July 2018" "pivx-cli v3.1.99.0" "User Commands"
1+
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.3.
2+
.TH PIVX-CLI "1" "August 2021" "pivx-cli v5.3.0.0" "User Commands"
33
.SH NAME
4-
pivx-cli \- manual page for pivx-cli v3.1.99.0
4+
pivx-cli \- manual page for pivx-cli v5.3.0.0
55
.SH DESCRIPTION
6-
PIVX Core RPC client version v3.1.99.0\-11f4a2bba4\-dirty
6+
PIVX Core RPC client version v5.3.0.0\-bb4c83dff\-dirty
77
.SS "Usage:"
88
.TP
99
pivx\-cli [options] <command> [params]
1010
Send command to PIVX Core
11-
.TP
12-
pivx\-cli [options] help
13-
List commands
14-
.TP
15-
pivx\-cli [options] help <command>
16-
Get help for a command
11+
.IP
12+
pivx\-cli [options] \fB\-named\fR <command> [name=value] ... Send command to PIVX Core (with named arguments)
13+
pivx\-cli [options] help List commands
14+
pivx\-cli [options] help <command> Get help for a command
1715
.SH OPTIONS
1816
.HP
1917
\-?
@@ -27,24 +25,31 @@ Specify configuration file (default: pivx.conf)
2725
\fB\-datadir=\fR<dir>
2826
.IP
2927
Specify data directory
28+
.PP
29+
Chain selection options:
3030
.HP
3131
\fB\-testnet\fR
3232
.IP
33-
Use the test network
33+
Use the test chain
3434
.HP
3535
\fB\-regtest\fR
3636
.IP
3737
Enter regression test mode, which uses a special chain in which blocks
3838
can be solved instantly. This is intended for regression testing tools
3939
and app development.
4040
.HP
41+
\fB\-named\fR
42+
.IP
43+
Pass named instead of positional arguments (default: false)
44+
.HP
4145
\fB\-rpcconnect=\fR<ip>
4246
.IP
4347
Send commands to node running on <ip> (default: 127.0.0.1)
4448
.HP
4549
\fB\-rpcport=\fR<port>
4650
.IP
47-
Connect to JSON\-RPC on <port> (default: 51473 or testnet: 51475)
51+
Listen for JSON\-RPC connections on <port> (default: 51473 or testnet:
52+
51475)
4853
.HP
4954
\fB\-rpcwait\fR
5055
.IP
@@ -60,19 +65,23 @@ Password for JSON\-RPC connections
6065
.HP
6166
\fB\-rpcclienttimeout=\fR<n>
6267
.IP
63-
Timeout during HTTP requests (default: 900)
68+
Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
69+
900)
70+
.HP
71+
\fB\-rpcwallet=\fR<walletname>
72+
.IP
73+
Send RPC for non\-default wallet on RPC server (needs to exactly match
74+
corresponding \fB\-wallet\fR option passed to pivxd)
6475
.SH COPYRIGHT
65-
Copyright (C) 2009-2018 The Bitcoin Core Developers
76+
Copyright (C) 2009-2021 The Bitcoin Core Developers
6677

67-
Copyright (C) 2014-2018 The Dash Core Developers
78+
Copyright (C) 2014-2021 The Dash Core Developers
6879

69-
Copyright (C) 2015-2018 The PIVX Core Developers
80+
Copyright (C) 2015-2021 The PIVX Core Developers
7081

7182
This is experimental software.
7283

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

76-
This product includes software developed by the OpenSSL Project for use in the
77-
OpenSSL Toolkit <https://www.openssl.org/> and cryptographic software written
78-
by Eric Young and UPnP software written by Thomas Bernard.
87+
This product includes UPnP software written by Thomas Bernard.

0 commit comments

Comments
 (0)