Rename and update man pages (#1451)

This commit is contained in:
Ross Nicoll 2018-01-20 18:34:28 +00:00
parent 236d74580b
commit 47a048b962
6 changed files with 93 additions and 93 deletions

View file

@ -4,10 +4,10 @@ TOPDIR=${TOPDIR:-$(git rev-parse --show-toplevel)}
SRCDIR=${SRCDIR:-$TOPDIR/src}
MANDIR=${MANDIR:-$TOPDIR/doc/man}
BITCOIND=${BITCOIND:-$SRCDIR/bitcoind}
BITCOINCLI=${BITCOINCLI:-$SRCDIR/bitcoin-cli}
BITCOINTX=${BITCOINTX:-$SRCDIR/bitcoin-tx}
BITCOINQT=${BITCOINQT:-$SRCDIR/qt/bitcoin-qt}
BITCOIND=${BITCOIND:-$SRCDIR/dogecoind}
BITCOINCLI=${BITCOINCLI:-$SRCDIR/dogecoin-cli}
BITCOINTX=${BITCOINTX:-$SRCDIR/dogecoin-tx}
BITCOINQT=${BITCOINQT:-$SRCDIR/qt/dogecoin-qt}
[ ! -x $BITCOIND ] && echo "$BITCOIND not found or not executable." && exit 1
@ -15,8 +15,8 @@ BITCOINQT=${BITCOINQT:-$SRCDIR/qt/bitcoin-qt}
BTCVER=($($BITCOINCLI --version | head -n1 | awk -F'[ -]' '{ print $6, $7 }'))
# Create a footer file with copyright content.
# This gets autodetected fine for bitcoind if --version-string is not set,
# but has different outcomes for bitcoin-qt and bitcoin-cli.
# This gets autodetected fine for dogecoind if --version-string is not set,
# but has different outcomes for dogecoin-qt and dogecoin-cli.
echo "[COPYRIGHT]" > footer.h2m
$BITCOIND --version | sed -n '1!p' >> footer.h2m

View file

@ -1,13 +1,13 @@
dist_man1_MANS=
if BUILD_BITCOIND
dist_man1_MANS+=bitcoind.1
dist_man1_MANS+=dogecoind.1
endif
if ENABLE_QT
dist_man1_MANS+=bitcoin-qt.1
dist_man1_MANS+=dogecoin-qt.1
endif
if BUILD_BITCOIN_UTILS
dist_man1_MANS+=bitcoin-cli.1 bitcoin-tx.1
dist_man1_MANS+=dogecoin-cli.1 dogecoin-tx.1
endif

View file

@ -1,17 +1,17 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
.TH BITCOIN-CLI "1" "February 2017" "bitcoin-cli v0.14.0.0" "User Commands"
.TH DOGECOIN-CLI "1" "January 2018" "dogecoin-cli v1.14.0.0" "User Commands"
.SH NAME
bitcoin-cli \- manual page for bitcoin-cli v0.14.0.0
dogecoin-cli \- manual page for dogecoin-cli v1.14.0.0
.SH DESCRIPTION
Bitcoin Core RPC client version v0.14.0.0\-dirty
Dogecoin Core RPC client version v1.14.0.0
.SS "Usage:"
.TP
bitcoin\-cli [options] <command> [params]
Send command to Bitcoin Core
dogecoin\-cli [options] <command> [params]
Send command to Dogecoin Core
.IP
bitcoin\-cli [options] \fB\-named\fR <command> [name=value] ... Send command to Bitcoin Core (with named arguments)
bitcoin\-cli [options] help List commands
bitcoin\-cli [options] help <command> Get help for a command
dogecoin\-cli [options] \fB\-named\fR <command> [name=value] ... Send command to Dogecoin Core (with named arguments)
dogecoin\-cli [options] help List commands
dogecoin\-cli [options] help <command> Get help for a command
.SH OPTIONS
.HP
\-?
@ -20,7 +20,7 @@ This help message
.HP
\fB\-conf=\fR<file>
.IP
Specify configuration file (default: bitcoin.conf)
Specify configuration file (default: dogecoin.conf)
.HP
\fB\-datadir=\fR<dir>
.IP
@ -48,7 +48,7 @@ Send commands to node running on <ip> (default: 127.0.0.1)
.HP
\fB\-rpcport=\fR<port>
.IP
Connect to JSON\-RPC on <port> (default: 8332 or testnet: 18332)
Connect to JSON\-RPC on <port> (default: 22555 or testnet: 44555)
.HP
\fB\-rpcwait\fR
.IP
@ -71,11 +71,11 @@ Timeout during HTTP requests (default: 900)
Read extra arguments from standard input, one per line until EOF/Ctrl\-D
(recommended for sensitive information such as passphrases)
.SH COPYRIGHT
Copyright (C) 2009-2017 The Bitcoin Core developers
Copyright (C) 2013-2017 The Bitcoin Core and Dogecoin Core developers
Please contribute if you find Bitcoin Core useful. Visit
<https://bitcoincore.org> for further information about the software.
The source code is available from <https://github.com/bitcoin/bitcoin>.
Please contribute if you find Dogecoin Core useful. Visit
<https://dogecoin.com> for further information about the software.
The source code is available from <https://github.com/dogecoin/dogecoin>.
This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING

View file

@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
.TH BITCOIN-QT "1" "February 2017" "bitcoin-qt v0.14.0.0" "User Commands"
.TH DOGECOIN-QT "1" "January 2018" "dogecoin-qt v1.14.0.0" "User Commands"
.SH NAME
bitcoin-qt \- manual page for bitcoin-qt v0.14.0.0
dogecoin-qt \- manual page for dogecoin-qt v1.14.0.0
.SH DESCRIPTION
Bitcoin Core version v0.14.0.0\-dirty (64\-bit)
Dogecoin Core version v1.14.0.0 (64\-bit)
Usage:
.IP
bitcoin\-qt [command\-line options]
dogecoin\-qt [command\-line options]
.SH OPTIONS
.HP
\-?
@ -32,13 +32,13 @@ block hash)
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:
00000000000000000013176bf8d7dfeab4e1db31dc93bc311b436e82ab226b90,
ca5eb72f1e0d160f1481f74d56d7cc4a27d91aa585ba012da8018a5fe934d61b,
testnet:
00000000000128796ee387cf110ccb9d2f36cffaf7f73079c995377c65ac0dcc)
6943eaeaba98dc7d09f7e73398daccb4abcabb18b66c8c875e52b07638d93951)
.HP
\fB\-conf=\fR<file>
.IP
Specify configuration file (default: bitcoin.conf)
Specify configuration file (default: dogecoin.conf)
.HP
\fB\-datadir=\fR<dir>
.IP
@ -72,12 +72,12 @@ Extra transactions to keep in memory for compact block reconstructions
.HP
\fB\-par=\fR<n>
.IP
Set the number of script verification threads (\fB\-6\fR to 16, 0 = auto, <0 =
Set the number of script verification threads (\fB\-3\fR to 16, 0 = auto, <0 =
leave that many cores free, default: 0)
.HP
\fB\-pid=\fR<file>
.IP
Specify pid file (default: bitcoind.pid)
Specify pid file (default: dogecoind.pid)
.HP
\fB\-prune=\fR<n>
.IP
@ -203,7 +203,7 @@ Support filtering of blocks and transaction with bloom filters (default:
.HP
\fB\-port=\fR<port>
.IP
Listen for connections on <port> (default: 8333 or testnet: 18333)
Listen for connections on <port> (default: 22556 or testnet: 44556)
.HP
\fB\-proxy=\fR<ip:port>
.IP
@ -280,17 +280,17 @@ Set key pool size to <n> (default: 100)
.HP
\fB\-fallbackfee=\fR<amt>
.IP
A fee rate (in BTC/kB) that will be used when fee estimation has
insufficient data (default: 0.0002)
A fee rate (in DOGE/kB) that will be used when fee estimation has
insufficient data (default: 1.00)
.HP
\fB\-mintxfee=\fR<amt>
.IP
Fees (in BTC/kB) smaller than this are considered zero fee for
transaction creation (default: 0.00001)
Fees (in DOGE/kB) smaller than this are considered zero fee for
transaction creation (default: 1.00)
.HP
\fB\-paytxfee=\fR<amt>
.IP
Fee (in BTC/kB) to add to transactions you send (default: 0.00)
Fee (in DOGE/kB) to add to transactions you send (default: 0.00)
.HP
\fB\-rescan\fR
.IP
@ -389,14 +389,14 @@ Prepend debug output with timestamp (default: 1)
.HP
\fB\-minrelaytxfee=\fR<amt>
.IP
Fees (in BTC/kB) smaller than this are considered zero fee for relaying,
mining and transaction creation (default: 0.00001)
Fees (in DOGE/kB) smaller than this are considered zero fee for
relaying, mining and transaction creation (default: 1.00)
.HP
\fB\-maxtxfee=\fR<amt>
.IP
Maximum total fees (in BTC) to use in a single wallet transaction or raw
transaction; setting this too low may abort large transactions
(default: 0.10)
Maximum total fees (in DOGE) to use in a single wallet transaction or
raw transaction; setting this too low may abort large
transactions (default: 400.00)
.HP
\fB\-printtoconsole\fR
.IP
@ -445,12 +445,12 @@ Set maximum block size in bytes (default: 750000)
\fB\-blockprioritysize=\fR<n>
.IP
Set maximum size of high\-priority/low\-fee transactions in bytes
(default: 0)
(default: 27000)
.HP
\fB\-blockmintxfee=\fR<amt>
.IP
Set lowest fee rate (in BTC/kB) for transactions to be included in block
creation. (default: 0.00001)
Set lowest fee rate (in DOGE/kB) for transactions to be included in
block creation. (default: 0.00001)
.PP
RPC server options:
.HP
@ -491,8 +491,8 @@ option can be specified multiple times
.HP
\fB\-rpcport=\fR<port>
.IP
Listen for JSON\-RPC connections on <port> (default: 8332 or testnet:
18332)
Listen for JSON\-RPC connections on <port> (default: 22555 or testnet:
44555)
.HP
\fB\-rpcallowip=\fR<ip>
.IP
@ -531,11 +531,11 @@ Show splash screen on startup (default: 1)
.IP
Reset all settings changed in the GUI
.SH COPYRIGHT
Copyright (C) 2009-2017 The Bitcoin Core developers
Copyright (C) 2013-2017 The Bitcoin Core and Dogecoin Core developers
Please contribute if you find Bitcoin Core useful. Visit
<https://bitcoincore.org> for further information about the software.
The source code is available from <https://github.com/bitcoin/bitcoin>.
Please contribute if you find Dogecoin Core useful. Visit
<https://dogecoin.com> for further information about the software.
The source code is available from <https://github.com/dogecoin/dogecoin>.
This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING

View file

@ -1,16 +1,16 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
.TH BITCOIN-TX "1" "February 2017" "bitcoin-tx v0.14.0.0" "User Commands"
.TH DOGECOIN-TX "1" "January 2018" "dogecoin-tx v1.14.0.0" "User Commands"
.SH NAME
bitcoin-tx \- manual page for bitcoin-tx v0.14.0.0
dogecoin-tx \- manual page for dogecoin-tx v1.14.0.0
.SH DESCRIPTION
Bitcoin Core bitcoin\-tx utility version v0.14.0.0\-dirty
Dogecoin Core dogecoin\-tx utility version v1.14.0.0
.SS "Usage:"
.TP
bitcoin\-tx [options] <hex\-tx> [commands]
Update hex\-encoded bitcoin transaction
dogecoin\-tx [options] <hex\-tx> [commands]
Update hex\-encoded dogecoin transaction
.TP
bitcoin\-tx [options] \fB\-create\fR [commands]
Create hex\-encoded bitcoin transaction
dogecoin\-tx [options] \fB\-create\fR [commands]
Create hex\-encoded dogecoin transaction
.SH OPTIONS
.HP
\-?
@ -107,11 +107,11 @@ set=NAME:JSON\-STRING
.IP
Set register NAME to given JSON\-STRING
.SH COPYRIGHT
Copyright (C) 2009-2017 The Bitcoin Core developers
Copyright (C) 2013-2017 The Bitcoin Core and Dogecoin Core developers
Please contribute if you find Bitcoin Core useful. Visit
<https://bitcoincore.org> for further information about the software.
The source code is available from <https://github.com/bitcoin/bitcoin>.
Please contribute if you find Dogecoin Core useful. Visit
<https://dogecoin.com> for further information about the software.
The source code is available from <https://github.com/dogecoin/dogecoin>.
This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING

View file

@ -1,13 +1,13 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
.TH BITCOIND "1" "February 2017" "bitcoind v0.14.0.0" "User Commands"
.TH DOGECOIND "1" "January 2018" "dogecoind v1.14.0.0" "User Commands"
.SH NAME
bitcoind \- manual page for bitcoind v0.14.0.0
dogecoind \- manual page for dogecoind v1.14.0.0
.SH DESCRIPTION
Bitcoin Core Daemon version v0.14.0.0\-dirty
Dogecoin Core Daemon version v1.14.0.0
.SS "Usage:"
.TP
bitcoind [options]
Start Bitcoin Core Daemon
dogecoind [options]
Start Dogecoin Core Daemon
.SH OPTIONS
.HP
\-?
@ -33,13 +33,13 @@ block hash)
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:
00000000000000000013176bf8d7dfeab4e1db31dc93bc311b436e82ab226b90,
ca5eb72f1e0d160f1481f74d56d7cc4a27d91aa585ba012da8018a5fe934d61b,
testnet:
00000000000128796ee387cf110ccb9d2f36cffaf7f73079c995377c65ac0dcc)
6943eaeaba98dc7d09f7e73398daccb4abcabb18b66c8c875e52b07638d93951)
.HP
\fB\-conf=\fR<file>
.IP
Specify configuration file (default: bitcoin.conf)
Specify configuration file (default: dogecoin.conf)
.HP
\fB\-daemon\fR
.IP
@ -77,12 +77,12 @@ Extra transactions to keep in memory for compact block reconstructions
.HP
\fB\-par=\fR<n>
.IP
Set the number of script verification threads (\fB\-6\fR to 16, 0 = auto, <0 =
Set the number of script verification threads (\fB\-3\fR to 16, 0 = auto, <0 =
leave that many cores free, default: 0)
.HP
\fB\-pid=\fR<file>
.IP
Specify pid file (default: bitcoind.pid)
Specify pid file (default: dogecoind.pid)
.HP
\fB\-prune=\fR<n>
.IP
@ -208,7 +208,7 @@ Support filtering of blocks and transaction with bloom filters (default:
.HP
\fB\-port=\fR<port>
.IP
Listen for connections on <port> (default: 8333 or testnet: 18333)
Listen for connections on <port> (default: 22556 or testnet: 44556)
.HP
\fB\-proxy=\fR<ip:port>
.IP
@ -285,17 +285,17 @@ Set key pool size to <n> (default: 100)
.HP
\fB\-fallbackfee=\fR<amt>
.IP
A fee rate (in BTC/kB) that will be used when fee estimation has
insufficient data (default: 0.0002)
A fee rate (in DOGE/kB) that will be used when fee estimation has
insufficient data (default: 1.00)
.HP
\fB\-mintxfee=\fR<amt>
.IP
Fees (in BTC/kB) smaller than this are considered zero fee for
transaction creation (default: 0.00001)
Fees (in DOGE/kB) smaller than this are considered zero fee for
transaction creation (default: 1.00)
.HP
\fB\-paytxfee=\fR<amt>
.IP
Fee (in BTC/kB) to add to transactions you send (default: 0.00)
Fee (in DOGE/kB) to add to transactions you send (default: 0.00)
.HP
\fB\-rescan\fR
.IP
@ -394,14 +394,14 @@ Prepend debug output with timestamp (default: 1)
.HP
\fB\-minrelaytxfee=\fR<amt>
.IP
Fees (in BTC/kB) smaller than this are considered zero fee for relaying,
mining and transaction creation (default: 0.00001)
Fees (in DOGE/kB) smaller than this are considered zero fee for
relaying, mining and transaction creation (default: 1.00)
.HP
\fB\-maxtxfee=\fR<amt>
.IP
Maximum total fees (in BTC) to use in a single wallet transaction or raw
transaction; setting this too low may abort large transactions
(default: 0.10)
Maximum total fees (in DOGE) to use in a single wallet transaction or
raw transaction; setting this too low may abort large
transactions (default: 400.00)
.HP
\fB\-printtoconsole\fR
.IP
@ -450,12 +450,12 @@ Set maximum block size in bytes (default: 750000)
\fB\-blockprioritysize=\fR<n>
.IP
Set maximum size of high\-priority/low\-fee transactions in bytes
(default: 0)
(default: 27000)
.HP
\fB\-blockmintxfee=\fR<amt>
.IP
Set lowest fee rate (in BTC/kB) for transactions to be included in block
creation. (default: 0.00001)
Set lowest fee rate (in DOGE/kB) for transactions to be included in
block creation. (default: 0.00001)
.PP
RPC server options:
.HP
@ -496,8 +496,8 @@ option can be specified multiple times
.HP
\fB\-rpcport=\fR<port>
.IP
Listen for JSON\-RPC connections on <port> (default: 8332 or testnet:
18332)
Listen for JSON\-RPC connections on <port> (default: 22555 or testnet:
44555)
.HP
\fB\-rpcallowip=\fR<ip>
.IP
@ -510,11 +510,11 @@ option can be specified multiple times
.IP
Set the number of threads to service RPC calls (default: 4)
.SH COPYRIGHT
Copyright (C) 2009-2017 The Bitcoin Core developers
Copyright (C) 2013-2017 The Bitcoin Core and Dogecoin Core developers
Please contribute if you find Bitcoin Core useful. Visit
<https://bitcoincore.org> for further information about the software.
The source code is available from <https://github.com/bitcoin/bitcoin>.
Please contribute if you find Dogecoin Core useful. Visit
<https://dogecoin.com> for further information about the software.
The source code is available from <https://github.com/dogecoin/dogecoin>.
This is experimental software.
Distributed under the MIT software license, see the accompanying file COPYING