From 7095563153af0e3481605eb5979ca8e6982d95cc Mon Sep 17 00:00:00 2001 From: Christophe Fergeau Date: Mon, 13 Jan 2014 20:01:42 +0100 Subject: Add reference manual This manual documents how to enable/use various SPICE features when creating a VM by running QEMU directly, or when using libvirt, or when using virt-manager. This is based on work by Lubos Kocman --- docs/manual/SpiceUserManual-References.xml | 218 +++++++++++++++++++++++++++++ 1 file changed, 218 insertions(+) create mode 100644 docs/manual/SpiceUserManual-References.xml (limited to 'docs/manual/SpiceUserManual-References.xml') diff --git a/docs/manual/SpiceUserManual-References.xml b/docs/manual/SpiceUserManual-References.xml new file mode 100644 index 00000000..6fcee02c --- /dev/null +++ b/docs/manual/SpiceUserManual-References.xml @@ -0,0 +1,218 @@ + + + + + QEMU Spice Reference + +
+ QEMU Spice command line options + + They are covered in QEMU online documentation. + Basic syntax is -spice <spice_options> + + + + + [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) + + + + + 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 + The auto_[glz/lz] modes choose between the [glz/lz] and quic, + based on the image properties + + + + 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) + + + + jpeg-wan-compression=<auto|never|always> + (default = auto) + + + + zlib-glz-wan-compression=<auto|never|always> + (default = auto) + + + + + 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. + + + + sasl=<on|off> + + + + x509-dir=<dir_name> + + + + x509-key-file=<key_file> + TLS private key file + + + + x509-key-password=<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 + + + + tls-ciphers=<ciphers> + Cipher suite to use, see http://www.openssl.org/docs/apps/ciphers.html or ciphers(1) + + + + 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 TLS and plain text connection, depending on the + port and tls-port parameters. + + + + + + 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 + + + ram_size + + + vram_size + + + revision + + + debug + + + guestdebug + + + cmdlog + + + ram_size_mb + + + vram_size_mb + + + vram64_size_mb + + + vgamem_mb + + + surfaces + + +
+ +
+ QEMU Console Spice control commands + + + 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. + + + + expire_password + + + + client_migrate_info + + + +
+ +
+ QEMU Console Spice info commands + + + info spice + Show current spice state + + +
+ + -- cgit