1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-06-19 00:05:36 +00:00
elinks/doc/Makefile

222 lines
6.4 KiB
Makefile
Raw Normal View History

2005-10-20 02:00:35 +00:00
top_builddir=..
include $(top_builddir)/Makefile.config
SUBDIRS = man
# A little trick to simplify some of the rules.
2007-07-18 12:41:16 +00:00
VPATH = $(builddir):$(srcdir):$(top_srcdir)/contrib/perl
2006-01-13 11:42:14 +00:00
docdir = $(datadir)/doc
# Used by install-doc
HTML_DIR = $(DESTDIR)$(docdir)/$(PACKAGE)/html
PDF_DIR = $(DESTDIR)$(docdir)/$(PACKAGE)/pdf
TXT_DIR = $(DESTDIR)$(docdir)/$(PACKAGE)/txt
2006-01-13 11:42:14 +00:00
ASCIIDOC_CONF = $(srcdir)asciidoc.conf
ASCIIDOC_FLAGS += --no-conf -f $(srcdir)tools/asciidoc/asciidoc.conf \
-f $(srcdir)tools/asciidoc/$(call backend).conf \
-f $(ASCIIDOC_CONF) \
-a "builddir=$(CURDIR)/" \
-a elinks_version=$(VERSION)
#############################################################################
# Build files
TXT_DOCS_NOINSTALL = \
features.txt \
keymap-actions.txt \
keymap-defaults.txt \
TXT_DOCS_ASIS = \
python.txt
2006-01-08 20:46:21 +00:00
HTML_DOCS-$(CONFIG_ASCIIDOC) += \
2006-01-08 20:57:55 +00:00
elinks.1.html \
elinks.conf.5.html \
2006-01-08 20:57:55 +00:00
elinkskeys.5.html \
hacking.html \
manual.html
2006-01-08 20:46:21 +00:00
HTML_DOCS-$(CONFIG_XMLTO) += \
2006-01-08 20:57:55 +00:00
manual.html-chunked
HTML_DOCS-$(CONFIG_POD2HTML) += \
perl.html \
2006-01-14 09:59:58 +00:00
perl-hooks.html
2007-07-18 12:41:16 +00:00
# We don't nowadays run pod2html on the po/perl/ scripts, because
# "make install" does not install them and they do not have the .pl
# suffix expected by the pod2html rule below.
2006-01-08 20:46:21 +00:00
MAN_DOCS-$(CONFIG_XMLTO) += \
elinks.1 \
elinks.conf.5 \
elinkskeys.5
2005-09-16 02:38:48 +00:00
2020-09-03 16:44:43 +00:00
# Use dblatex for generating PDF
PDF_DOCS-$(CONFIG_DBLATEX) += \
2006-01-08 20:57:55 +00:00
manual.pdf
API_DOCS-$(CONFIG_DOXYGEN) += \
api/doxygen
#############################################################################
## Set the default doc rules
MAN_DOCS = $(MAN_DOCS-yes)
HTML_DOCS = $(HTML_DOCS-yes)
PDF_DOCS = $(PDF_DOCS-yes)
API_DOCS = $(API_DOCS-yes)
txt: $(TXT_DOCS_NOINSTALL)
2007-07-18 12:41:16 +00:00
html: txt $(HTML_DOCS)
pdf: txt $(PDF_DOCS)
2006-01-12 09:29:05 +00:00
man: txt $(MAN_DOCS)
api: $(API_DOCS)
all-docs: man html pdf
install-doc: all-docs update-man install
2006-01-14 18:40:29 +00:00
@$(foreach doc,$(HTML_DOCS), \
2006-01-13 11:42:14 +00:00
if test -d $(doc); then \
$(MKINSTALLDIRS) $(DESTDIR)$(docdir)/$(PACKAGE)/html/$(doc); \
$(call ncmd,installdata,$(doc)/*,$(HTML_DIR)/$(doc)); \
else \
$(MKINSTALLDIRS) $(DESTDIR)$(docdir)/$(PACKAGE)/html; \
$(call ncmd,installdata,$(doc),$(HTML_DIR)); \
fi;)
2006-01-14 18:40:29 +00:00
@$(foreach doc,$(PDF_DOCS), \
2006-01-13 11:42:14 +00:00
$(MKINSTALLDIRS) $(DESTDIR)$(docdir)/$(PACKAGE)/pdf; \
$(call ncmd,installdata,$(doc),$(PDF_DIR));)
@$(foreach doc,$(TXT_DOCS_ASIS), \
$(MKINSTALLDIRS) $(DESTDIR)$(docdir)/$(PACKAGE)/txt; \
$(call ncmd,installdata,$(srcdir)$(doc),$(TXT_DIR));)
2006-01-13 11:42:14 +00:00
2006-01-12 09:29:05 +00:00
update-man: man
2006-01-14 18:40:29 +00:00
@$(if $(MAN_DOCS), \
$(call ncmd,installdata,elinks.1,$(srcdir)man/man1/elinks.1.in); \
$(call ncmd,installdata,elinkskeys.5,$(srcdir)man/man5/); \
$(call ncmd,installdata,elinks.conf.5,$(srcdir)man/man5/))
clean-local:
2007-07-18 12:41:16 +00:00
@$(RM) -r api $(TXT_DOCS_NOINSTALL) $(MAN_DOCS) $(HTML_DOCS) $(PDF_DOCS) *.tmp *.xml
# TODO: perl.pod should be pod2ized during make install. --pasky
install-local:
#############################################################################
# Generated asciidoc files
# Scripts and Dependencies
HELP2XML = $(srcdir)tools/help2xml
CONF2DOC = $(srcdir)tools/conf2doc
KEYS2DOC = $(srcdir)tools/keys2doc
ELINKS = $(top_builddir)/src/elinks
FEATURES = $(top_srcdir)/features.conf
KBDBIND = $(top_srcdir)/src/config/kbdbind.c
# Locale env vars to override system one to ensure commands
# using elinks binary will generate texts in english
LOCALES = LC_ALL=C LANGUAGE=en
# FIXME: Keep generated .txt files relative to the source directory and files
# they are included in.
quiet_cmd_help2xml = ' [$(LINK_COLOR)HELP2XML$(END_COLOR)] $(RELPATH)$@'
cmd_help2xml = $(LOCALES) $(HELP2XML) $(ELINKS) $@
2006-01-12 09:29:05 +00:00
quiet_cmd_conf2doc = ' [$(LINK_COLOR)CONF2DOC$(END_COLOR)] $(RELPATH)$@'
cmd_conf2doc = $(LOCALES) $(CONF2DOC) $(FEATURES) > $@
quiet_cmd_keys2doc = ' [$(LINK_COLOR)KEYS2DOC$(END_COLOR)] $(RELPATH)$@'
cmd_keys2doc = $(LOCALES) $(KEYS2DOC) $(KBDBIND) $@ > $@
features.txt: $(FEATURES) $(CONF2DOC)
$(call cmd,conf2doc)
keymap-%.txt: $(KBDBIND) $(KEYS2DOC)
$(call cmd,keys2doc)
option-%.frag.xml: $(ELINKS) $(HELP2XML)
$(call cmd,help2xml)
option-%.frag.xhtml: $(ELINKS) $(HELP2XML)
$(call cmd,help2xml)
#############################################################################
# Build commands and macros
2020-09-03 16:44:43 +00:00
quiet_cmd_dblatex = ' [$(LINK_COLOR)DBLATEX$(END_COLOR)] $(RELPATH)$@'
cmd_dblatex = $(DBLATEX) $<
quiet_cmd_xmlto = ' [$(LINK_COLOR)XMLTO$(END_COLOR)] $(RELPATH)$@'
cmd_xmlto = $(XMLTO) -o $(call outdir) $(3) $(2) $<
quiet_cmd_pod2html = ' [$(LINK_COLOR)POD2HTML$(END_COLOR)] $(RELPATH)$@'
cmd_pod2html = $(POD2HTML) --outfile=$@ < $<
quiet_cmd_asciidoc = ' [$(LINK_COLOR)ASCIIDOC$(END_COLOR)] $(RELPATH)$@'
cmd_asciidoc = $(ASCIIDOC) $(ASCIIDOC_FLAGS) -b $(call backend) -d $(call doctype) -o $@ $<
quiet_cmd_doxygen = ' [$(LINK_COLOR)DOXYGEN$(END_COLOR)] $(RELPATH)$@'
cmd_doxygen = $(DOXYGEN) $(2)
# Based on $@ find out asciidoc doctype or backend + xmlto output dir.
doctype = $(if $(findstring .1.,$@)$(findstring .5.,$@),manpage,book)
backend = $(if $(findstring .xml,$@),docbook,xhtml11)
outdir = $(if $(findstring -chunked,$@),$@,.)
# Loosely track dependencies via asciidoc includes.
asciidoc_dep = sed -n 's/[{]builddir}//g;s@include1\{0,1\}::\(.*\)\[.*@$@: $< \1@p' < $< > .deps/$(@F).asciidoc
-include .deps/*.asciidoc
#############################################################################
# Build recipies
%.html: %.txt $(ASCIIDOC_CONF)
2006-01-11 10:12:03 +00:00
$(call cmd,asciidoc,xhtml11)
2006-01-14 18:40:29 +00:00
@-$(call asciidoc_dep)
2019-01-25 21:20:14 +00:00
manual.xml: txt
%.xml: %.txt $(ASCIIDOC_CONF)
2006-01-11 10:12:03 +00:00
$(call cmd,asciidoc,docbook)
2006-01-14 18:40:29 +00:00
@-$(call asciidoc_dep)
# asciidoc_dep above also generates these dependencies, but it runs
# only after asciidoc has succeeded, which won't happen if the files
# are missing.
elinks.1.xml: option-command.frag.xml
elinks.conf.5.xml: option-config.frag.xml
elinks.1.html: option-command.frag.xhtml
elinks.conf.5.html: option-config.frag.xhtml
%.1: %.1.xml
2006-01-11 10:12:03 +00:00
$(call cmd,xmlto,man)
%.5: %.5.xml
2006-01-11 10:12:03 +00:00
$(call cmd,xmlto,man)
%.html-chunked: %.xml
$(call cmd,xmlto,html)
2005-09-16 02:38:48 +00:00
%.pdf: %.xml
2020-09-03 16:44:43 +00:00
$(call cmd,dblatex)
%.html: %.pod
2006-01-11 10:12:03 +00:00
$(call cmd,pod2html)
perl-%.html: %.pl
2006-01-11 10:12:03 +00:00
$(call cmd,pod2html)
Doxyfile: $(srcdir)Doxyfile.in $(top_srcdir)/configure.ac
cd $(top_builddir) && \
CONFIG_FILES="$(RELPATH)$@" CONFIG_HEADERS= $(SHELL) ./config.status
api/doxygen: Doxyfile $(shell find $(top_srcdir)/src/ -name '*.[ch]' -o -name options.inc -o -name 'actions-*.inc' | sort)
$(call cmd,doxygen,$<)
include $(top_srcdir)/Makefile.lib