tinyproxy/docs/man5/Makefile.am

if HAVE_MANPAGE_INTEREST
MAN5_FILES  = \
	tinyproxy.conf.txt
endif

if HAVE_XMLLINT
A2X_ARGS = -d manpage -f manpage
else
A2X_ARGS = -d manpage -f manpage -L
endif

ASCIIDOCTOR_ARGS = -b manpage

man_MANS = \
	$(MAN5_FILES:.txt=.5)

.txt.5:
if HAVE_A2X
	$(AM_V_GEN) $(A2X) $(A2X_ARGS) $<
else
if HAVE_ASCIIDOCTOR
	$(AM_V_GEN) $(ASCIIDOCTOR) $(ASCIIDOCTOR_ARGS) $<
else
	@echo "*** a2x (asciidoc) or asciidoctor is required to regenerate $(@) ***"; exit 1;
endif
endif

MAINTAINERCLEANFILES = \
	$(MAN5_FILES:.txt=.5)

CLEANFILES = \
	$(MAN5_FILES:.txt=.xml)

EXTRA_DIST = \
	$(MAN5_FILES:.txt=.5)
add configure option to disable manpage generation using --disable-manpage-support it's finally possibly to disable the formerly obligatory use of a2x to generate the manpage documentation. this is the final solution to the decade old problem that users need to install the enormous asciidoc package to compile TINYproxy from source, or otherwise get a build error, even though the vast majority is only interested in the program itself. solution was inspired by PR #179. closes #179 closes #111 note that since 1.10.0 release the generated release tarball includes the generated manpages too; in which case neither the use of a2x nor --disable-manpage-support is required. 2020-08-12 07:15:45 +08:00			`if HAVE_MANPAGE_INTEREST`
docs: Add placeholder for tinyproxy.conf manpage 2009-09-19 12:27:24 +08:00			`MAN5_FILES = \`
			`tinyproxy.conf.txt`
add configure option to disable manpage generation using --disable-manpage-support it's finally possibly to disable the formerly obligatory use of a2x to generate the manpage documentation. this is the final solution to the decade old problem that users need to install the enormous asciidoc package to compile TINYproxy from source, or otherwise get a build error, even though the vast majority is only interested in the program itself. solution was inspired by PR #179. closes #179 closes #111 note that since 1.10.0 release the generated release tarball includes the generated manpages too; in which case neither the use of a2x nor --disable-manpage-support is required. 2020-08-12 07:15:45 +08:00			`endif`
docs: Add placeholder for tinyproxy.conf manpage 2009-09-19 12:27:24 +08:00
Added conditional for xmllint by testing "a2x" without the -L flag. 2016-12-28 02:53:02 +08:00			`if HAVE_XMLLINT`
			`A2X_ARGS = -d manpage -f manpage`
			`else`
			`A2X_ARGS = -d manpage -f manpage -L`
			`endif`
docs: Add placeholder for tinyproxy.conf manpage 2009-09-19 12:27:24 +08:00
add support for asciidoctor to generate manpages asciidoctor is a modern replacement for asciidoc and much more lightweight, issuing "apt-get install asciidoc" on ubuntu 16.04 results in an attempt to install more than 1.3 GB of dependencies. 2020-08-11 21:52:16 +08:00			`ASCIIDOCTOR_ARGS = -b manpage`

docs: Add placeholder for tinyproxy.conf manpage 2009-09-19 12:27:24 +08:00			`man_MANS = \`
			`$(MAN5_FILES:.txt=.5)`

			`.txt.5:`
			`if HAVE_A2X`
Use located a2x binary instead of hard-coded name 2009-11-14 18:17:51 +08:00			`$(AM_V_GEN) $(A2X) $(A2X_ARGS) $<`
docs: Add placeholder for tinyproxy.conf manpage 2009-09-19 12:27:24 +08:00			`else`
add support for asciidoctor to generate manpages asciidoctor is a modern replacement for asciidoc and much more lightweight, issuing "apt-get install asciidoc" on ubuntu 16.04 results in an attempt to install more than 1.3 GB of dependencies. 2020-08-11 21:52:16 +08:00			`if HAVE_ASCIIDOCTOR`
			`$(AM_V_GEN) $(ASCIIDOCTOR) $(ASCIIDOCTOR_ARGS) $<`
			`else`
			`@echo "* a2x (asciidoc) or asciidoctor is required to regenerate $(@) *"; exit 1;`
			`endif`
docs: Add placeholder for tinyproxy.conf manpage 2009-09-19 12:27:24 +08:00			`endif`

move manpages to maintainer-clean make target according to https://www.gnu.org/prep/standards/html_node/Standard-Targets.html#Standard-Targets `maintainer-clean` is the proper make target for files that are distributed in a release tarball: > The ‘maintainer-clean’ target is intended to be used by a maintainer of the > package, not by ordinary users. > You may need special tools to reconstruct some of the files that > ‘make maintainer-clean’ deletes. this prevents users without a2x or asciidoctor from losing their ability to recompile tinyproxy after `make clean`, but it also means that users wanting to regenerate the documentation need to run `make maintainer-clean`. 2020-08-12 00:48:57 +08:00			`MAINTAINERCLEANFILES = \`
			`$(MAN5_FILES:.txt=.5)`

docs: Add placeholder for tinyproxy.conf manpage 2009-09-19 12:27:24 +08:00			`CLEANFILES = \`
			`$(MAN5_FILES:.txt=.xml)`
ship manpages as part of the dist tarball `make dist` now creates the manpages and puts them into the tarball, so the user does not need to have `a2x` installed to build them. closes #2 2016-12-21 04:07:23 +08:00
			`EXTRA_DIST = \`
			`$(MAN5_FILES:.txt=.5)`