1REMOTE-VIEWER(1)            Virtualization Support            REMOTE-VIEWER(1)
2
3
4

NAME

6       remote-viewer - a simple remote desktop client
7

SYNOPSIS

9       remote-viewer [OPTIONS] -- [URI]
10

DESCRIPTION

12       remote-viewer is a simple remote display client. The supported
13       protocols are SPICE and VNC.
14
15       Starting remote-viewer without URI will open a simple dialog with an
16       entry and a list of previously successfully accessed URI.
17
18       The URI can also point to a connection settings file, see the
19       CONNECTION FILE section for a description of the format.
20
21       If URI is '-', then remote-viewer will read the standard input as a
22       connection settings file and attempt to connect using it.
23

OPTIONS

25       The following options are accepted when running "remote-viewer":
26
27       -h, --help
28           Display command line help summary
29
30       -V, --version
31           Display program version number
32
33       -v, --verbose
34           Display information about the connection
35
36       -z PCT, --zoom=PCT
37           Zoom level of the display window in percentage. Range 10-400.
38
39       -f, --full-screen
40           Start with the windows maximized to fullscreen.
41
42           If supported, the remote display will be reconfigured to match the
43           physical client monitor configuration, by enabling or disabling
44           extra monitors as necessary. This is currently implemented by the
45           Spice backend only.
46
47           To specify which client monitors are used in fullscreen mode, see
48           the CONFIGURATION section below.
49
50       -t TITLE, --title TITLE
51           Set the window title to TITLE
52
53       --debug
54           Print debugging information
55
56       -H HOTKEYS, --hotkeys HOTKEYS
57           Set global hotkey bindings. By default, keyboard shortcuts only
58           work when the guest display widget does not have focus.  Any
59           actions specified in HOTKEYS will be effective even when the guest
60           display widget has input focus. The format for HOTKEYS is
61           <action1>=<key1>[+<key2>][,<action2>=<key3>[+<key4>]].  Key-names
62           are case-insensitive. Valid actions are: toggle-fullscreen,
63           release-cursor, secure-attention, smartcard-insert and smartcard-
64           remove.  The "secure-attention" action sends a secure attention
65           sequence (Ctrl+Alt+Del) to the guest. Examples:
66
67             --hotkeys=toggle-fullscreen=shift+f11,release-cursor=shift+f12
68
69             --hotkeys=release-cursor=ctrl+alt
70
71           Note that hotkeys for which no binding is given are disabled.
72           Although the hotkeys specified here are handled by the client, it
73           is still possible to send these key combinations to the guest via a
74           menu item.
75
76       -k, --kiosk
77           Start in kiosk mode. In this mode, the application will start in
78           fullscreen with minimal UI. It will prevent the user from quitting
79           or performing any interaction outside of usage of the remote
80           desktop session.
81
82           Note that it can't offer a complete secure solution by itself. Your
83           kiosk system must have additional configuration and security
84           settings to lock down the OS. In particular, you must configure or
85           disable the window manager, limit the session capabilities, use
86           some restart/watchdog mechanism, disable VT switching etc.
87
88       --kiosk-quit <never|on-disconnect>
89           By default, when kiosk mode is enabled, virt-viewer will remain
90           open when the connection to the remote server is terminated. By
91           setting kiosk-quit option to "on-disconnect" value, virt-viewer
92           will quit instead.
93

HOTKEY

95       A key binding combination is described by a series of key strings
96       separated by '+' that must be pressed together in order to activate the
97       associated action.
98
99       It must be composed of modifiers (shift, ctrl or alt) and a non-
100       modifier key. For example, "shift+f11".
101

CONNECTION FILE

