summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/typog/Makefile
blob: bb3c83ab24b2e5e8644ac1ae3b48d17449fed20c (plain)
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
###  name:      	Makefile
###  synopsis:  	Build `typog' style file, tools, and documentation
###  author:    	Dr. Christoph L. Spiel
###  GNU make version:  4.3


SHELL := /bin/sh


LATEX := /usr/bin/env max_print_line=2147483647 pdflatex
LATEX_FLAGS := -file-line-error -halt-on-error -interaction=nonstopmode
LATEX_RERUN_TRIGGER := '^Package rerunfilecheck Warning: File [^ ]* has changed'
LATEX_WARNING := '^LaTeX (|[A-Za-z0-9_]* )Warning:'

MAKEINDEX := makeindex
MAKEINDEX_FLAGS := -q


METAPOST := mpost
METAPOST_FLAGS := -file-line-error -interaction=nonstopmode -tex=latex


PODCHECKER := podchecker
PODCHECKER_FLAGS := -warnings


POD2MAN := pod2man
POD2MAN_FLAGS := $$(sed -ne 's,\\ProvidesPackage{typog}\[\([0-9][0-9]*/[0-9][0-9]*/[0-9][0-9]*\) *v\([^ ]*\) .*$$,--date=\1 --release=\2,p' < typog.sty)


POD2TEXI := pod2texi
POD2TEXI_FLAGS :=


GROFF := groff
##  Codes of serif fonts that work for PDF output
##  	BM: URW Bookman L
##  	N:  URW Century Schoolbook L
##  	P:  URW Palladio L
##  	T:  URW Nimbus Roman No9 L
GROFF_FLAGS := -Tpdf -dpaper=a4 -fP -man -wall


SPELLCHECK := aspell
SPELLCHECK_FLAGS :=  \
    --add-tex-command='citenum p'  --add-tex-command='code p'  \
    --add-tex-command='Cref p' --add-tex-command='cref p'  \
    --add-tex-command='cs p'  \
    --add-tex-command='DescribeEnv p' --add-tex-command='DescribeMacro p'  \
    --add-tex-command='marg p' --add-tex-command='meta p'  \
    --add-tex-command='oarg p'  \
    --lang=en_US --mode=tex


SOURCE_FILES := LICENSE Makefile typog.dtx typog.ins



.PHONY: all
all: sty pdf man


.PHONY: sty
sty: typog.sty


.PHONY: pdf
pdf: doc ex nomt


.PHONY: doc
doc: typog.pdf


.PHONY: ex
ex: typog-example.pdf


.PHONY: nomt
nomt: typog-nomt.pdf


.PHONY: man
man: typog-grep.1


.PHONY: cpio
cpio:
	cd ..;  \
            echo $(addprefix typog/,$(SOURCE_FILES))  |  \
            cpio -o  |  \
            gzip  > "typog-$$(date +%Y-%m-%d).cpio.gz"


.PHONY: tar
tar:
	cd ..;  \
            tar czf "typog-$$(date +%Y-%m-%d).tar.gz" $(addprefix typog/,$(SOURCE_FILES))


.PHONY: clean
clean:
	$(RM) ./*.1 ./*.aux ./*.brf ./*.glg ./*.glo ./*.gls
	$(RM) ./*.hd ./*.idx ./*.ilg ./*.ind ./*.loe ./*.lof ./*.log ./*.lot
	$(RM) ./*.mps ./*.mpx ./*.out ./*.pdf ./*.toc
	$(RM) mptextmp.* mpxerr.tex
	$(RM) README README.html RELEASE-HOWTO RELEASE-HOWTO.html


.PHONY: mostlyclean
mostlyclean: clean


.PHONY: maintainer-clean
maintainer-clean: mostlyclean
	$(RM) ./*.ist ./*.mp ./*.pl ./*.pod ./*.sed ./*.sty ./*.tex


.PHONY: tool-check
tool-check:
	@printf '***  LATEX = "%s"\n' '$(LATEX)'
	$(LATEX) --version
	@printf '\n\n***  MAKEINDEX = "%s"\n' '$(MAKEINDEX)'
	$(MAKEINDEX) < /dev/null
	@printf '\n\n***  METAPOST = "%s"\n' '$(METAPOST)'
	$(METAPOST) --version
	@printf '\n***  POD2MAN = "%s"\n' '$(POD2MAN)'
	$(POD2MAN) --help > /dev/null
	@printf '\n\n***  POD2TEXI = "%s"\n' '$(POD2TEXI)'
	$(POD2TEXI) --version
	@printf '\n\nTool check passed.\n'


.PHONY: spell-check
spell-check:
	@sed -e '\#<DISABLE-SPELL-CHECK/>#d'  \
             -e '\#<DISABLE-SPELL-CHECK>#,\#</DISABLE-SPELL-CHECK>#d'  < typog.dtx  |  \
	    sed -e 's/^ *%%*//'  |  \
	    sed -e 's/\\-//g' -e 's/|[^|]*|/ /g'  |  \
	    $(SPELLCHECK) $(SPELLCHECK_FLAGS) list  |  \
	    sort  |  uniq  |  fmt  |  sed -e 's/ /  /g'


.PHONY: update-docs
update-docs: doc ex typog-grep.1.pdf
	cp -f typog.pdf typog-example.pdf typog-grep.1 typog-grep.1.pdf docs


define HELP_SCREEN
Selected Phony Targets
----------------------
all:    Make everything there is to make.  This is the .DEFAULT_GOAL.

clean:  Remove some products.

