]> git.proxmox.com Git - pve-docs.git/blame - pve-doc-generator.mk
vzdump.adoc: improve backup mode descriptions
[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
0840a663
DM
51PVECEPH_MAN1_SOURCES= \
52 pveceph.adoc \
53 pveceph.1-synopsis.adoc \
54 ${PVE_COMMON_DOC_SOURCES}
55
f6b81378
DM
56PCT_MAN1_SOURCES= \
57 pct.adoc \
58 pct.1-synopsis.adoc \
59 ${PVE_COMMON_DOC_SOURCES}
60
672abac1 61PCT_CONF_MAN5_SOURCES= \
6ec3cd20
DM
62 pct.conf.adoc \
63 pct.conf.5-opts.adoc \
64 ${PVE_COMMON_DOC_SOURCES}
65
672abac1
DM
66DATACENTER_CONF_MAN5_SOURCES= \
67 datacenter.cfg.adoc \
68 datacenter.cfg.5-opts.adoc \
69 ${PVE_COMMON_DOC_SOURCES}
70
7f8858a2
DM
71QM_MAN1_SOURCES= \
72 qm.adoc \
73 qm.1-synopsis.adoc \
74 ${PVE_COMMON_DOC_SOURCES}
75
672abac1 76QM_CONF_MAN5_SOURCES= \
6ec3cd20
DM
77 qm.conf.adoc \
78 qm.conf.5-opts.adoc \
79 ${PVE_COMMON_DOC_SOURCES}
80
a5bb4c40
DM
81QMRESTORE_MAN1_SOURCES= \
82 qmrestore.adoc \
83 qmrestore.1-synopsis.adoc \
84 ${PVE_COMMON_DOC_SOURCES}
85
d7810cdb
DM
86PVEUM_MAN1_SOURCES= \
87 pveum.adoc \
88 pveum.1-synopsis.adoc \
89 ${PVE_COMMON_DOC_SOURCES}
90
6198e7c5
DM
91PVEAM_MAN1_SOURCES= \
92 pveam.adoc \
93 pveam.1-synopsis.adoc \
94 ${PVE_COMMON_DOC_SOURCES}
95
96HA_MANAGER_MAN1_SOURCES= \
97 ha-manager.adoc \
98 ha-manager.1-synopsis.adoc \
e26d2ff0
DM
99 ${PVE_COMMON_DOC_SOURCES}
100
6198e7c5
DM
101PVE_HA_CRM_MAN8_SOURCES= \
102 pve-ha-crm.adoc \
103 pve-ha-crm.8-synopsis.adoc \
47e1b0c6
DM
104 ${PVE_COMMON_DOC_SOURCES}
105
6198e7c5
DM
106PVE_HA_LRM_MAN8_SOURCES= \
107 pve-ha-lrm.adoc \
108 pve-ha-lrm.8-synopsis.adoc \
954a26fd
DM
109 ${PVE_COMMON_DOC_SOURCES}
110
4db6a3f3
DM
111PVESTATD_MAN8_SOURCES= \
112 pvestatd.adoc \
113 pvestatd.8-synopsis.adoc \
114 ${PVE_COMMON_DOC_SOURCES}
115
9ddb9dc3
DM
116PVEDAEMON_MAN8_SOURCES= \
117 pvedaemon.adoc \
118 pvedaemon.8-synopsis.adoc \
119 ${PVE_COMMON_DOC_SOURCES}
120
96f2beeb
DM
121PVEPROXY_MAN8_SOURCES= \
122 pveproxy.adoc \
123 pveproxy.8-synopsis.adoc \
124 ${PVE_COMMON_DOC_SOURCES}
125
2d8f1c92
DM
126SPICEPROXY_MAN8_SOURCES= \
127 spiceproxy.adoc \
128 spiceproxy.8-synopsis.adoc \
129 ${PVE_COMMON_DOC_SOURCES}
130
bd88f9d9
DM
131PMXCFS_MAN8_SOURCES= \
132 pmxcfs.adoc \
133 pmxcfs.8-cli.adoc \
134 ${PVE_COMMON_DOC_SOURCES}
135
9344ee0d
DM
136attributes.txt docinfo.xml:
137 cp ${DGDIR}/$@ $@.tmp
138 mv $@.tmp $@
139
140%-opts.adoc: ${DGDIR}/gen-%-opts.pl
f6b81378 141 ${DGDIR}/gen-$*-opts.pl >$@.tmp
9344ee0d
DM
142 mv $@.tmp $@
143
144%.adoc: ${DGDIR}/gen-%-adoc.pl
f6b81378 145 ${DGDIR}/gen-$*-adoc.pl >$@.tmp
9344ee0d
DM
146 mv $@.tmp $@
147
148%.1-synopsis.adoc:
149 perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
150 mv $@.tmp $@
151
152%.8-synopsis.adoc:
153 perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
154 mv $@.tmp $@
155
f6b81378 156ifneq (${DGDIR},.)
9344ee0d
DM
157%.adoc: ${DGDIR}/%.adoc
158 cp $< $@.tmp
159 mv $@.tmp $@
f6b81378 160endif
9344ee0d 161
872bbc1b
DM
162A2X_MAN_COMMON_OPTIONS=-a docinfo1 -a "manversion=Release ${DOCRELEASE}" -f manpage
163A2X_MAN1_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=1"
164A2X_MAN5_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=5"
165A2X_MAN8_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=8"
166
9344ee0d 167pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
872bbc1b 168 a2x ${A2X_MAN8_OPTIONS} pve-firewall.adoc
9344ee0d
DM
169 test -n "$${NOVIEW}" || man -l $@
170
828a27f5 171pvesm.1: ${PVESM_MAN1_SOURCES}
872bbc1b 172 a2x ${A2X_MAN1_OPTIONS} pvesm.adoc
828a27f5
DM
173 test -n "$${NOVIEW}" || man -l $@
174
0840a663
DM
175pveceph.1: ${PVECEPH_MAN1_SOURCES}
176 a2x ${A2X_MAN1_OPTIONS} pveceph.adoc
177 test -n "$${NOVIEW}" || man -l $@
178
f6b81378 179pct.1: ${PCT_MAN1_SOURCES}
872bbc1b 180 a2x ${A2X_MAN1_OPTIONS} pct.adoc
f6b81378
DM
181 test -n "$${NOVIEW}" || man -l $@
182
6198e7c5
DM
183vzdump.1: ${VZDUMP_MAN1_SOURCES}
184 a2x ${A2X_MAN1_OPTIONS} vzdump.adoc
185 test -n "$${NOVIEW}" || man -l $@
186
ebd2a7fb
DM
187pvesubscription.1: ${PVESUBSCRIPTION_MAN1_SOURCES}
188 a2x ${A2X_MAN1_OPTIONS} pvesubscription.adoc
189 test -n "$${NOVIEW}" || man -l $@
190
7f8858a2 191qm.1: ${QM_MAN1_SOURCES}
872bbc1b 192 a2x ${A2X_MAN1_OPTIONS} qm.adoc
7f8858a2
DM
193 test -n "$${NOVIEW}" || man -l $@
194
a5bb4c40 195qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
872bbc1b 196 a2x ${A2X_MAN1_OPTIONS} qmrestore.adoc
a5bb4c40
DM
197 test -n "$${NOVIEW}" || man -l $@
198
d8742b0c 199pvecm.1: ${PVECM_MAN1_SOURCES}
872bbc1b 200 a2x ${A2X_MAN1_OPTIONS} pvecm.adoc
d8742b0c
DM
201 test -n "$${NOVIEW}" || man -l $@
202
d7810cdb 203pveum.1: ${PVEUM_MAN1_SOURCES}
872bbc1b 204 a2x ${A2X_MAN1_OPTIONS} pveum.adoc
d7810cdb
DM
205 test -n "$${NOVIEW}" || man -l $@
206
6198e7c5
DM
207pveam.1: ${PVEAM_MAN1_SOURCES}
208 a2x ${A2X_MAN1_OPTIONS} pveam.adoc
209 test -n "$${NOVIEW}" || man -l $@
210
e26d2ff0 211ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
872bbc1b 212 a2x ${A2X_MAN1_OPTIONS} ha-manager.adoc
e26d2ff0
DM
213 test -n "$${NOVIEW}" || man -l $@
214
47e1b0c6 215pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES}
25d13a7a 216 a2x ${A2X_MAN8_OPTIONS} pve-ha-crm.adoc
47e1b0c6
DM
217 test -n "$${NOVIEW}" || man -l $@
218
954a26fd 219pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
872bbc1b 220 a2x ${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
954a26fd
DM
221 test -n "$${NOVIEW}" || man -l $@
222
4db6a3f3
DM
223pvestatd.8: ${PVESTATD_MAN8_SOURCES}
224 a2x ${A2X_MAN8_OPTIONS} pvestatd.adoc
225 test -n "$${NOVIEW}" || man -l $@
226
9ddb9dc3
DM
227pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES}
228 a2x ${A2X_MAN8_OPTIONS} pvedaemon.adoc
229 test -n "$${NOVIEW}" || man -l $@
230
96f2beeb
DM
231pveproxy.8: ${PVEPROXY_MAN8_SOURCES}
232 a2x ${A2X_MAN8_OPTIONS} pveproxy.adoc
233 test -n "$${NOVIEW}" || man -l $@
234
2d8f1c92
DM
235spiceproxy.8: ${SPICEPROXY_MAN8_SOURCES}
236 a2x ${A2X_MAN8_OPTIONS} spiceproxy.adoc
237 test -n "$${NOVIEW}" || man -l $@
238
bd88f9d9
DM
239pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
240 a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
241 test -n "$${NOVIEW}" || man -l $@
242
672abac1
DM
243qm.conf.5: ${QM_CONF_MAN5_SOURCES}
244
245pct.conf.5: ${PCT_CONF_MAN5_SOURCES}
6ec3cd20 246
672abac1 247datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES}
6ec3cd20 248
b0f56e11 249%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
872bbc1b 250 a2x ${A2X_MAN5_OPTIONS} $*.adoc
f6b81378 251 test -n "$${NOVIEW}" || man -l $@
9344ee0d
DM
252
253.PHONY: cleanup-docgen
254cleanup-docgen:
427b88e5 255 rm -f *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml