VNC Viewer for Windows

Installation

VNC Viewer for Windows is supplied as a component of the VNC Open installation program. If the viewer has been installed in this way then it will be accessible via the Start Menu group created during the installation process (usually RealVNC/VNC Viewer 4).

The viewer executable may also be downloaded, either directly or Zipped. VNC Viewer for Windows is designed to run stand-alone, without requiring any other packages to be installed first.

Connecting to a VNC Server

If installed by the WinVNC setup package then VNC Viewer is accessible from the Start Menu.

winvncviewer4 startmenu

If downloaded directly, the VNC Viewer can be run either by double-clicking on the program icon, or from the command-line.

The VNC Viewer will present the Connection Details dialog, allowing the IP address or name of the target VNC Server to be specified.

winvncviewer4 ip

winvncviewer4 name

If the VNC server's Display Number is non-zero then the display number can be specified by adding a colon to the server's IP address or name, followed by the display number:

winvncviewer4 display

If the VNC server is using a non-standard port number to accept connections then this is specified by adding two colons to the server's address or name, followed by the port number:

winvncviewer4 port

Encryption is not currently supported by VNC Open.

Once you have selected the VNC server to connect to, you can simply click OK or press return to attempt to connect to it. If your connection attempt succeeds then the server's details will be added to the Connection Details drop-down menu, to save you typing next time.

Alternatively, you can select the Options... button, to override the default connection configuration, before you connect. See the Configuring VNC Viewer documentation for more details.

Connecting using .vnc files

VNC Viewer supports loading and saving of .vnc files, containing a set of connection options. VNC Viewer 4 can load .vnc files saved by itself, or by VNC Viewer 3.

To use a connection options file from the command-line, simply run VNC Viewer with the -config command-line option, followed by the .vnc filename.

winvncviewer4 config cmd

winvncviewer4 config dbclick

If you have installed VNC Viewer using the WinVNC setup package then .vnc files will have been automatically registered, so that you can simply double-click on one to have VNC Viewer open it.

winvncviewer4 dragndropIf you have not installed VNC Viewer using the WinVNC setup package then you can instead drag .vnc files and drop them on the VNC Viewer executable icon in order to launch them.

Alternatively, if you have had VNC Viewer 3 installed and have used .vnc files with it then it is likely that VNC Viewer 3 is already registered with Windows as the application responsible for .vnc files. VNC Viewer 4 supports the old /config form of the -config command-line option, so you should find that you can simply replace your old VNC Viewer with the new one and have .vnc files continue to work.

User Authentication

VNC Viewer can be used to connect to servers configured for No Authentication or VNC Password Authentication. If VNC Password Authentication is configured then you will be prompted to enter the password. VNC Open does not currently support usernames.

winvncviewer4 userpasswd

Configuring VNC Viewer

VNC Viewer provides a number of options allowing its behaviour to be tailored to your needs. These are configured in one of three ways listed below.

Changing the Default Options

VNC Viewer allows a set of options to be saved per-user, which will be used as the defaults for all connections that user makes to VNC Servers. These Default Options can be overridden from the Connection Details dialog before making a connection, or during a connection via the F8 Menu, or by specifying the options to override on the VNC Viewer command-line.

While the VNC Viewer is running in listening mode, it will place an icon in the system tray. Right-clicking on this icon will cause a menu to be displayed, through which the Default Options may be accessed. The Default Options are saved on a per-user basis, and are used for all subsequent VNC connections.

Changing the Options for a New/Current Connection

The Options dialog can be accessed from the Connection Details dialog when making a new VNC connection, or from the F8 Menu of an active connection. In either case, the dialog can be used to override any settings configured through the Default Options dialog.

Specifying Command-Line Options

VNC Viewer allows any option to be specified on the command-line when it is launched. Options specified on the command-line override those specified in the Default Options dialog. However, options configured on the command-line can be changed once a connection has been made using the Connection Options dialog.

The Options

The Options dialog consists of a number of pages of options, grouped according to their function. The following documentation describes each option and the equivalent command-line parameters.

Color / Encoding

winvncviewer4 format

Auto select
AutoSelect=true/false

The Auto select check-box controls whether or not VNC Viewer should attempt to automatically gauge the speed of the network connection to the VNC Server and adjust its behaviour accordingly. If selected, the viewer will take control of the graphical compression scheme used, and will only request full color updates if the network appears fast enough to support them. If not selected, then the user must select suitable encoding and format options manually.

ZRLE
PreferredEncoding=ZRLE
Hextile
PreferredEncoding=Hextile
Raw
PreferredEncoding=Raw

The ZRLE, Hextile and Raw radio buttons allow the preferred graphical encoding used by VNC Viewer to be controlled by the user. The available encodings are arranged in order of increasing bandwidth requirements and decreasing processing requirements, so that ZRLE is most effective on slow networks such as dial-ups, while Raw is often most effective on fast LANs. The preferred encoding is determined automatically by VNC Viewer if the Auto select checkbox is ticked.

Colour level

