From 6a414a4087a59ad8c62cbef30984632ea31ced23 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sat, 19 Apr 2014 19:19:06 +0000 Subject: various documentation updates We have an HTML homepage, OMG! --- Documentation/include.mk | 65 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 Documentation/include.mk (limited to 'Documentation/include.mk') diff --git a/Documentation/include.mk b/Documentation/include.mk new file mode 100644 index 00000000..776413e6 --- /dev/null +++ b/Documentation/include.mk @@ -0,0 +1,65 @@ +# Copyright (C) 2013, Eric Wong and all contributors +# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) +all:: + +RSYNC = rsync +RSYNC_DEST = public-inbox.org:/srv/public-inbox/ +docs := README COPYING INSTALL $(shell git ls-files 'Documentation/*.txt') +INSTALL = install +PANDOC = pandoc +PANDOC_OPTS = -f markdown --email-obfuscation=none +pandoc = $(PANDOC) $(PANDOC_OPTS) + +m1 = +m1 += public-inbox-mda +m5 = +m7 = + +man1 := $(addsuffix .1, $(m1)) +man5 := $(addsuffix .5, $(m5)) +man7 := $(addsuffix .7, $(m7)) + +all:: man html + +man: $(man1) $(man5) $(man7) + +prefix ?= $(HOME) +mandir ?= $(prefix)/share/man +man1dir = $(mandir)/man1 +man5dir = $(mandir)/man5 +man7dir = $(mandir)/man7 + +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 + +INSTALL.html: INSTALL + $(txt2pre) +index.html: README + $(txt2pre) + +docs_html := index.html INSTALL.html +html: $(docs_html) +gz_docs := $(addsuffix .gz, $(docs) $(docs_html)) +rsync_docs := $(gz_docs) $(docs) $(txt) $(docs_html) +%.gz: % + gzip -9 --rsyncable < $< > $@+ + touch -r $< $@+ + mv $@+ $@ + +gz-doc: $(gz_docs) +rsync-doc: + git set-file-times $(docs) $(txt) + $(MAKE) gz-doc + $(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(RSYNC_DEST) +clean-doc: + $(RM) $(man1) $(man5) $(man7) $(gz_docs) $(docs_html) -- cgit v1.2.3-24-ge0c7