From 0b1bfb5c89e89968239c6b2bbe372d8224636dfc Mon Sep 17 00:00:00 2001 From: Christophe Fergeau Date: Wed, 25 Sep 2013 17:23:38 +0200 Subject: 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. --- books/docbook/SpiceUserManual-References.xml | 184 ++++++++++++++++++++++++++- 1 file 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 @@ - References - - Spice remote computing protocol definition - - + QEMU Spice Reference + +
+ QEMU Spice command line options + + Basic syntax is -spice <spice_options> + + + + [port=<port>][,tls-port=<tls-port>][,host=<host>] + Listen on interface address <host> (if given, otherwise any interface) + using port <port> and/or tls-port <tls-port> (at least one of them must be given) + + + + + 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 + + + + sv=<on|off> + Set video streams detection and (lossy) compression (default=on) + + + + renderer=<oglpbuf+oglpixmap+cairo> + Select renderers. Multiple choice prioritized by order (default=cairo) + + + + playback-compression=<on|off> + Set playback compression, using the CELT algorithm (default=on) + + + + + disable-ticketing + Enables client connection with no password. + + + + password=<password> + Set ticket password, which must be used by a client for connection. The passwords never expires. + + + + sslkey=<key_file> + SSL private key file + + + + sslcert=<cert_file> + 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. + + + + sslcafile=<ca_file> + SSL certificates file of the trusted CA (certificate authority) and CRL (certificate revocation list) + + + + ssldhfile=<dh_file> + Symmetric Diffie-Hellman key file + + + + sslpassword=<pem_password> + Password to open the private key file which is in PEM format + + + + sslciphersuite=<cipher_suite> + Cipher suite to use, see http://www.openssl.org/docs/apps/ciphers.html + + + + 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. + + + + + + agent-mouse=<on|off> + Define whether spice agent is used for client mouse mode (default=on) + + +
+ +
+ QEMU QXL command line options + + +
+ +
+ QEMU Console Spice control commands + + + spice.set_image_compression <on|auto_glz|auto_lz|quic|glz|lz|off> + refer to the ic spice option + + + + spice.set_streaming_video <on|off> + Set video streams detection and compression + + + + spice.set_playback_compression <on|off> + Set playback compression + + + + spice.set_ticket <password> [expiration=<seconds> [,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. + + + + spice.set_ticket64 + Same as set_ticket, but using base64 for printable ASCII password. + + + + spice.disable_ticketing + Entirely disables password, so any client is allowed to connect. + + + + spice.set_agent_mouse <on|off> + Define whether guest agent is used for client mouse mode + + + + spice.reset_stat + Reset spice statistics + + + + 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'. + + +
+ +
+ QEMU Console Spice info commands + + + info spice.state + Show current spice state, including client address (if connected), ticketing, image compression, video streaming and playback compression. + + + + info spice.ticket + Show ticket expiration (if enabled) + + + + info spice.stat + Show spice statistics + + + + info spice.rtt_client + Show round trip time (minimum, maximum & average) to spice client after pinging it. + + +
+ -- cgit v1.2.3