The Colour level box controls whether VNC Viewer should request as many colors as it and the server can handle, or one of a predefined set of lower-color, less bandwidth-intensive levels.

Full (all available colors)
FullColour=true/false

If Full Colour mode is selected then VNC Viewer will attempt to render colors as accurately as possible. Otherwise, a reduced number of colors will be used, to limit the required network bandwidth. The reduced color mode to use is determined by the LowColourLevel setting.

Medium (256 colors)
LowColourLevel=2

Low (64 colors)
LowColourLevel=1

Very Low (8 colors)
LowColourLevel=0

If Full Colour mode is not active then VNC Viewer will instead request one of a set of preset lower color modes. These modes range from Medium color, which requests 8bpp palettized pixel data from the server, to Very Low color, which requests pixel data in 3bpp true-color format, causing the entire desktop to be rendered in lurid primary colors.

Note that if the Auto select check-box is ticked then the automatic pixel format selection routines may override the user's selection and cause the connection to revert to Full Colour mode. However, it will not automatically select between the low color options.

Inputs

winvncviewer4 onputs

Send pointer events to server
SendPointerEvents=true/false

By default, any pointer actions within the VNC Viewer window will be sent to the VNC server. If this checkbox is unticked then pointer events will no longer be sent, allowing VNC Viewer to operate in a view-only mode.

Send keyboard events to server
SendKeyEvents=true/false

By default, any key presses within the VNC Viewer window will be sent to the VNC server. If this checkbox is unticked then key events will no longer be sent, allowing VNC Viewer to operate in a view-only mode.

Send clipboard changes to server
SendCutText=true/false

By default, any text copied to the clipboard will be sent to the VNC server, so that the remote and local clipboards are synchronised. If this checkbox is unticked then clipboard data will no longer be sent, ensuring that clipboard actions made at the server are not affected by the viewer, and that sensitive data in the local clipboard cannot be leaked to the server.

Accept clipboard changes from server
AcceptCutText=true/false

By default, any text copied to the remote clipboard will be sent by the VNC Server to the VNC Viewer. If this checkbox is unticked then clipboard data sent by the server will be ignored, ensuring that clipboard actions made at the server cannot affect the local clipboard.

Enable 3-button mouse emulation
Emulate3=true/false

If this checkbox is ticked then VNC Viewer will translate simultaneous left and right mouse-button press events as a middle button press. This is normally used when accessing applications for systems such as X Windows, which assume the availability of a middle mouse button, from older Windows systems that don't have one.

Menu key
MenuKey=F1/.../F12/

This option allows the key used to summon the "F8 Menu" to be changed to one of the function keys F1 to F12, or to be disabled entirely by setting MenuKey to be empty.

Pass special keys directly to server
DisableWinKeys=true/false

If this checkbox is ticked (DisableWinKeys is true) then special key sequences such as the Windows keys, Application key or Alt-Tab will be passed to the VNC Server rather than being interpreted locally. The special Secure Access Sequence Ctrl-Alt-Del is always processed by the viewer computer, and not passed to the server.

Note that if you run a full-screen VNC Viewer, with MenuKey disabled and DisableWinKeys set, then you will find it rather hard to get out of the viewer, back to your local applications! In this case, you will probably need to use Ctrl-Alt-Del to close VNC Viewer, or to switch to another application if possible.

Misc

winvncviewer4 misc

Shared connection (do not disconnect other viewers)
Shared=true/false

When connecting to a VNC Server, VNC Viewer can request that all other connected viewers are disconnected before the connection continues. If Shared connection is ticked then VNC Viewer will not request that other viewers be disconnected. Note that the server may choose to ignore or refuse VNC Viewer's request. Note that this option is only available when configuring the Default Options or when configuring a new connection, not when the connection is already active.

Full-screen mode
FullScreen=true/false

If the Full-screen mode checkbox is ticked then VNC Viewer will attempt to take over the entire local display in order to show the remote desktop. The full-screen setting can be set as a default, used for new connections, and changed once a connection is active. The F8 Menu also provides a shortcut to toggle full-screen mode.

Render cursor locally
UseLocalCursor=true/false

VNC Viewer 4 supports rendering of the VNC Server's cursor locally, by the viewer. This means that the cursor responds more quickly to mouse movemements and makes VNC connections over slow networks appear faster. Over faster networks, or for personal preference, this local rendering may be disabled by unticking the Render cursor locally checkbox.

Allow dynamic desktop resizing
UseDesktopResize=true/false

VNC Viewer 4 supports dynamic resizing of the VNC Server desktop. If dynamic resizing is not supported by both viewer and server then changes to the dimensions of the remote desktop may cause the VNC connection to be closed. Dynamic desktop resizing can be disabled if it causes problems on your system.

Only use protocol version 3.3
Protocol3.3=true/false

VNC Viewer 4 supports both the original VNC version 3.3 protocol, and the new VNC protocol version 3.7. Some third-party VNC software use non-standard version numbers which may cause incompatibility issues. VNC Viewer 4 can therefore be configured to use only the original VNC protocol version 3.3, ensuring compatibility even with non-standard VNC Servers. Note that this option may be set as a Default Option, or when making a new connection, but cannot be changed once a connection is active.

