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