Initial import of QEMU Spice reference

It's based on the Spice User Manual .odt file and must be quite
outdated. The goal here is to have the structure ready.

1 files changed, 179 insertions, 5 deletions

diff --git a/books/docbook/SpiceUserManual-References.xml b/books/docbook/SpiceUserManual-References.xml
index d2da673..562c5ab 100644
--- a/books/docbook/SpiceUserManual-References.xml
+++ b/books/docbook/SpiceUserManual-References.xml
@@ -4,9 +4,183 @@
 <chapter xmlns="http://docbook.org/ns/docbook" 
     xmlns:xi="http://www.w3.org/2001/XInclude"
     xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
-    <title>References</title>
-    <orderedlist numeration="arabic">
-        <listitem xml:id="spice_protocol_defs"><para>Spice remote computing protocol definition</para></listitem>
-    </orderedlist>
-    
+    <title>QEMU Spice Reference</title>
+
+    <section xml:id="commandline-spice">
+        <title>QEMU Spice command line options</title>
+        <para>
+            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)
+                using port &lt;port&gt; and/or tls-port &lt;tls-port&gt; (at least one of them must be given)
+            </listitem>
+
+<!-- Image, video & audio options -->
+            <listitem>
+                ic=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
+                The auto_[glz/lz] modes choose between the [glz/lz] and quic,
+                based on the image properties
+            </listitem>
+
+            <listitem>
+                sv=&lt;on|off&gt;
+                Set video streams detection and (lossy) compression (default=on)
+            </listitem>
+
+            <listitem>
+                renderer=&lt;oglpbuf+oglpixmap+cairo&gt;
+                Select renderers. Multiple choice prioritized by order (default=cairo)
+            </listitem>
+
+            <listitem>
+                playback-compression=&lt;on|off&gt;
+                Set playback compression, using the CELT algorithm (default=on)
+            </listitem>
+
+<!-- Security options -->
+            <listitem>
+                disable-ticketing
+                Enables client connection with no password.
+            </listitem>
+
+            <listitem>
+                password=&lt;password&gt;
+                Set ticket password, which must be used by a client for connection. The passwords never expires.
+            </listitem>
+
+            <listitem>
+                sslkey=&lt;key_file&gt;
+                SSL private key file
+            </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.
+            </listitem>
+
+            <listitem>
+                sslcafile=&lt;ca_file&gt;
+                SSL certificates file of the trusted CA (certificate authority) and CRL (certificate revocation list)
+            </listitem>
+
+            <listitem>
+                ssldhfile=&lt;dh_file&gt;
+                Symmetric Diffie-Hellman key file
+            </listitem>
+
+            <listitem>
+                sslpassword=&lt;pem_password&gt;
+                Password to open the private key file which is in PEM format
+            </listitem>
+
+            <listitem>
+                sslciphersuite=&lt;cipher_suite&gt;
+                Cipher suite to use, see http://www.openssl.org/docs/apps/ciphers.html
+            </listitem>
+
+            <listitem>
+                secure-channels=[all|ch0+ch1+...]
+                unsecure-channels=[all|ch0+ch1+...]
+                Force secured/unsecured connection on all/specific channels
+                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.
+            </listitem>
+
+<!-- Other options -->
+
+            <listitem>
+                agent-mouse=&lt;on|off&gt;
+                Define whether spice agent is used for client mouse mode (default=on)
+            </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
+            </listitem>
+
+            <listitem>
+                spice.set_streaming_video &lt;on|off&gt;
+                Set video streams detection and compression
+            </listitem>
+
+            <listitem>
+                spice.set_playback_compression &lt;on|off&gt;
+                Set playback compression
+            </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.
+            </listitem>
+
+            <listitem>
+                spice.set_ticket64
+                Same as set_ticket, but using base64 for printable ASCII password.
+            </listitem>
+
+            <listitem>
+                spice.disable_ticketing
+                Entirely disables password, so any client is allowed to connect.
+            </listitem>
+
+            <listitem>
+                spice.set_agent_mouse &lt;on|off&gt;
+                Define whether guest agent is used for client mouse mode
+            </listitem>
+
+            <listitem>
+                spice.reset_stat
+                Reset spice statistics
+            </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'.
+            </listitem>
+        </itemizedlist>
+    </section>
+
+    <section xml:id="console-info">
+        <title>QEMU Console Spice info commands</title>
+        <itemizedlist>
+            <listitem>
+                info spice.state
+                Show current spice state, including client address (if connected), ticketing, image compression, video  streaming and playback compression.
+            </listitem>
+
+            <listitem>
+                info spice.ticket
+                Show ticket expiration (if enabled)
+            </listitem>
+
+            <listitem>
+                info spice.stat
+                Show spice statistics
+            </listitem>
+
+            <listitem>
+                info spice.rtt_client
+                Show round trip time (minimum, maximum &amp; average) to spice client after pinging it.
+            </listitem>
+        </itemizedlist>
+    </section>
+
 </chapter>