DragonX/hush3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update manpages

Browse Source
This commit is contained in:
Duke
2023-02-09 17:27:25 -05:00
parent 1313d39a71
commit 2c083978e0
3 changed files with 100 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/man/hush-cli.1
View File

@@ -1,9 +1,9 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
.TH HUSH-CLI "1" "September 2022" "hush-cli v3.9.2" "User Commands" .TH HUSH-CLI "1" "February 2023" "hush-cli v3.9.3" "User Commands"
.SH NAME .SH NAME
hush-cli \- manual page for hush-cli v3.9.2 hush-cli \- manual page for hush-cli v3.9.3
.SH DESCRIPTION .SH DESCRIPTION
Hush RPC client version v3.9.2\-54cfe1099 Hush RPC client version v3.9.3\-1313d39a7
.PP .PP
In order to ensure you are adequately protecting your privacy when using Hush, In order to ensure you are adequately protecting your privacy when using Hush,
please see <https://hush.is/security/>. please see <https://hush.is/security/>.
@@ -38,8 +38,8 @@ Use the test network
\fB\-regtest\fR \fB\-regtest\fR
.IP .IP
Enter regression test mode, which uses a special chain in which blocks Enter regression test mode, which uses a special chain in which blocks
can be solved instantly. This is intended for regression testing tools can be solved instantly. This is intended for regression testing
and app development. tools and app development.
.HP .HP
\fB\-rpcconnect=\fR<ip> \fB\-rpcconnect=\fR<ip>
.IP .IP
@@ -75,7 +75,7 @@ Read extra arguments from standard input, one per line until EOF/Ctrl\-D
In order to ensure you are adequately protecting your privacy when using Hush, In order to ensure you are adequately protecting your privacy when using Hush,
please see <https://hush.is/security/>. please see <https://hush.is/security/>.
Copyright (C) 2016-2022 Duke Leto and The Hush Developers Copyright (C) 2016-2023 Duke Leto and The Hush Developers
Copyright (C) 2016-2020 jl777 and SuperNET developers Copyright (C) 2016-2020 jl777 and SuperNET developers

11
doc/man/hush-tx.1
View File

@@ -1,9 +1,9 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
.TH HUSH-TX "1" "September 2022" "hush-tx v3.9.2" "User Commands" .TH HUSH-TX "1" "February 2023" "hush-tx v3.9.3" "User Commands"
.SH NAME .SH NAME
hush-tx \- manual page for hush-tx v3.9.2 hush-tx \- manual page for hush-tx v3.9.3
.SH DESCRIPTION .SH DESCRIPTION
hush\-tx utility version v3.9.2\-54cfe1099 hush\-tx utility version v3.9.3\-1313d39a7
.SS "Usage:" .SS "Usage:"
.TP .TP
hush\-tx [options] <hex\-tx> [commands] hush\-tx [options] <hex\-tx> [commands]
@@ -72,7 +72,8 @@ sign=HEIGHT:SIGHASH\-FLAGS
.IP .IP
Add zero or more signatures to transaction. This command requires JSON Add zero or more signatures to transaction. This command requires JSON
registers:prevtxs=JSON object, privatekeys=JSON object. See registers:prevtxs=JSON object, privatekeys=JSON object. See
signrawtransaction docs for format of sighash flags, JSON objects. signrawtransaction docs for format of sighash flags, JSON
objects.
.PP .PP
Register Commands: Register Commands:
.IP .IP
@@ -88,7 +89,7 @@ Set register NAME to given JSON\-STRING
In order to ensure you are adequately protecting your privacy when using Hush, In order to ensure you are adequately protecting your privacy when using Hush,
please see <https://hush.is/security/>. please see <https://hush.is/security/>.
Copyright (C) 2016-2022 Duke Leto and The Hush Developers Copyright (C) 2016-2023 Duke Leto and The Hush Developers
Copyright (C) 2016-2020 jl777 and SuperNET developers Copyright (C) 2016-2020 jl777 and SuperNET developers

133
doc/man/hushd.1
View File

