From d2cd9c033b603cb25dc4516f3511afa52dfb1ce0 Mon Sep 17 00:00:00 2001 From: nomnombtc Date: Sat, 27 Aug 2016 00:59:07 +0200 Subject: add script to generate manpages with help2man --- contrib/devtools/gen-manpages.sh | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100755 contrib/devtools/gen-manpages.sh (limited to 'contrib') diff --git a/contrib/devtools/gen-manpages.sh b/contrib/devtools/gen-manpages.sh new file mode 100755 index 0000000000..7cd7d1b509 --- /dev/null +++ b/contrib/devtools/gen-manpages.sh @@ -0,0 +1,18 @@ +#!/bin/sh + +# the autodetected version git tag at the end +# can screw up manpage output a little bit +BTCVER=$(bitcoin-cli --version | cut -d"-" -f1 | cut -d"v" -f3) + +# 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. +echo "[COPYRIGHT]" > footer.h2m +bitcoind --version | sed -n '1!p' >> footer.h2m + +for cmd in bitcoind bitcoin-qt bitcoin-cli; do + help2man -N --version-string=${BTCVER} --include=footer.h2m -o ../../doc/man/${cmd}.1 ${cmd} +done + +rm -f footer.h2m -- cgit v1.2.3 From 6edf2fdb85047be2d3236a2ced4c89116aa243bc Mon Sep 17 00:00:00 2001 From: nomnombtc Date: Sat, 27 Aug 2016 00:59:45 +0200 Subject: add gen-manpages.sh description to README.md --- contrib/devtools/README.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'contrib') diff --git a/contrib/devtools/README.md b/contrib/devtools/README.md index af5c000b03..60fe69e7e3 100644 --- a/contrib/devtools/README.md +++ b/contrib/devtools/README.md @@ -40,6 +40,12 @@ would be changed to: ```// Copyright (c) 2009-2015 The Bitcoin Core developers``` +gen-manpages.sh +=============== + +A small script to automatically create manpages in ../../doc/man by running the release binaries with the -help option. +This requires help2man which can be found at: https://www.gnu.org/software/help2man/ + git-subtree-check.sh ==================== -- cgit v1.2.3 From d19583f478f4104ea8ff787a475f9064d2c388ae Mon Sep 17 00:00:00 2001 From: nomnombtc Date: Thu, 1 Sep 2016 16:51:24 +0200 Subject: improved gen-manpages.sh, includes bitcoin-tx and strips commit tag, now also runs binaries from build dir by default, added variables for more control --- contrib/devtools/gen-manpages.sh | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) (limited to 'contrib') diff --git a/contrib/devtools/gen-manpages.sh b/contrib/devtools/gen-manpages.sh index 7cd7d1b509..967717e1e0 100755 --- a/contrib/devtools/gen-manpages.sh +++ b/contrib/devtools/gen-manpages.sh @@ -1,18 +1,29 @@ #!/bin/sh -# the autodetected version git tag at the end -# can screw up manpage output a little bit -BTCVER=$(bitcoin-cli --version | cut -d"-" -f1 | cut -d"v" -f3) +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} + +[ ! -x $BITCOIND ] && echo "$BITCOIND not found or not executable." && exit 1 + +# The autodetected version git tag can screw up manpage output a little bit +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 bitcoind if --version-string is not set, +# but has different outcomes for bitcoin-qt and bitcoin-cli. echo "[COPYRIGHT]" > footer.h2m -bitcoind --version | sed -n '1!p' >> footer.h2m +$BITCOIND --version | sed -n '1!p' >> footer.h2m -for cmd in bitcoind bitcoin-qt bitcoin-cli; do - help2man -N --version-string=${BTCVER} --include=footer.h2m -o ../../doc/man/${cmd}.1 ${cmd} +for cmd in $BITCOIND $BITCOINCLI $BITCOINTX $BITCOINQT; do + cmdname="${cmd##*/}" + help2man -N --version-string=${BTCVER[0]} --include=footer.h2m -o ${MANDIR}/${cmdname}.1 ${cmd} + sed -i "s/\\\-${BTCVER[1]}//g" ${MANDIR}/${cmdname}.1 done rm -f footer.h2m -- cgit v1.2.3