Original HUSH source code based on ZEC 1.0.8 . For historical purposes only!
https://hush.is
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
518 lines
12 KiB
518 lines
12 KiB
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
|
|
.TH HUSHD "1" "October 2018" "hushd v1.0.13-72e2e60" "User Commands"
|
|
.SH NAME
|
|
hushd \- manual page for hushd v1.0.13-72e2e60
|
|
.SH DESCRIPTION
|
|
Hush Daemon version v1.0.13
|
|
.PP
|
|
In order to ensure you are adequately protecting your privacy when using Hush,
|
|
please see <https://github.com/MyHush/hush/blob/master/doc/security.md>.
|
|
.SS "Usage:"
|
|
.TP
|
|
hushd [options]
|
|
Start Hush 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<cmd>
|
|
.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<cmd>
|
|
.IP
|
|
Execute command when the best block changes (%s in cmd is replaced by
|
|
block hash)
|
|
.HP
|
|
\fB\-checkblocks=\fR<n>
|
|
.IP
|
|
How many blocks to check at startup (default: 288, 0 = all)
|
|
.HP
|
|
\fB\-checklevel=\fR<n>
|
|
.IP
|
|
How thorough the block verification of \fB\-checkblocks\fR is (0\-4, default: 3)
|
|
.HP
|
|
\fB\-conf=\fR<file>
|
|
.IP
|
|
Specify configuration file (default: hush.conf)
|
|
.HP
|
|
\fB\-daemon\fR
|
|
.IP
|
|
Run in the background as a daemon and accept commands
|
|
.HP
|
|
\fB\-datadir=\fR<dir>
|
|
.IP
|
|
Specify data directory
|
|
.HP
|
|
\fB\-disabledeprecation=\fR<version>
|
|
.IP
|
|
Disable block\-height node deprecation and automatic shutdown (example:
|
|
\fB\-disabledeprecation\fR=\fI\,1\/\fR.0.13)
|
|
.HP
|
|
\fB\-exportdir=\fR<dir>
|
|
.IP
|
|
Specify directory to be used when exporting data
|
|
.HP
|
|
\fB\-dbcache=\fR<n>
|
|
.IP
|
|
Set database cache size in megabytes (4 to 16384, default: 100)
|
|
.HP
|
|
\fB\-loadblock=\fR<file>
|
|
.IP
|
|
Imports blocks from external blk000??.dat file on startup
|
|
.HP
|
|
\fB\-maxorphantx=\fR<n>
|
|
.IP
|
|
Keep at most <n> unconnectable transactions in memory (default: 100)
|
|
.HP
|
|
\fB\-mempooltxinputlimit=\fR<n>
|
|
.IP
|
|
Set the maximum number of transparent inputs in a transaction that the
|
|
mempool will accept (default: 0 = no limit applied)
|
|
.HP
|
|
\fB\-par=\fR<n>
|
|
.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<file>
|
|
.IP
|
|
Specify pid file (default: hushd.pid)
|
|
.HP
|
|
\fB\-prune=\fR<n>
|
|
.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: 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)
|
|
.PP
|
|
Connection options:
|
|
.HP
|
|
\fB\-addnode=\fR<ip>
|
|
.IP
|
|
Add a node to connect to and attempt to keep the connection open
|
|
.HP
|
|
\fB\-banscore=\fR<n>
|
|
.IP
|
|
Threshold for disconnecting misbehaving peers (default: 100)
|
|
.HP
|
|
\fB\-bantime=\fR<n>
|
|
.IP
|
|
Number of seconds to keep misbehaving peers from reconnecting (default:
|
|
86400)
|
|
.HP
|
|
\fB\-bind=\fR<addr>
|
|
.IP
|
|
Bind to given address and always listen on it. Use [host]:port notation
|
|
for IPv6
|
|
.HP
|
|
\fB\-connect=\fR<ip>
|
|
.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>
|
|
.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<n>
|
|
.IP
|
|
Maintain at most <n> connections to peers (default: 125)
|
|
.HP
|
|
\fB\-maxreceivebuffer=\fR<n>
|
|
.IP
|
|
Maximum per\-connection receive buffer, <n>*1000 bytes (default: 5000)
|
|
.HP
|
|
\fB\-maxsendbuffer=\fR<n>
|
|
.IP
|
|
Maximum per\-connection send buffer, <n>*1000 bytes (default: 1000)
|
|
.HP
|
|
\fB\-onion=\fR<ip:port>
|
|
.IP
|
|
Use separate SOCKS5 proxy to reach peers via Tor hidden services
|
|
(default: \fB\-proxy\fR)
|
|
.HP
|
|
\fB\-onlynet=\fR<net>
|
|
.IP
|
|
Only connect to nodes in network <net> (ipv4, ipv6 or onion)
|
|
.HP
|
|
\fB\-permitbaremultisig\fR
|
|
.IP
|
|
Relay non\-P2SH multisig (default: 1)
|
|
.HP
|
|
\fB\-port=\fR<port>
|
|
.IP
|
|
Listen for connections on <port> (default: 8888 or testnet: 18888)
|
|
.HP
|
|
\fB\-proxy=\fR<ip:port>
|
|
.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>
|
|
.IP
|
|
Connect to a node to retrieve peer addresses, and disconnect
|
|
.HP
|
|
\fB\-timeout=\fR<n>
|
|
.IP
|
|
Specify connection timeout in milliseconds (minimum: 1, default: 5000)
|
|
.HP
|
|
\fB\-torcontrol=\fR<ip>:<port>
|
|
.IP
|
|
Tor control port to use if onion listening enabled (default:
|
|
127.0.0.1:9051)
|
|
.HP
|
|
\fB\-torpassword=\fR<pass>
|
|
.IP
|
|
Tor control port password (default: empty)
|
|
.HP
|
|
\fB\-tlsforce=\fR<0 or 1>
|
|
.IP
|
|
Only connect to peers who are also using TLS (default: 0)
|
|
.HP
|
|
\fB\-tlsvalidate=\fR<0 or 1>
|
|
.IP
|
|
Connect to peers only with valid certificates (default: 0)
|
|
.HP
|
|
\fB\-tlskeypath=\fR<path>
|
|
.IP
|
|
Full path to a private key
|
|
.HP
|
|
\fB\-tlskeypwd=\fR<password>
|
|
.IP
|
|
Password for a private key encryption (default: not set, i.e. private
|
|
key will be stored unencrypted)
|
|
.HP
|
|
\fB\-tlscertpath=\fR<path>
|
|
.IP
|
|
Full path to a certificate
|
|
.HP
|
|
\fB\-tlstrustdir=\fR<path>
|
|
.IP
|
|
Full path to a trusted certificates directory
|
|
.HP
|
|
\fB\-whitebind=\fR<addr>
|
|
.IP
|
|
Bind to given address and whitelist peers connecting to it. Use
|
|
[host]:port notation for IPv6
|
|
.HP
|
|
\fB\-whitelist=\fR<netmask>
|
|
.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<n>
|
|
.IP
|
|
Set key pool size to <n> (default: 100)
|
|
.HP
|
|
\fB\-paytxfee=\fR<amt>
|
|
.IP
|
|
Fee (in ZEC/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<n>
|
|
.IP
|
|
If paytxfee is not set, include enough fee so transactions begin
|
|
confirmation on average within n blocks (default: 2)
|
|
.HP
|
|
\fB\-maxtxfee=\fR<amt>
|
|
.IP
|
|
Maximum total fees (in ZEC) 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<file>
|
|
.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<cmd>
|
|
.IP
|
|
Execute command when a wallet transaction changes (%s in cmd is replaced
|
|
by TxID)
|
|
.HP
|
|
\fB\-zapwallettxes=\fR<mode>
|
|
.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<address>
|
|
.IP
|
|
Enable publish hash block in <address>
|
|
.HP
|
|
\fB\-zmqpubhashtx=\fR<address>
|
|
.IP
|
|
Enable publish hash transaction in <address>
|
|
.HP
|
|
\fB\-zmqpubrawblock=\fR<address>
|
|
.IP
|
|
Enable publish raw block in <address>
|
|
.HP
|
|
\fB\-zmqpubrawtx=\fR<address>
|
|
.IP
|
|
Enable publish raw transaction in <address>
|
|
.PP
|
|
Debugging/Testing options:
|
|
.HP
|
|
\fB\-debug=\fR<category>
|
|
.IP
|
|
Output debugging information (default: 0, supplying <category> is
|
|
optional). If <category> is not supplied or if <category> = 1, output
|
|
all debugging information. <category> 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<amt>
|
|
.IP
|
|
Fees (in ZEC/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: 80)
|
|
.PP
|
|
Block creation options:
|
|
.HP
|
|
\fB\-blockminsize=\fR<n>
|
|
.IP
|
|
Set minimum block size in bytes (default: 0)
|
|
.HP
|
|
\fB\-blockmaxsize=\fR<n>
|
|
.IP
|
|
Set maximum block size in bytes (default: 2000000)
|
|
.HP
|
|
\fB\-blockprioritysize=\fR<n>
|
|
.IP
|
|
Set maximum size of high\-priority/low\-fee transactions in bytes
|
|
(default: 1000000)
|
|
.PP
|
|
Mining options:
|
|
.HP
|
|
\fB\-gen\fR
|
|
.IP
|
|
Generate coins (default: 0)
|
|
.HP
|
|
\fB\-genproclimit=\fR<n>
|
|
.IP
|
|
Set the number of threads for coin generation if enabled (\fB\-1\fR = all
|
|
cores, default: 1)
|
|
.HP
|
|
\fB\-equihashsolver=\fR<name>
|
|
.IP
|
|
Specify the Equihash solver to be used if enabled (default: "default")
|
|
.HP
|
|
\fB\-mineraddress=\fR<addr>
|
|
.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<addr>
|
|
.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<user>
|
|
.IP
|
|
Username for JSON\-RPC connections
|
|
.HP
|
|
\fB\-rpcpassword=\fR<pw>
|
|
.IP
|
|
Password for JSON\-RPC connections
|
|
.HP
|
|
\fB\-rpcport=\fR<port>
|
|
.IP
|
|
Listen for JSON\-RPC connections on <port> (default: 8822 or testnet:
|
|
18822)
|
|
.HP
|
|
\fB\-rpcallowip=\fR<ip>
|
|
.IP
|
|
Allow JSON\-RPC connections from specified source. Valid for <ip> 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<n>
|
|
.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)
|
|
.SH COPYRIGHT
|
|
|
|
In order to ensure you are adequately protecting your privacy when using Hush,
|
|
please see <https://github.com/MyHush/hush/blob/master/doc/security.md>.
|
|
|
|
Copyright (C) 2009-2017 The Bitcoin Core Developers
|
|
Copyright (C) 2015-2017 The Zcash Developers
|
|
Copyright (C) 2016-2017 The Hush 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.
|
|
|