103       remote-viewer connection file is of INI file format, with a mandatory
104       [virt-viewer] group and "type" key.
105
106   Example
107       Opening a file with the following content will start remote-viewer in
108       fullscreen and connect to the host "betsiboka" using the SPICE
109       protocol:
110
111        [virt-viewer]
112        type=spice
113        host=betsiboka
114        port=5900
115        fullscreen=1
116
117   Key list
118       "version" (string)
119           If remote-viewer version number isn't greater or equal to the
120           required version, an error is raised with the expected version.
121
122           The version format accepted is a list of integers separated by '.'.
123           It can be followed by a dash '-' and an additional build number
124           with the same format.
125
126           Version comparison is done by comparing each integer from the list
127           one by one. If any of the component is not a number, the version
128           comparison will fail and consider that the 2 versions are
129           considered to be the same.
130
131       "versions" (osid:version list)
132           This is a list of osid:version couples separated by ';'. osid is an
133           arbitrary string, version is a version number in the same format as
134           in the 'version' field. A given couple indicates that remote-viewer
135           builds matching the given 'osid' (fedora22, debian7, ...) must be
136           at least version 'version'. For consistency, it's recommended to
137           use libosinfo OS shortids as the osid.
138
139       "newer-version-url" (string)
140           If specified, this field is an URL which will be displayed to the
141           user when a version check fails.
142
143       "type" (string, mandatory)
144           The session type, either "spice", "vnc" or "ovirt".
145
146       "host" (string, mandatory)
147           The server host to connect to.
148
149       "port" (integer)
150           The server port to connect to.
151
152       "tls-port" (integer)
153           The server TLS/SSL port to connect to.
154
155       "username" (string)
156           The username for the session authentication.
157
158       "password" (string)
159           The password for the session authentication.
160
161       "disable-channels" (string list)
162           The list of session channels to disable.
163
164           The current SPICE channels are: main, display, inputs, cursor,
165           playback, record, smartcard, usbredir.
166
167       "tls-ciphers" (string)
168           Set the cipher list to use for the secure connection, in textual
169           OpenSSL cipher list format. (see ciphers(1))
170
171       "title" (string)
172           String to present in the window title.
173
174       "fullscreen" (boolean)
175           Opens the client windows in fullscreen.
176
177       "ca" (string)
178           CA certificate in PEM format (using "\n" to separate the lines).
179           This will be used to verify the SSL certificate used for SPICE TLS
180           sessions.
181
182       "host-subject" (string)
183           Verify the certificate subject matches with the given subject.
184
185       "toggle-fullscreen" (hotkey string)
186           Key binding for entering and leaving fullscreen mode. (see HOTKEY
187           for description of expected string)
188
189       "release-cursor" (hotkey string)
190           Key binding for releasing cursor grab. (see HOTKEY for description
191           of expected string)
192
193       "smartcard-insert" (hotkey string)
194           Key binding for inserting emulated smartcard. (see HOTKEY for
195           description of expected string)
196
197       "smartcard-remove" (hotkey string)
198           Key binding for removing emulated smartcard. (see HOTKEY for
199           description of expected string)
200
201       "color-depth" (integer)
202           Set the color depth of the guest display (16 or 32).
203
204       "disable-effects" (string list)
205           A list of desktop effects to disable in the remote guest.
206
207           The effects that can be disabled with SPICE are: wallpaper, font-
208           smooth, animation or all.
209
210       "enable-smartcard" (boolean)
211           Set to 1 to enable client smartcard redirection.
212
213       "enable-usbredir" (boolean)
214           Set to 1 to enable client USB device redirection.
215
216       "enable-usb-autoshare" (boolean)
217           Set to 1 to enable client USB devices auto-sharing.
218
219       "usb-filter" (string)
220           Set a string specifying a filter to use to determine which USB
221           devices to autoconnect when plugged in, a filter consists of one or
222           more rules. Where each rule has the form of:
223
224           "class,vendor,product,version,allow"
225
226           Use -1 for class/vendor/product/version to accept any value.
227
228           And the rules themselves are concatenated like this:
229
230           "rule1|rule2|rule3"
231
232       "secure-channels" (string list)
233           The list of session channels to secure.
234
235           The current SPICE channels are: main, display, inputs, cursor,
236           playback, record, smartcard, usbredir.
237
238       "delete-this-file" (boolean)
239           Set to 1 for the client to remove this connection file (if it
240           can't, it will fail silently)
241
242       "proxy" (string)
243           A proxy URL to tunnel the connection through.
244
245           At the time of writing this documentation, the only supported proxy
246           method with Spice is HTTP CONNECT.
247
248           For example, to tunnel connection through foobar host HTTP proxy on
249           port 8080, use the value "http://foobar:8080".
250
251   oVirt Support
252       The connection file can also carry some oVirt-specific options when
253       oVirt support is compiled in. These options are used to interact with
254       oVirt REST API.  This is currently only used in order to show a menu
255       allowing to change the CD image being used by the virtual machine from
256       remote-viewer user interface.  These options go in an optional [ovirt]
257       group.
258
259       "host" (string, mandatory)
260           The oVirt instance to connect to. This corresponds to the hostname
261           one would connect to access the oVirt user or admin portal.
262
263       "vm-guid" (string, mandatory)
264           GUID of the oVirt virtual machine to connect to.
265
266       "jsessionid" (string)
267           Value to set the 'jsessionid' cookie to. With oVirt 3.6, setting
268           this authentication cookie to a valid value will allow to interact
269           with the oVirt REST API without being asked for credentials.
270
271       "sso-token" (string)
272           Value to set the 'Authorization' header to. With oVirt 4.0 or
273           newer, setting this authentication header to a valid value will
274           allow to interact with the oVirt REST API without being asked for
275           credentials.
276
277       "ca" (string)
278           CA certificate in PEM format (using "\n" to separate the lines).
279           This will be used to validate the certificate used for the oVirt
280           REST https session remote-viewer will establish.
281

CONFIGURATION

283       A small number of configuration options can be controlled by editing
284       the settings file located in the user configuration directory:
285
286           <USER-CONFIG-DIR>/virt-viewer/settings
287
288       This file is a text file in INI format, with application options in the
289       [virt-viewer] group and per-guest options in a group identified by the
290       guest's UUID. The application options should not be edited manually.
291       There is also a special [fallback] group which specifies options for
292       all guests that don't have an explicit group.
293
294       For each guest, the initial fullscreen monitor configuration can be
295       specified by using the monitor-mapping key. This configuration only
296       takes effect when the -f/--full-screen option is specified.
297
298       The value of this key is a list of mappings between a guest display and
299       a client monitor. Each mapping is separated by a semicolon character,
300       and the mappings have the format
301       <GUEST-DISPLAY-ID>:<CLIENT-MONITOR-ID>.
302
303       For example, to map guest displays 1 and 2 to client monitors 2 and 3
304       for the guest with a UUID of e4591275-d9d3-4a44-a18b-ef2fbc8ac3e2, use:
305
306           [e4591275-d9d3-4a44-a18b-ef2fbc8ac3e2]
307           monitor-mapping=1:2;2:3
308
309       The monitor-mapping must contain ids of all displays from 1 to the last
310       desired display id, e.g. "monitor-mapping=3:3" is invalid because
311       mappings for displays 1 and 2 are not specified.
312

EXAMPLES

314       To connect to SPICE server on host "makai" with port 5900
315
316          remote-viewer spice://makai:5900
317
318       To connect to VNC server on host "tsingy" with port 5900
319
320          remote-viewer vnc://tsingy:5900
321
322       To connect to a virtual machine named "toliara" on an oVirt server at
323       example.org
324
325          remote-viewer ovirt://[username@]example.org/toliara
326

BUGS

328       Report bugs to the mailing list
329       "http://www.redhat.com/mailman/listinfo/virt-tools-list"
330
332       Copyright (C) 2012-2014 Red Hat, Inc., and various contributors.  This
333       is free software. You may redistribute copies of it under the terms of
334       the GNU General Public License
335       "https://www.gnu.org/licenses/gpl-2.0.html". There is NO WARRANTY, to
336       the extent permitted by law.
337

SEE ALSO

339       "virt-viewer(1)", "spice-client(1)", the project website
340       "http://virt-manager.org"
341
342
343
344perl v5.26.2                      2018-07-27                  REMOTE-VIEWER(1)
Impressum