1 # Copyright (C) 2013-2019 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
5 # Note: some GNU-isms present and required to build docs
6 # (including manpages), but at least this should not trigger
7 # warnings with BSD make(1) when running "make check"
8 # Maybe it's not worth it to support non-GNU make, though...
10 RSYNC_DEST = public-inbox.org:/srv/public-inbox/
11 txt := INSTALL README COPYING TODO HACKING
12 dtxt := design_notes.txt design_www.txt dc-dlvr-spam-flow.txt hosted.txt
15 dtxt := $(addprefix Documentation/, $(dtxt))
16 docs := $(txt) $(dtxt)
20 PODMAN_OPTS = -v --stderr -d 1993-10-02 -c 'public-inbox user manual'
21 PODMAN_OPTS += -r public-inbox.git
22 podman = $(PODMAN) $(PODMAN_OPTS)
24 PODTEXT_OPTS = --stderr
25 podtext = $(PODTEXT) $(PODTEXT_OPTS)
27 # MakeMaker only seems to support manpage sections 1 and 3...
29 m1 += public-inbox-compact
30 m1 += public-inbox-httpd
31 m1 += public-inbox-index
32 m1 += public-inbox-mda
33 m1 += public-inbox-nntpd
34 m1 += public-inbox-watch
35 m1 += public-inbox-xcpdb
37 m5 += public-inbox-config
38 m5 += public-inbox-v1-format
39 m5 += public-inbox-v2-format
41 m7 += public-inbox-overview
43 m8 += public-inbox-daemon
45 man1 := $(addsuffix .1, $(m1))
46 man5 := $(addsuffix .5, $(m5))
47 man7 := $(addsuffix .7, $(m7))
48 man8 := $(addsuffix .8, $(m8))
52 man: $(man1) $(man5) $(man7) $(man8)
56 mandir ?= $(prefix)/share/man
57 man1dir = $(mandir)/man1
58 man5dir = $(mandir)/man5
59 man7dir = $(mandir)/man7
60 man8dir = $(mandir)/man8
63 $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
64 $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
65 $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
66 $(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
67 $(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir)
68 $(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
69 $(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
70 $(INSTALL) -m 644 $(man8) $(DESTDIR)$(man8dir)
72 doc_install :: install-man
74 %.1 %.5 %.7 %.8 : Documentation/%.pod
75 $(podman) -s $(subst .,,$(suffix $@)) $< $@+ && mv $@+ $@
83 mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(manuals)))
89 Documentation/%.txt : Documentation/%.pod
90 $(podtext) $< $@+ && mv $@+ $@
92 txt2pre = $(PERL) -I lib ./Documentation/txt2pre <$< >$@+ && \
93 touch -r $< $@+ && mv $@+ $@
95 Documentation/standards.txt : Documentation/standards.perl
96 $(PERL) $< >$@+ && mv $@+ $@
98 Documentation/%.html: Documentation/%.txt
104 docs_html := $(addsuffix .html, $(subst .txt,,$(dtxt)) $(txt))
106 gz_docs := $(addsuffix .gz, $(docs) $(docs_html))
107 rsync_docs := $(gz_docs) $(docs) $(docs_html)
112 gzip -9 --rsyncable <$< >$@+
118 git set-file-times $(docs) $(txt)
120 $(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(RSYNC_DEST)
122 $(RM) $(man1) $(man5) $(man7) $(gz_docs) $(docs_html) $(mantxt)
127 @if test x"$(addprefix g, make)" != xgmake; then \
128 echo W: gmake is currently required to build manpages; fi