Start updating QEMU reference doc

All the listed options should be valid, still missing formatting and
actual documentation.

1 files changed, 100 insertions, 68 deletions

diff --git a/books/docbook/SpiceUserManual-References.xml b/books/docbook/SpiceUserManual-References.xml
index 562c5ab..6fcee02 100644
--- a/books/docbook/SpiceUserManual-References.xml
+++ b/books/docbook/SpiceUserManual-References.xml
@@ -9,18 +9,30 @@
     <section xml:id="commandline-spice">
         <title>QEMU Spice command line options</title>
         <para>
+            They are covered in <link xlink:href="http://qemu.weilnetz.de/qemu-doc.html#index-g_t_002dspice-58">QEMU online documentation</link>.
             Basic syntax is -spice &lt;spice_options&gt;
         </para>
+
         <itemizedlist>
             <listitem>
-                [port=&lt;port&gt;][,tls-port=&lt;tls-port&gt;][,host=&lt;host&gt;]
-                Listen on interface address &lt;host> (if given, otherwise any interface)
+                [port=&lt;port&gt;][,tls-port=&lt;tls-port&gt;][,addr=&lt;addr&gt;]
+                Listen on interface addr &lt;addr> (if given, otherwise any interface)
                 using port &lt;port&gt; and/or tls-port &lt;tls-port&gt; (at least one of them must be given)
             </listitem>
 
+            <listitem>
+                ipv4=&lt;on|off&gt;
+                IPv4 only (default:off)
+            </listitem>
+
+            <listitem>
+                ipv6=&lt;on|off&gt;
+                IPv6 only (default:off)
+            </listitem>
+
 <!-- Image, video & audio options -->
             <listitem>
-                ic=on|auto_glz|auto_lz|quic|glz|lz|off
+                image-compression=on|auto_glz|auto_lz|quic|glz|lz|off
                 Set image compression (default=on=auto_glz)
                 quic is based on the SFALIC algorithm
                 lz is the Lempel-Ziv algorithm, glz uses lz with history based global dictionary
@@ -29,18 +41,23 @@
             </listitem>
 
             <listitem>
-                sv=&lt;on|off&gt;
-                Set video streams detection and (lossy) compression (default=on)
+                streaming-video=&lt;all|filter|off&gt;
+                Set video streams detection and (lossy) compression (default=filter)
+            </listitem>
+
+            <listitem>
+                playback-compression=&lt;on|off&gt;
+                Set playback compression, using the CELT algorithm (default=on)
             </listitem>
 
             <listitem>
-                renderer=&lt;oglpbuf+oglpixmap+cairo&gt;
-                Select renderers. Multiple choice prioritized by order (default=cairo)
+                jpeg-wan-compression=&lt;auto|never|always&gt;
+                (default = auto)
             </listitem>
 
             <listitem>
-                playback-compression=&lt;on|off&gt;
-                Set playback compression, using the CELT algorithm (default=on)
+                zlib-glz-wan-compression=&lt;auto|never|always&gt;
+                (default = auto)
             </listitem>
 
 <!-- Security options -->
@@ -55,42 +72,52 @@
             </listitem>
 
             <listitem>
-                sslkey=&lt;key_file&gt;
-                SSL private key file
+                sasl=&lt;on|off&gt;
             </listitem>
 
             <listitem>
-                sslcert=&lt;cert_file&gt;
-                SSL certificate file (self signed or chain of certificates). The certificate is currently not verified by the client, and used only for sending the server public key to the client.
+                x509-dir=&lt;dir_name&gt;
             </listitem>
 
             <listitem>
-                sslcafile=&lt;ca_file&gt;
-                SSL certificates file of the trusted CA (certificate authority) and CRL (certificate revocation list)
+                x509-key-file=&lt;key_file&gt;
+                TLS private key file
             </listitem>
 
             <listitem>
-                ssldhfile=&lt;dh_file&gt;
-                Symmetric Diffie-Hellman key file
+                x509-key-password=&lt;pem_password&gt;
+                Password to open the private key file which is in PEM format
             </listitem>
 
             <listitem>
-                sslpassword=&lt;pem_password&gt;
-                Password to open the private key file which is in PEM format
+                x509-cert-file=&lt;cert_file&gt;
+                TLS certificate file
+            </listitem>
+
+            <listitem>
+                tls-cacert-file=&lt;ca_file&gt;
+                SSL certificates file of the trusted CA (certificate authority) and CRL (certificate revocation list)
+            </listitem>
+
+            <listitem>
+                x509-dh-key-file=&lt;dh_file&gt;
+                Symmetric Diffie-Hellman key file
             </listitem>
 
             <listitem>
-                sslciphersuite=&lt;cipher_suite&gt;
-                Cipher suite to use, see http://www.openssl.org/docs/apps/ciphers.html
+                tls-ciphers=&lt;ciphers&gt;
+                Cipher suite to use, see http://www.openssl.org/docs/apps/ciphers.html or ciphers(1)
             </listitem>
 
             <listitem>
