projects / pmg-docs.git / blame
| Commit | Line | Data |
|---|---|---|
| 410dc2c9 DM |
1 | # also update debian/changelog |
| 2 | DOCRELEASE=5.0 | |
| 3 | ||
| 4 | DGDIR?=/usr/share/pmg-doc-generator | |
| 5 | ||
| 6 | ASCIIDOC_PMG?=/usr/bin/asciidoc-pmg | |
| 7 | ||
| 8 | PERL_DOC_ENV=PMG_GENERATING_DOCS=1 | |
| 9 | ||
| 10 | PMG_COMMON_DOC_SOURCES= \ | |
| 11 | ${ASCIIDOC_PMG} \ | |
| 12 | pmg-copyright.adoc \ | |
| 13 | docinfo.xml | |
| 14 | ||
| 15 | all: | |
| 16 | ||
| 93f5feff DM |
17 | pmgsh.1-synopsis.adoc: |
| 18 | @echo 'Interactive session:' >$@.tmp | |
| 19 | @echo '' >>$@.tmp | |
| 20 | @echo '*pmgsh*' >>$@.tmp | |
| 21 | @echo '' >>$@.tmp | |
| 22 | @echo 'Directly call API functions:' >>$@.tmp | |
| 23 | @echo '' >>$@.tmp | |
| 24 | @echo '*pmgsh* `(get|set|create|help)` `<path>` `[OPTIONS]`' >>$@.tmp | |
| 25 | mv $@.tmp $@ | |
| 26 | ||
| 43a49777 DM |
27 | pmg-smtp-filter.8-synopsis.adoc: |
| 28 | @echo 'Please use systemd tools to manage this service.' >$@.tmp | |
| 29 | @echo '' >>$@.tmp | |
| 17f66284 | 30 | @echo '*systemctl* `(start|stop|restart|reload|status)` `pmg-smtp-filter`' >>$@.tmp |
| 43a49777 DM |
31 | mv $@.tmp $@ |
| 32 | ||
| 17f66284 DM |
33 | pmgpolicy.8-synopsis.adoc: |
| 34 | @echo 'Please use systemd tools to manage this service.' >$@.tmp | |
| 35 | @echo '' >>$@.tmp | |
| 36 | @echo '*systemctl* `(start|stop|restart|reload|status)` `pmgpolicy`' >>$@.tmp | |
| 37 | mv $@.tmp $@ | |
| 43a49777 | 38 | |
| 410dc2c9 DM |
39 | docinfo.xml: |
| 40 | cp ${DGDIR}/$@ $@.tmp | |
| 41 | mv $@.tmp $@ | |
| 42 | ||
| 43 | %-opts.adoc: ${DGDIR}/gen-%-opts.pl | |
| 44 | $(PERL_DOC_ENV) perl -I. ${DGDIR}/gen-$*-opts.pl >$@.tmp | |
| 45 | mv $@.tmp $@ | |
| 46 | ||
| 47 | %.adoc: ${DGDIR}/gen-%-adoc.pl | |
| 48 | $(PERL_DOC_ENV) perl -I. ${DGDIR}/gen-$*-adoc.pl >$@.tmp | |
| 49 | mv $@.tmp $@ | |
| 50 | ||
| 51 | %.1-synopsis.adoc: | |
| 52 | $(PERL_DOC_ENV) perl -I. -e "use PMG::CLI::$(subst -,_,$*);print PMG::CLI::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp | |
| 53 | mv $@.tmp $@ | |
| 54 | ||
| 55 | %.8-synopsis.adoc: | |
| 56 | $(PERL_DOC_ENV) perl -I. -e "use PMG::Service::$(subst -,_,$*);print PMG::Service::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp | |
| 57 | mv $@.tmp $@ | |
| 58 | ||
| 59 | ifneq (${DGDIR},.) | |
| 60 | %.adoc: ${DGDIR}/%.adoc | |
| 61 | cp $< $@.tmp | |
| 62 | mv $@.tmp $@ | |
| 63 | endif | |
| 64 | ||
| 65 | ||
| 66 | %-plain.html: %.adoc ${PMG_COMMON_DOC_SOURCES} | |
| 67 | ${ASCIIDOC_PMG} compile-wiki -o $@ $*.adoc | |
| 68 | ||
| 69 | chapter-%.html: %.adoc ${PMG_COMMON_DOC_SOURCES} | |
| 70 | ${ASCIIDOC_PMG} compile-chapter -o $@ $*.adoc | |
| 71 | ||
| 72 | %.1: %.adoc %.1-synopsis.adoc ${PMG_COMMON_DOC_SOURCES} | |
| 73 | ${ASCIIDOC_PMG} compile-man -o $@ $*.adoc | |
| 74 | test -n "$${NOVIEW}" || man -l $@ | |
| 75 | ||
| 76 | %.1.html: %.adoc %.1-synopsis.adoc ${PMG_COMMON_DOC_SOURCES} | |
| 77 | ${ASCIIDOC_PMG} compile-man-html -o $@ $*.adoc | |
| 78 | ||
| 79 | %.8: %.adoc %.8-synopsis.adoc ${PMG_COMMON_DOC_SOURCES} | |
| 80 | ${ASCIIDOC_PMG} compile-man -o $@ $*.adoc | |
| 81 | test -n "$${NOVIEW}" || man -l $@ | |
| 82 | ||
| 83 | %.8.html: %.adoc %.8-synopsis.adoc ${PMG_COMMON_DOC_SOURCES} | |
| 84 | ${ASCIIDOC_PMG} compile-man-html -o $@ $*.adoc | |
| 85 | ||
| 86 | %.5: %.adoc %.5-opts.adoc ${PMG_COMMON_DOC_SOURCES} | |
| 87 | ${ASCIIDOC_PMG} compile-man -o $@ $*.adoc | |
| 88 | test -n "$${NOVIEW}" || man -l $@ | |
| 89 | ||
| 90 | %.5.html: %.adoc %.5-opts.adoc ${PMG_COMMON_DOC_SOURCES} | |
| 91 | ${ASCIIDOC_PMG} compile-man-html -o $@ $*.adoc | |
| 92 | ||
| 93 | %.5-plain.html: %.adoc %.5-opts.adoc ${PMG_COMMON_DOC_SOURCES} | |
| 94 | ${ASCIIDOC_PMG} compile-man-wiki -o $@ $*.adoc | |
| 95 | ||
| 96 | ||
| 97 | .PHONY: cleanup-docgen | |
| 98 | cleanup-docgen: | |
| 99 | rm -f *.xml.tmp *.1 *.5 *.8 *.adoc docinfo.xml | |
| 43a49777 | 100 |