From 47e1b0c6ffb02563f82960150c94847565ce53cd Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Fri, 8 Apr 2016 08:13:23 +0200 Subject: [PATCH] add pve-ha-crm man page --- Makefile | 4 +++- index.adoc | 1 + pve-admin-guide.adoc | 8 ++++++++ pve-doc-generator.mk | 9 +++++++++ pve-ha-crm.8-synopsis.adoc | 40 ++++++++++++++++++++++++++++++++++++++ pve-ha-crm.adoc | 31 +++++++++++++++++++++++++++++ 6 files changed, 92 insertions(+), 1 deletion(-) create mode 100644 pve-ha-crm.8-synopsis.adoc create mode 100644 pve-ha-crm.adoc diff --git a/Makefile b/Makefile index eb56795..18c8753 100644 --- a/Makefile +++ b/Makefile @@ -36,6 +36,7 @@ DEB_SOURCES= \ datacenter.cfg.adoc \ pveam.adoc \ ha-manager.adoc \ + pve-ha-crm.adoc \ pve-copyright.adoc \ docinfo.xml @@ -79,6 +80,7 @@ PVE_ADMIN_GUIDE_SOURCES= \ ${QM_MAN1_SOURCES} \ ${QMRESTORE_MAN1_SOURCES} \ ${HA_MANAGER_MAN1_SOURCES} \ + ${PVE_HA_CRM_MAN8_SOURCES} \ ${PVEAM_SOURCES} \ ${VZDUMP_SOURCES} \ images/cluster-nwdiag.svg \ @@ -126,7 +128,7 @@ all: pve-admin-guide.html index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub - $(MAKE) NOVIEW=1 pvecm.1.html qm.1.html qmrestore.1.html pct.1.html pveam.1.html pvesm.1.html pveum.1.html vzdump.1.html pve-firewall.8.html ha-manager.1.html datacenter.cfg.5.html vm.conf.5.html pct.conf.5.html + $(MAKE) NOVIEW=1 pvecm.1.html qm.1.html qmrestore.1.html pct.1.html pveam.1.html pvesm.1.html pveum.1.html vzdump.1.html pve-firewall.8.html ha-manager.1.html pve-ha-crm.8.html datacenter.cfg.5.html vm.conf.5.html pct.conf.5.html asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc test -n "$${NOVIEW}" || $(BROWSER) index.html & diff --git a/index.adoc b/index.adoc index 091fe80..e1ee463 100644 --- a/index.adoc +++ b/index.adoc @@ -30,6 +30,7 @@ include::attributes.txt[] | pveum | link:pveum.1.html[pveum.1] | vzdump | link:vzdump.1.html[vzdump.1] | ha-manager | link:ha-manager.1.html[ha-manager.1] +| pve-ha-crm | link:pve-ha-crm.8.html[pve-ha-crm.8] | pve-firewall | link:pve-firewall.8.html[pve-firewall.8] | '/etc/pve/datacenter.cfg' | link:datacenter.cfg.5.html[datacenter.cfg.5] | '/etc/pve/qemu-server/.conf' | link:vm.conf.5.html[vm.conf.5] diff --git a/pve-admin-guide.adoc b/pve-admin-guide.adoc index c7ed0ea..4d2e1b8 100644 --- a/pve-admin-guide.adoc +++ b/pve-admin-guide.adoc @@ -124,6 +124,14 @@ include::ha-manager.1-synopsis.adoc[] :leveloffset: 0 +*pve-ha-crm* - Cluster Ressource Manager Daemon +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:leveloffset: 1 +include::pve-ha-crm.8-synopsis.adoc[] + +:leveloffset: 0 + [appendix] Configuration Files ------------------- diff --git a/pve-doc-generator.mk b/pve-doc-generator.mk index cd1ade4..3e4e0d7 100644 --- a/pve-doc-generator.mk +++ b/pve-doc-generator.mk @@ -63,6 +63,11 @@ HA_MANAGER_MAN1_SOURCES= \ ha-manager.1-synopsis.adoc \ ${PVE_COMMON_DOC_SOURCES} +PVE_HA_CRM_MAN8_SOURCES= \ + pve-ha-crm.adoc \ + pve-ha-crm.8-synopsis.adoc \ + ${PVE_COMMON_DOC_SOURCES} + attributes.txt docinfo.xml: cp ${DGDIR}/$@ $@.tmp mv $@.tmp $@ @@ -121,6 +126,10 @@ ha-manager.1: ${HA_MANAGER_MAN1_SOURCES} a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage ha-manager.adoc test -n "$${NOVIEW}" || man -l $@ +pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES} + a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${DOCRELEASE}" -f manpage pve-ha-crm.adoc + test -n "$${NOVIEW}" || man -l $@ + %.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES} a2x -a docinfo1 -a "manvolnum=5" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc test -n "$${NOVIEW}" || man -l $@ diff --git a/pve-ha-crm.8-synopsis.adoc b/pve-ha-crm.8-synopsis.adoc new file mode 100644 index 0000000..ad02399 --- /dev/null +++ b/pve-ha-crm.8-synopsis.adoc @@ -0,0 +1,40 @@ +*pve-ha-crm* ` [ARGS] [OPTIONS]` + +*pve-ha-crm help* `[]` `[OPTIONS]` + +Get help about specified command. + +`` `string` :: + +Command name + +`-verbose` `boolean` :: + +Verbose output format. + + + + +*pve-ha-crm start* `[OPTIONS]` + +Start the daemon. + +`-debug` `boolean` (default=`0`):: + +Debug mode - stay in foreground + + + +*pve-ha-crm status* + +Get daemon status. + + + +*pve-ha-crm stop* + +Stop the daemon. + + + + diff --git a/pve-ha-crm.adoc b/pve-ha-crm.adoc new file mode 100644 index 0000000..547f1f9 --- /dev/null +++ b/pve-ha-crm.adoc @@ -0,0 +1,31 @@ +ifdef::manvolnum[] +PVE({manvolnum}) +================ +include::attributes.txt[] + +NAME +---- + +pve-ha-crm - PVE Cluster Ressource Manager Daemon + + +SYNOPSYS +-------- + +include::pve-ha-crm.8-synopsis.adoc[] + +DESCRIPTION +----------- +endif::manvolnum[] + +ifndef::manvolnum[] +Cluster Ressource Manager Daemon +================================ +include::attributes.txt[] +endif::manvolnum[] + +This is the Cluster Ressource Manager Daemon. + +ifdef::manvolnum[] +include::pve-copyright.adoc[] +endif::manvolnum[] -- 2.39.2