5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-03-20 22:50:06 +03:00

add pvestatd manual page

This commit is contained in:
Dietmar Maurer 2016-04-09 10:41:09 +02:00
parent 427b88e5d7
commit 4db6a3f387
6 changed files with 98 additions and 1 deletions

View File

@ -38,6 +38,7 @@ DEB_SOURCES= \
ha-manager.adoc \
pve-ha-crm.adoc \
pve-ha-lrm.adoc \
pvestatd.adoc \
pve-copyright.adoc \
docinfo.xml
@ -130,7 +131,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 pve-ha-lrm.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 pvestatd.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

@ -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]
| pvestatd | link:pvestatd.8.html[pvestatd.8]
| 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]

View File

@ -140,6 +140,15 @@ include::pve-ha-lrm.8-synopsis.adoc[]
:leveloffset: 0
*pvestatd* - {PVE} Status Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pvestatd.8-synopsis.adoc[]
:leveloffset: 0
[appendix]
Configuration Files
-------------------

View File

@ -83,6 +83,11 @@ PVE_HA_LRM_MAN8_SOURCES= \
pve-ha-lrm.8-synopsis.adoc \
${PVE_COMMON_DOC_SOURCES}
PVESTATD_MAN8_SOURCES= \
pvestatd.adoc \
pvestatd.8-synopsis.adoc \
${PVE_COMMON_DOC_SOURCES}
attributes.txt docinfo.xml:
cp ${DGDIR}/$@ $@.tmp
mv $@.tmp $@
@ -154,6 +159,10 @@ pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
a2x ${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
test -n "$${NOVIEW}" || man -l $@
pvestatd.8: ${PVESTATD_MAN8_SOURCES}
a2x ${A2X_MAN8_OPTIONS} pvestatd.adoc
test -n "$${NOVIEW}" || man -l $@
qm.conf.5: ${QM_CONF_MAN5_SOURCE}
pct.conf.5: ${PCT_CONF_MAN5_SOURCE}

46
pvestatd.8-synopsis.adoc Normal file
View File

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

31
pvestatd.adoc Normal file
View File

@ -0,0 +1,31 @@
ifdef::manvolnum[]
PVE({manvolnum})
================
include::attributes.txt[]
NAME
----
pvestatd - PVE Status Daemon
SYNOPSYS
--------
include::pvestatd.8-synopsis.adoc[]
DESCRIPTION
-----------
endif::manvolnum[]
ifndef::manvolnum[]
{pve} Status Daemon
==============================
include::attributes.txt[]
endif::manvolnum[]
This daemom queries the status of VMs, storages and containers at
regular intervals. The result is sent to all nodes in the cluster.
ifdef::manvolnum[]
include::pve-copyright.adoc[]
endif::manvolnum[]