]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/include.mk
truncate Message-IDs and References consistently
[public-inbox.git] / Documentation / include.mk
1 # Copyright (C) 2013-2018 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
3 all::
4
5 RSYNC = rsync
6 RSYNC_DEST = public-inbox.org:/srv/public-inbox/
7 docs := README COPYING INSTALL TODO HACKING
8 docs += $(shell git ls-files 'Documentation/*.txt')
9 INSTALL = install
10 PODMAN = pod2man
11 PODMAN_OPTS = -v --stderr -d 1993-10-02 -c 'public-inbox user manual'
12 PODMAN_OPTS += -r public-inbox.git
13 podman = $(PODMAN) $(PODMAN_OPTS)
14 PODTEXT = pod2text
15 PODTEXT_OPTS = --stderr
16 podtext = $(PODTEXT) $(PODTEXT_OPTS)
17
18 # MakeMaker only seems to support manpage sections 1 and 3...
19 m1 =
20 m1 += public-inbox-mda
21 m1 += public-inbox-httpd
22 m1 += public-inbox-nntpd
23 m1 += public-inbox-watch
24 m1 += public-inbox-index
25 m5 =
26 m5 += public-inbox-config
27 m7 =
28 m7 += public-inbox-overview
29 m8 =
30 m8 += public-inbox-daemon
31
32 man1 := $(addsuffix .1, $(m1))
33 man5 := $(addsuffix .5, $(m5))
34 man7 := $(addsuffix .7, $(m7))
35 man8 := $(addsuffix .8, $(m8))
36
37 all:: man html
38
39 man: $(man1) $(man5) $(man7) $(man8)
40
41 prefix ?= $(PREFIX)
42 prefix ?= $(HOME)
43 mandir ?= $(prefix)/share/man
44 man1dir = $(mandir)/man1
45 man5dir = $(mandir)/man5
46 man7dir = $(mandir)/man7
47 man8dir = $(mandir)/man8
48
49 install-man: man
50         $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
51         $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
52         $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
53         $(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
54         $(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir)
55         $(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
56         $(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
57         $(INSTALL) -m 644 $(man8) $(DESTDIR)$(man8dir)
58
59 doc_install :: install-man
60
61 %.1 %.5 %.7 %.8 : Documentation/%.pod
62         $(podman) -s $(subst .,,$(suffix $@)) $< $@+ && mv $@+ $@
63
64 manuals :=
65 manuals += $(m1)
66 manuals += $(m5)
67 manuals += $(m7)
68 manuals += $(m8)
69
70 mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(manuals)))
71 docs += $(mantxt)
72
73 all :: $(mantxt)
74
75 Documentation/%.txt : Documentation/%.pod
76         $(podtext) $< $@+ && mv $@+ $@
77
78 txt2pre = $(PERL) -I lib ./Documentation/txt2pre <$< >$@+ && \
79         touch -r $< $@+ && mv $@+ $@
80 txt := INSTALL README COPYING TODO
81 dtxt := design_notes.txt design_www.txt dc-dlvr-spam-flow.txt hosted.txt
82 dtxt := $(addprefix Documentation/, $(dtxt)) $(mantxt)
83
84 %.html: %.txt
85         TITLE="$(basename $(<F))" $(txt2pre)
86 %.html: %
87         $(txt2pre)
88
89 docs_html := $(addsuffix .html, $(subst .txt,,$(dtxt)) $(txt))
90 html: $(docs_html)
91 gz_docs := $(addsuffix .gz, $(docs) $(docs_html))
92 rsync_docs := $(gz_docs) $(docs) $(txt) $(docs_html)
93 %.gz: %
94         gzip -9 --rsyncable <$< >$@+
95         touch -r $< $@+
96         mv $@+ $@
97
98 gz-doc: $(gz_docs)
99 rsync-doc:
100         git set-file-times $(docs) $(txt)
101         $(MAKE) gz-doc
102         $(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(RSYNC_DEST)
103 clean-doc:
104         $(RM) $(man1) $(man5) $(man7) $(gz_docs) $(docs_html) $(mantxt)
105
106 clean :: clean-doc