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/
16 txt := INSTALL README COPYING TODO HACKING
17 dtxt := design_notes.txt design_www.txt dc-dlvr-spam-flow.txt hosted.txt
20 dtxt := $(addprefix Documentation/, $(dtxt))
21 docs := $(txt) $(dtxt)
25 PODMAN_OPTS = -v --stderr -d 1993-10-02 -c 'public-inbox user manual'
26 PODMAN_OPTS += -r public-inbox.git
27 podman = $(PODMAN) $(PODMAN_OPTS)
29 PODTEXT_OPTS = --stderr
30 podtext = $(PODTEXT) $(PODTEXT_OPTS)
32 # MakeMaker only seems to support manpage sections 1 and 3...
34 m1 += public-inbox-compact
35 m1 += public-inbox-convert
36 m1 += public-inbox-edit
37 m1 += public-inbox-httpd
38 m1 += public-inbox-index
39 m1 += public-inbox-mda
40 m1 += public-inbox-nntpd
41 m1 += public-inbox-watch
42 m1 += public-inbox-xcpdb
44 m5 += public-inbox-config
45 m5 += public-inbox-v1-format
46 m5 += public-inbox-v2-format
48 m7 += public-inbox-overview
50 m8 += public-inbox-daemon
52 man1 := $(addsuffix .1, $(m1))
53 man5 := $(addsuffix .5, $(m5))
54 man7 := $(addsuffix .7, $(m7))
55 man8 := $(addsuffix .8, $(m8))
59 man: $(man1) $(man5) $(man7) $(man8)
63 mandir ?= $(prefix)/share/man
64 man1dir = $(mandir)/man1
65 man5dir = $(mandir)/man5
66 man7dir = $(mandir)/man7
67 man8dir = $(mandir)/man8
70 $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
71 $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
72 $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
73 $(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
74 $(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir)
75 $(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
76 $(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
77 $(INSTALL) -m 644 $(man8) $(DESTDIR)$(man8dir)
79 doc_install :: install-man
81 %.1 %.5 %.7 %.8 : Documentation/%.pod
82 $(podman) -s $(subst .,,$(suffix $@)) $< $@+ && mv $@+ $@
90 mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(manuals)))
96 Documentation/%.txt : Documentation/%.pod
97 $(podtext) $< $@+ && touch -r $< $@+ && mv $@+ $@
99 txt2pre = $(PERL) -I lib ./Documentation/txt2pre <$< >$@+ && \
100 touch -r $< $@+ && mv $@+ $@
102 Documentation/standards.txt : Documentation/standards.perl
103 $(PERL) $< >$@+ && touch -r $< $@+ && mv $@+ $@
105 Documentation/%.html: Documentation/%.txt
111 docs_html := $(addsuffix .html, $(subst .txt,,$(dtxt)) $(txt))
113 gz_docs := $(addsuffix .gz, $(docs) $(docs_html))
114 rsync_docs := $(gz_docs) $(docs) $(docs_html)
116 # external manpages which we host ourselves, since some packages
117 # (currently just Xapian) doesn't host manpages themselves.
119 xtxt += .copydatabase.1
120 xtxt += .xapian-compact.1
121 xtxt := $(addprefix Documentation/.x/, $(addsuffix .txt, $(xtxt)))
123 xdocs_html := $(addsuffix .html, $(subst .txt,,$(xtxt)))
124 gz_xdocs := $(addsuffix .gz, $(xdocs) $(xdocs_html))
125 rsync_xdocs := $(gz_xdocs) $(xdocs_html) $(xdocs)
126 xdoc: $(xdocs) $(xdocs_html)
128 Documentation/.x/%.txt::
130 $(PERL) -w Documentation/extman.perl $@ >$@+
133 Documentation/.x/%.html: Documentation/.x/%.txt
139 gzip -9 --rsyncable <$< >$@+
148 # /usr/share/doc/rsync/scripts/git-set-file-times{.gz} on Debian systems
149 # It is also at: https://yhbt.net/git-set-file-times
150 -git set-file-times $(docs) $(txt)
151 $(MAKE) gz-doc gz-xdoc
152 $(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(rsync_xdocs) $(RSYNC_DEST)
155 $(RM) $(man1) $(man5) $(man7) $(man8) $(gz_docs) $(docs_html) $(mantxt)
156 $(RM) $(gz_xdocs) $(xdocs_html) $(xdocs)
161 @if test x"$(addprefix g, make)" != xgmake; then \
162 echo W: gmake is currently required to build manpages; fi