add pveproxy 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
f6b81378
DM
41PCT_MAN1_SOURCES= \
42 pct.adoc \
43 pct.1-synopsis.adoc \
44 ${PVE_COMMON_DOC_SOURCES}
45
672abac1 46PCT_CONF_MAN5_SOURCES= \
6ec3cd20
DM
47 pct.conf.adoc \
48 pct.conf.5-opts.adoc \
49 ${PVE_COMMON_DOC_SOURCES}
50
672abac1
DM
51DATACENTER_CONF_MAN5_SOURCES= \
52 datacenter.cfg.adoc \
53 datacenter.cfg.5-opts.adoc \
54 ${PVE_COMMON_DOC_SOURCES}
55
7f8858a2
DM
56QM_MAN1_SOURCES= \
57 qm.adoc \
58 qm.1-synopsis.adoc \
59 ${PVE_COMMON_DOC_SOURCES}
60
672abac1 61QM_CONF_MAN5_SOURCES= \
6ec3cd20
DM
62 qm.conf.adoc \
63 qm.conf.5-opts.adoc \
64 ${PVE_COMMON_DOC_SOURCES}
65
a5bb4c40
DM
66QMRESTORE_MAN1_SOURCES= \
67 qmrestore.adoc \
68 qmrestore.1-synopsis.adoc \
69 ${PVE_COMMON_DOC_SOURCES}
70
d7810cdb
DM
71PVEUM_MAN1_SOURCES= \
72 pveum.adoc \
73 pveum.1-synopsis.adoc \
74 ${PVE_COMMON_DOC_SOURCES}
75
e26d2ff0
DM
76HA_MANAGER_MAN1_SOURCES= \
77 ha-manager.adoc \
78 ha-manager.1-synopsis.adoc \
79 ${PVE_COMMON_DOC_SOURCES}
80
47e1b0c6
DM
81PVE_HA_CRM_MAN8_SOURCES= \
82 pve-ha-crm.adoc \
83 pve-ha-crm.8-synopsis.adoc \
84 ${PVE_COMMON_DOC_SOURCES}
85
954a26fd
DM
86PVE_HA_LRM_MAN8_SOURCES= \
87 pve-ha-lrm.adoc \
88 pve-ha-lrm.8-synopsis.adoc \
89 ${PVE_COMMON_DOC_SOURCES}
90
4db6a3f3
DM
91PVESTATD_MAN8_SOURCES= \
92 pvestatd.adoc \
93 pvestatd.8-synopsis.adoc \
94 ${PVE_COMMON_DOC_SOURCES}
95
9ddb9dc3
DM
96PVEDAEMON_MAN8_SOURCES= \
97 pvedaemon.adoc \
98 pvedaemon.8-synopsis.adoc \
99 ${PVE_COMMON_DOC_SOURCES}
100
96f2beeb
DM
101PVEPROXY_MAN8_SOURCES= \
102 pveproxy.adoc \
103 pveproxy.8-synopsis.adoc \
104 ${PVE_COMMON_DOC_SOURCES}
105
bd88f9d9
DM
106PMXCFS_MAN8_SOURCES= \
107 pmxcfs.adoc \
108 pmxcfs.8-cli.adoc \
109 ${PVE_COMMON_DOC_SOURCES}
110
9344ee0d
DM
111attributes.txt docinfo.xml:
112 cp ${DGDIR}/$@ $@.tmp
113 mv $@.tmp $@
114
115%-opts.adoc: ${DGDIR}/gen-%-opts.pl
f6b81378 116 ${DGDIR}/gen-$*-opts.pl >$@.tmp
9344ee0d
DM
117 mv $@.tmp $@
118
119%.adoc: ${DGDIR}/gen-%-adoc.pl
f6b81378 120 ${DGDIR}/gen-$*-adoc.pl >$@.tmp
9344ee0d
DM
121 mv $@.tmp $@
122
123%.1-synopsis.adoc:
124 perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
125 mv $@.tmp $@
126
127%.8-synopsis.adoc:
128 perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
129 mv $@.tmp $@
130
f6b81378 131ifneq (${DGDIR},.)
9344ee0d
DM
132%.adoc: ${DGDIR}/%.adoc
133 cp $< $@.tmp
134 mv $@.tmp $@
f6b81378 135endif
9344ee0d 136
872bbc1b
DM
137A2X_MAN_COMMON_OPTIONS=-a docinfo1 -a "manversion=Release ${DOCRELEASE}" -f manpage
138A2X_MAN1_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=1"
139A2X_MAN5_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=5"
140A2X_MAN8_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=8"
141
9344ee0d 142pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
872bbc1b 143 a2x ${A2X_MAN8_OPTIONS} pve-firewall.adoc
9344ee0d
DM
144 test -n "$${NOVIEW}" || man -l $@
145
828a27f5 146pvesm.1: ${PVESM_MAN1_SOURCES}
872bbc1b 147 a2x ${A2X_MAN1_OPTIONS} pvesm.adoc
828a27f5
DM
148 test -n "$${NOVIEW}" || man -l $@
149
f6b81378 150pct.1: ${PCT_MAN1_SOURCES}
872bbc1b 151 a2x ${A2X_MAN1_OPTIONS} pct.adoc
f6b81378
DM
152 test -n "$${NOVIEW}" || man -l $@
153
7f8858a2 154qm.1: ${QM_MAN1_SOURCES}
872bbc1b 155 a2x ${A2X_MAN1_OPTIONS} qm.adoc
7f8858a2
DM
156 test -n "$${NOVIEW}" || man -l $@
157
a5bb4c40 158qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
872bbc1b 159 a2x ${A2X_MAN1_OPTIONS} qmrestore.adoc
a5bb4c40
DM
160 test -n "$${NOVIEW}" || man -l $@
161
d8742b0c 162pvecm.1: ${PVECM_MAN1_SOURCES}
872bbc1b 163 a2x ${A2X_MAN1_OPTIONS} pvecm.adoc
d8742b0c
DM
164 test -n "$${NOVIEW}" || man -l $@
165
d7810cdb 166pveum.1: ${PVEUM_MAN1_SOURCES}
872bbc1b 167 a2x ${A2X_MAN1_OPTIONS} pveum.adoc
d7810cdb
DM
168 test -n "$${NOVIEW}" || man -l $@
169
e26d2ff0 170ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
872bbc1b 171 a2x ${A2X_MAN1_OPTIONS} ha-manager.adoc
e26d2ff0
DM
172 test -n "$${NOVIEW}" || man -l $@
173
47e1b0c6 174pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES}
872bbc1b 175 a2x ${A2X_MAN8_OPTIONS} manpage pve-ha-crm.adoc
47e1b0c6
DM
176 test -n "$${NOVIEW}" || man -l $@
177
954a26fd 178pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
872bbc1b 179 a2x ${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
954a26fd
DM
180 test -n "$${NOVIEW}" || man -l $@
181
4db6a3f3
DM
182pvestatd.8: ${PVESTATD_MAN8_SOURCES}
183 a2x ${A2X_MAN8_OPTIONS} pvestatd.adoc
184 test -n "$${NOVIEW}" || man -l $@
185
9ddb9dc3
DM
186pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES}
187 a2x ${A2X_MAN8_OPTIONS} pvedaemon.adoc
188 test -n "$${NOVIEW}" || man -l $@
189
96f2beeb
DM
190pveproxy.8: ${PVEPROXY_MAN8_SOURCES}
191 a2x ${A2X_MAN8_OPTIONS} pveproxy.adoc
192 test -n "$${NOVIEW}" || man -l $@
193
bd88f9d9
DM
194pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
195 a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
196 test -n "$${NOVIEW}" || man -l $@
197
672abac1
DM
198qm.conf.5: ${QM_CONF_MAN5_SOURCES}
199
200pct.conf.5: ${PCT_CONF_MAN5_SOURCES}
6ec3cd20 201
672abac1 202datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES}
6ec3cd20 203
b0f56e11 204%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
872bbc1b 205 a2x ${A2X_MAN5_OPTIONS} $*.adoc
f6b81378 206 test -n "$${NOVIEW}" || man -l $@
9344ee0d
DM
207
208.PHONY: cleanup-docgen
209cleanup-docgen:
427b88e5 210 rm -f *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml