From 8b98aa6b72e71775f949e49036359808484b9ff8 Mon Sep 17 00:00:00 2001 From: JackPiri Date: Thu, 14 Dec 2023 16:31:38 +0100 Subject: [PATCH] Update man pages --- doc/man/zen-cli.1 | 80 +++++- doc/man/zen-tx.1 | 101 +++++++- doc/man/zend.1 | 649 +++++++++++++++++++++++++++++++++++++++++++++- 3 files changed, 821 insertions(+), 9 deletions(-) diff --git a/doc/man/zen-cli.1 b/doc/man/zen-cli.1 index abca4cde19..38dc3954a4 100644 --- a/doc/man/zen-cli.1 +++ b/doc/man/zen-cli.1 @@ -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] [params] +Send command to horizen +.TP +zen\-cli [options] help +List commands +.TP +zen\-cli [options] help +Get help for a command +.SH OPTIONS +.HP +\-? +.IP +This help message +.HP +\fB\-conf=\fR +.IP +Specify configuration file (default: zen.conf) +.HP +\fB\-datadir=\fR +.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 +Send commands to node running on (default: 127.0.0.1) +.HP +\fB\-rpcport=\fR +.IP +Connect to JSON\-RPC on (default: 8231 or testnet: 18231) +.HP +\fB\-rpcwait\fR +.IP +Wait for RPC server to start +.HP +\fB\-rpcuser=\fR +.IP +Username for JSON\-RPC connections +.HP +\fB\-rpcpassword=\fR +.IP +Password for JSON\-RPC connections +.HP +\fB\-rpcclienttimeout=\fR +.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 . + +This product includes software developed by the OpenSSL Project for use in the +OpenSSL Toolkit and cryptographic software written +by Eric Young. diff --git a/doc/man/zen-tx.1 b/doc/man/zen-tx.1 index 9011d6309b..af4404e0cd 100644 --- a/doc/man/zen-tx.1 +++ b/doc/man/zen-tx.1 @@ -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] [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 . + +This product includes software developed by the OpenSSL Project for use in the +OpenSSL Toolkit and cryptographic software written +by Eric Young. diff --git a/doc/man/zend.1 b/doc/man/zend.1 index 95f88d72a0..c61618dca2 100644 --- a/doc/man/zend.1 +++ b/doc/man/zend.1 @@ -1,5 +1,648 @@ -.TH ZEND "1" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1. +.TH ZEND "1" "December 2023" "zend v4.2.0-rc1" "User Commands" .SH NAME -zend \- manual page for zend +zend \- manual page for zend v4.2.0-rc1 +.SH DESCRIPTION +Zen Daemon version v4.2.0\-rc1 +.SS "Usage:" +.TP +zend [options] +Start Zen Daemon +.SH OPTIONS +.HP +\-? +.IP +This help message +.HP +\fB\-alertnotify=\fR +.IP +Execute command when a relevant internal alert is risen or we see a +really long fork (%s in cmd is replaced by message) +.HP +\fB\-blocknotify=\fR +.IP +Execute command when the best block changes (%s in cmd is replaced by +block hash) +.HP +\fB\-checkblocks=\fR +.IP +How many blocks to check at startup (default: 288, 0 = all) +.HP +\fB\-checklevel=\fR +.IP +How thorough the block verification of \fB\-checkblocks\fR is (0\-4, default: 3) +.HP +\fB\-conf=\fR +.IP +Specify configuration file (default: zen.conf) +.HP +\fB\-daemon\fR +.IP +Run in the background as a daemon and accept commands +.HP +\fB\-datadir=\fR +.IP +Specify data directory +.HP +\fB\-disabledeprecation=\fR +.IP +Disable block\-height node deprecation and automatic shutdown (example: +\fB\-disabledeprecation\fR=\fI\,4\/\fR.2.0\-rc1) +.HP +\fB\-enable_mc_crypto_logger\fR +.IP +Enable libzendoo logging to file. It creates a new configuration file in +the current datadir, if it does not already exist. +.HP +\fB\-exportdir=\fR +.IP +Specify directory to be used when exporting data +.HP +\fB\-dbcache=\fR +.IP +Set database cache size in megabytes (4 to 16384, default: 450) +.HP +\fB\-loadblock=\fR +.IP +Imports blocks from external blk000??.dat file on startup +.HP +\fB\-maxorphantx=\fR +.IP +Keep at most unconnectable transactions in memory (default: 100) +.HP +\fB\-mempooltxinputlimit=\fR +.IP +Set the maximum number of transparent inputs in a transaction that the +mempool will accept (default: 0 = no limit applied) +.HP +\fB\-maxmempool=\fR +.IP +Keep the transaction memory pool below megabytes (default: 400) +.HP +\fB\-par=\fR +.IP +Set the number of script verification threads (\fB\-4\fR to 16, 0 = auto, <0 = +leave that many cores free, default: 0) +.HP +\fB\-pid=\fR +.IP +Specify pid file (default: zend.pid) +.HP +\fB\-prune=\fR +.IP +Reduce storage requirements by pruning (deleting) old blocks. This mode +disables wallet support and is incompatible with \fB\-txindex\fR. Warning: +Reverting this setting requires re\-downloading the entire blockchain. +(default: 0 = disable pruning blocks, >550 = target size in MiB to use +for block files) +.HP +\fB\-reindex\fR +.IP +Rebuild block chain index from current blk000??.dat files on startup +.HP +\fB\-reindexfast\fR +.IP +Rebuild block chain index from current blk000??.dat files on startup, +skipping expensive checks for blocks below checkpoints. It is +incompatible with reindex +.HP +\fB\-sysperms\fR +.IP +Create new files with system default permissions, instead of umask 077 +(only effective with disabled wallet functionality) +.HP +\fB\-txindex\fR +.IP +Maintain a full transaction index, used by the getrawtransaction rpc +call (default: 0) +.HP +\fB\-maturityheightindex\fR +.IP +Maintain a maturity height index that stores for every height the +cerficates that became mature, used by the getblockexpanded rpc call. It +requires \fB\-txindex\fR (default: 0) +.HP +\fB\-addressindex\fR +.IP +Maintain a full address index, used to query for the balance, txids and +unspent outputs for addresses (default: 0) +.HP +\fB\-timestampindex\fR +.IP +Maintain a timestamp index for block hashes, used to query blocks hashes +by a range of timestamps (default: 0) +.HP +\fB\-spentindex\fR +.IP +Maintain a full spent index, used to query the spending txid and input +index for an outpoint (default: 0) +.HP +\fB\-blocktreedbmaxopenfiles\fR +.IP +Maximum number of open files for the Block Tree LevelDB (default: 400) +.HP +\fB\-coinsviewdbmaxopenfiles\fR +.IP +Maximum number of open files for the Coins View LevelDB (default: 400) +.PP +Connection options: +.HP +\fB\-addnode=\fR +.IP +Add a node to connect to and attempt to keep the connection open +.HP +\fB\-banscore=\fR +.IP +Threshold for disconnecting misbehaving peers (default: 100) +.HP +\fB\-bantime=\fR +.IP +Number of seconds to keep misbehaving peers from reconnecting (default: +86400) +.HP +\fB\-bind=\fR +.IP +Bind to given address and always listen on it. Use [host]:port notation +for IPv6 +.HP +\fB\-connect=\fR +.IP +Connect only to the specified node(s) +.HP +\fB\-discover\fR +.IP +Discover own IP addresses (default: 1 when listening and no \fB\-externalip\fR +or \fB\-proxy\fR) +.HP +\fB\-dns\fR +.IP +Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (default: 1) +.HP +\fB\-dnsseed\fR +.IP +Query for peer addresses via DNS lookup, if low on addresses (default: 1 +unless \fB\-connect\fR) +.HP +\fB\-externalip=\fR +.IP +Specify your own public address +.HP +\fB\-forcednsseed\fR +.IP +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) +.HP +\fB\-listenonion\fR +.IP +Automatically create Tor hidden service (default: 1) +.HP +\fB\-maxconnections=\fR +.IP +Maintain at most connections to peers (default: 125) +.HP +\fB\-maxreceivebuffer=\fR +.IP +Maximum per\-connection receive buffer, *1000 bytes (default: 5000) +.HP +\fB\-maxsendbuffer=\fR +.IP +Maximum per\-connection send buffer, *1000 bytes (default: 1000) +.HP +\fB\-onion=\fR +.IP +Use separate SOCKS5 proxy to reach peers via Tor hidden services +(default: \fB\-proxy\fR) +.HP +\fB\-onlynet=\fR +.IP +Only connect to nodes in network (ipv4, ipv6 or onion) +.HP +\fB\-permitbaremultisig\fR +.IP +Relay non\-P2SH multisig (default: 1) +.HP +\fB\-port=\fR +.IP +Listen for connections on (default: 9033 or testnet: 19033) +.HP +\fB\-proxy=\fR +.IP +Connect through SOCKS5 proxy +.HP +\fB\-proxyrandomize\fR +.IP +Randomize credentials for every proxy connection. This enables Tor +stream isolation (default: 1) +.HP +\fB\-seednode=\fR +.IP +Connect to a node to retrieve peer addresses, and disconnect +.HP +\fB\-timeout=\fR +.IP +Specify connection timeout in milliseconds (minimum: 1, default: 5000) +.HP +\fB\-torcontrol=\fR: +.IP +Tor control port to use if onion listening enabled (default: +127.0.0.1:9051) +.HP +\fB\-torpassword=\fR +.IP +Tor control port password (default: empty) +.HP +\fB\-tlsfallbacknontls=\fR<0 or 1> +.IP +If a TLS connection fails, the next connection attempt of the same peer +(based on IP address) takes place without TLS (default: 1) +.HP +\fB\-tlsvalidate=\fR<0 or 1> +.IP +Connect to peers only with valid certificates (default: 0) +.HP +\fB\-tlskeypath=\fR +.IP +Full path to a private key +.HP +\fB\-tlskeypwd=\fR +.IP +Password for a private key encryption (default: not set, i.e. private +key will be stored unencrypted) +.HP +\fB\-tlscertpath=\fR +.IP +Full path to a certificate +.HP +\fB\-tlstrustdir=\fR +.IP +Full path to a trusted certificates directory +.HP +\fB\-websocket=\fR<0 or 1> +.IP +If set to 1 opens a websocket channel listening for client connections +(default: 0) +.HP +\fB\-wsaddress=\fR +.IP +If websocket=1, listen for ws connections at this ip address (default: +127.0.0.1) +.HP +\fB\-wsport=\fR +.IP +If websocket=1, listen for ws connections at : +(default: 8888) +.HP +\fB\-whitebind=\fR +.IP +Bind to given address and whitelist peers connecting to it. Use +[host]:port notation for IPv6 +.HP +\fB\-whitelist=\fR +.IP +Whitelist peers connecting from the given netmask or IP address. Can be +specified multiple times. Whitelisted peers cannot be DoS banned and +their transactions are always relayed, even if they are already in the +mempool, useful e.g. for a gateway +.PP +Wallet options: +.HP +\fB\-disablewallet\fR +.IP +Do not load the wallet and disable wallet RPC calls +.HP +\fB\-keypool=\fR +.IP +Set key pool size to (default: 100) +.HP +\fB\-paytxfee=\fR +.IP +Fee (in ZEN/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 +.HP +\fB\-salvagewallet\fR +.IP +Attempt to recover private keys from a corrupt wallet.dat on startup +.HP +\fB\-sendfreetransactions\fR +.IP +Send transactions as zero\-fee transactions if possible (default: 0) +.HP +\fB\-spendzeroconfchange\fR +.IP +Spend unconfirmed change when sending transactions (default: 1) +.HP +\fB\-txconfirmtarget=\fR +.IP +If paytxfee is not set, include enough fee so transactions begin +confirmation on average within n blocks (default: 2) +.HP +\fB\-maxtxfee=\fR +.IP +Maximum total fees (in ZEN) to use in a single wallet transaction; +setting this too low may abort large transactions (default: 0.10) +.HP +\fB\-upgradewallet\fR +.IP +Upgrade wallet to latest format on startup +.HP +\fB\-wallet=\fR +.IP +Specify wallet file (within data directory) (default: wallet.dat) +.HP +\fB\-walletbroadcast\fR +.IP +Make the wallet broadcast transactions (default: 1) +.HP +\fB\-walletnotify=\fR +.IP +Execute command when a wallet transaction changes (%s in cmd is replaced +by TxID) +.HP +\fB\-zapwallettxes=\fR +.IP +Delete all wallet transactions and only recover those parts of the +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
+.IP +Enable publish hash block in
+.HP +\fB\-zmqpubhashtx=\fR
+.IP +Enable publish hash transaction in
+.HP +\fB\-zmqpubrawblock=\fR
+.IP +Enable publish raw block in
+.HP +\fB\-zmqpubrawtx=\fR
+.IP +Enable publish raw transaction in
+.PP +Debugging/Testing options: +.HP +\fB\-debug=\fR +.IP +Output debugging information (default: 0, supplying is +optional). If is not supplied or if = 1, output +all debugging information. can be: addrman, alert, bench, +cert, coindb, db, estimatefee, forks, http, libevent, lock, mempool, +net, partitioncheck, pow, proxy, prune, rand, reindex, rpc, sc, +selectcoins, tor, ws, zendoo_mc_cryptolib, zmq, zrpc, zrpcunsafe +(implies zrpc). +.HP +\fB\-experimentalfeatures\fR +.IP +Enable use of experimental features +.HP +\fB\-help\-debug\fR +.IP +Show all debugging options (usage: \fB\-\-help\fR \fB\-help\-debug\fR) +.HP +\fB\-logips\fR +.IP +Include IP addresses in debug output (default: 0) +.HP +\fB\-logtimestamps\fR +.IP +Prepend debug output with timestamp (default: 1) +.HP +\fB\-logtimemicros\fR +.IP +Meaningful if \fB\-logtimestamps\fR=\fI\,1\/\fR. In debug output timestamp reports +microseconds (default: 0) +.HP +\fB\-minrelaytxfee=\fR +.IP +Fees (in ZEN/kB) smaller than this are considered zero fee for relaying +(default: 0.000001) +.HP +\fB\-printtoconsole\fR +.IP +Send trace/debug info to console instead of debug.log file +.HP +\fB\-shrinkdebugfile\fR +.IP +Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR) +.HP +\fB\-limitdebuglogsize\fR +.IP +Limit the debug.log file size to 10Mb (default: 1 when no \fB\-debug\fR) +.HP +\fB\-testnet\fR +.IP +Use the test network +.PP +Node relay options: +.HP +\fB\-datacarrier\fR +.IP +Relay and mine data carrier transactions (default: 1) +.HP +\fB\-datacarriersize\fR +.IP +Maximum size of data in data carrier transactions we relay and mine +(default: 80) +.PP +Block creation options: +.HP +\fB\-blockminsize=\fR +.IP +Set minimum block size in bytes (default: 0) +.HP +\fB\-blockmaxsize=\fR +.IP +Set maximum block size in bytes (default: 4000000) +.HP +\fB\-blocktxpartitionmaxsize=\fR (regtest only) +.IP +Set maximum partition block size for transcations in bytes (default: +2000000) +.HP +\fB\-blockprioritysize=\fR +.IP +Set maximum size of high\-priority/low\-fee transactions/certificates in +bytes (default: 1000000) +.HP +\fB\-blockmaxcomplexity=\fR +.IP +Limit transactions to be included into blocks based on block complexity. +Block complexity is the sum of transaction complexity per block. +Transaction complexity is the number of inputs of a transaction squared. +Like \fB\-mempooltxinputlimit\fR this switch is intended as a last resort when +unable to build blocks fast enough because of poor GBT performance. 0 or +negative values means no limit is applied. (default: 0) +.HP +\fB\-deprecatedgetblocktemplate\fR +.IP +Disable block complexity calculation and use the previous +GetBlockTemplate implementation +.HP +\fB\-scproofverificationdelay=\fR