Differential D7677 Diff 24047 doc/man/gen-manpages.sh

Changeset View

Standalone View

doc/man/gen-manpages.sh

	Show All 19 Lines
	fi			fi

	if ! command -v help2man			if ! command -v help2man
	then			then
	echo "help2man is required to run $0, please install it"			echo "help2man is required to run $0, please install it"
	exit 2			exit 2
	fi			fi

				# Unfortunately bitcoin-qt requires a handle on the DISPLAY, even for the
				# --help option. We can spoof an X window using xvfb.
				if ! command -v xvfb-run
				then
				echo "xvfb is required to run $0 headlessly, please install it"
				exit 3
				fi

	BITCOIND="$1"			BITCOIND="$1"
	BIN="$2"			BIN="$2"
	MANPAGE="$3"			MANPAGE="$3"

	if [ ! -x "${BITCOIND}" ]			if [ ! -x "${BITCOIND}" ]
	then			then
	echo "${BITCOIND} not found or not executable."			echo "${BITCOIND} not found or not executable."
	exit 3			exit 4
	fi			fi
	if [ ! -x "${BIN}" ]			if [ ! -x "${BIN}" ]
	then			then
	echo "${BIN} not found or not executable."			echo "${BIN} not found or not executable."
	exit 3			exit 5
	fi			fi

	mkdir -p "$(dirname ${MANPAGE})"			mkdir -p "$(dirname ${MANPAGE})"

	# The autodetected version git tag can screw up manpage output a little bit			# The autodetected version git tag can screw up manpage output a little bit
	read -r -a VERSION <<< "$(${BITCOIND} --version \| head -n1 \| awk -F'[ -]' '{ print $5, $6 }')"			read -r -a VERSION <<< "$(${BITCOIND} --version \| head -n1 \| awk -F'[ -]' '{ print $5, $6 }')"

	# Create a footer file with copyright content.			# Create a footer file with copyright content.
	# This gets autodetected fine for bitcoind if --version-string is not set,			# This gets autodetected fine for bitcoind if --version-string is not set,
	# but has different outcomes for bitcoin-qt and bitcoin-cli.			# but has different outcomes for bitcoin-qt and bitcoin-cli.
	FOOTER="$(basename ${BIN})_footer.h2m"			FOOTER="$(basename ${BIN})_footer.h2m"
	cleanup() {			cleanup() {
	rm -f "${FOOTER}"			rm -f "${FOOTER}"
	}			}
	trap "cleanup" EXIT			trap "cleanup" EXIT
	echo "[COPYRIGHT]" > "${FOOTER}"			echo "[COPYRIGHT]" > "${FOOTER}"
	"${BITCOIND}" --version \| sed -n '1!p' >> "${FOOTER}"			"${BITCOIND}" --version \| sed -n '1!p' >> "${FOOTER}"

				xvfb-run -a -e /dev/stderr \
	help2man -N --version-string="${VERSION[0]}" --include="${FOOTER}" -o "${MANPAGE}" "${BIN}"			help2man -N --version-string="${VERSION[0]}" --include="${FOOTER}" -o "${MANPAGE}" "${BIN}"
	sed -i "s/\\\-${VERSION[1]}//g" "${MANPAGE}"			sed -i "s/\\\-${VERSION[1]}//g" "${MANPAGE}"