cpio:   In the parent directory create a cpio(1) archive of the
        project source files whose name is time-stamped.

doc:    Build "typog.pdf" the Typog documentation.

ex:     Build "typog-example.pdf" an example and test file for Typog.

maintainer-clean: Remove every product file that can be rebuilt even
        if uncommon tools are necessary.

mostlyclean: Remove some more products than clean:.

pdf:    Build doc: and gauge:.

sty:    Only extract "typog.sty" from "typog.dtx".  This
        operation requires LaTeX (-> $(LATEX)) and nothing else.

tar:    In the parent directory create a tar(1) file of the project
        source files whose name is time-stamped.

tool-check: Check whether some of the required tools to build the
        project are available.


Selected Implicit Rules
-----------------------
%.pdf: %.dtx
        Run LaTeX or pdfLaTeX (-> $(LATEX)) on dtx source until a
        fix-point is reached.

%.pdf: %.tex
        Run LaTeX or pdfLaTeX (-> $(LATEX)) on tex file until a
        fix-point is reached.

%.1: %.pod
        Create a manual page from plain old documentation format.
        Requires podchecker (-> $(PODCHECKER)) and pod2man
        (-> $(POD2MAN)).

%.1.pdf: %.1
        Convert a manual page into a pdf file.  Requires groff
        (-> $(GROFF)).


Some Explicit Rules
-------------------
README.html:
        Convert "README.md" to html.  Requires markdown(1).

README: Convert "README.html" to plain text.  Requires w3m(1).

endef

.PHONY: help
help:
	$(info $(HELP_SCREEN))



.PRECIOUS: %.mps



define MAKE_INDEX_AND_GLOSSARY
sed -e '/@/d' -e 's/{\\ttfamily /{\\ttfamily\\hskip0pt\\relax /' < $*.idx  > ,$*.idx;  \
mv ,$*.idx $*.idx;  \
$(MAKEINDEX) $(MAKEINDEX_FLAGS) -s typog.ist -t $*.ilg -o $*.ind $*.idx;  \
$(MAKEINDEX) $(MAKEINDEX_FLAGS) -s gglo.ist -t $*.glg -o $*.gls $*.glo
endef

define GREP_LATEX_WARNINGS
test -e $*.log  &&  grep -E $(LATEX_WARNING) $*.log  |  uniq
endef

%.pdf: %.dtx
	$(RM) ./$*.aux ./$*.ind ./$*.idx ./$*.gls ./$*.glo ./$*.lot ./$*.toc
	$(LATEX) $(LATEX_FLAGS) -draftmode $<
	$(MAKE_INDEX_AND_GLOSSARY)
	$(LATEX) $(LATEX_FLAGS) $<
	$(MAKE_INDEX_AND_GLOSSARY)
	while test -e $*.log  &&  grep -q $(LATEX_RERUN_TRIGGER) $*.log;  \
        do  \
	    $(LATEX) $(LATEX_FLAGS) $<;  \
	    $(MAKE_INDEX_AND_GLOSSARY);  \
	done
	$(GREP_LATEX_WARNINGS)


%.pdf: %.tex
	$(RM) ./$*.aux ./$*.ind ./$*.idx ./$*.lot ./$*.toc
	$(LATEX) $(LATEX_FLAGS) -draftmode $<
	$(LATEX) $(LATEX_FLAGS) $<
	while test -e $*.log  &&  grep -q $(LATEX_RERUN_TRIGGER) $*.log;  \
        do  \
	    $(LATEX) $(LATEX_FLAGS) $<;  \
	done
	$(GREP_LATEX_WARNINGS)


%-1.mps %-2.mps %-3.mps %-4.mps: %.mp
	$(METAPOST) -s 'outputtemplate="%j-%c.mps"' $(METAPOST_FLAGS) $<


%.1: %.pod
	$(PODCHECKER) $(PODCHECKER_FLAGS) $<
	$(POD2MAN) $(POD2MAN_FLAGS) $< $@

%.1.pdf: %.1
	$(GROFF) $(GROFF_FLAGS) ./$<  > $@

%.tex: %.pod | teximan2latex.sed
	$(POD2TEXI) $(POD2TEXI_FLAGS) ./$<  |  sed -f teximan2latex.sed  > $@


%.html: %.md
	markdown $<  > $@

%: %.html
	w3m -cols 79 $<  > $@


crooked-paragraphs.mp slant-angle.mp smooth-parshapes.mp title.mp  \
teximan2latex.sed  \
typog-grep.pl typog-grep typog-grep.pod  \
typog.sty typog.ist typog-example.tex typog-nomt.tex:  \
  typog.ins typog.dtx
	$(LATEX) $(LATEX_FLAGS) $<
	chmod 755 typog-grep.pl
	ln -sf typog-grep.pl typog-grep


crooked-paragraphs-1.mps crooked-paragraphs-2.mps  \
crooked-paragraphs-3.mps crooked-paragraphs-4.mps: crooked-paragraphs.mp

smooth-parshapes-1.mps smooth-parshapes-2.mps smooth-parshapes-3.mps: smooth-parshapes.mp

slant-angle-1.mps: slant-angle.mp

title-1.mps: title.mp

typog.pdf: typog.dtx  \
           crooked-paragraphs-1.mps crooked-paragraphs-2.mps  \
           crooked-paragraphs-3.mps crooked-paragraphs-4.mps  \
           slant-angle-1.mps title-1.mps  \
           smooth-parshapes-1.mps smooth-parshapes-2.mps smooth-parshapes-3.mps  \
           typog-grep.tex  \
           | typog.sty