add pveproxy man page
[pve-docs.git] / pve-doc-generator.mk
1 # also update debian/changelog
2 DOCRELEASE=4.1
3
4 DGDIR?=/usr/share/pve-doc-generator
5
6 all:
7
8 PVE_COMMON_DOC_SOURCES= \
9 attributes.txt \
10 pve-copyright.adoc \
11 docinfo.xml
12
13 PVECM_MAN1_SOURCES= \
14 pvecm.adoc \
15 pvecm.1-synopsis.adoc \
16 ${PVE_COMMON_DOC_SOURCES}
17
18 PVE_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 \
26 ${PVE_COMMON_DOC_SOURCES}
27
28 PVESM_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}
40
41 PCT_MAN1_SOURCES= \
42 pct.adoc \
43 pct.1-synopsis.adoc \
44 ${PVE_COMMON_DOC_SOURCES}
45
46 PCT_CONF_MAN5_SOURCES= \
47 pct.conf.adoc \
48 pct.conf.5-opts.adoc \
49 ${PVE_COMMON_DOC_SOURCES}
50
51 DATACENTER_CONF_MAN5_SOURCES= \
52 datacenter.cfg.adoc \
53 datacenter.cfg.5-opts.adoc \
54 ${PVE_COMMON_DOC_SOURCES}
55
56 QM_MAN1_SOURCES= \
57 qm.adoc \
58 qm.1-synopsis.adoc \
59 ${PVE_COMMON_DOC_SOURCES}
60
61 QM_CONF_MAN5_SOURCES= \
62 qm.conf.adoc \
63 qm.conf.5-opts.adoc \
64 ${PVE_COMMON_DOC_SOURCES}
65
66 QMRESTORE_MAN1_SOURCES= \
67 qmrestore.adoc \
68 qmrestore.1-synopsis.adoc \
69 ${PVE_COMMON_DOC_SOURCES}
70
71 PVEUM_MAN1_SOURCES= \
72 pveum.adoc \
73 pveum.1-synopsis.adoc \
74 ${PVE_COMMON_DOC_SOURCES}
75
76 HA_MANAGER_MAN1_SOURCES= \
77 ha-manager.adoc \
78 ha-manager.1-synopsis.adoc \
79 ${PVE_COMMON_DOC_SOURCES}
80
81 PVE_HA_CRM_MAN8_SOURCES= \
82 pve-ha-crm.adoc \
83 pve-ha-crm.8-synopsis.adoc \
84 ${PVE_COMMON_DOC_SOURCES}
85
86 PVE_HA_LRM_MAN8_SOURCES= \
87 pve-ha-lrm.adoc \
88 pve-ha-lrm.8-synopsis.adoc \
89 ${PVE_COMMON_DOC_SOURCES}
90
91 PVESTATD_MAN8_SOURCES= \
92 pvestatd.adoc \
93 pvestatd.8-synopsis.adoc \
94 ${PVE_COMMON_DOC_SOURCES}
95
96 PVEDAEMON_MAN8_SOURCES= \
97 pvedaemon.adoc \
98 pvedaemon.8-synopsis.adoc \
99 ${PVE_COMMON_DOC_SOURCES}
100
101 PVEPROXY_MAN8_SOURCES= \
102 pveproxy.adoc \
103 pveproxy.8-synopsis.adoc \
104 ${PVE_COMMON_DOC_SOURCES}
105
106 PMXCFS_MAN8_SOURCES= \
107 pmxcfs.adoc \
108 pmxcfs.8-cli.adoc \
109 ${PVE_COMMON_DOC_SOURCES}
110
111 attributes.txt docinfo.xml:
112 cp ${DGDIR}/$@ $@.tmp
113 mv $@.tmp $@
114
115 %-opts.adoc: ${DGDIR}/gen-%-opts.pl
116 ${DGDIR}/gen-$*-opts.pl >$@.tmp
117 mv $@.tmp $@
118
119 %.adoc: ${DGDIR}/gen-%-adoc.pl
120 ${DGDIR}/gen-$*-adoc.pl >$@.tmp
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
131 ifneq (${DGDIR},.)
132 %.adoc: ${DGDIR}/%.adoc
133 cp $< $@.tmp
134 mv $@.tmp $@
135 endif
136
137 A2X_MAN_COMMON_OPTIONS=-a docinfo1 -a "manversion=Release ${DOCRELEASE}" -f manpage
138 A2X_MAN1_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=1"
139 A2X_MAN5_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=5"
140 A2X_MAN8_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=8"
141
142 pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
143 a2x ${A2X_MAN8_OPTIONS} pve-firewall.adoc
144 test -n "$${NOVIEW}" || man -l $@
145
146 pvesm.1: ${PVESM_MAN1_SOURCES}
147 a2x ${A2X_MAN1_OPTIONS} pvesm.adoc
148 test -n "$${NOVIEW}" || man -l $@
149
150 pct.1: ${PCT_MAN1_SOURCES}
151 a2x ${A2X_MAN1_OPTIONS} pct.adoc
152 test -n "$${NOVIEW}" || man -l $@
153
154 qm.1: ${QM_MAN1_SOURCES}
155 a2x ${A2X_MAN1_OPTIONS} qm.adoc
156 test -n "$${NOVIEW}" || man -l $@
157
158 qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
159 a2x ${A2X_MAN1_OPTIONS} qmrestore.adoc
160 test -n "$${NOVIEW}" || man -l $@
161
162 pvecm.1: ${PVECM_MAN1_SOURCES}
163 a2x ${A2X_MAN1_OPTIONS} pvecm.adoc
164 test -n "$${NOVIEW}" || man -l $@
165
166 pveum.1: ${PVEUM_MAN1_SOURCES}
167 a2x ${A2X_MAN1_OPTIONS} pveum.adoc
168 test -n "$${NOVIEW}" || man -l $@
169
170 ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
171 a2x ${A2X_MAN1_OPTIONS} ha-manager.adoc
172 test -n "$${NOVIEW}" || man -l $@
173
174 pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES}
175 a2x ${A2X_MAN8_OPTIONS} manpage pve-ha-crm.adoc
176 test -n "$${NOVIEW}" || man -l $@
177
178 pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
179 a2x ${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
180 test -n "$${NOVIEW}" || man -l $@
181
182 pvestatd.8: ${PVESTATD_MAN8_SOURCES}
183 a2x ${A2X_MAN8_OPTIONS} pvestatd.adoc
184 test -n "$${NOVIEW}" || man -l $@
185
186 pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES}
187 a2x ${A2X_MAN8_OPTIONS} pvedaemon.adoc
188 test -n "$${NOVIEW}" || man -l $@
189
190 pveproxy.8: ${PVEPROXY_MAN8_SOURCES}
191 a2x ${A2X_MAN8_OPTIONS} pveproxy.adoc
192 test -n "$${NOVIEW}" || man -l $@
193
194 pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
195 a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
196 test -n "$${NOVIEW}" || man -l $@
197
198 qm.conf.5: ${QM_CONF_MAN5_SOURCES}
199
200 pct.conf.5: ${PCT_CONF_MAN5_SOURCES}
201
202 datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES}
203
204 %.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
205 a2x ${A2X_MAN5_OPTIONS} $*.adoc
206 test -n "$${NOVIEW}" || man -l $@
207
208 .PHONY: cleanup-docgen
209 cleanup-docgen:
210 rm -f *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml