X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Finclude.mk;h=28fa7574ed9d6d2c4f6ad0a528fa55caf01662c2;hb=cf35d38e7f845393659dfce0249a76d529a2c92c;hp=396a2585527188777417d08d8324dd9e0d7f3fdc;hpb=120b17a46f06e143d4a59825cdd5db72e852cff2;p=public-inbox.git
diff --git a/Documentation/include.mk b/Documentation/include.mk
index 396a2585..28fa7574 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -1,5 +1,5 @@
-# Copyright (C) 2013-2015 all contributors
-# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
+# Copyright (C) 2013-2019 all contributors
+# License: AGPL-3.0+
all::
RSYNC = rsync
@@ -7,58 +7,84 @@ RSYNC_DEST = public-inbox.org:/srv/public-inbox/
docs := README COPYING INSTALL TODO HACKING
docs += $(shell git ls-files 'Documentation/*.txt')
INSTALL = install
-POD2MAN ?= pod2man
-POD2MAN_OPTS = -v --stderr -d 1994-10-02 -c 'public-inbox user manual'
-pod2man = $(POD2MAN) $(POD2MAN_OPTS)
-POD2TEXT = pod2text
-POD2TEXT_OPTS = --stderr
-pod2text = $(POD2TEXT) $(POD2TEXT_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
+m5 += public-inbox-v1-format
+m5 += public-inbox-v2-format
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 : Documentation/%.pod
- $(pod2man) -s 1 $< $@+ && mv $@+ $@
-
-mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(m1)))
+ $(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
- $(pod2text) $< $@+ && mv $@+ $@
+ $(podtext) $< $@+ && mv $@+ $@
-txt2pre = ./Documentation/txt2pre < $< > $@+ && touch -r $< $@+ && 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
+dtxt := design_notes.txt design_www.txt dc-dlvr-spam-flow.txt hosted.txt
dtxt := $(addprefix Documentation/, $(dtxt)) $(mantxt)
%.html: %.txt
- $(txt2pre)
+ TITLE="$(basename $( $@+
+ gzip -9 --rsyncable <$< >$@+
touch -r $< $@+
mv $@+ $@