add pve-ha-lrm man page

This commit is contained in:
Dietmar Maurer 2016-04-08 08:20:12 +02:00
parent 47e1b0c6ff
commit 954a26fd27
6 changed files with 92 additions and 1 deletions

View File

@ -37,6 +37,7 @@ DEB_SOURCES= \
pveam.adoc \
ha-manager.adoc \
pve-ha-crm.adoc \
pve-ha-lrm.adoc \
pve-copyright.adoc \
docinfo.xml
@ -81,6 +82,7 @@ PVE_ADMIN_GUIDE_SOURCES= \
${QMRESTORE_MAN1_SOURCES} \
${HA_MANAGER_MAN1_SOURCES} \
${PVE_HA_CRM_MAN8_SOURCES} \
${PVE_HA_LRM_MAN8_SOURCES} \
${PVEAM_SOURCES} \
${VZDUMP_SOURCES} \
images/cluster-nwdiag.svg \
@ -128,7 +130,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 pve-ha-crm.8.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 pve-ha-lrm.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 &

View File

@ -31,6 +31,7 @@ include::attributes.txt[]
| 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-ha-lrm | link:pve-ha-lrm.8.html[pve-ha-lrm.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/<VMID>.conf' | link:vm.conf.5.html[vm.conf.5]

View File

@ -132,6 +132,14 @@ include::pve-ha-crm.8-synopsis.adoc[]
:leveloffset: 0
*pve-ha-lrm* - Local Ressource Manager Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pve-ha-lrm.8-synopsis.adoc[]
:leveloffset: 0
[appendix]
Configuration Files
-------------------

View File

@ -68,6 +68,11 @@ PVE_HA_CRM_MAN8_SOURCES= \
pve-ha-crm.8-synopsis.adoc \
${PVE_COMMON_DOC_SOURCES}
PVE_HA_LRM_MAN8_SOURCES= \
pve-ha-lrm.adoc \
pve-ha-lrm.8-synopsis.adoc \
${PVE_COMMON_DOC_SOURCES}
attributes.txt docinfo.xml:
cp ${DGDIR}/$@ $@.tmp
mv $@.tmp $@
@ -130,6 +135,10 @@ 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 $@
pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${DOCRELEASE}" -f manpage pve-ha-lrm.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 $@

View File

@ -0,0 +1,40 @@
*pve-ha-lrm* `<COMMAND> [ARGS] [OPTIONS]`
*pve-ha-lrm help* `[<cmd>]` `[OPTIONS]`
Get help about specified command.
`<cmd>` `string` ::
Command name
`-verbose` `boolean` ::
Verbose output format.
*pve-ha-lrm start* `[OPTIONS]`
Start the daemon.
`-debug` `boolean` (default=`0`)::
Debug mode - stay in foreground
*pve-ha-lrm status*
Get daemon status.
*pve-ha-lrm stop*
Stop the daemon.

31
pve-ha-lrm.adoc Normal file
View File

@ -0,0 +1,31 @@
ifdef::manvolnum[]
PVE({manvolnum})
================
include::attributes.txt[]
NAME
----
pve-ha-lrm - PVE Local Ressource Manager Daemon
SYNOPSYS
--------
include::pve-ha-lrm.8-synopsis.adoc[]
DESCRIPTION
-----------
endif::manvolnum[]
ifndef::manvolnum[]
Local Ressource Manager Daemon
==============================
include::attributes.txt[]
endif::manvolnum[]
This is the Local Ressource Manager Daemon.
ifdef::manvolnum[]
include::pve-copyright.adoc[]
endif::manvolnum[]