phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-02-02 14:37:42 -03:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Add manual page generation for bitcoin-util

Browse source 
- Add `-version` option to `bitcoin-util`
- Add `bitcoin-util` call to `gen-manpages.sh`
- Add stub manual page `bitcoin-util.1`
- Add install of `bitcoin-util.1` to build system
This commit is contained in:
Wladimir J. van der Laan 2021-01-12 14:01:09 +01:00
parent 7b975639ef
commit b5e93f873a
4 changed files with 21 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
contrib/devtools/gen-manpages.sh
View file

@ -14,13 +14,14 @@ BITCOIND=${BITCOIND:-$BINDIR/bitcoind}
BITCOINCLI=${BITCOINCLI:-$BINDIR/bitcoin-cli} BITCOINCLI=${BITCOINCLI:-$BINDIR/bitcoin-cli}
BITCOINTX=${BITCOINTX:-$BINDIR/bitcoin-tx} BITCOINTX=${BITCOINTX:-$BINDIR/bitcoin-tx}
WALLET_TOOL=${WALLET_TOOL:-$BINDIR/bitcoin-wallet} WALLET_TOOL=${WALLET_TOOL:-$BINDIR/bitcoin-wallet}
BITCOINUTIL=${BITCOINQT:-$BINDIR/bitcoin-util}
BITCOINQT=${BITCOINQT:-$BINDIR/qt/bitcoin-qt} BITCOINQT=${BITCOINQT:-$BINDIR/qt/bitcoin-qt}
[ ! -x $BITCOIND ] && echo "$BITCOIND not found or not executable." && exit 1 [ ! -x $BITCOIND ] && echo "$BITCOIND not found or not executable." && exit 1
# Don't allow man pages to be generated for binaries built from a dirty tree # Don't allow man pages to be generated for binaries built from a dirty tree
DIRTY="" DIRTY=""
for cmd in $BITCOIND $BITCOINCLI $BITCOINTX $WALLET_TOOL $BITCOINQT; do for cmd in $BITCOIND $BITCOINCLI $BITCOINTX $WALLET_TOOL $BITCOINUTIL $BITCOINQT; do
VERSION_OUTPUT=$($cmd --version) VERSION_OUTPUT=$($cmd --version)
if [[ $VERSION_OUTPUT == *"dirty"* ]]; then if [[ $VERSION_OUTPUT == *"dirty"* ]]; then
DIRTY="${DIRTY}${cmd}\n" DIRTY="${DIRTY}${cmd}\n"
@ -43,7 +44,7 @@ read -r -a BTCVER <<< "$($BITCOINCLI --version | head -n1 | awk -F'[ -]' '{ prin
echo "[COPYRIGHT]" > footer.h2m echo "[COPYRIGHT]" > footer.h2m
$BITCOIND --version | sed -n '1!p' >> footer.h2m $BITCOIND --version | sed -n '1!p' >> footer.h2m
for cmd in $BITCOIND $BITCOINCLI $BITCOINTX $WALLET_TOOL $BITCOINQT; do for cmd in $BITCOIND $BITCOINCLI $BITCOINTX $WALLET_TOOL $BITCOINUTIL $BITCOINQT; do
cmdname="${cmd##*/}" cmdname="${cmd##*/}"
help2man -N --version-string=${BTCVER[0]} --include=footer.h2m -o ${MANDIR}/${cmdname}.1 ${cmd} help2man -N --version-string=${BTCVER[0]} --include=footer.h2m -o ${MANDIR}/${cmdname}.1 ${cmd}
sed -i "s/\\\-${BTCVER[1]}//g" ${MANDIR}/${cmdname}.1 sed -i "s/\\\-${BTCVER[1]}//g" ${MANDIR}/${cmdname}.1

4
doc/man/Makefile.am
View file

@ -16,6 +16,10 @@ if BUILD_BITCOIN_TX
dist_man1_MANS+=bitcoin-tx.1 dist_man1_MANS+=bitcoin-tx.1
endif endif
if BUILD_BITCOIN_UTIL
dist_man1_MANS+=bitcoin-util.1
endif
if ENABLE_WALLET if ENABLE_WALLET
if BUILD_BITCOIN_WALLET if BUILD_BITCOIN_WALLET
dist_man1_MANS+=bitcoin-wallet.1 dist_man1_MANS+=bitcoin-wallet.1

5
doc/man/bitcoin-util.1 Normal file
View file

@ -0,0 +1,5 @@
.TH BITCOIN-UTIL "1"
.SH NAME
bitcoin-util \- manual page for bitcoin-util
This is a placefolder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.

14
src/bitcoin-util.cpp
View file

@ -40,6 +40,8 @@ static void SetupBitcoinUtilArgs(ArgsManager &argsman)
{ {
SetupHelpOptions(argsman); SetupHelpOptions(argsman);
argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
SetupChainParamsBaseOptions(argsman); SetupChainParamsBaseOptions(argsman);
} }
@ -62,12 +64,14 @@ static int AppInitUtil(int argc, char* argv[])
return EXIT_FAILURE; return EXIT_FAILURE;
} }
if (argc < 2 || HelpRequested(gArgs)) { if (argc < 2 || HelpRequested(gArgs) || gArgs.IsArgSet("-version")) {
// First part of help message is specific to this utility // First part of help message is specific to this utility
std::string strUsage = PACKAGE_NAME " bitcoin-util utility version " + FormatFullVersion() + "\n\n" + std::string strUsage = PACKAGE_NAME " bitcoin-util utility version " + FormatFullVersion() + "\n";
"Usage: bitcoin-util [options] [commands] Do stuff\n" + if (!gArgs.IsArgSet("-version")) {
"\n"; strUsage += "\n"
strUsage += gArgs.GetHelpMessage(); "Usage: bitcoin-util [options] [commands] Do stuff\n";
strUsage += "\n" + gArgs.GetHelpMessage();
}
tfm::format(std::cout, "%s", strUsage); tfm::format(std::cout, "%s", strUsage);