doc/Makefile

   1 top_builddir=..
   2 include $(top_builddir)/Makefile.config
   3
   4 SUBDIRS = man
   5
   6 # A little trick to simplify some of the rules.
   7 VPATH = $(builddir):$(srcdir):$(top_srcdir)/contrib/perl
   8
   9 docdir = $(datadir)/doc
  10
  11 # Used by install-doc
  12 HTML_DIR = $(DESTDIR)$(docdir)/$(PACKAGE)/html
  13 PDF_DIR  = $(DESTDIR)$(docdir)/$(PACKAGE)/pdf
  14 TXT_DIR  = $(DESTDIR)$(docdir)/$(PACKAGE)/txt
  15
  16 ASCIIDOC_CONF  = $(srcdir)asciidoc.conf
  17 ASCIIDOC_FLAGS += --no-conf -f $(srcdir)tools/asciidoc/asciidoc.conf \
  18                   -f $(srcdir)tools/asciidoc/$(call backend).conf \
  19                   -f $(ASCIIDOC_CONF) \
  20                   -a "builddir=$(CURDIR)/" \
  21                   -a elinks_version=$(VERSION)
  22
  23 #############################################################################
  24 # Build files
  25
  26 TXT_DOCS_NOINSTALL = \
  27  features.txt \
  28  keymap-actions.txt \
  29  keymap-defaults.txt \
  30
  31 TXT_DOCS_ASIS = \
  32  python.txt
  33
  34 HTML_DOCS-$(CONFIG_ASCIIDOC) += \
  35  elinks.1.html \
  36  elinks.conf.5.html \
  37  elinkskeys.5.html \
  38  hacking.html \
  39  manual.html
  40
  41 HTML_DOCS-$(CONFIG_XMLTO) += \
  42  manual.html-chunked
  43
  44 HTML_DOCS-$(CONFIG_POD2HTML) += \
  45  perl.html \
  46  perl-hooks.html
  47
  48 # We don't nowadays run pod2html on the po/perl/ scripts, because
  49 # "make install" does not install them and they do not have the .pl
  50 # suffix expected by the pod2html rule below.
  51
  52 MAN_DOCS-$(CONFIG_XMLTO) += \
  53  elinks.1 \
  54  elinks.conf.5 \
  55  elinkskeys.5
  56
  57 # Use jw for generating PDF, since xmlto seems to freak out.
  58 PDF_DOCS-$(CONFIG_JW) += \
  59  manual.pdf
  60
  61 API_DOCS-$(CONFIG_DOXYGEN) += \
  62  api/doxygen
  63
  64 #############################################################################
  65 ## Set the default doc rules
  66
  67 MAN_DOCS  = $(MAN_DOCS-yes)
  68 HTML_DOCS = $(HTML_DOCS-yes)
  69 PDF_DOCS  = $(PDF_DOCS-yes)
  70 API_DOCS  = $(API_DOCS-yes)
  71
  72 txt:  $(TXT_DOCS_NOINSTALL)
  73 html: txt $(HTML_DOCS)
  74 pdf:  txt $(PDF_DOCS)
  75 man:  txt $(MAN_DOCS)
  76 api:  $(API_DOCS)
  77
  78 all-docs: man html pdf
  79
  80 install-doc: all-docs update-man install
  81         @$(foreach doc,$(HTML_DOCS), \
  82                 if test -d $(doc); then \
  83                         $(MKINSTALLDIRS) $(DESTDIR)$(docdir)/$(PACKAGE)/html/$(doc); \
  84                         $(call ncmd,installdata,$(doc)/*,$(HTML_DIR)/$(doc)); \
  85                 else \
  86                         $(MKINSTALLDIRS) $(DESTDIR)$(docdir)/$(PACKAGE)/html; \
  87                         $(call ncmd,installdata,$(doc),$(HTML_DIR)); \
  88                 fi;)
  89         @$(foreach doc,$(PDF_DOCS), \
  90                 $(MKINSTALLDIRS) $(DESTDIR)$(docdir)/$(PACKAGE)/pdf; \
  91                 $(call ncmd,installdata,$(doc),$(PDF_DIR));)
  92         @$(foreach doc,$(TXT_DOCS_ASIS), \
  93                 $(MKINSTALLDIRS) $(DESTDIR)$(docdir)/$(PACKAGE)/txt; \
  94                 $(call ncmd,installdata,$(srcdir)$(doc),$(TXT_DIR));)
  95
  96 update-man: man
  97         @$(if $(MAN_DOCS), \
  98                 $(call ncmd,installdata,elinks.1,$(srcdir)man/man1/elinks.1.in); \
  99                 $(call ncmd,installdata,elinkskeys.5,$(srcdir)man/man5/); \
 100                 $(call ncmd,installdata,elinks.conf.5,$(srcdir)man/man5/))
 101
 102 clean-local:
 103         @$(RM) -r api $(TXT_DOCS_NOINSTALL) $(MAN_DOCS) $(HTML_DOCS) $(PDF_DOCS) *.tmp *.xml
 104
 105 # TODO: perl.pod should be pod2ized during make install. --pasky
 106 install-local:
 107
 108 #############################################################################
 109 # Generated asciidoc files
 110
 111 # Scripts and Dependencies
 112 HELP2XML = $(srcdir)tools/help2xml
 113 CONF2DOC = $(srcdir)tools/conf2doc
 114 KEYS2DOC = $(srcdir)tools/keys2doc
 115 ELINKS   = $(top_builddir)/src/elinks
 116 FEATURES = $(top_srcdir)/features.conf
 117 KBDBIND  = $(top_srcdir)/src/config/kbdbind.c
 118
 119 # Locale env vars to override system one to ensure commands
 120 # using elinks binary will generate texts in english
 121 LOCALES = LC_ALL=C LANGUAGE=en
 122
 123 # FIXME: Keep generated .txt files relative to the source directory and files
 124 # they are included in.
 125 quiet_cmd_help2xml = ' [$(LINK_COLOR)HELP2XML$(END_COLOR)]   $(RELPATH)$@'
 126       cmd_help2xml = $(LOCALES) $(HELP2XML) $(ELINKS) $@
 127
 128 quiet_cmd_conf2doc = ' [$(LINK_COLOR)CONF2DOC$(END_COLOR)]   $(RELPATH)$@'
 129       cmd_conf2doc = $(LOCALES) $(CONF2DOC) $(FEATURES) > $@
 130
 131 quiet_cmd_keys2doc = ' [$(LINK_COLOR)KEYS2DOC$(END_COLOR)]   $(RELPATH)$@'
 132       cmd_keys2doc = $(LOCALES) $(KEYS2DOC) $(KBDBIND) $@ > $@
 133
 134 features.txt: $(FEATURES) $(CONF2DOC)
 135         $(call cmd,conf2doc)
 136
 137 keymap-%.txt: $(KBDBIND) $(KEYS2DOC)
 138         $(call cmd,keys2doc)
 139
 140 option-%.frag.xml: $(ELINKS) $(HELP2XML)
 141         $(call cmd,help2xml)
 142
 143 option-%.frag.xhtml: $(ELINKS) $(HELP2XML)
 144         $(call cmd,help2xml)
 145
 146 #############################################################################
 147 # Build commands and macros
 148
 149       quiet_cmd_jw = '       [$(LINK_COLOR)JW$(END_COLOR)]   $(RELPATH)$@'
 150             cmd_jw = $(JW) -b $(2) $<
 151
 152    quiet_cmd_xmlto = '    [$(LINK_COLOR)XMLTO$(END_COLOR)]   $(RELPATH)$@'
 153          cmd_xmlto = $(XMLTO) -o $(call outdir) $(3) $(2) $<
 154
 155 quiet_cmd_pod2html = ' [$(LINK_COLOR)POD2HTML$(END_COLOR)]   $(RELPATH)$@'
 156       cmd_pod2html = $(POD2HTML) --outfile=$@ < $<
 157
 158 quiet_cmd_asciidoc = ' [$(LINK_COLOR)ASCIIDOC$(END_COLOR)]   $(RELPATH)$@'
 159       cmd_asciidoc = $(ASCIIDOC) $(ASCIIDOC_FLAGS) -b $(call backend) -d $(call doctype) -o $@ $<
 160
 161  quiet_cmd_doxygen = ' [$(LINK_COLOR)DOXYGEN$(END_COLOR)]   $(RELPATH)$@'
 162        cmd_doxygen = $(DOXYGEN) $(2)
 163
 164 # Based on $@ find out asciidoc doctype or backend + xmlto output dir.
 165 doctype = $(if $(findstring .1.,$@)$(findstring .5.,$@),manpage,book)
 166 backend = $(if $(findstring .xml,$@),docbook,xhtml11)
 167 outdir  = $(if $(findstring -chunked,$@),$@,.)
 168
 169 # Loosely track dependencies via asciidoc includes.
 170 asciidoc_dep = sed -n 's/[{]builddir}//g;s@include1\{0,1\}::\(.*\)\[.*@$@: $< \1@p' < $< > .deps/$(@F).asciidoc
 171
 172 -include .deps/*.asciidoc
 173
 174
 175 #############################################################################
 176 # Build recipies
 177
 178 %.html: %.txt $(ASCIIDOC_CONF)
 179         $(call cmd,asciidoc,xhtml11)
 180         @-$(call asciidoc_dep)
 181
 182 %.xml: %.txt $(ASCIIDOC_CONF)
 183         $(call cmd,asciidoc,docbook)
 184         @-$(call asciidoc_dep)
 185
 186 # asciidoc_dep above also generates these dependencies, but it runs
 187 # only after asciidoc has succeeded, which won't happen if the files
 188 # are missing.
 189 elinks.1.xml: option-command.frag.xml
 190 elinks.conf.5.xml: option-config.frag.xml
 191 elinks.1.html: option-command.frag.xhtml
 192 elinks.conf.5.html: option-config.frag.xhtml
 193
 194 %.1: %.1.xml
 195         $(call cmd,xmlto,man)
 196
 197 %.5: %.5.xml
 198         $(call cmd,xmlto,man)
 199
 200 %.html-chunked: %.xml
 201         $(call cmd,xmlto,html)
 202
 203 %.pdf: %.xml
 204         $(call cmd,jw,pdf)
 205
 206 %.html: %.pod
 207         $(call cmd,pod2html)
 208
 209 perl-%.html: %.pl
 210         $(call cmd,pod2html)
 211
 212 Doxyfile: $(srcdir)Doxyfile.in $(top_srcdir)/configure.in
 213         cd $(top_builddir) && \
 214         CONFIG_FILES="$(RELPATH)$@" CONFIG_HEADERS= $(SHELL) ./config.status
 215
 216 api/doxygen: Doxyfile $(shell find $(top_srcdir)/src/ -name '*.[ch]' -o -name options.inc -o -name 'actions-*.inc' | sort)
 217         $(call cmd,doxygen,$<)
 218
 219 include $(top_srcdir)/Makefile.lib