b4a2830b57db9b8f406773303e096e8ab4e6bf55
[pve-docs.git] / Makefile
1 RELEASE=4.1
2
3 PVESM_SOURCES=attributes.txt pvesm.adoc pvesm.1-synopsis.adoc $(shell ls pve-storage-*.adoc)
4 PVEUM_SOURCES=attributes.txt pveum.adoc pveum.1-synopsis.adoc
5 VZDUMP_SOURCES=attributes.txt vzdump.adoc vzdump.1-synopsis.adoc
6 PVEFW_SOURCES=attributes.txt pve-firewall.adoc pve-firewall-rules-opts.adoc pve-firewall-cluster-opts.adoc pve-firewall-host-opts.adoc pve-firewall-vm-opts.adoc pve-firewall-macros.adoc pve-firewall.8-synopsis.adoc
7 QM_SOURCES=attributes.txt qm.adoc qm.1-synopsis.adoc
8 PCT_SOURCES=attributes.txt pct.adoc pct.1-synopsis.adoc
9 PVEAM_SOURCES=attributes.txt pveam.adoc pveam.1-synopsis.adoc
10 HA_SOURCES=attributes.txt ha-manager.1-synopsis.adoc ha-manager.adoc
11
12 SYSADMIN_SOURCES= \
13 getting-help.adoc \
14 pve-package-repos.adoc \
15 pve-installation.adoc \
16 system-software-updates.adoc \
17 sysadmin.adoc
18
19 PVE_ADMIN_GUIDE_SOURCES= \
20 datacenter.cfg.adoc \
21 datacenter.cfg.5-opts.adoc \
22 vm.conf.adoc \
23 vm.conf.5-opts.adoc \
24 pct.conf.adoc \
25 pct.conf.5-opts.adoc \
26 ${SYSADMIN_SOURCES} \
27 pve-admin-guide.adoc \
28 pve-intro.adoc \
29 pmxcfs.adoc \
30 pve-faq.adoc \
31 ${QM_SOURCES} \
32 ${PCT_SOURCES} \
33 ${PVEAM_SOURCES} \
34 ${PVEFW_SOURCES} \
35 ${PVEUM_SOURCES} \
36 ${PVESM_SOURCES} \
37 ${VZDUMP_SOURCES} \
38 ${HA_SOURCES} \
39 images/cluster-nwdiag.svg \
40 images/node-nwdiag.svg \
41 pve-bibliography.adoc \
42 GFDL.adoc \
43 attributes.txt
44
45 ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)"
46 ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG} -a "revnumber=${RELEASE}"
47 ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG} -a "revnumber=${RELEASE}"
48 ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG} -a "revnumber=${RELEASE}"
49
50 BROWSER?=xdg-open
51
52 all: pve-admin-guide.html
53
54 %-nwdiag.svg: %.nwdiag
55 nwdiag -T svg $*.nwdiag -o $@;
56
57 %.1-synopsis.adoc:
58 perl -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
59 mv $@.tmp $@
60
61 %.1: %.adoc %.1-synopsis.adoc docinfo.xml
62 a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${RELEASE}" -f manpage $*.adoc
63 test -z "$${NOVIEW}" && man -l $@
64
65 %.1.html: %.adoc %.1-synopsis.adoc docinfo.xml
66 asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
67 test -z "$${NOVIEW}" && $(BROWSER) $@ &
68
69
70 %.8-synopsis.adoc:
71 perl -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
72 mv $@.tmp $@
73
74 %.8: %.adoc %.8-synopsis.adoc docinfo.xml
75 a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${RELEASE}" -f manpage $*.adoc
76 test -z "$${NOVIEW}" && man -l $@
77
78 %.8.html: %.adoc %.8-synopsis.adoc docinfo.xml
79 asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc
80 test -z "$${NOVIEW}" && $(BROWSER) $@ &
81
82 pve-firewall-cluster-opts.adoc:
83 ./gen-pve-firewall-cluster-opts.pl >$@.tmp
84 mv $@.tmp $@
85
86 pve-firewall-host-opts.adoc:
87 ./gen-pve-firewall-host-opts.pl >$@.tmp
88 mv $@.tmp $@
89
90 pve-firewall-vm-opts.adoc:
91 ./gen-pve-firewall-vm-opts.pl >$@.tmp
92 mv $@.tmp $@
93
94 pve-firewall-rules-opts.adoc:
95 ./gen-pve-firewall-rules-opts-adoc.pl >$@.tmp
96 mv $@.tmp $@
97
98 pve-firewall-macros.adoc:
99 ./gen-pve-firewall-macros-adoc.pl >$@.tmp
100 mv $@.tmp $@
101
102 datacenter.cfg.5-opts.adoc:
103 ./gen-datacenter-cfg-opts-adoc.pl >$@.tmp
104 mv $@.tmp $@
105
106 vm.conf.5-opts.adoc:
107 ./gen-vm-conf-opts-adoc.pl >$@.tmp
108 mv $@.tmp $@
109
110 pct.conf.5-opts.adoc:
111 ./gen-pct-conf-opts-adoc.pl >$@.tmp
112 mv $@.tmp $@
113
114 %.5: %.adoc %.5-opts.adoc docinfo.xml
115 a2x -a docinfo1 -a "manvolnum=5" -a "manversion=Release ${RELEASE}" -f manpage $*.adoc
116 test -z "$${NOVIEW}" && man -l $@
117
118 %.5.html: %.adoc %.5-opts.adoc docinfo.xml
119 asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
120 test -z "$${NOVIEW}" && $(BROWSER) $@ &
121
122 index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES}
123 $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
124 $(MAKE) NOVIEW=1 qm.1.html pct.1.html pveam.1.html pvesm.1.html pveum.1.html vzdump.1.html pve-firewall.8.html ha-manager.1.html datacenter.cfg.5.html vm.conf.5.html pct.conf.5.html
125 asciidoc -a "date=$(shell date)" -a "revnumber=${RELEASE}" index.adoc
126 $(BROWSER) index.html &
127
128 pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
129 asciidoc -a "revnumber=${RELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
130 test -z "$${NOVIEW}" && $(BROWSER) $@ &
131
132 pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
133 grep ">Release ${RELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false);
134 a2x -a docinfo -a docinfo1 -f pdf -L --dblatex-opts "-P latex.output.revhistory=0" --dblatex-opts "-P latex.class.options=12pt" pve-admin-guide.adoc
135 test -z "$${NOVIEW}" && $(BROWSER) $@ &
136
137 pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
138 a2x -f epub pve-admin-guide.adoc
139 test -z "$${NOVIEW}" && $(BROWSER) $@ &
140
141 update: clean
142 rm -f *.5-opts.adoc .1-synopsis.adoc .8-synopsis.adoc
143 make all
144
145 clean:
146 rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8