public-inbox 1.1.0-pre1

[public-inbox.git] / Documentation / include.mk

diff --git a/Documentation/include.mk b/Documentation/include.mk
index 55bfc97a784e0ae83ce705275ee02f3edcccfb94..ad7b80a6edfc00427a0fac2d47708a8d80c435c6 100644 (file)
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -1,58 +1,97 @@
-# Copyright (C) 2013-2015 all contributors <meta@public-inbox.org>
-# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
+# Copyright (C) 2013-2018 all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 all::
 
 RSYNC = rsync
 RSYNC_DEST = public-inbox.org:/srv/public-inbox/
-docs := README COPYING INSTALL TODO $(shell git ls-files 'Documentation/*.txt')
+docs := README COPYING INSTALL TODO HACKING
+docs += $(shell git ls-files 'Documentation/*.txt')
 INSTALL = install
-PANDOC = pandoc
-PANDOC_OPTS = -f markdown --email-obfuscation=none
-pandoc = $(PANDOC) $(PANDOC_OPTS)
+PODMAN = pod2man
+PODMAN_OPTS = -v --stderr -d 1993-10-02 -c 'public-inbox user manual'
+PODMAN_OPTS += -r public-inbox.git
+podman = $(PODMAN) $(PODMAN_OPTS)
+PODTEXT = pod2text
+PODTEXT_OPTS = --stderr
+podtext = $(PODTEXT) $(PODTEXT_OPTS)
 
+# MakeMaker only seems to support manpage sections 1 and 3...
 m1 =
 m1 += public-inbox-mda
+m1 += public-inbox-httpd
+m1 += public-inbox-nntpd
+m1 += public-inbox-watch
+m1 += public-inbox-index
 m5 =
+m5 += public-inbox-config
 m7 =
+m7 += public-inbox-overview
+m8 =
+m8 += public-inbox-daemon
 
 man1 := $(addsuffix .1, $(m1))
 man5 := $(addsuffix .5, $(m5))
 man7 := $(addsuffix .7, $(m7))
+man8 := $(addsuffix .8, $(m8))
 
 all:: man html
 
-man: $(man1) $(man5) $(man7)
+man: $(man1) $(man5) $(man7) $(man8)
 
+prefix ?= $(PREFIX)
 prefix ?= $(HOME)
 mandir ?= $(prefix)/share/man
 man1dir = $(mandir)/man1
 man5dir = $(mandir)/man5
 man7dir = $(mandir)/man7
+man8dir = $(mandir)/man8
 
 install-man: man
-       test -z "$(man1)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
-       test -z "$(man5)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
-       test -z "$(man7)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
-       test -z "$(man1)" || $(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir)
-       test -z "$(man5)" || $(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
-       test -z "$(man7)" || $(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
-%.1 %.5 %.7 : Documentation/%.txt
-       $(pandoc) -s -t man < $< > $@+ && mv $@+ $@
-
-txt2pre = ./Documentation/txt2pre < $< > $@+ && touch -r $< $@+ && mv $@+ $@
-txt := INSTALL README COPYING
-dtxt :=  design_notes.txt design_www.txt dc-dlvr-spam-flow.txt
-txt += $(addprefix Documentation/, $(dtxt))
+       $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
+       $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
+       $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
+       $(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
+       $(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir)
+       $(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
+       $(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
+       $(INSTALL) -m 644 $(man8) $(DESTDIR)$(man8dir)
 
+doc_install :: install-man
+
+%.1 %.5 %.7 %.8 : Documentation/%.pod
+       $(podman) -s $(subst .,,$(suffix $@)) $< $@+ && mv $@+ $@
+
+manuals :=
+manuals += $(m1)
+manuals += $(m5)
+manuals += $(m7)
+manuals += $(m8)
+
+mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(manuals)))
+docs += $(mantxt)
+
+all :: $(mantxt)
+
+Documentation/%.txt : Documentation/%.pod
+       $(podtext) $< $@+ && mv $@+ $@
+
+txt2pre = $(PERL) -I lib ./Documentation/txt2pre <$< >$@+ && \
+       touch -r $< $@+ && mv $@+ $@
+txt := INSTALL README COPYING TODO
+dtxt := design_notes.txt design_www.txt dc-dlvr-spam-flow.txt hosted.txt
+dtxt := $(addprefix Documentation/, $(dtxt)) $(mantxt)
+
+%.html: %.txt
+       TITLE="$(basename $(<F))" $(txt2pre)
 %.html: %
        $(txt2pre)
 
-docs_html := $(addsuffix .html, $(txt))
+docs_html := $(addsuffix .html, $(subst .txt,,$(dtxt)) $(txt))
 html: $(docs_html)
 gz_docs := $(addsuffix .gz, $(docs) $(docs_html))
 rsync_docs := $(gz_docs) $(docs) $(txt) $(docs_html)
 %.gz: %
-       gzip -9 --rsyncable < $< > $@+
+       gzip -9 --rsyncable <$< >$@+
        touch -r $< $@+
        mv $@+ $@
 
@@ -62,4 +101,6 @@ rsync-doc:
        $(MAKE) gz-doc
        $(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(RSYNC_DEST)
 clean-doc:
-       $(RM) $(man1) $(man5) $(man7) $(gz_docs) $(docs_html)
+       $(RM) $(man1) $(man5) $(man7) $(gz_docs) $(docs_html) $(mantxt)
+
+clean :: clean-doc