diff --git a/contrib/devtools/gen-manpages.sh b/contrib/devtools/gen-manpages.sh index aaed44643..804caca7c 100755 --- a/contrib/devtools/gen-manpages.sh +++ b/contrib/devtools/gen-manpages.sh @@ -21,6 +21,7 @@ HUSHVER=$(./src/hushd --version|head -n2|tail -n1|cut -d' ' -f4|cut -d- -f1) echo "[COPYRIGHT]" > footer.h2m $HUSHD --version | sed -n '1!p' >> footer.h2m +echo "Generating man pages for Hush $HUSHVER" for cmd in $HUSHD $HUSHCLI $HUSHTX; do cmdname="${cmd##*/}" help2man -N --version-string=${HUSHVER} --include=footer.h2m -o ${MANDIR}/${cmdname}.1 ${cmd} diff --git a/doc/man/hush-cli.1 b/doc/man/hush-cli.1 new file mode 100644 index 000000000..a1be67812 --- /dev/null +++ b/doc/man/hush-cli.1 @@ -0,0 +1,91 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.10. +.TH HUSH-CLI "1" "January 2020" "hush-cli v3.3.1" "User Commands" +.SH NAME +hush-cli \- manual page for hush-cli v3.3.1 +.SH DESCRIPTION +Komodo RPC client version v3.3.1\-d4ac8162f +.PP +In order to ensure you are adequately protecting your privacy when using Hush, +please see . +.SS "Usage:" +.TP +komodo\-cli [options] [params] +Send command to Komodo +.TP +komodo\-cli [options] help +List commands +.TP +komodo\-cli [options] help +Get help for a command +.SH OPTIONS +.HP +\-? +.IP +This help message +.HP +\fB\-conf=\fR +.IP +Specify configuration file (default: komodo.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: 8232 or testnet: 18232) +.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) +.HP +\fB\-stdin\fR +.IP +Read extra arguments from standard input, one per line until EOF/Ctrl\-D +(recommended for sensitive information such as passphrases) +.SH COPYRIGHT +Hush Daemon version v3.3.1-d4ac8162f + +In order to ensure you are adequately protecting your privacy when using Hush, +please see . + +Copyright (C) 2009-2020 The Bitcoin Core Developers +Copyright (C) 2015-2020 The Zcash Developers +Copyright (C) 2015-2020 jl777 and SuperNET developers +Copyright (C) 2018-2020 The Hush developers + +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/hush-tx.1 b/doc/man/hush-tx.1 new file mode 100644 index 000000000..b707fd059 --- /dev/null +++ b/doc/man/hush-tx.1 @@ -0,0 +1,104 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.10. +.TH HUSH-TX "1" "January 2020" "hush-tx v3.3.1" "User Commands" +.SH NAME +hush-tx \- manual page for hush-tx v3.3.1 +.SH DESCRIPTION +Hush komodo\-tx utility version v3.3.1\-d4ac8162f +.SS "Usage:" +.TP +komodo\-tx [options] [commands] +Update hex\-encoded zcash transaction +.TP +komodo\-tx [options] \fB\-create\fR [commands] +Create hex\-encoded zcash 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(:SEQUENCE_NUMBER) +.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=HEIGHT: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 +Hush Daemon version v3.3.1-d4ac8162f + +In order to ensure you are adequately protecting your privacy when using Hush, +please see . + +Copyright (C) 2009-2020 The Bitcoin Core Developers +Copyright (C) 2015-2020 The Zcash Developers +Copyright (C) 2015-2020 jl777 and SuperNET developers +Copyright (C) 2018-2020 The Hush developers + +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/hushd.1 b/doc/man/hushd.1 new file mode 100644 index 000000000..0c47538ea --- /dev/null +++ b/doc/man/hushd.1 @@ -0,0 +1,619 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.10. +.TH HUSHD "1" "January 2020" "hushd v3.3.1" "User Commands" +.SH NAME +hushd \- manual page for hushd v3.3.1 +.SH DESCRIPTION +Found binary: ./komodod +Hush Daemon version v3.3.1\-d4ac8162f +.PP +In order to ensure you are adequately protecting your privacy when using Hush, +please see . +.SS "Usage:" +.TP +komodod [options] +Start Hush\-flavored Komodo Daemon +.SH OPTIONS +.HP +\-? +.IP +This help message +.HP +\fB\-alerts\fR +.IP +Receive and display P2P network alerts (default: 1) +.HP +\fB\-alertnotify=\fR +.IP +Execute command when a relevant alert is received 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\-clientname=\fR +.IP +Full node client name, default 'MagicBean' +.HP +\fB\-conf=\fR +.IP +Specify configuration file (default: komodo.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\-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 +[DEPRECATED FROM OVERWINTER] Set the maximum number of transparent +inputs in a transaction that the mempool will accept (default: 0 = no +limit applied) +.HP +\fB\-par=\fR +.IP +Set the number of script verification threads (\fB\-8\fR to 16, 0 = auto, <0 = +leave that many cores free, default: 0) +.HP +\fB\-pid=\fR +.IP +Specify pid file (default: komodod.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\-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\-addressindex\fR +.IP +Maintain a full address index, used to query for the balance, txids and +unspent outputs for addresses (default: 1) +.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: 1) +.HP +\fB\-zindex\fR +.IP +Maintain extra statistics about shielded transactions and payments +(default: 0) +.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: 384) +.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\-peerbloomfilters\fR +.IP +Support filtering of blocks and transaction with Bloom filters (default: +1) +.HP +\fB\-port=\fR +.IP +Listen for connections on (default: 7770 or testnet: 17770) +.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\-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 KMD/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\-txexpirydelta\fR +.IP +Set the number of blocks after which a transaction that has not been +mined will become invalid (default: 200) +.HP +\fB\-maxtxfee=\fR +.IP +Maximum total fees (in KMD) 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\-whitelistaddress=\fR +.IP +Enable the wallet filter for notary nodes and add one Raddress to the +whitelist of the wallet filter. If \fB\-whitelistaddress=\fR is used, then the +wallet filter is automatically activated. Several Raddresses can be +defined using several \fB\-whitelistaddress=\fR (similar to \fB\-addnode\fR). The +wallet filter will filter the utxo to only ones coming from my own +Raddress (derived from pubkey) and each Raddress defined using +\fB\-whitelistaddress=\fR this option is mostly for Notary Nodes). +.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, +coindb, db, estimatefee, http, libevent, lock, mempool, net, +partitioncheck, pow, proxy, prune, rand, reindex, rpc, selectcoins, tor, +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\-minrelaytxfee=\fR +.IP +Fees (in KMD/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\-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: 8192) +.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: 2000000) +.HP +\fB\-blockprioritysize=\fR +.IP +Set maximum size of high\-priority/low\-fee transactions in bytes +(default: 1000000) +.PP +Mining options: +.HP +\fB\-gen\fR +.IP +Mine/generate coins (default: 0) +.HP +\fB\-genproclimit=\fR +.IP +Set the number of threads for coin mining if enabled (\fB\-1\fR = all cores, +default: 0) +.HP +\fB\-equihashsolver=\fR +.IP +Specify the Equihash solver to be used if enabled (default: "default") +.HP +\fB\-mineraddress=\fR +.IP +Send mined coins to a specific single address +.HP +\fB\-minetolocalwallet\fR +.IP +Require that mined blocks use a coinbase address in the local wallet +(default: 1) +.PP +RPC server options: +.HP +\fB\-server\fR +.IP +Accept command line and JSON\-RPC commands +.HP +\fB\-rest\fR +.IP +Accept public REST requests (default: 0) +.HP +\fB\-rpcbind=\fR +.IP +Bind to given address to listen for JSON\-RPC connections. Use +[host]:port notation for IPv6. This option can be specified multiple +times (default: bind to all interfaces) +.HP +\fB\-rpcuser=\fR +.IP +Username for JSON\-RPC connections +.HP +\fB\-rpcpassword=\fR +.IP +Password for JSON\-RPC connections +.HP +\fB\-rpcport=\fR +.IP +Listen for JSON\-RPC connections on (default: 7771 or testnet: +17771) +.HP +\fB\-rpcallowip=\fR +.IP +Allow JSON\-RPC connections from specified source. Valid for are a +single IP (e.g. 1.2.3.4), a network/netmask (e.g. 1.2.3.4/255.255.255.0) +or a network/CIDR (e.g. 1.2.3.4/24). This option can be specified +multiple times +.HP +\fB\-rpcthreads=\fR +.IP +Set the number of threads to service RPC calls (default: 4) +.PP +Metrics Options (only if \fB\-daemon\fR and \fB\-printtoconsole\fR are not set): +.HP +\fB\-showmetrics\fR +.IP +Show metrics on stdout (default: 1 if running in a console, 0 otherwise) +.HP +\fB\-metricsui\fR +.IP +Set to 1 for a persistent metrics screen, 0 for sequential metrics +output (default: 1 if running in a console, 0 otherwise) +.HP +\fB\-metricsrefreshtime\fR +.IP +Number of seconds between metrics refreshes (default: 1 if running in a +console, 600 otherwise) +.PP +Komodo Asset Chain options: +.HP +\fB\-ac_algo\fR +.IP +Choose PoW mining algorithm, default is Equihash +.HP +\fB\-ac_blocktime\fR +.IP +Block time in seconds, default is 60 +.HP +\fB\-ac_cc\fR +.IP +Cryptoconditions, default 0 +.HP +\fB\-ac_beam\fR +.IP +BEAM integration +.HP +\fB\-ac_coda\fR +.IP +CODA integration +.HP +\fB\-ac_cclib\fR +.IP +Cryptoconditions dynamicly loadable library +.HP +\fB\-ac_ccenable\fR +.IP +Cryptoconditions to enable +.HP +\fB\-ac_ccactivate\fR +.IP +Block height to enable Cryptoconditions +.HP +\fB\-ac_decay\fR +.IP +Percentage of block reward decrease at each halving +.HP +\fB\-ac_end\fR +.IP +Block height at which block rewards will end +.HP +\fB\-ac_eras\fR +.IP +Block reward eras +.HP +\fB\-ac_founders\fR +.IP +Number of blocks between founders reward payouts +.HP +\fB\-ac_halving\fR +.IP +Number of blocks between each block reward halving +.HP +\fB\-ac_name\fR +.IP +Name of asset chain +.HP +\fB\-ac_notarypay\fR +.IP +Pay notaries, default 0 +.HP +\fB\-ac_perc\fR +.IP +Percentage of block rewards paid to the founder +.HP +\fB\-ac_private\fR +.IP +Shielded transactions only (except coinbase + notaries), default is 0 +.HP +\fB\-ac_pubkey\fR +.IP +Public key for receiving payments on the network +.HP +\fB\-ac_public\fR +.IP +Transparent transactions only, default 0 +.HP +\fB\-ac_reward\fR +.IP +Block reward in satoshis, default is 0 +.HP +\fB\-ac_sapling\fR +.IP +Sapling activation block height +.HP +\fB\-ac_script\fR +.IP +P2SH/multisig address to receive founders rewards +.HP +\fB\-ac_supply\fR +.IP +Starting supply, default is 0 +.HP +\fB\-ac_txpow\fR +.IP +Enforce transaction\-rate limit, default 0 +.SH COPYRIGHT +Hush Daemon version v3.3.1-d4ac8162f + +In order to ensure you are adequately protecting your privacy when using Hush, +please see . + +Copyright (C) 2009-2020 The Bitcoin Core Developers +Copyright (C) 2015-2020 The Zcash Developers +Copyright (C) 2015-2020 jl777 and SuperNET developers +Copyright (C) 2018-2020 The Hush developers + +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.