user/dev discussion of public-inbox itself
 help / color / Atom feed
b064f29520a5e3064762469ded5aa2155af5f7e7 blob 4248 bytes (raw)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# Copyright (C) 2013-2019 all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
all::

# Note: some GNU-isms present and required to build docs
# (including manpages), but at least this should not trigger
# warnings with BSD make(1) when running "make check"
# Maybe it's not worth it to support non-GNU make, though...
RSYNC = rsync
RSYNC_DEST = public-inbox.org:/srv/public-inbox/
MAN = man

# same as pod2text
COLUMNS = 76

txt := INSTALL README COPYING TODO HACKING
dtxt := design_notes.txt design_www.txt dc-dlvr-spam-flow.txt hosted.txt
dtxt += marketing.txt
dtxt += standards.txt
dtxt := $(addprefix Documentation/, $(dtxt))
docs := $(txt) $(dtxt)

INSTALL = install
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-compact
m1 += public-inbox-httpd
m1 += public-inbox-index
m1 += public-inbox-mda
m1 += public-inbox-nntpd
m1 += public-inbox-watch
m1 += public-inbox-xcpdb
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) $(man8)

prefix ?= $(PREFIX)
prefix ?= $(HOME)
mandir ?= $(prefix)/share/man
man1dir = $(mandir)/man1
man5dir = $(mandir)/man5
man7dir = $(mandir)/man7
man8dir = $(mandir)/man8

install-man: man
	$(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)
dtxt += $(mantxt)

all :: $(mantxt)

Documentation/%.txt : Documentation/%.pod
	$(podtext) $< $@+ && touch -r $< $@+ && mv $@+ $@

txt2pre = $(PERL) -I lib ./Documentation/txt2pre <$< >$@+ && \
	touch -r $< $@+ && mv $@+ $@

Documentation/standards.txt : Documentation/standards.perl
	$(PERL) $< >$@+ && touch -r $< $@+ && mv $@+ $@

Documentation/%.html: Documentation/%.txt
	$(txt2pre)

%.html: %
	$(txt2pre)

docs_html := $(addsuffix .html, $(subst .txt,,$(dtxt)) $(txt))
html: $(docs_html)
gz_docs := $(addsuffix .gz, $(docs) $(docs_html))
rsync_docs := $(gz_docs) $(docs) $(docs_html)

# external manpages which we host ourselves, since some packages
# (currently just Xapian) doesn't host manpages themselves.
xtxt :=
xtxt += .copydatabase.1
xtxt += .xapian-compact.1
xtxt := $(addprefix Documentation/.x/, $(addsuffix .txt, $(xtxt)))
xdocs := $(xtxt)
xdocs_html := $(addsuffix .html, $(subst .txt,,$(xtxt)))
gz_xdocs := $(addsuffix .gz, $(xdocs) $(xdocs_html))
rsync_xdocs := $(gz_xdocs) $(xdocs_html) $(xdocs)
xdoc: $(xdocs) $(xdocs_html)

Documentation/.x/%.txt::
	@-mkdir -p $(@D)
	$(PERL) -w Documentation/extman.perl $@ >$@+
	mv $@+ $@

Documentation/.x/%.html: Documentation/.x/%.txt
	$(txt2pre)

doc: $(docs)

%.gz: %
	gzip -9 --rsyncable <$< >$@+
	touch -r $< $@+
	mv $@+ $@

gz-doc: $(gz_docs)

gz-xdoc: $(gz_xdocs)

rsync-doc:
	# /usr/share/doc/rsync/scripts/git-set-file-times{.gz} on Debian systems
	# It is also at: https://yhbt.net/git-set-file-times
	-git set-file-times $(docs) $(txt)
	$(MAKE) gz-doc gz-xdoc
	$(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(rsync_xdocs) $(RSYNC_DEST)

clean-doc:
	$(RM) $(man1) $(man5) $(man7) $(gz_docs) $(docs_html) $(mantxt)
	$(RM) $(gz_xdocs) $(xdocs_html) $(xdocs)

clean :: clean-doc

pure_all ::
	@if test x"$(addprefix g, make)" != xgmake; then \
	echo W: gmake is currently required to build manpages; fi
debug log:

solving b064f29 ...
found b064f29 in https://80x24.org/public-inbox.git

user/dev discussion of public-inbox itself

Archives are clonable:
	git clone --mirror http://public-inbox.org/meta
	git clone --mirror http://czquwvybam4bgbro.onion/meta
	git clone --mirror http://hjrcffqmbrq6wope.onion/meta
	git clone --mirror http://ou63pmih66umazou.onion/meta

Example config snippet for mirrors

Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
	nntp://ou63pmih66umazou.onion/inbox.comp.mail.public-inbox.meta
	nntp://czquwvybam4bgbro.onion/inbox.comp.mail.public-inbox.meta
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
	nntp://news.gmane.org/gmane.mail.public-inbox.general

 note: .onion URLs require Tor: https://www.torproject.org/

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git