1 # also update debian/changelog
4 DGDIR?
=/usr
/share
/pve-doc-generator
6 ASCIIDOC_PVE?
=/usr
/bin
/asciidoc-pve
10 PVE_COMMON_DOC_SOURCES
= \
17 pvecm
.1-synopsis.adoc \
18 ${PVE_COMMON_DOC_SOURCES}
20 PVE_FIREWALL_MAN8_SOURCES
= \
22 pve-firewall
.8-synopsis.adoc \
23 pve-firewall-cluster-opts.adoc \
24 pve-firewall-host-opts.adoc \
25 pve-firewall-vm-opts.adoc \
26 pve-firewall-rules-opts.adoc \
27 pve-firewall-macros.adoc \
28 ${PVE_COMMON_DOC_SOURCES}
32 pvesm
.1-synopsis.adoc \
33 pve-storage-dir.adoc \
34 pve-storage-glusterfs.adoc \
35 pve-storage-iscsi.adoc \
36 pve-storage-iscsidirect.adoc \
37 pve-storage-lvm.adoc \
38 pve-storage-lvmthin.adoc \
39 pve-storage-nfs.adoc \
40 pve-storage-rbd.adoc \
41 pve-storage-zfspool.adoc \
42 ${PVE_COMMON_DOC_SOURCES}
44 VZDUMP_MAN1_SOURCES
= \
46 vzdump
.1-synopsis.adoc \
47 vzdump.conf
.5-opts.adoc \
48 ${PVE_COMMON_DOC_SOURCES}
50 PVESUBSCRIPTION_MAN1_SOURCES
= \
51 pvesubscription.adoc \
52 pvesubscription
.1-synopsis.adoc \
53 ${PVE_COMMON_DOC_SOURCES}
55 PVECEPH_MAN1_SOURCES
= \
57 pveceph
.1-synopsis.adoc \
58 ${PVE_COMMON_DOC_SOURCES}
63 pct.conf
.5-opts.adoc \
64 pct-network-opts.adoc \
65 pct-mountpoint-opts.adoc \
66 ${PVE_COMMON_DOC_SOURCES}
68 PCT_CONF_MAN5_SOURCES
= \
70 pct.conf
.5-opts.adoc \
71 ${PVE_COMMON_DOC_SOURCES}
73 DATACENTER_CONF_MAN5_SOURCES
= \
75 datacenter.cfg
.5-opts.adoc \
76 ${PVE_COMMON_DOC_SOURCES}
82 ${PVE_COMMON_DOC_SOURCES}
84 QM_CONF_MAN5_SOURCES
= \
87 ${PVE_COMMON_DOC_SOURCES}
89 QMRESTORE_MAN1_SOURCES
= \
91 qmrestore
.1-synopsis.adoc \
92 ${PVE_COMMON_DOC_SOURCES}
96 pveum
.1-synopsis.adoc \
97 ${PVE_COMMON_DOC_SOURCES}
101 pveam
.1-synopsis.adoc \
102 ${PVE_COMMON_DOC_SOURCES}
104 HA_MANAGER_MAN1_SOURCES
= \
106 ha-manager
.1-synopsis.adoc \
107 ${PVE_COMMON_DOC_SOURCES}
109 PVE_HA_CRM_MAN8_SOURCES
= \
111 pve-ha-crm
.8-synopsis.adoc \
112 ${PVE_COMMON_DOC_SOURCES}
114 PVE_HA_LRM_MAN8_SOURCES
= \
116 pve-ha-lrm
.8-synopsis.adoc \
117 ${PVE_COMMON_DOC_SOURCES}
119 PVESTATD_MAN8_SOURCES
= \
121 pvestatd
.8-synopsis.adoc \
122 ${PVE_COMMON_DOC_SOURCES}
124 PVEDAEMON_MAN8_SOURCES
= \
126 pvedaemon
.8-synopsis.adoc \
127 ${PVE_COMMON_DOC_SOURCES}
129 PVEPROXY_MAN8_SOURCES
= \
131 pveproxy
.8-synopsis.adoc \
132 ${PVE_COMMON_DOC_SOURCES}
134 SPICEPROXY_MAN8_SOURCES
= \
136 spiceproxy
.8-synopsis.adoc \
137 ${PVE_COMMON_DOC_SOURCES}
139 PMXCFS_MAN8_SOURCES
= \
142 ${PVE_COMMON_DOC_SOURCES}
144 PVEPERF_MAN1_SOURCES
= \
146 pveperf
.1-synopsis.adoc \
147 ${PVE_COMMON_DOC_SOURCES}
149 attributes.txt docinfo.xml
:
150 cp
${DGDIR}/$@
$@.tmp
153 %-opts.adoc
: ${DGDIR}/gen-
%-opts.pl
154 ${DGDIR}/gen-
$*-opts.pl
>$@.tmp
157 %.adoc
: ${DGDIR}/gen-
%-adoc.pl
158 ${DGDIR}/gen-
$*-adoc.pl
>$@.tmp
161 pveperf
.1-synopsis.adoc
:
162 echo
'*pveperf* `[PATH]`' > pveperf
.1-synopsis.adoc
165 perl
-I.
-e
"use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp
169 perl
-I.
-e
"use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp
173 %.adoc
: ${DGDIR}/%.adoc
178 pve-firewall
.8: ${PVE_FIREWALL_MAN8_SOURCES} ${ASCIIDOC_PVE}
179 ${ASCIIDOC_PVE} compile-man
-o
$@ pve-firewall.adoc
180 test -n
"$${NOVIEW}" || man
-l
$@
182 pvesm
.1: ${PVESM_MAN1_SOURCES} ${ASCIIDOC_PVE}
183 ${ASCIIDOC_PVE} compile-man
-o
$@ pvesm.adoc
184 test -n
"$${NOVIEW}" || man
-l
$@
186 pveceph
.1: ${PVECEPH_MAN1_SOURCES} ${ASCIIDOC_PVE}
187 ${ASCIIDOC_PVE} compile-man
-o
$@ pveceph.adoc
188 test -n
"$${NOVIEW}" || man
-l
$@
190 pct
.1: ${PCT_MAN1_SOURCES} ${ASCIIDOC_PVE}
191 ${ASCIIDOC_PVE} compile-man
-o
$@ pct.adoc
192 test -n
"$${NOVIEW}" || man
-l
$@
194 vzdump
.1: ${VZDUMP_MAN1_SOURCES} ${ASCIIDOC_PVE}
195 ${ASCIIDOC_PVE} compile-man
-o
$@ vzdump.adoc
196 test -n
"$${NOVIEW}" || man
-l
$@
198 pvesubscription
.1: ${PVESUBSCRIPTION_MAN1_SOURCES} ${ASCIIDOC_PVE}
199 ${ASCIIDOC_PVE} compile-man
-o
$@ pvesubscription.adoc
200 test -n
"$${NOVIEW}" || man
-l
$@
202 qm
.1: ${QM_MAN1_SOURCES} ${ASCIIDOC_PVE}
203 ${ASCIIDOC_PVE} compile-man
-o
$@ qm.adoc
204 test -n
"$${NOVIEW}" || man
-l
$@
206 qmrestore
.1: ${QMRESTORE_MAN1_SOURCES} ${ASCIIDOC_PVE}
207 ${ASCIIDOC_PVE} compile-man
-o
$@ qmrestore.adoc
208 test -n
"$${NOVIEW}" || man
-l
$@
210 pvecm
.1: ${PVECM_MAN1_SOURCES} ${ASCIIDOC_PVE}
211 ${ASCIIDOC_PVE} compile-man
-o
$@ pvecm.adoc
212 test -n
"$${NOVIEW}" || man
-l
$@
214 pveum
.1: ${PVEUM_MAN1_SOURCES} ${ASCIIDOC_PVE}
215 ${ASCIIDOC_PVE} compile-man
-o
$@ pveum.adoc
216 test -n
"$${NOVIEW}" || man
-l
$@
218 pveam
.1: ${PVEAM_MAN1_SOURCES} ${ASCIIDOC_PVE}
219 ${ASCIIDOC_PVE} compile-man
-o
$@ pveam.adoc
220 test -n
"$${NOVIEW}" || man
-l
$@
222 ha-manager
.1: ${HA_MANAGER_MAN1_SOURCES} ${ASCIIDOC_PVE}
223 ${ASCIIDOC_PVE} compile-man
-o
$@ ha-manager.adoc
224 test -n
"$${NOVIEW}" || man
-l
$@
226 pve-ha-crm
.8: ${PVE_HA_CRM_MAN8_SOURCES} ${ASCIIDOC_PVE}
227 ${ASCIIDOC_PVE} compile-man
-o
$@ pve-ha-crm.adoc
228 test -n
"$${NOVIEW}" || man
-l
$@
230 pve-ha-lrm
.8: ${PVE_HA_LRM_MAN8_SOURCES} ${ASCIIDOC_PVE}
231 ${ASCIIDOC_PVE} compile-man
-o
$@ pve-ha-lrm.adoc
232 test -n
"$${NOVIEW}" || man
-l
$@
234 pvestatd
.8: ${PVESTATD_MAN8_SOURCES} ${ASCIIDOC_PVE}
235 ${ASCIIDOC_PVE} compile-man
-o
$@ pvestatd.adoc
236 test -n
"$${NOVIEW}" || man
-l
$@
238 pvedaemon
.8: ${PVEDAEMON_MAN8_SOURCES} ${ASCIIDOC_PVE}
239 ${ASCIIDOC_PVE} compile-man
-o
$@ pvedaemon.adoc
240 test -n
"$${NOVIEW}" || man
-l
$@
242 pveproxy
.8: ${PVEPROXY_MAN8_SOURCES} ${ASCIIDOC_PVE}
243 ${ASCIIDOC_PVE} compile-man
-o
$@ pveproxy.adoc
244 test -n
"$${NOVIEW}" || man
-l
$@
246 spiceproxy
.8: ${SPICEPROXY_MAN8_SOURCES} ${ASCIIDOC_PVE}
247 ${ASCIIDOC_PVE} compile-man
-o
$@ spiceproxy.adoc
248 test -n
"$${NOVIEW}" || man
-l
$@
250 pmxcfs
.8: ${PMXCFS_MAN8_SOURCES} ${ASCIIDOC_PVE}
251 ${ASCIIDOC_PVE} compile-man
-o
$@ pmxcfs.adoc
252 test -n
"$${NOVIEW}" || man
-l
$@
254 qm.conf
.5: ${QM_CONF_MAN5_SOURCES}
256 pct.conf
.5: ${PCT_CONF_MAN5_SOURCES}
258 datacenter.cfg
.5: ${DATACENTER_CONF_MAN5_SOURCES}
260 %.5: %.adoc
%.5-opts.adoc
${PVE_COMMON_DOC_SOURCES} ${ASCIIDOC_PVE}
261 ${ASCIIDOC_PVE} compile-man
-o
$@
$*.adoc
262 test -n
"$${NOVIEW}" || man
-l
$@
264 .PHONY
: cleanup-docgen
266 rm -f
*.tmp.xml
*.1 *.5 *.8 *.adoc attributes.txt docinfo.xml