Add ability to install man pages via make install (#27)

* Add support for out-of-tree builds in gen-manpages.sh

This adds support for setting the environment variable `BUILDDIR`
to point to executables that are outside the source directory.

E.g. to invoke the tool when the build is in $PWD/build:

```bash
BUILDDIR=$PWD/build contrib/devtools/gen-manpages.sh
```

* Add autogenerated manpages for 3.0.4

* Add ability to install man pages via `make install`

Author: MitchellCash

Makefile.am

@@ -6,6 +6,9 @@
 
 ACLOCAL_AMFLAGS = -I build-aux/m4
 SUBDIRS = src
+if ENABLE_MAN
+SUBDIRS += doc/man
+endif
 .PHONY: deploy FORCE
 
 export PYTHONPATH
@@ -227,5 +230,7 @@ CLEANFILES = $(OSX_DMG) $(BITCOIN_WIN_INSTALLER)
 
 .INTERMEDIATE: $(COVERAGE_INFO)
 
+DISTCHECK_CONFIGURE_FLAGS = --enable-man
+
 clean-local:
 	rm -rf test_ion.coverage/ total.coverage/ $(OSX_APP)

configure.ac

@@ -179,6 +179,12 @@ AC_ARG_WITH([system-univalue],
 
 AC_ARG_WITH([protoc-bindir],[AS_HELP_STRING([--with-protoc-bindir=BIN_DIR],[specify protoc bin path])], [protoc_bin_path=$withval], [])
 
+AC_ARG_ENABLE(man,
+    [AS_HELP_STRING([--disable-man],
+                    [do not install man pages (default is to install)])],,
+    enable_man=yes)
+AM_CONDITIONAL(ENABLE_MAN, test "$enable_man" != no)
+
 # Enable debug
 AC_ARG_ENABLE([debug],
     [AS_HELP_STRING([--enable-debug],
@@ -1141,7 +1147,7 @@ AC_SUBST(EVENT_PTHREADS_LIBS)
 AC_SUBST(ZMQ_LIBS)
 AC_SUBST(PROTOBUF_LIBS)
 AC_SUBST(QR_LIBS)
-AC_CONFIG_FILES([Makefile src/Makefile share/setup.nsi share/qt/Info.plist src/test/buildenv.py])
+AC_CONFIG_FILES([Makefile src/Makefile doc/man/Makefile share/setup.nsi share/qt/Info.plist src/test/buildenv.py])
 AC_CONFIG_FILES([qa/pull-tester/run-bitcoind-for-test.sh],[chmod +x qa/pull-tester/run-bitcoind-for-test.sh])
 AC_CONFIG_FILES([qa/pull-tester/tests-config.sh],[chmod +x qa/pull-tester/tests-config.sh])
 AC_CONFIG_FILES([contrib/devtools/split-debug.sh],[chmod +x contrib/devtools/split-debug.sh])

contrib/devtools/README.md

@@ -1,5 +1,5 @@
 Contents
-===========
+========
 This directory contains tools for developers working on this repository.
 
 check-doc.py
@@ -8,6 +8,20 @@ check-doc.py
 Check if all command line args are documented. The return value indicates the
 number of undocumented args.
 
+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/
+
+With in-tree builds this tool can be run from any directory within the
+repostitory. To use this tool with out-of-tree builds set `BUILDDIR`. For
+example:
+
+```bash
+BUILDDIR=$PWD/build contrib/devtools/gen-manpages.sh
+```
+
 github-merge.py
 ===============
 

contrib/devtools/gen-manpages.sh

@@ -1,18 +1,20 @@
 #!/bin/bash
 
 TOPDIR=${TOPDIR:-$(git rev-parse --show-toplevel)}
-SRCDIR=${SRCDIR:-$TOPDIR/src}
+BUILDDIR=${BUILDDIR:-$TOPDIR}
+
+BINDIR=${BINDIR:-$BUILDDIR/src}
 MANDIR=${MANDIR:-$TOPDIR/doc/man}
 
-IOND=${IOND:-$SRCDIR/iond}
-IONCLI=${IONCLI:-$SRCDIR/ion-cli}
-IONTX=${IONTX:-$SRCDIR/ion-tx}
-IONQT=${IONQT:-$SRCDIR/qt/ion-qt}
+IOND=${IOND:-$BINDIR/iond}
+IONCLI=${IONCLI:-$BINDIR/ion-cli}
+IONTX=${IONTX:-$BINDIR/ion-tx}
+IONQT=${IONQT:-$BINDIR/qt/ion-qt}
 
 [ ! -x $IOND ] && echo "$IOND not found or not executable." && exit 1
 
 # The autodetected version git tag can screw up manpage output a little bit
-BTCVER=($($IONCLI --version | head -n1 | awk -F'[ -]' '{ print $6, $7 }'))
+IONVER=($($IONCLI --version | head -n1 | awk -F'[ -]' '{ print $6, $7 }'))
 
 # Create a footer file with copyright content.
 # This gets autodetected fine for iond if --version-string is not set,
@@ -22,8 +24,8 @@ $IOND --version | sed -n '1!p' >> footer.h2m
 
 for cmd in $IOND $IONCLI $IONTX $IONQT; 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
+  help2man -N --version-string=${IONVER[0]} --include=footer.h2m -o ${MANDIR}/${cmdname}.1 ${cmd}
+  sed -i "s/\\\-${IONVER[1]}//g" ${MANDIR}/${cmdname}.1
 done
 
 rm -f footer.h2m

doc/man/Makefile.am

@@ -0,0 +1,13 @@
+dist_man1_MANS=
+
+if BUILD_BITCOIND
+  dist_man1_MANS+=iond.1
+endif
+
+if ENABLE_QT
+  dist_man1_MANS+=ion-qt.1
+endif
+
+if BUILD_BITCOIN_UTILS
+  dist_man1_MANS+=ion-cli.1 ion-tx.1
+endif

doc/man/ion-cli.1

@@ -0,0 +1,80 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
+.TH ION-CLI "1" "April 2018" "ion-cli v3.0.4.0" "User Commands"
+.SH NAME
+ion-cli \- manual page for ion-cli v3.0.4.0
+.SH DESCRIPTION
+Ion Core RPC client version v3.0.4.0\-CEVAP
+.SS "Usage:"
+.TP
+ion\-cli [options] <command> [params]
+Send command to Ion Core
+.TP
+ion\-cli [options] help
+List commands
+.TP
+ion\-cli [options] help <command>
+Get help for a command
+.SH OPTIONS
+.HP
+\-?
+.IP
+This help message
+.HP
+\fB\-conf=\fR<file>
+.IP
+Specify configuration file (default: ioncoin.conf)
+.HP
+\fB\-datadir=\fR<dir>
+.IP
+Specify data directory
+.HP
+\fB\-testnet\fR
+.IP
+Use the test network
+.HP
+\fB\-regtest\fR
+.IP
+Enter regression test mode, which uses a special chain in which blocks
+can be solved instantly. This is intended for regression testing tools
+and app development.
+.HP
+\fB\-rpcconnect=\fR<ip>
+.IP
+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: 51473 or testnet: 51475)
+.HP
+\fB\-rpcwait\fR
+.IP
+Wait for RPC server to start
+.HP
+\fB\-rpcuser=\fR<user>
+.IP
+Username for JSON\-RPC connections
+.HP
+\fB\-rpcpassword=\fR<pw>
+.IP
+Password for JSON\-RPC connections
+.HP
+\fB\-rpcclienttimeout=\fR<n>
+.IP
+Timeout during HTTP requests (default: 900)
+.SH COPYRIGHT
+Copyright (C) 2009-2018 The Bitcoin Core Developers
+
+Copyright (C) 2014-2018 The Dash Core Developers
+
+Copyright (C) 2015-2018 The PIVX Core Developers
+
+Copyright (C) 2018 The Ion Core Developers
+
+This is experimental software.
+
+Distributed under the MIT software license, see the accompanying file COPYING
+or <http://www.opensource.org/licenses/mit-license.php>.
+
+This product includes software developed by the OpenSSL Project for use in the
+OpenSSL Toolkit <https://www.openssl.org/> and cryptographic software written
+by Eric Young and UPnP software written by Thomas Bernard.