This cleanups the documentation, reformat some of the paragraphs to use
instead of and rewrites the listen part to be more extendable.
Signed-off-by: Pavel Hrdina
---
docs/formatdomain.html.in | 351 ++
1 file changed, 169 insertions(+), 182 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 957b839..c43c737 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -4933,108 +4933,113 @@ qemu-kvm -net nic,model=? /dev/null
graphics
- The graphics element has a mandatory type
-attribute which takes the value "sdl", "vnc", "spice", "rdp" or
-"desktop":
+
+
+ The graphics element has a mandatory type
+ attribute which takes the value sdl, vnc,
+ spice, rdp or desktop:
+
"sdl"
-This displays a window on the host desktop, it can take 3
-optional arguments: a display attribute for
-the display to use, an xauth attribute for
-the authentication identifier, and an
-optional fullscreen attribute accepting
-values 'yes' or 'no'.
+
+ This displays a window on the host desktop, it can take 3
optional
+ arguments: a display attribute for the display to
use,
+ an xauth attribute for the authentication
identifier,
+ and an optional fullscreen attribute accepting
values
+ yes or no.
+
"vnc"
-Starts a VNC server. The port attribute
-specifies the TCP port number (with -1 as legacy syntax
-indicating that it should be
-auto-allocated). The autoport attribute is
-the new preferred syntax for indicating autoallocation of
-the TCP port to use. The listen attribute is
-an IP address for the server to listen
-on. The passwd attribute provides a VNC
-password in clear text. The keymap attribute
-specifies the keymap to use. It is possible to set a limit
-on the validity of the password be giving an
-timestamp passwdValidTo='2010-04-09T15:51:00'
-assumed to be in UTC. The connected attribute
-allows control of connected client during password changes.
-VNC accepts keep value only.
-since 0.9.3
-NB, this may not be supported by all hypervisors.
-The optional sharePolicy attribute specifies vnc
server
-display sharing policy. "allow-exclusive" allows clients to ask
-for exclusive access by dropping other connections. Connecting
-multiple clients in parallel requires all clients asking for a
-shared session (vncviewer: -Shared switch). This is the default
-value. "force-shared" disables exclusive client access, every
-connection has to specify -Shared switch for vncviewer. "ignore"
-welcomes every connection unconditionally
-since 1.0.6.
-Rather than using listen/port, QEMU supports a
-socket attribute for listening on a unix
-domain socket path.Since 0.8.8
-
-For VNC WebSocket functionality, websocket
-attribute may be used to specify port to listen on (with
--1 meaning auto-allocation and autoport
-having no effect due to security reasons).
-Since 1.0.6
+
+ Starts a VNC server. The port attribute specifies
+ the TCP port number (with -1 as legacy syntax indicating that it
+ should be auto-allocated). The autoport attribute is
+ the new preferred syntax for indicating auto-allocation of the
TCP
+ port to use. The listen attribute is an IP address
+ for the server to listen on. The passwd attribute
+ provides a VNC password in clear text. The keymap
+ attribute specifies the keymap to use. It is possible to set
+ a limit on the validity of the password by giving an timestamp
+ passwdValidTo='2010-04-09T15:51:00' assumed to be
+ in UTC. The connected attribute allows control of
+ connected client during password changes. VNC accepts
+ keep value only since
0.9.3.
+ NB, this may not be supported by all hypervisors.
+
+
+ The optional sharePolicy attribute specifies vnc
+ server display sharing policy. allow-exclusive
allows
+ clients to ask for exclusive access by dropping other
connections.
+ Connecting multiple clients in parallel requires all clients
asking
+ for a shared session (vncviewer: -Shared switch). This