Skip to content

Commit

Permalink
MERGE-FIX: manpage fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenroose committed May 21, 2019
1 parent 52f6f69 commit a39bad4
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 18 deletions.
2 changes: 1 addition & 1 deletion contrib/devtools/gen-manpages.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ BITCOIND=${BITCOIND:-$BINDIR/elementsd}
BITCOINCLI=${BITCOINCLI:-$BINDIR/elements-cli}
BITCOINTX=${BITCOINTX:-$BINDIR/elements-tx}
WALLET_TOOL=${WALLET_TOOL:-$BINDIR/elements-wallet}
BITCOINQT=${BITCOINQT:-$BINDIR/qt/bitcoin-qt}
BITCOINQT=${BITCOINQT:-$BINDIR/qt/elements-qt}

[ ! -x $BITCOIND ] && echo "$BITCOIND not found or not executable." && exit 1

Expand Down
3 changes: 2 additions & 1 deletion doc/man/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ if BUILD_BITCOIND
endif

if ENABLE_QT
dist_man1_MANS+=bitcoin-qt.1
#TODO(stevenroose) uncomment and fix
# dist_man1_MANS+=elements-qt.1
endif

if BUILD_BITCOIN_CLI
Expand Down
9 changes: 6 additions & 3 deletions doc/man/elements-cli.1
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Elements Core RPC client version v0.17.0.1\-dirty
.HP
\-?
.IP
This help message
Print this help message and exit
.HP
\fB\-conf=\fR<file>
.IP
Expand Down Expand Up @@ -77,7 +77,9 @@ Wait for RPC server to start
\fB\-rpcwallet=\fR<walletname>
.IP
Send RPC for non\-default wallet on RPC server (needs to exactly match
corresponding \fB\-wallet\fR option passed to the daemon)
corresponding \fB\-wallet\fR option passed to the daemon). This changes
the RPC endpoint used, e.g.
http://127.0.0.1:8332/wallet/<walletname>
.HP
\fB\-stdin\fR
.IP
Expand Down Expand Up @@ -153,7 +155,8 @@ Elements Options:
.HP
\fB\-con_blocksubsidy\fR
.IP
Defines the amount of block subsidy to start with, at genesis block.
Defines the amount of block subsidy to start with, at genesis block, in
satoshis.
.HP
\fB\-con_connect_coinbase\fR
.IP
Expand Down
29 changes: 16 additions & 13 deletions doc/man/elementsd.1
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ long fork (%s in cmd is replaced by message)
If this block is in the chain assume that it and its ancestors are valid
and potentially skip their script verification (0 to verify all,
default:
0000000000000000002e63058c023a9a1de233554f28c7b21380b6c9003f36a8,
0000000000000000000f1c54590ee18d15ec70e68c8cd4cfbadb1b4f11697eee,
testnet:
0000000000000037a8cd3e06cd5edbfe9dd1dbcc5dacab279376ef7cfc2b4c75)
.HP
Expand Down Expand Up @@ -56,7 +56,9 @@ Specify data directory
.HP
\fB\-dbcache=\fR<n>
.IP
Set database cache size in megabytes (4 to 16384, default: 450)
Maximum database cache size <n> MiB (4 to 16384, default: 450). In
addition, unused mempool memory is shared for this cache (see
\fB\-maxmempool\fR).
.HP
\fB\-debuglogfile=\fR<file>
.IP
Expand Down Expand Up @@ -98,7 +100,7 @@ Whether to save the mempool on shutdown and load on restart (default: 1)
\fB\-pid=\fR<file>
.IP
Specify pid file. Relative paths will be prefixed by a net\-specific
datadir location. (default: elementsd.pid)
datadir location. (default: bitcoind.pid)
.HP
\fB\-prune=\fR<n>
.IP
Expand Down Expand Up @@ -644,7 +646,7 @@ mining and transaction creation (default: 0.00001)
\fB\-whitelistforcerelay\fR
.IP
Force relay of transactions from whitelisted peers even if they violate
local relay policy (default: 1)
local relay policy (default: 0)
.HP
\fB\-whitelistrelay\fR
.IP
Expand Down Expand Up @@ -677,21 +679,21 @@ option can be specified multiple times
.HP
\fB\-rpcauth=\fR<userpw>
.IP
Username and hashed password for JSON\-RPC connections. The field
<userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A
Username and HMAC\-SHA\-256 hashed password for JSON\-RPC connections. The
field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A
canonical python script is included in share/rpcauth. The client
then connects normally using the
rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This
option can be specified multiple times
.HP
\fB\-rpcbind=\fR<addr>[:port]
.IP
Bind to given address to listen for JSON\-RPC connections. This option is
ignored unless \fB\-rpcallowip\fR is also passed. Port is optional and
overrides \fB\-rpcport\fR. Use [host]:port notation for IPv6. This
option can be specified multiple times (default: 127.0.0.1 and
::1 i.e., localhost, or if \fB\-rpcallowip\fR has been specified,
0.0.0.0 and :: i.e., all addresses)
Bind to given address to listen for JSON\-RPC connections. Do not expose
the RPC server to untrusted networks such as the public internet!
This option is ignored unless \fB\-rpcallowip\fR is also passed. Port is
optional and overrides \fB\-rpcport\fR. Use [host]:port notation for
IPv6. This option can be specified multiple times (default:
127.0.0.1 and ::1 i.e., localhost)
.HP
\fB\-rpccookiefile=\fR<loc>
.IP
Expand Down Expand Up @@ -742,7 +744,8 @@ The byte prefix, in decimal, of blinded addresses. (default: 4)
.HP
\fB\-con_blocksubsidy\fR
.IP
Defines the amount of block subsidy to start with, at genesis block.
Defines the amount of block subsidy to start with, at genesis block, in
satoshis.
.HP
\fB\-con_connect_coinbase\fR
.IP
Expand Down

0 comments on commit a39bad4

Please sign in to comment.