add pve-ha-lrm man page
authorDietmar Maurer <dietmar@proxmox.com>
Fri, 8 Apr 2016 06:20:12 +0000 (08:20 +0200)
committerDietmar Maurer <dietmar@proxmox.com>
Fri, 8 Apr 2016 06:20:12 +0000 (08:20 +0200)
Makefile
index.adoc
pve-admin-guide.adoc
pve-doc-generator.mk
pve-ha-lrm.8-synopsis.adoc [new file with mode: 0644]
pve-ha-lrm.adoc [new file with mode: 0644]

index 18c8753..4d72493 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -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 &
 
index e1ee463..86e2624 100644 (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]
index 4d2e1b8..601c735 100644 (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
 -------------------
index 3e4e0d7..4f90dbe 100644 (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 $@
diff --git a/pve-ha-lrm.8-synopsis.adoc b/pve-ha-lrm.8-synopsis.adoc
new file mode 100644 (file)
index 0000000..a11ee59
--- /dev/null
@@ -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.
+
+
+
+
diff --git a/pve-ha-lrm.adoc b/pve-ha-lrm.adoc
new file mode 100644 (file)
index 0000000..9b063ed
--- /dev/null
@@ -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[]