Beep when requested to by the server
AcceptBell=true/false

By default, VNC Viewer will cause a sound to be produced whenever a bell event is received from the server. This option allows bell events to be ignored by VNC Viewer.

Offer to automatically reconnect
AutoReconnect=true/false

When an error occurs that causes the VNC connection to be closed, VNC Viewer can offer to reconnect to the server, using the same username and password. This option applies only to connections made from viewer to server, and not to reverse connections.

Load / Save

winvncviewer4 loadsave

VNC Viewer stores a set of preferred defaults for all new connections in the user's registry. Special purpose settings, or settings specific to particular hosts can be maintained by using VNC Configuration (.vnc) files.

Configuration File
Reload

If the VNC session was started by loading settings from a VNC Configuration file then the original settings are reloaded from that file.

Save

If the VNC session was started by loading settings from a VNC Configuration file then the current settings are saved back to that file.

Save As...

Presents the standard File Save dialog, allowing a target VNC Configuration filename to be specified. The current settings will then be saved to the specified file.

Defaults
Reload

Reloads the default VNC Viewer settings from the registry.

Save

Saves the current settings to the registry as the defaults for all new VNC Viewer sessions.

Other Settings

In addition to the settings described above, the VNC viewer supports several advanced options. These options can be set either on the command-line or by adding an appropriate value to the Windows registry under the HKEY_CURRENT_USER\Software\RealVNC\VNCViewer4 key. For a full list of options, run vncviewer -help.

Using F8 Menu

The so-called F8 Menu provides a quick way to access a set of frequently-used VNC Viewer functions. It is called the F8 Menu because by default it can be accessed simply by pressing the F8 key in a VNC Viewer window! If the MenuKey option has been used to specify a different key then we still call it the F8 Menu, to keep things simple...

The F8 Menu can also be accessed by right-clicking on the titlebar of a VNC Viewer window, or by left-clicking on the System Menu button in the top left of the VNC Viewer window's titlebar.

Clicking anywhere outside the F8 Menu will cause it to go away again.

F8 Menu Functions

winvncviewer4 f* menu

The F8 Menu provides the same set of available functions as the VNC Viewer window's normal System Menu, namely those allowing the window to be minimized, maximized, moved or closed.

Additionally, some VNC-specific actions are available:

Full screen

The Full screen menu item allows full-screen mode to be toggled on or off directly, without having to use the Options dialog. See the description of the Full screen setting in the Options page for more information.

Ctrl and Alt

Toggles the status of the Ctrl or Alt keys, respectively, on the VNC Server. This affects the interpretation by the server of keypress sent while either or both of these menu items is activated. For example, if the Alt menu item is selected, then pressing the Tab key in the VNC Viewer will cause the VNC Server to process an Alt+Tab. This can be useful to send keypresses that would otherwise be intercepted locally by the operating system.

Send F8

Because the F8 key is used to access the F8 menu, it will not be sent to the VNC Server when it is pressed. To send an F8 keypress to the server, you can bring up the F8 Menu locally and select the Send F8 menu option.

Note that if the MenuKey option has been changed to a different function key then this menu item will reflect that change. If the MenuKey has been disabled entirely then this option will not be present.

Send Ctrl-Alt-Del

The Ctrl-Alt-Del key sequence is intercepted by the operating system for use as a Secure Access Sequence and so cannot be captured by the VNC Viewer for transmission to a remote server. Instead, you can bring up the F8 Menu and select Send Ctrl-Alt-Del to achieve the same effect.

Note that on some versions of the operating system, pressing Alt Gr-Del will cause the Ctrl-Alt-Del sequence to be captured by VNC Viewer without the operating system intercepting it. This is available primarily on European versions of the operating system.

Note that on all versions tested, pressing Shift-Ctrl-Alt-Del could be used to cause Ctrl-Alt-Del to be received by a WinVNC Server without having the local operating system capture the it.

Refresh Screen

Requests a full screen update from the VNC Server. Use this if you experience any unexpected visual artifacts.

New Connection...

The New Connection... option causes a new Connection Details dialog to be displayed, so that a connection can easily be made to another VNC Server.

Note that a VNC Viewer started in this way actually shares the same process as the VNC Viewer window from which it was started. The VNC Viewer process will not quit until both windows have been closed. This may affect the behaviour of scripts which launch VNC Viewer.

Options...

This causes the Connection Options dialog to be displayed, allowing the settings for the current connection to be modified. See the description of VNC Viewer Options for more details.

Connection Info...

The Connection Info dialog displays information about the remote host, pixel format, line-speed estimate and protocol version. If you don't know what any of this means then don't worry - it's all safe to ignore! The main use of the Connection Info dialog is to help in diagnosing any problems you might encounter while using VNC Viewer.

About...

Displays program and version information.

Problems?

If you have difficulties which are not covered by this document, try reading the Knowledge Base. There are also some pages to help with troubleshooting.

If that doesn't help then try subscribing to the mailing list and ask your question there.