.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "SPICE-CLIENT 1" .TH SPICE-CLIENT 1 "2020-12-04" "perl v5.32.0" "Spice-GTK Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Spice\-GTK \- a client\-side library to access remote SPICE displays .SH "DESCRIPTION" .IX Header "DESCRIPTION" Spice-GTK is a library allowing access to remote displays over the \s-1SPICE\s0 protocol. At the moment It's mainly used to access remote virtual machines. .PP The Spice-GTK library provides a set of command line options which can be used to tweak some SPICE-specific option. .SH "URI" .IX Header "URI" To initiate a plain \s-1SPICE\s0 connection (the connection will be unencrypted) to hostname.example.com and port 5900, use the following \&\s-1URI:\s0 .PP .Vb 1 \& spice://hostname.example.com:5900 .Ve .PP In order to start a \s-1TLS\s0 connection, one would use: .PP .Vb 1 \& spice+tls://hostname.example.com:5900 .Ve .PP Note: 'spice+tls' is available since v0.35, you have to use the spice:// query string with the 'tls\-port' parameter before that. .SH "URI query string" .IX Header "URI query string" spice \s-1URI\s0 accepts query string. Several parameters can be specified at once if they are separated by & or ; .PP .Vb 1 \& spice://hostname.example.com?port=5900;tls\-port=5901 .Ve .PP When using 'tls\-port', it's recommended to not specify any non-TLS port. If you give both 'port' and 'tls\-port', make sure you use the \&\-\-spice\-secure\-channels options to indicate which channels must be secure. Otherwise, Spice-GTK first attempts a connection to the non-TLS port, and then try to use the \s-1TLS\s0 port. This means a man-in-the-middle could force the whole \s-1SPICE\s0 session to go in clear text regardless of the \s-1TLS\s0 settings of the \s-1SPICE\s0 server. .PP Other valid \s-1URI\s0 parameters are 'username' and 'password'. Be careful that passing a password through a \s-1SPICE URI\s0 might cause the password to be visible by any local user through 'ps'. .SH "OPTIONS" .IX Header "OPTIONS" The following options are accepted when running a \s-1SPICE\s0 client which makes use of the default Spice-GTK options: .IP "\-\-spice\-secure\-channels=" 4 .IX Item "--spice-secure-channels=" Force the specified channels to be secured .Sp This instructs the \s-1SPICE\s0 client that it must use a \s-1TLS\s0 connection for these channels. If the server only offers non-TLS connections for these channels, the client will not use these. If the special value \*(L"all\*(R" is used, this indicates that all \s-1SPICE\s0 channels must be encrypted. .Sp The current \s-1SPICE\s0 channels are: main, display, inputs, cursor, playback, record, smartcard, usbredir. .IP "\-\-spice\-disable\-effects=" 4 .IX Item "--spice-disable-effects=" Disable guest display effects .Sp This tells the \s-1SPICE\s0 client that it should attempt to disable some guest features in order to lower bandwidth usage. This requires guest support, usually through a \s-1SPICE\s0 agent. This is currently only supported on Windows guests. .Sp \&\*(L"wallpaper\*(R" will disable the guest wallpaper, \*(L"font-smooth\*(R" will disable font antialiasing, \*(L"animation\*(R" will try to disable some of the desktop environment animations. \*(L"all\*(R" will attempt to disable everything which can be disabled. .IP "\-\-spice\-color\-depth=<16,32>" 4 .IX Item "--spice-color-depth=<16,32>" Guest display color depth \- \s-1DEPRECATED\s0 .Sp This tells the \s-1SPICE\s0 client that it should attempt to force the guest \s-1OS\s0 color depth. A lower color depth should lower bandwith usage. This requires guest support, usually through a \s-1SPICE\s0 agent. This is currently only supported on Windows 7 and older guests. .IP "\-\-spice\-ca\-file=" 4 .IX Item "--spice-ca-file=" Truststore file for secure connections .Sp This option is used to specify a .crt file containing the \s-1CA\s0 certificate with which the \s-1SPICE\s0 server \s-1TLS\s0 certificates are signed. This is useful when using self-signed \&\s-1TLS\s0 certificates rather than certificates signed by an official \s-1CA.\s0 .IP "\-\-spice\-host\-subject=" 4 .IX Item "--spice-host-subject=" Subject of the host certificate (field=value pairs separated by commas) .Sp When using self-signed certificates, or when the guest is migrated between different hosts, the subject/altSubject of the \s-1TLS\s0 certificate the \s-1SPICE\s0 server will provide will not necessarily match the hostname we are connecting to. This option makes it possible to override the expected subject of the \s-1TLS\s0 certificate. .Sp The subject must correspond to the \*(L"Subject:\*(R" line returned by: openssl x509 \-noout \-text \-in server\-cert.pem .IP "\-\-spice\-debug" 4 .IX Item "--spice-debug" Enable Spice-GTK debugging. This can also be toggled on with the \&\s-1SPICE_DEBUG\s0 environment variable, or using G_MESSAGES_DEBUG=all .IP "\-\-spice\-disable\-audio" 4 .IX Item "--spice-disable-audio" Disable audio support .IP "\-\-spice\-disable\-usbredir" 4 .IX Item "--spice-disable-usbredir" Disable \s-1USB\s0 redirection support .IP "\-\-spice\-usbredir\-auto\-redirect\-filter=" 4 .IX Item "--spice-usbredir-auto-redirect-filter=" Filter selecting \s-1USB\s0 devices to be auto-redirected when plugged in .Sp This filter specifies which \s-1USB\s0 devices should be automatically redirected when they are plugged in during the lifetime of a \s-1SPICE\s0 session. .Sp A rule has the form of: \&\f(CW\*(C`class,vendor,product,version,allow\*(C'\fR .Sp \&\-1 can be used instead of class, vendor, product or version in order to accept any value. Several rules can be concatenated with '|': \&\f(CW\*(C`rule1|rule2|rule3\*(C'\fR .IP "\-\-spice\-usbredir\-redirect\-on\-connect=" 4 .IX Item "--spice-usbredir-redirect-on-connect=" Filter selecting \s-1USB\s0 devices to redirect on connect .Sp This filter specifies which \s-1USB\s0 devices should be automatically redirected when a \s-1SPICE\s0 connection to a remote display has been established. .IP "\-\-spice\-gtk\-version" 4 .IX Item "--spice-gtk-version" Display Spice-GTK version information .IP "\-\-spice\-smartcard" 4 .IX Item "--spice-smartcard" Enable smartcard support .IP "\-\-spice\-smartcard\-db=" 4 .IX Item "--spice-smartcard-db=" Path to the local certificate database to use for software smartcard certificates .Sp This option is only useful for testing purpose. Instead of having a hardware smartcard reader, and a physical smartcard, you can specify a file containing 3 certificates which will be used to emulate a smartcard in software. See \&\f(CW\*(C`http://www.spice\-space.org/page/SmartcardUsage#Using_a_software_smartcard\*(C'\fR for more details about how to generate these certificates. .IP "\-\-spice\-smartcard\-certificates=" 4 .IX Item "--spice-smartcard-certificates=" Certificates to use for software smartcards (field=values separated by commas) .Sp This option is only useful for testing purpose. This allows to specify which certificates from the certificate database specified with \-\-spice\-smartcard\-db should be used for smartcard emulation. .IP "\-\-spice\-cache\-size=" 4 .IX Item "--spice-cache-size=" Image cache size \- \s-1DEPRECATED\s0 .Sp This option should only be used for testing/debugging. .IP "\-\-spice\-glz\-window\-size=" 4 .IX Item "--spice-glz-window-size=" Glz compression history size \- \s-1DEPRECATED\s0 .Sp This option should only be used for testing/debugging. .SH "BUGS" .IX Header "BUGS" Report bugs to the mailing list \f(CW\*(C`http://lists.freedesktop.org/mailman/listinfo/spice\-devel\*(C'\fR .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2011, 2014 Red Hat, Inc., and various contributors. This is free software. You may redistribute copies of it under the terms of the \s-1GNU\s0 Lesser General Public License \&\f(CW\*(C`https://www.gnu.org/licenses/old\-licenses/lgpl\-2.1.html\*(C'\fR. There is \s-1NO WARRANTY,\s0 to the extent permitted by law. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\f(CW\*(C`virt\-viewer(1)\*(C'\fR, the project website \f(CW\*(C`http://spice\-space.org\*(C'\fR