-                secure-channels=[all|ch0+ch1+...]
-                unsecure-channels=[all|ch0+ch1+...]
-                Force secured/unsecured connection on all/specific channels
+                tls-channel=[all|channel_name]
+                plaintext-channel=[all|channel_name]
+                Force TLS/plain text connection on all/specific channels. This option
+                can be specified multiple times in order to force multiple channels
+                to use TLS or plain text.
                 Channels are: main, display, inputs, cursor, playback and record
-                By default, any channel allows both secured and unsecured connection, depending on the
-                port and sport parameters.
+                By default, any channel allows both TLS and plain text connection, depending on the
+                port and tls-port parameters.
             </listitem>
 
 <!-- Other options -->
@@ -99,86 +126,91 @@
                 agent-mouse=&lt;on|off&gt;
                 Define whether spice agent is used for client mouse mode (default=on)
             </listitem>
+
+            <listitem>
+                disable-copy-paste=&lt;on|off&gt;
+                (default=off)
+            </listitem>
+
+            <listitem>
+                disable-agent-file-xfer=&lt;on|off&gt;
+                (default=off)
+            </listitem>
+
+            <listitem>
+                seamless-migration=&lt;on|off&gt;
+                (default=off)
+            </listitem>
         </itemizedlist>
     </section>
 
     <section xml:id="commandline-qxl">
         <title>QEMU QXL command line options</title>
         <itemizedlist>
-        </itemizedlist>
-    </section>
-
-    <section xml:id="console-control">
-        <title>QEMU Console Spice control commands</title>
-        <itemizedlist>
             <listitem>
-                spice.set_image_compression &lt;on|auto_glz|auto_lz|quic|glz|lz|off&gt;
-                refer to the ic spice option
+                ram_size
             </listitem>
-
             <listitem>
-                spice.set_streaming_video &lt;on|off&gt;
-                Set video streams detection and compression
+                vram_size
             </listitem>
-
             <listitem>
-                spice.set_playback_compression &lt;on|off&gt;
-                Set playback compression
+                revision
             </listitem>
-
             <listitem>
-                spice.set_ticket &lt;password&gt; [expiration=&lt;seconds&gt; [,connected=keep|disconnect|fail]
-                Set the spice connection ticket (one time password), with expiration and behavior when already connected. An empty password prevents any connection. A zero value for expiration means the password never expires.
+                debug
             </listitem>
-
             <listitem>
-                spice.set_ticket64
-                Same as set_ticket, but using base64 for printable ASCII password.
+                guestdebug
             </listitem>
-
             <listitem>
-                spice.disable_ticketing
-                Entirely disables password, so any client is allowed to connect.
+                cmdlog
             </listitem>
-
             <listitem>
-                spice.set_agent_mouse &lt;on|off&gt;
-                Define whether guest agent is used for client mouse mode
+                ram_size_mb
             </listitem>
-
             <listitem>
-                spice.reset_stat
-                Reset spice statistics
+                vram_size_mb
+            </listitem>
+            <listitem>
+                vram64_size_mb
+            </listitem>
+            <listitem>
+                vgamem_mb
             </listitem>
-
             <listitem>
-                spice.ping_client [on [interval]|off]
-                Ping spice client to measure round-trip. Single ping needs no parameter. Repeating ping is started with 'on' and sent every 'interval' (default is 1 second). Pinging is stopped with 'off'.
+                surfaces
             </listitem>
         </itemizedlist>
     </section>
 
-    <section xml:id="console-info">
-        <title>QEMU Console Spice info commands</title>
+    <section xml:id="console-control">
+        <title>QEMU Console Spice control commands</title>
         <itemizedlist>
             <listitem>
-                info spice.state
-                Show current spice state, including client address (if connected), ticketing, image compression, video  streaming and playback compression.
+                set_password spice &lt;password&gt; [keep|disconnect]
+                Set the spice connection ticket (one time password). An
+                empty password prevents any connection. keep/disconnect
+                indicates what to do if a client is already connected
+                when the command is issued.
             </listitem>
 
             <listitem>
-                info spice.ticket
-                Show ticket expiration (if enabled)
+                expire_password
             </listitem>
 
             <listitem>
-                info spice.stat
-                Show spice statistics
+                client_migrate_info
             </listitem>
 
+        </itemizedlist>
+    </section>
+
+    <section xml:id="console-info">
+        <title>QEMU Console Spice info commands</title>
+        <itemizedlist>
             <listitem>
-                info spice.rtt_client
-                Show round trip time (minimum, maximum &amp; average) to spice client after pinging it.
+                info spice
+                Show current spice state
             </listitem>
         </itemizedlist>
     </section>