Skip to content

Commit

Permalink
Update man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
JackPiri committed Dec 14, 2023
1 parent 068d3b8 commit 8b98aa6
Show file tree
Hide file tree
Showing 3 changed files with 821 additions and 9 deletions.
80 changes: 77 additions & 3 deletions doc/man/zen-cli.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,79 @@
.TH ZEN-CLI "1"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
.TH ZEN-CLI "1" "December 2023" "zen-cli v4.2.0-rc1" "User Commands"
.SH NAME
zen-cli \- manual page for zen-cli
zen-cli \- manual page for zen-cli v4.2.0-rc1
.SH DESCRIPTION
Horizen RPC client version v4.2.0\-rc1
.SS "Usage:"
.TP
zen\-cli [options] <command> [params]
Send command to horizen
.TP
zen\-cli [options] help
List commands
.TP
zen\-cli [options] help <command>
Get help for a command
.SH OPTIONS
.HP
\-?
.IP
This help message
.HP
\fB\-conf=\fR<file>
.IP
Specify configuration file (default: zen.conf)
.HP
\fB\-datadir=\fR<dir>
.IP
Specify data directory
.HP
\fB\-testnet\fR
.IP
Use the test network
.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\-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: 8231 or testnet: 18231)
.HP
\fB\-rpcwait\fR
.IP
Wait for RPC server to start
.HP
\fB\-rpcuser=\fR<user>
.IP
Username for JSON\-RPC connections
.HP
\fB\-rpcpassword=\fR<pw>
.IP
Password for JSON\-RPC connections
.HP
\fB\-rpcclienttimeout=\fR<n>
.IP
Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
900)
.SH COPYRIGHT

This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
Copyright (C) 2009-2023 The Bitcoin Core Developers
Copyright (C) 2015-2023 The Zcash Developers
Copyright (C) 2015-2023 Zdeveloper.org
Copyright (C) 2015-2023 Zen Blockchain Foundation

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.
101 changes: 98 additions & 3 deletions doc/man/zen-tx.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,100 @@
.TH ZEN-TX "1"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
.TH ZEN-TX "1" "December 2023" "zen-tx v4.2.0-rc1" "User Commands"
.SH NAME
zen-tx \- manual page for zen-tx
zen-tx \- manual page for zen-tx v4.2.0-rc1
.SH DESCRIPTION
Horizen zen\-tx utility version v4.2.0\-rc1
.SS "Usage:"
.TP
zen\-tx [options] <hex\-tx> [commands]
Update hex\-encoded zencash transaction
.TP
zen\-tx [options] \fB\-create\fR [commands]
Create hex\-encoded zencash transaction
.SH OPTIONS
.HP
\-?
.IP
This help message
.HP
\fB\-create\fR
.IP
Create new, empty TX.
.HP
\fB\-json\fR
.IP
Select JSON output
.HP
\fB\-txid\fR
.IP
Output only the hex\-encoded transaction id of the resultant transaction.
.HP
\fB\-regtest\fR
.IP
Enter regression test mode, which uses a special chain in which blocks
can be solved instantly.
.HP
\fB\-testnet\fR
.IP
Use the test network
.PP
Commands:
.IP
delin=N
.IP
Delete input N from TX
.IP
delout=N
.IP
Delete output N from TX
.IP
in=TXID:VOUT
.IP
Add input to TX
.IP
locktime=N
.IP
Set TX lock time to N
.IP
nversion=N
.IP
Set TX version to N
.IP
outaddr=VALUE:ADDRESS
.IP
Add address\-based output to TX
.IP
outscript=VALUE:SCRIPT
.IP
Add raw script output to TX
.IP
sign=SIGHASH\-FLAGS
.IP
Add zero or more signatures to transaction. This command requires JSON
registers:prevtxs=JSON object, privatekeys=JSON object. See
signrawtransaction docs for format of sighash flags, JSON objects.
.PP
Register Commands:
.IP
load=NAME:FILENAME
.IP
Load JSON file FILENAME into register NAME
.IP
set=NAME:JSON\-STRING
.IP
Set register NAME to given JSON\-STRING
.SH COPYRIGHT

This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
Copyright (C) 2009-2023 The Bitcoin Core Developers
Copyright (C) 2015-2023 The Zcash Developers
Copyright (C) 2015-2023 Zdeveloper.org
Copyright (C) 2015-2023 Zen Blockchain Foundation

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.
Loading

0 comments on commit 8b98aa6

Please sign in to comment.