add pvesubscription man page
[pve-docs.git] / pve-doc-generator.mk
CommitLineData
bef0c1b4
DM
1# also update debian/changelog
2DOCRELEASE=4.1
3
9344ee0d
DM
4DGDIR?=/usr/share/pve-doc-generator
5
6all:
7
828a27f5
DM
8PVE_COMMON_DOC_SOURCES= \
9 attributes.txt \
10 pve-copyright.adoc \
11 docinfo.xml
12
d8742b0c
DM
13PVECM_MAN1_SOURCES= \
14 pvecm.adoc \
15 pvecm.1-synopsis.adoc \
16 ${PVE_COMMON_DOC_SOURCES}
17
9344ee0d
DM
18PVE_FIREWALL_MAN8_SOURCES= \
19 pve-firewall.adoc \
20 pve-firewall.8-synopsis.adoc \
21 pve-firewall-cluster-opts.adoc \
22 pve-firewall-host-opts.adoc \
23 pve-firewall-vm-opts.adoc \
24 pve-firewall-rules-opts.adoc \
25 pve-firewall-macros.adoc \
828a27f5
DM
26 ${PVE_COMMON_DOC_SOURCES}
27
28PVESM_MAN1_SOURCES= \
29 pvesm.adoc \
30 pvesm.1-synopsis.adoc \
31 pve-storage-dir.adoc \
32 pve-storage-glusterfs.adoc \
33 pve-storage-iscsi.adoc \
34 pve-storage-iscsidirect.adoc \
35 pve-storage-lvm.adoc \
36 pve-storage-nfs.adoc \
37 pve-storage-rbd.adoc \
38 pve-storage-zfspool.adoc \
39 ${PVE_COMMON_DOC_SOURCES}
9344ee0d 40
6198e7c5
DM
41VZDUMP_MAN1_SOURCES= \
42 vzdump.adoc \
43 vzdump.1-synopsis.adoc \
44 ${PVE_COMMON_DOC_SOURCES}
45
ebd2a7fb
DM
46PVESUBSCRIPTION_MAN1_SOURCES= \
47 pvesubscription.adoc \
48 pvesubscription.1-synopsis.adoc \
49 ${PVE_COMMON_DOC_SOURCES}
50
f6b81378
DM
51PCT_MAN1_SOURCES= \
52 pct.adoc \
53 pct.1-synopsis.adoc \
54 ${PVE_COMMON_DOC_SOURCES}
55
672abac1 56PCT_CONF_MAN5_SOURCES= \
6ec3cd20
DM
57 pct.conf.adoc \
58 pct.conf.5-opts.adoc \
59 ${PVE_COMMON_DOC_SOURCES}
60
672abac1
DM
61DATACENTER_CONF_MAN5_SOURCES= \
62 datacenter.cfg.adoc \
63 datacenter.cfg.5-opts.adoc \
64 ${PVE_COMMON_DOC_SOURCES}
65
7f8858a2
DM
66QM_MAN1_SOURCES= \
67 qm.adoc \
68 qm.1-synopsis.adoc \
69 ${PVE_COMMON_DOC_SOURCES}
70
672abac1 71QM_CONF_MAN5_SOURCES= \
6ec3cd20
DM
72 qm.conf.adoc \
73 qm.conf.5-opts.adoc \
74 ${PVE_COMMON_DOC_SOURCES}
75
a5bb4c40
DM
76QMRESTORE_MAN1_SOURCES= \
77 qmrestore.adoc \
78 qmrestore.1-synopsis.adoc \
79 ${PVE_COMMON_DOC_SOURCES}
80
d7810cdb
DM
81PVEUM_MAN1_SOURCES= \
82 pveum.adoc \
83 pveum.1-synopsis.adoc \
84 ${PVE_COMMON_DOC_SOURCES}
85
6198e7c5
DM
86PVEAM_MAN1_SOURCES= \
87 pveam.adoc \
88 pveam.1-synopsis.adoc \
89 ${PVE_COMMON_DOC_SOURCES}
90
91HA_MANAGER_MAN1_SOURCES= \
92 ha-manager.adoc \
93 ha-manager.1-synopsis.adoc \
e26d2ff0
DM
94 ${PVE_COMMON_DOC_SOURCES}
95
6198e7c5
DM
96PVE_HA_CRM_MAN8_SOURCES= \
97 pve-ha-crm.adoc \
98 pve-ha-crm.8-synopsis.adoc \
47e1b0c6
DM
99 ${PVE_COMMON_DOC_SOURCES}
100
6198e7c5
DM
101PVE_HA_LRM_MAN8_SOURCES= \
102 pve-ha-lrm.adoc \
103 pve-ha-lrm.8-synopsis.adoc \
954a26fd
DM
104 ${PVE_COMMON_DOC_SOURCES}
105
4db6a3f3
DM
106PVESTATD_MAN8_SOURCES= \
107 pvestatd.adoc \
108 pvestatd.8-synopsis.adoc \
109 ${PVE_COMMON_DOC_SOURCES}
110
9ddb9dc3
DM
111PVEDAEMON_MAN8_SOURCES= \
112 pvedaemon.adoc \
113 pvedaemon.8-synopsis.adoc \
114 ${PVE_COMMON_DOC_SOURCES}
115
96f2beeb
DM
116PVEPROXY_MAN8_SOURCES= \
117 pveproxy.adoc \
118 pveproxy.8-synopsis.adoc \
119 ${PVE_COMMON_DOC_SOURCES}
120
2d8f1c92
DM
121SPICEPROXY_MAN8_SOURCES= \
122 spiceproxy.adoc \
123 spiceproxy.8-synopsis.adoc \
124 ${PVE_COMMON_DOC_SOURCES}
125
bd88f9d9
DM
126PMXCFS_MAN8_SOURCES= \
127 pmxcfs.adoc \
128 pmxcfs.8-cli.adoc \
129 ${PVE_COMMON_DOC_SOURCES}
130
9344ee0d
DM
131attributes.txt docinfo.xml:
132 cp ${DGDIR}/$@ $@.tmp
133 mv $@.tmp $@
134
135%-opts.adoc: ${DGDIR}/gen-%-opts.pl
f6b81378 136 ${DGDIR}/gen-$*-opts.pl >$@.tmp
9344ee0d
DM
137 mv $@.tmp $@
138
139%.adoc: ${DGDIR}/gen-%-adoc.pl
f6b81378 140 ${DGDIR}/gen-$*-adoc.pl >$@.tmp
9344ee0d
DM
141 mv $@.tmp $@
142
143%.1-synopsis.adoc:
144 perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
145 mv $@.tmp $@
146
147%.8-synopsis.adoc:
148 perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
149 mv $@.tmp $@
150
f6b81378 151ifneq (${DGDIR},.)
9344ee0d
DM
152%.adoc: ${DGDIR}/%.adoc
153 cp $< $@.tmp
154 mv $@.tmp $@
f6b81378 155endif
9344ee0d 156
872bbc1b
DM
157A2X_MAN_COMMON_OPTIONS=-a docinfo1 -a "manversion=Release ${DOCRELEASE}" -f manpage
158A2X_MAN1_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=1"
159A2X_MAN5_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=5"
160A2X_MAN8_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=8"
161
9344ee0d 162pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
872bbc1b 163 a2x ${A2X_MAN8_OPTIONS} pve-firewall.adoc
9344ee0d
DM
164 test -n "$${NOVIEW}" || man -l $@
165
828a27f5 166pvesm.1: ${PVESM_MAN1_SOURCES}
872bbc1b 167 a2x ${A2X_MAN1_OPTIONS} pvesm.adoc
828a27f5
DM
168 test -n "$${NOVIEW}" || man -l $@
169
f6b81378 170pct.1: ${PCT_MAN1_SOURCES}
872bbc1b 171 a2x ${A2X_MAN1_OPTIONS} pct.adoc
f6b81378
DM
172 test -n "$${NOVIEW}" || man -l $@
173
6198e7c5
DM
174vzdump.1: ${VZDUMP_MAN1_SOURCES}
175 a2x ${A2X_MAN1_OPTIONS} vzdump.adoc
176 test -n "$${NOVIEW}" || man -l $@
177
ebd2a7fb
DM
178pvesubscription.1: ${PVESUBSCRIPTION_MAN1_SOURCES}
179 a2x ${A2X_MAN1_OPTIONS} pvesubscription.adoc
180 test -n "$${NOVIEW}" || man -l $@
181
7f8858a2 182qm.1: ${QM_MAN1_SOURCES}
872bbc1b 183 a2x ${A2X_MAN1_OPTIONS} qm.adoc
7f8858a2
DM
184 test -n "$${NOVIEW}" || man -l $@
185
a5bb4c40 186qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
872bbc1b 187 a2x ${A2X_MAN1_OPTIONS} qmrestore.adoc
a5bb4c40
DM
188 test -n "$${NOVIEW}" || man -l $@
189
d8742b0c 190pvecm.1: ${PVECM_MAN1_SOURCES}
872bbc1b 191 a2x ${A2X_MAN1_OPTIONS} pvecm.adoc
d8742b0c
DM
192 test -n "$${NOVIEW}" || man -l $@
193
d7810cdb 194pveum.1: ${PVEUM_MAN1_SOURCES}
872bbc1b 195 a2x ${A2X_MAN1_OPTIONS} pveum.adoc
d7810cdb
DM
196 test -n "$${NOVIEW}" || man -l $@
197
6198e7c5
DM
198pveam.1: ${PVEAM_MAN1_SOURCES}
199 a2x ${A2X_MAN1_OPTIONS} pveam.adoc
200 test -n "$${NOVIEW}" || man -l $@
201
e26d2ff0 202ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
872bbc1b 203 a2x ${A2X_MAN1_OPTIONS} ha-manager.adoc
e26d2ff0
DM
204 test -n "$${NOVIEW}" || man -l $@
205
47e1b0c6 206pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES}
872bbc1b 207 a2x ${A2X_MAN8_OPTIONS} manpage pve-ha-crm.adoc
47e1b0c6
DM
208 test -n "$${NOVIEW}" || man -l $@
209
954a26fd 210pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
872bbc1b 211 a2x ${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
954a26fd
DM
212 test -n "$${NOVIEW}" || man -l $@
213
4db6a3f3
DM
214pvestatd.8: ${PVESTATD_MAN8_SOURCES}
215 a2x ${A2X_MAN8_OPTIONS} pvestatd.adoc
216 test -n "$${NOVIEW}" || man -l $@
217
9ddb9dc3
DM
218pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES}
219 a2x ${A2X_MAN8_OPTIONS} pvedaemon.adoc
220 test -n "$${NOVIEW}" || man -l $@
221
96f2beeb
DM
222pveproxy.8: ${PVEPROXY_MAN8_SOURCES}
223 a2x ${A2X_MAN8_OPTIONS} pveproxy.adoc
224 test -n "$${NOVIEW}" || man -l $@
225
2d8f1c92
DM
226spiceproxy.8: ${SPICEPROXY_MAN8_SOURCES}
227 a2x ${A2X_MAN8_OPTIONS} spiceproxy.adoc
228 test -n "$${NOVIEW}" || man -l $@
229
bd88f9d9
DM
230pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
231 a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
232 test -n "$${NOVIEW}" || man -l $@
233
672abac1
DM
234qm.conf.5: ${QM_CONF_MAN5_SOURCES}
235
236pct.conf.5: ${PCT_CONF_MAN5_SOURCES}
6ec3cd20 237
672abac1 238datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES}
6ec3cd20 239
b0f56e11 240%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
872bbc1b 241 a2x ${A2X_MAN5_OPTIONS} $*.adoc
f6b81378 242 test -n "$${NOVIEW}" || man -l $@
9344ee0d
DM
243
244.PHONY: cleanup-docgen
245cleanup-docgen:
427b88e5 246 rm -f *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml