add pvedaemon 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 PMXCFS_MAN8_SOURCES=                    \
102         pmxcfs.adoc                     \
103         pmxcfs.8-cli.adoc               \
104         ${PVE_COMMON_DOC_SOURCES}
105
106 attributes.txt docinfo.xml:
107         cp ${DGDIR}/$@ $@.tmp
108         mv $@.tmp $@
109
110 %-opts.adoc: ${DGDIR}/gen-%-opts.pl
111         ${DGDIR}/gen-$*-opts.pl >$@.tmp
112         mv $@.tmp $@
113
114 %.adoc: ${DGDIR}/gen-%-adoc.pl
115         ${DGDIR}/gen-$*-adoc.pl >$@.tmp
116         mv $@.tmp $@
117
118 %.1-synopsis.adoc:
119         perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
120         mv $@.tmp $@
121
122 %.8-synopsis.adoc:
123         perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
124         mv $@.tmp $@
125
126 ifneq (${DGDIR},.)
127 %.adoc: ${DGDIR}/%.adoc
128         cp $< $@.tmp
129         mv $@.tmp $@
130 endif
131
132 A2X_MAN_COMMON_OPTIONS=-a docinfo1 -a "manversion=Release ${DOCRELEASE}" -f manpage
133 A2X_MAN1_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=1"
134 A2X_MAN5_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=5"
135 A2X_MAN8_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=8"
136
137 pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
138         a2x ${A2X_MAN8_OPTIONS} pve-firewall.adoc
139         test -n "$${NOVIEW}" || man -l $@
140
141 pvesm.1: ${PVESM_MAN1_SOURCES}
142         a2x ${A2X_MAN1_OPTIONS} pvesm.adoc
143         test -n "$${NOVIEW}" || man -l $@
144
145 pct.1: ${PCT_MAN1_SOURCES}
146         a2x ${A2X_MAN1_OPTIONS} pct.adoc
147         test -n "$${NOVIEW}" || man -l $@
148
149 qm.1: ${QM_MAN1_SOURCES}
150         a2x ${A2X_MAN1_OPTIONS} qm.adoc
151         test -n "$${NOVIEW}" || man -l $@
152
153 qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
154         a2x ${A2X_MAN1_OPTIONS} qmrestore.adoc
155         test -n "$${NOVIEW}" || man -l $@
156
157 pvecm.1: ${PVECM_MAN1_SOURCES}
158         a2x ${A2X_MAN1_OPTIONS} pvecm.adoc
159         test -n "$${NOVIEW}" || man -l $@
160
161 pveum.1: ${PVEUM_MAN1_SOURCES}
162         a2x ${A2X_MAN1_OPTIONS} pveum.adoc
163         test -n "$${NOVIEW}" || man -l $@
164
165 ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
166         a2x ${A2X_MAN1_OPTIONS} ha-manager.adoc
167         test -n "$${NOVIEW}" || man -l $@
168
169 pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES}
170         a2x ${A2X_MAN8_OPTIONS} manpage pve-ha-crm.adoc
171         test -n "$${NOVIEW}" || man -l $@
172
173 pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
174         a2x ${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
175         test -n "$${NOVIEW}" || man -l $@
176
177 pvestatd.8: ${PVESTATD_MAN8_SOURCES}
178         a2x ${A2X_MAN8_OPTIONS} pvestatd.adoc
179         test -n "$${NOVIEW}" || man -l $@
180
181 pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES}
182         a2x ${A2X_MAN8_OPTIONS} pvedaemon.adoc
183         test -n "$${NOVIEW}" || man -l $@
184
185 pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
186         a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
187         test -n "$${NOVIEW}" || man -l $@
188
189 qm.conf.5: ${QM_CONF_MAN5_SOURCES}
190
191 pct.conf.5: ${PCT_CONF_MAN5_SOURCES}
192
193 datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES}
194
195 %.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
196         a2x ${A2X_MAN5_OPTIONS} $*.adoc
197         test -n "$${NOVIEW}" || man -l $@
198
199 .PHONY: cleanup-docgen
200 cleanup-docgen:
201         rm -f *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml