From: Dietmar Maurer <dietmar@proxmox.com>
Date: Sun, 10 Apr 2016 12:35:23 +0000 (+0200)
Subject: add spiceproxy man page
X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=commitdiff_plain;h=2d8f1c9267103ca279abcde3e8413866020ae323;hp=15d7842ca3a9bc0695ccfabd5e12c7c910061a4b

add spiceproxy man page
---

diff --git a/Makefile b/Makefile
index dd9d172..9d6d6fa 100644
--- a/Makefile
+++ b/Makefile
@@ -20,6 +20,7 @@ SERVICE_LIST=		\
 	pvestatd 	\
 	pmxcfs 		\
 	pveproxy	\
+	spiceproxy	\
 	pvedaemon
 
 CONFIG_LIST=datacenter.cfg qm.conf pct.conf
@@ -80,6 +81,10 @@ PVE_ADMIN_GUIDE_SOURCES=			\
 	${QM_MAN1_SOURCES}			\
 	${QMRESTORE_MAN1_SOURCES}		\
 	${HA_MANAGER_MAN1_SOURCES}		\
+	${PVESTATD_MAN8_SOURCES}		\
+	${PVEDAEMON_MAN8_SOURCES}		\
+	${PVEPROXY_MAN8_SOURCES}		\
+	${SPICEPROXY_MAN8_SOURCES}		\
 	${PVE_HA_CRM_MAN8_SOURCES}		\
 	${PVE_HA_LRM_MAN8_SOURCES}		\
 	${PVEAM_SOURCES}			\
diff --git a/index.adoc b/index.adoc
index 37f8e07..3c2dadb 100644
--- a/index.adoc
+++ b/index.adoc
@@ -45,6 +45,7 @@ Service Daemons
 | pvedaemon    | pvedaemon.service    |link:pvedaemon.8.html[pvedaemon.8]
 | pveproxy     | pveproxy.service     |link:pveproxy.8.html[pveproxy.8]
 | pvestatd     | pvestatd.service     |link:pvestatd.8.html[pvestatd.8]
+| spiceproxy   | spiceproxy.service   |link:spiceproxy.8.html[spiceproxy.8]
 | pve-ha-crm   | pve-ha-crm.service   |link:pve-ha-crm.8.html[pve-ha-crm.8]
 | pve-ha-lrm   | pve-ha-lrm.service   |link:pve-ha-lrm.8.html[pve-ha-lrm.8]
 | pve-firewall | pve-firewall.service |link:pve-firewall.8.html[pve-firewall.8]
diff --git a/pve-admin-guide.adoc b/pve-admin-guide.adoc
index 3482f0a..3bce1e4 100644
--- a/pve-admin-guide.adoc
+++ b/pve-admin-guide.adoc
@@ -45,6 +45,8 @@ include::pveproxy.adoc[]
 
 include::pvestatd.adoc[]
 
+include::spiceproxy.adoc[]
+
 :leveloffset: 0
 
 
@@ -149,6 +151,7 @@ include::pve-firewall.8-synopsis.adoc[]
 include::pvedaemon.8-synopsis.adoc[]
 
 :leveloffset: 0
+
 *pveproxy* - {pve} API Proxy Daemon
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -166,6 +169,15 @@ include::pvestatd.8-synopsis.adoc[]
 
 :leveloffset: 0
 
+*spiceproxy* - SPICE Proxy Service
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+:leveloffset: 1
+
+include::spiceproxy.8-synopsis.adoc[]
+
+:leveloffset: 0
+
 *pmxcfs* - Proxmox Cluster File System
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/pve-doc-generator.mk b/pve-doc-generator.mk
index 281f882..ce7183e 100644
--- a/pve-doc-generator.mk
+++ b/pve-doc-generator.mk
@@ -103,6 +103,11 @@ PVEPROXY_MAN8_SOURCES=			\
 	pveproxy.8-synopsis.adoc	\
 	${PVE_COMMON_DOC_SOURCES}
 
+SPICEPROXY_MAN8_SOURCES=		\
+	spiceproxy.adoc			\
+	spiceproxy.8-synopsis.adoc	\
+	${PVE_COMMON_DOC_SOURCES}
+
 PMXCFS_MAN8_SOURCES=			\
 	pmxcfs.adoc			\
 	pmxcfs.8-cli.adoc		\
@@ -191,6 +196,10 @@ pveproxy.8: ${PVEPROXY_MAN8_SOURCES}
 	a2x ${A2X_MAN8_OPTIONS} pveproxy.adoc
 	test -n "$${NOVIEW}" || man -l $@
 
+spiceproxy.8: ${SPICEPROXY_MAN8_SOURCES}
+	a2x ${A2X_MAN8_OPTIONS} spiceproxy.adoc
+	test -n "$${NOVIEW}" || man -l $@
+
 pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
 	a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
 	test -n "$${NOVIEW}" || man -l $@
diff --git a/spiceproxy.8-synopsis.adoc b/spiceproxy.8-synopsis.adoc
new file mode 100644
index 0000000..37394d3
--- /dev/null
+++ b/spiceproxy.8-synopsis.adoc
@@ -0,0 +1,46 @@
+*spiceproxy* `<COMMAND> [ARGS] [OPTIONS]`
+
+*spiceproxy help* `[<cmd>]` `[OPTIONS]`
+
+Get help about specified command.
+
+`<cmd>` `string` ::
+
+Command name
+
+`-verbose` `boolean` ::
+
+Verbose output format.
+
+
+
+
+*spiceproxy restart*
+
+Restart the daemon (or start if not running).
+
+
+
+*spiceproxy start* `[OPTIONS]`
+
+Start the daemon.
+
+`-debug` `boolean` (default=`0`)::
+
+Debug mode - stay in foreground
+
+
+
+*spiceproxy status*
+
+Get daemon status.
+
+
+
+*spiceproxy stop*
+
+Stop the daemon.
+
+
+
+
diff --git a/spiceproxy.adoc b/spiceproxy.adoc
new file mode 100644
index 0000000..33737e7
--- /dev/null
+++ b/spiceproxy.adoc
@@ -0,0 +1,48 @@
+ifdef::manvolnum[]
+PVE({manvolnum})
+================
+include::attributes.txt[]
+
+NAME
+----
+
+spiceproxy - SPICE Proxy Service
+
+
+SYNOPSYS
+--------
+
+include::spiceproxy.8-synopsis.adoc[]
+
+DESCRIPTION
+-----------
+endif::manvolnum[]
+
+ifndef::manvolnum[]
+SPICE Proxy Service
+===================
+include::attributes.txt[]
+endif::manvolnum[]
+
+http://www.spice-space.org[SPICE] (the Simple Protocol for Independent
+Computing Environments) is an open remote computing solution,
+providing client access to remote displays and devices (e.g. keyboard,
+mouse, audio). The main use case is to get remote access to virtual
+machines and container.
+
+This daemon listens on TCP port 3128, and implements an HTTP proxy to
+forward 'CONNECT' request from the SPICE client to the correct {pve}
+VM. It runs as user 'www-data' and has very limited permissions.
+
+
+Host based Access Control
+-------------------------
+
+It is possible to configure "apache2" like access control
+lists. Values are read from file '/etc/default/pveproxy'.
+See 'pveproxy' documentation for details.
+
+
+ifdef::manvolnum[]
+include::pve-copyright.adoc[]
+endif::manvolnum[]