Skip to content

Commit

Permalink
Introduce gen-manpages.sh
Browse files Browse the repository at this point in the history
Script to update the man files in `doc/man/`
  • Loading branch information
Fuzzbawls committed Jun 17, 2019
1 parent 035dda7 commit fe7bf50
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions contrib/devtools/gen-manpages.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
#!/usr/bin/env bash

export LC_ALL=C
TOPDIR=${TOPDIR:-$(git rev-parse --show-toplevel)}
BUILDDIR=${BUILDDIR:-$TOPDIR}

BINDIR=${BINDIR:-$BUILDDIR/src}
MANDIR=${MANDIR:-$TOPDIR/doc/man}

BITCOIND=${BITCOIND:-$BINDIR/pivxd}
BITCOINCLI=${BITCOINCLI:-$BINDIR/pivx-cli}
BITCOINTX=${BITCOINTX:-$BINDIR/pivx-tx}
BITCOINQT=${BITCOINQT:-$BINDIR/qt/pivx-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.
echo "[COPYRIGHT]" > footer.h2m
$BITCOIND --version | sed -n '1!p' >> footer.h2m

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

0 comments on commit fe7bf50

Please sign in to comment.