diff options
| author | Giorgio Dal Molin <giorgio.nicole@arcor.de> | 2014-11-12 17:41:05 +0100 |
|---|---|---|
| committer | Pablo Neira Ayuso <pablo@netfilter.org> | 2014-11-12 21:43:45 +0100 |
| commit | c12d635ca3ef24345e37aca7bd2bb1aa280c0e34 (patch) | |
| tree | 466d66415fcac8679ccfeeae7db6cbdbc059d174 /doc | |
| parent | 5fa8e494ca240567313215a7d5a87c620e86024e (diff) | |
build: add autotools support for the 'doc' subdir
'nft' documentation is originally contained in the XML file 'doc/nft.xml'.
Processing this file with the proper tools we can obtain a PDF document,
'nft.pdf', and a unix man page, 'nft.8'.
To produce the PDF we need the tool 'dblatex' (current release
pypi.python.org/pypi/dblatex/0.3.5).
To produce the man page we use the tool 'docbook2man'; it is part of the
package 'docbook2X' (docbook2x.sourceforge.net). On some linux
distributions the tool can have slightly different names as 'docbook2x-man'
or 'db2x_docbook2man' so we search for all three names and use the first
one found and issue the command:
# ${DB2MAN} --xinclude $<
Signed-off-by: Giorgio Dal Molin <giorgio.nicole@arcor.de>
Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 19 | ||||
| -rw-r--r-- | doc/Makefile.in | 20 |
2 files changed, 19 insertions, 20 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 00000000..a92de7f5 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,19 @@ +if BUILD_MAN +man_MANS = nft.8 +endif + +if BUILD_PDF +pdf_DATA = nft.pdf +endif + +pdfdir=${docdir}/pdf + +.xml.pdf: + ${AM_V_GEN}dblatex -q -t pdf -o $@ $< + +.xml.8: + ${AM_V_GEN}${DB2MAN} --xinclude $< + +EXTRA_DIST = nft.xml + +CLEANFILES = nft.pdf nft.8 *~ diff --git a/doc/Makefile.in b/doc/Makefile.in deleted file mode 100644 index 1ec856c9..00000000 --- a/doc/Makefile.in +++ /dev/null @@ -1,20 +0,0 @@ -mandocs-@CONFIG_MAN@ += doc/nft.8 -pdfdocs-@CONFIG_PDF@ += doc/nft.pdf - -all: $(mandocs-y) $(pdfdocs-y) -clean: - @echo -e " CLEAN\t\tdoc" - $(RM) $(mandocs-y) $(pdfdocs-y) - -install: $(mandocs-y) $(pdfdocs-y) - @echo -e " INSTALL\tdoc" - if test -n "$(mandocs-y)"; then \ - $(MKDIR_P) $(DESTDIR)/${mandir}/man8 ;\ - $(INSTALL) -m 755 -p $(mandocs-y) \ - $(DESTDIR)/${mandir}/man8/ ;\ - fi - if test -n "$(pdfdocs-y)"; then \ - $(MKDIR_P) $(DESTDIR)/${pdfdir} ;\ - $(INSTALL) -m 755 -p $(pdfdocs-y) \ - $(DESTDIR)/${pdfdir}/ ;\ - fi |