From 69f6ed56152b33482ed4b88bf2b12d3f0a76d9ca Mon Sep 17 00:00:00 2001 From: Christophe Fergeau Date: Thu, 26 Sep 2013 12:26:18 +0200 Subject: Start updating QEMU reference doc All the listed options should be valid, still missing formatting and actual documentation. --- books/docbook/SpiceUserManual-References.xml | 168 ++++++++++++++++----------- 1 file 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 @@
QEMU Spice command line options + They are covered in QEMU online documentation. Basic syntax is -spice <spice_options> + - [port=<port>][,tls-port=<tls-port>][,host=<host>] - Listen on interface address <host> (if given, otherwise any interface) + [port=<port>][,tls-port=<tls-port>][,addr=<addr>] + Listen on interface addr <addr> (if given, otherwise any interface) using port <port> and/or tls-port <tls-port> (at least one of them must be given) + + ipv4=<on|off> + IPv4 only (default:off) + + + + ipv6=<on|off> + IPv6 only (default:off) + + - 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 @@ - sv=<on|off> - Set video streams detection and (lossy) compression (default=on) + streaming-video=<all|filter|off> + Set video streams detection and (lossy) compression (default=filter) + + + + playback-compression=<on|off> + Set playback compression, using the CELT algorithm (default=on) - renderer=<oglpbuf+oglpixmap+cairo> - Select renderers. Multiple choice prioritized by order (default=cairo) + jpeg-wan-compression=<auto|never|always> + (default = auto) - playback-compression=<on|off> - Set playback compression, using the CELT algorithm (default=on) + zlib-glz-wan-compression=<auto|never|always> + (default = auto) @@ -55,42 +72,52 @@ - sslkey=<key_file> - SSL private key file + sasl=<on|off> - 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. + x509-dir=<dir_name> - sslcafile=<ca_file> - SSL certificates file of the trusted CA (certificate authority) and CRL (certificate revocation list) + x509-key-file=<key_file> + TLS private key file - ssldhfile=<dh_file> - Symmetric Diffie-Hellman key file + x509-key-password=<pem_password> + Password to open the private key file which is in PEM format - sslpassword=<pem_password> - Password to open the private key file which is in PEM format + x509-cert-file=<cert_file> + TLS certificate file + + + + tls-cacert-file=<ca_file> + SSL certificates file of the trusted CA (certificate authority) and CRL (certificate revocation list) + + + + x509-dh-key-file=<dh_file> + Symmetric Diffie-Hellman key file - sslciphersuite=<cipher_suite> - Cipher suite to use, see http://www.openssl.org/docs/apps/ciphers.html + tls-ciphers=<ciphers> + Cipher suite to use, see http://www.openssl.org/docs/apps/ciphers.html or ciphers(1) - 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. @@ -99,86 +126,91 @@ agent-mouse=<on|off> Define whether spice agent is used for client mouse mode (default=on) + + + disable-copy-paste=<on|off> + (default=off) + + + + disable-agent-file-xfer=<on|off> + (default=off) + + + + seamless-migration=<on|off> + (default=off) +
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 + ram_size - - spice.set_streaming_video <on|off> - Set video streams detection and compression + vram_size - - spice.set_playback_compression <on|off> - Set playback compression + revision - - 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. + debug - - spice.set_ticket64 - Same as set_ticket, but using base64 for printable ASCII password. + guestdebug - - spice.disable_ticketing - Entirely disables password, so any client is allowed to connect. + cmdlog - - spice.set_agent_mouse <on|off> - Define whether guest agent is used for client mouse mode + ram_size_mb - - spice.reset_stat - Reset spice statistics + vram_size_mb + + + vram64_size_mb + + + vgamem_mb - - 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
-
- QEMU Console Spice info commands +
+ QEMU Console Spice control commands - info spice.state - Show current spice state, including client address (if connected), ticketing, image compression, video streaming and playback compression. + set_password spice <password> [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. - info spice.ticket - Show ticket expiration (if enabled) + expire_password - info spice.stat - Show spice statistics + client_migrate_info + +
+ +
+ QEMU Console Spice info commands + - info spice.rtt_client - Show round trip time (minimum, maximum & average) to spice client after pinging it. + info spice + Show current spice state
-- cgit v1.2.3