[pve-devel] [PATCH docs v4 1/1] add qmeventd manpage

[Dominik Csapak]

Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
---
new in v4
 Makefile                 |  3 ++-
 pve-doc-generator.mk.in  |  2 +-
 qmeventd.8-synopsis.adoc | 16 ++++++++++++++++
 qmeventd.adoc            | 33 +++++++++++++++++++++++++++++++++
 4 files changed, 52 insertions(+), 2 deletions(-)
 create mode 100644 qmeventd.8-synopsis.adoc
 create mode 100644 qmeventd.adoc

diff --git a/Makefile b/Makefile
index 4f8e0d4..5d65454 100644
--- a/Makefile
+++ b/Makefile
@@ -41,6 +41,7 @@ GEN_DEB_SOURCES=				\
 	pve-doc-generator.mk			\
 	${MANUAL_SOURCES}			\
 	pmxcfs.8-synopsis.adoc			\
+	qmeventd.8-synopsis.adoc		\
 	docinfo.xml
 
 GEN_SCRIPTS=					\
@@ -228,7 +229,7 @@ update-static:
 
 .PHONY: clean-static
 clean-static:
-	find . -regex '.*-\(opts\|synopsis\)\.adoc' -not -name pmxcfs.8-synopsis.adoc -exec rm -f \{\} \;
+	find . -regex '.*-\(opts\|synopsis\)\.adoc' -not -name pmxcfs.8-synopsis.adoc -not name qmeventd.8-synopsis.adoc -exec rm -f \{\} \;
 	rm -f api-viewer/apidata.js
 	rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
 
diff --git a/pve-doc-generator.mk.in b/pve-doc-generator.mk.in
index 9ff8eeb..7fc159d 100644
--- a/pve-doc-generator.mk.in
+++ b/pve-doc-generator.mk.in
@@ -16,7 +16,7 @@ PVE_COMMON_DOC_SOURCES=                 \
 
 all:
 
-attributes.txt docinfo.xml pmxcfs.8-synopsis.adoc:
+attributes.txt docinfo.xml pmxcfs.8-synopsis.adoc qmeventd.8-synopsis.adoc:
 	cp ${DGDIR}/$@ $@.tmp
 	mv $@.tmp $@
 
diff --git a/qmeventd.8-synopsis.adoc b/qmeventd.8-synopsis.adoc
new file mode 100644
index 0000000..5733256
--- /dev/null
+++ b/qmeventd.8-synopsis.adoc
@@ -0,0 +1,16 @@
+*qmeventd* `[-f]` `[-v]` `PATH`
+
+`-v`:: Turn on verbose messages
+
+`-f`:: Do not daemonize server
+
+`PATH`:: The path to listen on
+
+This service is usually started and managed using systemd toolset. The
+service is called 'qmeventd'.
+
+ systemctl start qmeventd
+
+ systemctl stop qmeventd
+
+ systemctl status qmeventd
diff --git a/qmeventd.adoc b/qmeventd.adoc
new file mode 100644
index 0000000..4e89e7d
--- /dev/null
+++ b/qmeventd.adoc
@@ -0,0 +1,33 @@
+ifdef::manvolnum[]
+qmeventd(8)
+===========
+:pve-toplevel:
+
+NAME
+----
+
+qmeventd - PVE Qemu Eventd Daemon
+
+SYNOPSIS
+--------
+
+include::qmeventd.8-synopsis.adoc[]
+
+DESCRIPTION
+-----------
+endif::manvolnum[]
+
+ifndef::manvolnum[]
+PVE Qemu Event Daemon
+=====================
+:pve-toplevel:
+endif::manvolnum[]
+
+`qmeventd` is a daemon that listens on PATH for incoming connections from
+a qemu qmp socket, and waits for SHUTDOWN events. When a client then
+disconnects, it executes `/usr/sbin/qm cleanup`. This makes it easy
+to clean up leftover tap devices, vgpus, etc.
+
+ifdef::manvolnum[]
+include::pve-copyright.adoc[]
+endif::manvolnum[]
-- 
2.11.0