@@ -1,9 +1,9 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
.TH HUSHD "1" "September 2022" "hushd v3.9.2" "User Commands" .TH HUSHD "1" "February 2023" "hushd v3.9.3" "User Commands"
.SH NAME .SH NAME
hushd \- manual page for hushd v3.9.2 hushd \- manual page for hushd v3.9.3
.SH DESCRIPTION .SH DESCRIPTION
Hush Daemon version v3.9.2\-54cfe1099 Hush Daemon version v3.9.3\-1313d39a7
.PP .PP
In order to ensure you are adequately protecting your privacy when using Hush, In order to ensure you are adequately protecting your privacy when using Hush,
please see <https://hush.is/security/>. please see <https://hush.is/security/>.
@@ -17,11 +17,6 @@ Start a Hush Daemon
.IP .IP
This help message This help message
.HP .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> \fB\-blocknotify=\fR<cmd>
.IP .IP
Execute command when the best block changes (%s in cmd is replaced by Execute command when the best block changes (%s in cmd is replaced by
@@ -63,14 +58,23 @@ Set database cache size in megabytes (4 to 16384, default: 512)
.IP .IP
Imports blocks from external blk000??.dat file on startup Imports blocks from external blk000??.dat file on startup
.HP .HP
\fB\-maxdebugfilesize=\fR<n>
.IP
Set the max size of the debug.log file (default: 15)
.HP
\fB\-maxorphantx=\fR<n> \fB\-maxorphantx=\fR<n>
.IP .IP
Keep at most <n> unconnectable transactions in memory (default: 100) Keep at most <n> unconnectable transactions in memory (default: 100)
.HP .HP
\fB\-maxreorg=\fR<n>
.IP
Specify the maximum length of a blockchain re\-organization
.HP
\fB\-mempooltxinputlimit=\fR<n> \fB\-mempooltxinputlimit=\fR<n>
.IP .IP
[DEPRECATED/IGNORED] Set the maximum number of transparent inputs in a [DEPRECATED/IGNORED] Set the maximum number of transparent inputs in a
transaction that the mempool will accept (default: 0 = no limit applied) transaction that the mempool will accept (default: 0 = no limit
applied)
.HP .HP
\fB\-par=\fR<n> \fB\-par=\fR<n>
.IP .IP
@@ -89,10 +93,10 @@ transaction id)
\fB\-prune=\fR<n> \fB\-prune=\fR<n>
.IP .IP
Reduce storage requirements by pruning (deleting) old blocks. This mode Reduce storage requirements by pruning (deleting) old blocks. This mode
disables wallet support and is incompatible with \fB\-txindex\fR. Warning: disables wallet support and is incompatible with \fB\-txindex\fR.
Reverting this setting requires re\-downloading the entire blockchain. Warning: Reverting this setting requires re\-downloading the
(default: 0 = disable pruning blocks, >550 = target size in MiB to use entire blockchain. (default: 0 = disable pruning blocks, >550 =
for block files) target size in MiB to use for block files)
.HP .HP
\fB\-reindex\fR \fB\-reindex\fR
.IP .IP
@@ -142,8 +146,8 @@ Add a node to connect to and attempt to keep the connection open
\fB\-asmap=\fR<file> \fB\-asmap=\fR<file>
.IP .IP
Specify ASN mapping used for bucketing of the peers (default: Specify ASN mapping used for bucketing of the peers (default:
asmap.dat). Relative paths will be prefixed by the net\-specific datadir asmap.dat). Relative paths will be prefixed by the net\-specific
location. datadir location.
.HP .HP
\fB\-banscore=\fR<n> \fB\-banscore=\fR<n>
.IP .IP
@@ -191,7 +195,7 @@ Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\
.HP .HP
\fB\-listenonion\fR \fB\-listenonion\fR
.IP .IP
Automatically create Tor hidden service (default: 0) Automatically create Tor hidden service (default: 1)
.HP .HP
\fB\-maxconnections=\fR<n> \fB\-maxconnections=\fR<n>
.IP .IP
@@ -210,9 +214,36 @@ Maximum per\-connection send buffer, <n>*1000 bytes (default: 1000)
Use separate SOCKS5 proxy to reach peers via Tor hidden services Use separate SOCKS5 proxy to reach peers via Tor hidden services
(default: \fB\-proxy\fR) (default: \fB\-proxy\fR)
.HP .HP
\fB\-nspv_msg\fR
.IP
Enable NSPV messages processing (default: true when \fB\-ac_private\fR=\fI\,1\/\fR,
otherwise false)
.HP
\fB\-i2psam=\fR<ip:port>
.IP
I2P SAM proxy to reach I2P peers and accept I2P connections (default:
none)
.HP
\fB\-i2pacceptincoming\fR
.IP
If set and \fB\-i2psam\fR is also set then incoming I2P connections are
accepted via the SAM proxy. If this is not set but \fB\-i2psam\fR is set
then only outgoing connections will be made to the I2P network.
Ignored if \fB\-i2psam\fR is not set. Listening for incoming I2P
connections is done through the SAM proxy, not by binding to a
local address and port (default: 1)
.HP
\fB\-onlynet=\fR<net> \fB\-onlynet=\fR<net>
.IP .IP
Only connect to nodes in network <net> (ipv4, ipv6 or onion) Only connect to nodes in network <net> (ipv4, ipv6, onion or i2p)
.HP
\fB\-disableipv4\fR
.IP
Disable Ipv4 network connections (default: 0)
.HP
\fB\-disableipv6\fR
.IP
Disable Ipv6 network connections (default: 0)
.HP .HP
\fB\-permitbaremultisig\fR \fB\-permitbaremultisig\fR
.IP .IP
@@ -242,7 +273,7 @@ Connect to a node to retrieve peer addresses, and disconnect
.HP .HP
\fB\-timeout=\fR<n> \fB\-timeout=\fR<n>
.IP .IP
Specify connection timeout in milliseconds (minimum: 1, default: 5000) Specify connection timeout in milliseconds (minimum: 1, default: 60000)
.HP .HP
\fB\-torcontrol=\fR<ip>:<port> \fB\-torcontrol=\fR<ip>:<port>
.IP .IP
@@ -287,9 +318,9 @@ Bind to given address and allowlist peers connecting to it. Use
\fB\-allowlist=\fR<netmask> \fB\-allowlist=\fR<netmask>
.IP .IP
Allowlist peers connecting from the given netmask or IP address. Can be Allowlist peers connecting from the given netmask or IP address. Can be
specified multiple times. Allowlisted peers cannot be DoS banned and specified multiple times. Allowlisted peers cannot be DoS banned
their transactions are always relayed, even if they are already in the and their transactions are always relayed, even if they are
mempool, useful e.g. for a gateway already in the mempool, useful e.g. for a gateway
.PP .PP
Wallet options: Wallet options:
.HP .HP
@@ -430,29 +461,32 @@ by TxID)
\fB\-allowlistaddress=\fR<Raddress> \fB\-allowlistaddress=\fR<Raddress>
.IP .IP
Enable the wallet filter for notary nodes and add one Raddress to the Enable the wallet filter for notary nodes and add one Raddress to the
allowlist of the wallet filter. If \fB\-allowlistaddress=\fR is used, then the allowlist of the wallet filter. If \fB\-allowlistaddress=\fR is used,
wallet filter is automatically activated. Several Raddresses can be then the wallet filter is automatically activated. Several
defined using several \fB\-allowlistaddress=\fR (similar to \fB\-addnode\fR). The Raddresses can be defined using several \fB\-allowlistaddress=\fR
wallet filter will filter the utxo to only ones coming from my own (similar to \fB\-addnode\fR). The wallet filter will filter the utxo to
Raddress (derived from pubkey) and each Raddress defined using only ones coming from my own Raddress (derived from pubkey) and
\fB\-allowlistaddress=\fR this option is mostly for Notary Nodes). each Raddress defined using \fB\-allowlistaddress=\fR this option is
mostly for Notary Nodes).
.HP .HP
\fB\-zapwallettxes=\fR<mode> \fB\-zapwallettxes=\fR<mode>
.IP .IP
Delete all wallet transactions and only recover those parts of the 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. 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) account owner and payment request information, 2 = drop tx meta
data)
.PP .PP
Debugging/Testing options: Debugging/Testing options:
.HP .HP
\fB\-debug=\fR<category> \fB\-debug=\fR<category>
.IP .IP
Output debugging information (default: 0, supplying <category> is Output debugging information (default: 0, supplying <category> is
optional). If <category> is not supplied or if <category> = 1, output optional). If <category> is not supplied or if <category> = 1,
all debugging information. <category> can be: addrman, alert, bench, output all debugging information. <category> can be: addrman,
coindb, db, deletetx, estimatefee, http, libevent, lock, mempool, net, bench, coindb, db, deletetx, estimatefee, http, libevent, lock,
tls, partitioncheck, pow, proxy, prune, rand, randomx, reindex, rpc, mempool, net, tls, partitioncheck, pow, proxy, prune, rand,
selectcoins, stratum, tor, zrpc, zrpcunsafe (implies zrpc). randomx, reindex, rpc, selectcoins, stratum, tor, zrpc,
zrpcunsafe (implies zrpc).
.HP .HP
\fB\-experimentalfeatures\fR \fB\-experimentalfeatures\fR
.IP .IP
@@ -550,8 +584,8 @@ Accept public REST requests (default: 0)
\fB\-rpcbind=\fR<addr> \fB\-rpcbind=\fR<addr>
.IP .IP
Bind to given address to listen for JSON\-RPC connections. Use Bind to given address to listen for JSON\-RPC connections. Use
[host]:port notation for IPv6. This option can be specified multiple [host]:port notation for IPv6. This option can be specified
times (default: bind to all interfaces) multiple times (default: bind to all interfaces)
.HP .HP
\fB\-rpcuser=\fR<user> \fB\-rpcuser=\fR<user>
.IP .IP
@@ -568,9 +602,9 @@ Listen for JSON\-RPC connections on <port> (default: 0 or testnet: 10000)
\fB\-rpcallowip=\fR<ip> \fB\-rpcallowip=\fR<ip>
.IP .IP
Allow JSON\-RPC connections from specified source. Valid for <ip> are a 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) single IP (e.g. 1.2.3.4), a network/netmask (e.g.
or a network/CIDR (e.g. 1.2.3.4/24). This option can be specified 1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This
multiple times option can be specified multiple times
.HP .HP
\fB\-rpcthreads=\fR<n> \fB\-rpcthreads=\fR<n>
.IP .IP
@@ -606,8 +640,8 @@ Mining address to use when special address of 'x' is sent by miner
\fB\-stratumbind=\fR<ipaddr> \fB\-stratumbind=\fR<ipaddr>
.IP .IP
Bind to given address to listen for Stratum work requests. Use Bind to given address to listen for Stratum work requests. Use
[host]:port notation for IPv6. This option can be specified multiple [host]:port notation for IPv6. This option can be specified
times (default: bind to all interfaces) multiple times (default: bind to all interfaces)
.HP .HP
\fB\-stratumport=\fR<port> \fB\-stratumport=\fR<port>
.IP .IP
@@ -617,9 +651,9 @@ Listen for Stratum work requests on <port> (default: 19031 or testnet:
\fB\-stratumallowip=\fR<ip> \fB\-stratumallowip=\fR<ip>
.IP .IP
Allow Stratum work requests from specified source. Valid for <ip> are a Allow Stratum work requests 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) single IP (e.g. 1.2.3.4), a network/netmask (e.g.
or a network/CIDR (e.g. 1.2.3.4/24). This option can be specified 1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This
multiple times option can be specified multiple times
.PP .PP
Hush Smart Chain options: Hush Smart Chain options:
.HP .HP
@@ -700,6 +734,15 @@ Public key for receiving payments on the network
.IP .IP
Transparent transactions only, default 0 Transparent transactions only, default 0
.HP .HP
\fB\-ac_randomx_interval\fR
.IP
Controls how often the RandomX key block will change, default is 1024
.HP
\fB\-ac_randomx_lag\fR
.IP
Sets the number of RandomX blocks to wait before updating the key block,
default is 64
.HP
\fB\-ac_reward\fR \fB\-ac_reward\fR
.IP .IP
Block reward in satoshis, default is 0 Block reward in satoshis, default is 0
@@ -714,7 +757,7 @@ P2SH/multisig address to receive founders rewards
.HP .HP
\fB\-ac_supply\fR \fB\-ac_supply\fR
.IP .IP
Starting supply, default is 0 Starting supply, default is 10
.HP .HP
\fB\-ac_txpow\fR \fB\-ac_txpow\fR
.IP .IP
@@ -724,7 +767,7 @@ Enforce transaction\-rate limit, default 0
In order to ensure you are adequately protecting your privacy when using Hush, In order to ensure you are adequately protecting your privacy when using Hush,
please see <https://hush.is/security/>. please see <https://hush.is/security/>.
Copyright (C) 2016-2022 Duke Leto and The Hush Developers Copyright (C) 2016-2023 Duke Leto and The Hush Developers
Copyright (C) 2016-2020 jl777 and SuperNET developers Copyright (C) 2016-2020 jl777 and SuperNET developers