« Back to docs

VNC Viewer parameter reference

You can configure VNC Viewer by changing parameters either on the Properties > Expert tab or at the command line.

Note that:

  • VNC Viewer parameters may be overridden by VNC Server parameters; where so is clearly stated.
  • Changes made to parameters in the Expert tab take effect when the OK button is clicked, unless otherwise stated.

AcceptBell

Platform Default value
All TRUE

Specify FALSE to suppress system beeps produced by the VNC Server computer.


AllowMainClose

Platform Default value Since
All FALSE 6.0.0

Specify TRUE to keep active session windows open if the main VNC Viewer app window is closed.


AllowSignIn

Platform Default value Since
All TRUE 6.0.0

Specify FALSE to prevent users signing in to VNC Viewer using their RealVNC account credentials. This means they can only establish direct connections, not cloud connections to team computers, nor sync their address book with other VNC Viewer devices.


AutoReconnect

Platform Default value
All TRUE

Specify FALSE to prevent VNC Viewer automatically reconnecting to VNC Server in certain circumstances, for example if the current user account is logged or switched out.


AutoSelect

Platform Default value Not after
All TRUE 5.3.2

Specify FALSE to request that VNC Server send screen updates using PreferredEncoding and ColorLevel.

By default, an encoding and pixel format is automatically chosen to suit the speed of the network connection.


AutoSelectLossy

Platform Default value Not after
All TRUE 5.3.2

Specify FALSE to prevent lossy encodings (such as JPEG and JRLE) being requested when AutoSelect is TRUE. This may be useful if perfect picture fidelity is required.


BumpScrollSpeed

Platform Default value Since
All 10 6.0.0

Specify a number between 1 and 9 to slow bump scrolling down when in full screen mode, or between 11 and 100 to speed it up.

See also: FullScreen


ChangeServerDefaultPrinter

Platform Default value
All TRUE

Specify FALSE to not change the default printer of the VNC Server computer. A connected VNC Viewer user must explicitly select a VNC printer at print-time.

By default, the VNC Server computer’s default printer is changed to that of the first VNC Viewer computer that connects.

Note

This parameter is ignored unless the EnableRemotePrinting parameter and the VNC Server AllowChangeDefaultPrinter and EnableRemotePrinting parameters are all TRUE.


ClientCutText

Platform Default value
All TRUE

Specify FALSE to prevent a connected VNC Viewer user pasting text to the VNC Server computer.

Note

This parameter is ignored unless the VNC Server AcceptCutText parameter is TRUE.

See also: ServerCutText


ColorLevel (ColourLevel)

Platform Default value
All pal8

Specify one of the following values to determine the picture quality of the VNC Server computer desktop:

  • rgb111 to use 8 colors
  • rgb222 to use 64 colors
  • pal8 to use 256 colors
  • full to use full color

Using more colors gives a better user experience, at a potential cost in performance.

Note

From version 6.0.0, this parameter is ignored unless Quality is set to CUSTOM.


DisableOptionsModeSwitch

Platform Default value Not after
All False 5.3.2

Specify TRUE to lock down the Options dialog box, preventing a VNC Viewer user switching between Basic and Advanced tabs.


DotWhenNoCursor

Platform Default value
All TRUE

Specify FALSE to not show a local cursor if an application running on the VNC Viewer computer is set to show an invisible cursor.

By default, VNC Viewer displays a dot cursor in this circumstance.

Note

This parameter is ignored unless SendPointerEvents and the VNC Server AcceptPointerEvents parameter are both TRUE.


Emulate2

Platform Default value
Mac FALSE

Specify TRUE if the VNC Viewer computer’s mouse has one button but the mouse attached to the VNC Server computer has two.

A connected VNC Viewer user can emulate the missing button by holding down the Ctrl key while clicking.

Note

This parameter is ignored unless SendPointerEvents and the VNC Server AcceptPointerEvents parameter are both TRUE.

See also: Emulate3


Emulate3

Platform Default value
All FALSE

Specify TRUE if the VNC Viewer computer’s mouse has two buttons but the mouse attached to the VNC Server computer has three.

A connected VNC Viewer user can emulate the missing middle button by clicking the left and right buttons simultaneously.

Note

This parameter is ignored unless SendPointerEvents and the VNC Server AcceptPointerEvents parameter are both TRUE.

See also: Emulate2


EnableAnalytics

Platform Default value Since
All FALSE 6.0.0

Specify TRUE to allow RealVNC to collect anonymous usage data to help improve our products.


EnableChat

Platform Default value
All TRUE

Specify FALSE to prevent a connected VNC Viewer user participating in a chat session.

The user can still view chat messages exchanged by other users connected at the same time.

Note

This parameter is ignored unless the VNC Server EnableChat parameter is TRUE.


EnableRemotePrinting

Platform Default value
All TRUE

Specify FALSE to prevent a connected VNC Viewer user printing a VNC Server computer file to a local printer.

Note

This parameter is ignored unless the VNC Server EnableRemotePrinting parameter is TRUE.

See also: ChangeServerDefaultPrinter


EnableToolbar

Platform Default value
All TRUE

Specify FALSE to disable the toolbar, preventing a connected VNC Viewer user performing key operations.

See also: MenuKey, ToolbarIconSize


Encryption

Platform Default value
All Server

For direct connections to VNC Server with an Enterprise subscription, determine, in conjunction with VNC Server, whether:

  • Remote control sessions are encrypted end-to-end.
  • The exchange of authentication credentials is encrypted, but subsequent sessions are not. This means session data may be susceptible to interception by third parties.

Note

Do not edit this parameter if VNC Server has a Home or Professional subscription, or an Enterprise subscription and you intend to establish cloud connections to the VNC Server computer.

Specify one of the following values:

  • Server to let VNC Server choose. By default, direct connections will be encrypted end-to-end unless the VNC Server Encryption parameter is set to PreferOff or AlwaysOff.
  • AlwaysMaximum to request that direct connections be encrypted end-to-end using 256-bit AES. This request is granted unless the VNC Server Encryption parameter is set to Alwaysoff.
  • AlwaysOn to request that direct connections be encrypted end-to-end using at least 128-bit AES. This request is granted unless the VNC Server Encryption parameter is set to Alwaysoff.
  • PreferOn to prefer that direct connections be encrypted end-to-end using at least 128-bit AES. This request is granted unless the VNC Server Encryption parameter is set to Alwaysoff.
  • PreferOff to prefer that the exchange of authentication credentials be encrypted using at least 128-bit AES, but that sessions themselves need not be encrypted. This may improve performance. This request is granted unless the VNC Server Encryption parameter is set to AlwaysMaximum or AlwaysOn.

See also: SecurityNotificationTimeout, WarnUnencrypted, RsaPrivateKeyFile


FetchDir

Platform Default value
All <platform-specific>

Specify a full path to a directory to which files transfered from the VNC Server computer are downloaded, for example C:\Users\johndoe\My Documents.

By default, files are downloaded:

  • Under Windows and Linux, to the VNC Viewer users’s Desktop directory.
  • Under Mac, to the user’s Downloads directory.

See also: ShareFiles


FullColor (FullColour)

Platform Default value Not after
All FALSE 5.3.2

Specify TRUE to display the VNC Server computer’s desktop in full color. Using more colors gives a better user experience, at a potential cost in performance. Note that:

  • When set to TRUE, this parameter overrides ColorLevel.
  • This parameter is ignored if AutoSelect is TRUE.

FullScreen

Platform Default value
All FALSE

Specify TRUE to display an active VNC Viewer session window in full screen. Note under Mac, the behavior is determined by UseLegacyFullScreenMode.

Note

Scrollbars are not displayed if the VNC Server computer’s desktop is larger than the session window; a connected VNC Viewer user must bump the mouse against an edge to scroll.

See also: FullScreenChangeResolution, UseAllMonitors


FullScreenChangeResolution

Platform Default value
Windows FALSE

Specify TRUE to change the VNC Viewer computer’s screen resolution to that of the VNC Server computer if FullScreen is TRUE.

See also: UseAllMonitors


GrabKeyboard

Platform Default value
Linux 1

Specify one of the following values to determine whether VNC Viewer monopolizes its computer keyboard, preventing other applications receiving keyboard input.

  • 0 to never grab the keyboard.
  • 1 to grab the keyboard if FullScreen is TRUE.
  • 2 to always grab the keyboard.

HideCloseAlert

Platform Default value
All FALSE

Specify TRUE to close VNC Viewer silently if a user is disconnected unexpectedly, perhaps because VNC Server has stopped. Use in conjunction with AutoReconnect set to FALSE in order to exit VNC Viewer cleanly if run from a script.

By default, a newly-disconnected user is informed of the reason in a message box that must be acknowledged before VNC Viewer can close.


HideScreenshots

Platform Default value Since
All FALSE 6.0.0

Specify TRUE to replace all desktop preview screenshots with a placeholder image.

Note this does not remove desktop previews, just hides them. To remove desktop previews entirely, navigate to File > Preferences > Privacy > Forget all sensitive data.


Identities

Platform Default value
Mac, Linux $HOME/.vnc/identities

Specify a path to a file storing signatures uniquely identifying instances of VNC Server already connected to.

Depending on the value of VerifyID, a connecting user is warned if a VNC Server signature is new or has changed, which might help prevent connections to unintended or illegitimate destinations.


InterpretDeadKeys

Platform Default value
Linux FALSE

Specify TRUE to compose a character from a dead key and the key-to-be-modified before sending the combination to VNC Server. This may be useful for connections to VNC Server computers that cannot natively compose particular symbols.

By default, the dead key and the key-to-be-modified are sent as separate key presses.

Note

This parameter is ignored unless SendKeyEvents and the VNC Server AcceptKeyEvents parameter are both TRUE.


KeepAliveInterval

Platform Default value
All 60

Specify a number of seconds for VNC Viewer to wait between sending keep alive messages to VNC Server, to maintain connections that might otherwise be considered idle by routers or gateways (perhaps because the VNC Viewer session window is minimized), and unexpectedly terminated.

Specify 0 to not send keep alive messages. Connections may be terminated unexpectedly.

See also: KeepAliveResponseTimeout


KeepAliveResponseTimeout

Platform Default value
All 0

Specify a number of seconds for VNC Viewer to wait for a response to a keep alive message from VNC Server.

It might be useful to set this to a value lower than the standard TCP timeout if connections are likely to be subject to network errors. By default, VNC Viewer waits for the standard TCP timeout before closing the VNC Viewer session window.

See also: KeepAliveInterval


LeftCmdKey

Platform Default value
Mac Alt_L

Specify one of the following values to send a particular keysym to the VNC Server computer when the left Command key is pressed:

  • Alt_L
  • Alt_R
  • Super_L
  • Super_R
  • ExtendedChars

By default, for a connection to a:

  • Windows or Linux computer with a PC keyboard, the left Alt key is simulated, which means that pressing left Command+F has the effect of opening the File menu on most Windows applications.
  • Mac computer, it is recommended you do not change this parameter unless you are also able to make the same change to the VNC Server LeftCmdKey parameter, which by default maps the Alt_L keysym back to the left Command key.

Note that ExtendedChars refers to the key typically used to create extended characters, for example AltGr on non-US PC keyboards.

Note

This parameter is ignored unless SendKeyEvents and the VNC Server AcceptKeyEvents parameter are both TRUE.

See also: LeftOptKey, RightCmdKey, RightOptKey


LeftOptKey

Platform Default value
Mac ExtendedChars

See LeftCmdKey, but for the left Option key.


Locale

Platform Default value
All  

Specify one of the following values to choose a display language:

  • en_US for English
  • fr_FR for French
  • de_DE for German
  • es_ES for Spanish

By default, this parameter is empty, and the VNC Viewer user interface inherits the desktop language of the currently logged-on computer user, or falls back to English if this language has not yet been translated. Note VNC Viewer must be restarted for a change to this parameter to take effect.

Note

Some messages are transmitted by VNC Server and thus may appear in a different language. See the VNC Server Locale parameter for more information.


Log

Platform Default value
All *:stderr:0

Specify an ordered, comma-separated list of activities to record, each of the form:

<log>:<target>:<level>

where:

  • <log> determines the type of activity to record, for example connection, printing or file transfer activity, or * to record all. To see a list of available logs, examine the Log names section in the advanced help output (run the command vncviewer -help all).
  • <target> determines the output destination: either stderr (the default) or file (see LogDir and LogFile).
  • <level> determines severity: 0 includes only serious errors, 10 includes basic audit information, 30 includes general information, and 100 includes all possible information, potentially including keystrokes.

Consider the following example:

*:file:10,CConnection:file:100

  • The first entry (*:file:10) specifies that all activity is recorded to file at level 10.
  • The second entry (CConnection:file:100) overrides this for connection activity, recording it (to the same file) at level 100.

LogDir

Platform Default value
All <platform-specific>

Specify a directory in which VNC Viewer should create a LogFile. This location must be writable.

Note

This parameter is ignored unless at least one Log entry has an output destination of file.

For example, under Windows X:\my\file\server\realvnc\logs\${COMPUTERNAME}\vncviewer specifies a file share mapped to drive X, and distinguishes the name of the originating computer.


LogFile

Platform Default value
All vncviewer.log

Specify a name for the file VNC Viewer should create in LogDir, for example realvnc debug.log.

Note

This parameter is ignored unless at least one Log entry has an output destination of file.


Platform Default value
All F8

Specify a function key in the range F1 to F12 to raise the shortcut menu when the active VNC Viewer session window has focus.

Specify NULL (-menukey=) to disable the shortcut menu, preventing a connected VNC Viewer user performing particular operations.

See also: EnableToolbar


Monitor

Platform Default value
Windows NULL

Specify a monitor attached to the VNC Viewer computer to display the VNC Viewer app window on, for example \\.\DISPLAY2.

By default, or if the specified value is not recognized, VNC Viewer is displayed on the primary monitor (equivalent to \\.\DISPLAY1).


MRUEntries

Platform Default value Not after
All 20 5.3.2

Specify the maximum number of VNC Server computer network addresses to remember, or 0 to remember no addresses.

This ‘most recently used’ list is available to a connecting VNC Viewer user from the VNC Server dropdown of the VNC Viewer dialog.


PasswordKeychain

Platform Default value Since
Mac   6.0.0

Specify the name of or path to a keychain in which to connection passwords VNC Viewer has been asked to remember.

Leave blank to use the default system keychain.


PasswordMasterTimeout

Platform Default value Since
All 900 6.0.0

The amount of time, in seconds, that VNC Viewer remembers its master password for when a VNC Viewer user attempts to connect.

Subsequently, the user must enter the master password in order to connect to any computer.


PasswordStoreOffer

Platform Default value Since
All TRUE 6.0.0

Specify FALSE to prevent connecting users being prompted to request that VNC Viewer remember connection passwords.


PointerCornerSnapThreshold

Platform Default value
All 30

Specify a number of pixels from each corner of the active VNC Viewer session window, on each axis.

If a connected user moves the VNC Viewer computer’s mouse cursor out of the window within this area, the VNC Server computer’s mouse cursor is snapped to the corner. This may be useful for connections to computers that trigger special effects in the corners, for example Windows 8 and Mac OS X 10.8 (Mountain Lion).

Note

This parameter is ignored unless SendPointerEvents and the VNC Server AcceptPointerEvents parameter are both TRUE.


PointerEventInterval

Platform Default value
All 0

Specify a number of milliseconds to wait before sending mouse events such as cursor movements, clicks, and scrolls to the VNC Server computer.

Increasing this value may make connections over a low-bandwidth network more responsive.

Note

This parameter is ignored unless SendPointerEvents and the VNC Server AcceptPointerEvents parameter are both TRUE.


PreferredEncoding

Platform Default value
All ZRLE

Specify one of the following values to request that VNC Server send screen updates in a particular encoding:

  • JPEG
  • Zlib
  • ZRLE
  • TRLE
  • Hextile
  • Raw
  • JRLE

For more information on encodings, consult RFC 6143.

Note

From version 6.0.0, this parameter is ignored unless Quality is set to CUSTOM.


ProtocolVersion

Platform Default value
All NULL

For direct connections to VNC Server with an Enterprise subscription, specify a particular value to request that VNC Server use only that version or lower of the underlying RFB protocol:

Note

Do not edit this parameter if VNC Server has a Home or Professional subscription, or an Enterprise subscription and you intend to establish cloud connections to the VNC Server computer.

  • 3.3
  • 3.8
  • 4.0
  • 4.1

A lower version might be useful for connections to legacy third party VNC-compatible Server apps that do not offer support for subsequent versions of the RFB protocol.

By default, the latest version of the RFB protocol is requested.


ProxyPassword

Platform Default value Not after
All NULL 5.3.2

Specify a password if ProxyServer requires authentication.

See also: ProxyUserName


ProxyServer

Platform Default value
All <system>

Specify the proxy type, network address and port number of a proxy server if the VNC Viewer computer is protected by one, for example http://myhttpproxyserver.com:8080 or socks://mysocksproxyserver.com:8080. Alternatively:

  • Under Windows, specify <system> to use the proxy server settings of Microsoft Internet Explorer.
  • Under Linux, specify <system> to use standard proxy server environment variables.
  • Under Mac, specify <system> to use standard proxy server environment variables.

Note

If you are using VNC Viewer 5.3.2 or earlier, you must specify ProxyType for a SOCKS 5 proxy server.

See also: ProxyUserName, ProxyPassword


ProxyType

Platform Default Value Not after
All httpconnect 5.3.2

Specify socks if ProxyServer is a SOCKS 5 proxy server. By default, an HTTP proxy server is assumed.


ProxyUserName

Platform Default value
All NULL

Specify a user name if ProxyServer requires authentication.

See also: ProxyPassword


Quality

Platform Default value Since
All AUTO 6.0.0

Specify HIGH or LOW to determine picture quality, irrespective of network speed. This may affect performance.

Specify CUSTOM to control the picture quality using the PreferredEncoding and ColorLevel parameters.

Note

It is not possible to configure PreferredEncoding or ColorLevel on VNC Viewer for iOS or Android. However, settings applied to VNC Viewer on a desktop computer are synced to mobile devices.


RelativePtr

Platform Default value
All FALSE

Specify TRUE to send relative changes in mouse cursor position to the VNC Server computer, rather than absolute co-ordinates.

This may be useful to synchronize the mouse cursors of the VNC Viewer and VNC Server computers, if one is diverging from the other, which can happen if an application running on the VNC Server computer does not support absolute mouse events, or for connections to KVM-over-IP switches. Note that a connected VNC Viewer user will not be able to move the mouse cursor outside the VNC Viewer app window.

Note

This parameter is ignored unless SendPointerEvents and the VNC Server AcceptPointerEvents parameter are both TRUE.


RightCmdKey

Platform Default value
Mac Super_L

See LeftCmdKey, but for the right Command key.


RightOptKey

Platform Default value
Mac ExtendedChars

See LeftCmdKey, but for the right Option key.


RsaPrivateKeyFile

Platform Default value
Mac, Linux <platform-specific

Specify the full path to a file storing a private key for VNC Viewer.

If the private key is missing or corrupt, connections cannot be established. To generate a new private key, restart VNC Viewer.

See also: Encryption


ScalePrintOutput

Platform Default value
All True

Specify FALSE to print VNC Server computer files at their actual size.

By default, pages are scaled to fit the boundaries of the local printer’s paper.

Note

This parameter is ignored unless EnableRemotePrinting and the VNC Server EnableRemotePrinting parameter are both TRUE.


Scaling

Platform Default value
All None

Specify one of the following values to determine whether the VNC Server computer’s desktop is scaled relative to the size of the active VNC Viewer session window:

  • None to not scale the VNC Server computer’s desktop. If it is bigger than the session window, scroll bars appear. The window cannot be resized larger than the desktop.
  • Fit to scale the desktop to the size of the session window.
  • AspectFit to scale the desktop to the size of the session window, but retain the aspect ratio.
  • <pixel-width> x <pixel-height> to scale the desktop to the specified session window size. The window cannot be resized larger.
  • <pixel-width> x to scale the desktop to the specified session window width; the height is determined by the aspect ratio. The window cannot be resized larger.
  • x <pixel-height> to scale the desktop to the specified session window height; the width is determined by the aspect ratio. The window cannot be resized larger.
  • <percentage-size> % to scale the desktop to a percentage of the size the session window would be were this parameter set to None. The window cannot be resized larger.
  • <percentage-width> %x <percentage-height> % to scale each axis of the desktop to a percentage of the size the session window would be were this parameter set to None. The window cannot be resized larger.

ScalingQuality

Platform Default value
Mac 2

Specify one of the following values to determine the rendering quality when the VNC Server computer’s desktop is scaled:

  • 0 to use standard quality.
  • 1 to use low quality (the desktop is rendered quicker).
  • 2 to use medium quality.
  • 3 to use high quality (note this might be CPU-intensive).

See also: Scaling


ScrollWheelAccel

Platform Default value
Mac TRUE

Specify FALSE to ignore the speed at which the mouse is set to scroll in System Preferences, causing turns of the mouse wheel to scroll pages at a regimented speed.

Note

This parameter is ignored unless SendPointerEvents and the VNC Server AcceptPointerEvents parameter are both TRUE.


SecurityNotificationTimeout

Platform Default value
All 2500

Specify the number of milliseconds to display encryption status to a newly-connected user for.

The status is displayed at the bottom of the active VNC Viewer session window, in a green bar if the connection is encrypted and in a red bar if it is unencrypted. The connected VNC Viewer user can dismiss the status bar at any time.

Specify 0 to suppress the display of the encryption status.

See also: Encryption


SelectDesktop

Platform Default Value
All NULL

Specify the name of a computer to connect to automatically when a connection is established to a suitably-enabled ADDERLink KVM-over-IP switch.

See also: RelativePtr


SendKeyEvents

Platform Default value
All TRUE

Specify FALSE to prevent a connected user controlling the VNC Server computer using the VNC Viewer computer’s keyboard.

Note

This parameter is ignored unless the VNC Server AcceptKeyEvents parameter is TRUE.

See also: SendPointerEvents


SendMediaKeys

Platform Default Value
Windows, Mac TRUE

Specify FALSE to cause media keys such as Play and Volume Up to be interpreted by the VNC Viewer computer. By default, these keys are sent to, and interpreted by, the VNC Server computer.

Note

This parameter is ignored unless SendKeyEvents and the VNC Server AcceptKeyEvents parameter are both TRUE.


SendPointerEvents

Platform Default value
All TRUE

Specify FALSE to prevent a connected user controlling the VNC Server computer using the VNC Viewer computer’s mouse.

Note

This parameter is ignored unless the VNC Server AcceptPointerEvents parameter is TRUE.

See also: SendKeyEvents


SendPrimary

Platform Default value
Linux TRUE

Specify FALSE to send the CLIPBOARD selection to VNC Server in preference to the PRIMARY selection (that is, the currently highlighted content).

See also: ClientCutText


SendSpecialKeys

Platform Default Value
Windows, Mac TRUE

Specify FALSE to cause the following keys and key combinations to be interpreted by the VNC Viewer computer:

  • Windows: The Windows key (also known as Start or Super), PrtScn (Print Screen), Alt+Tab, Alt+Esc, Ctrl+Esc
  • Mac: System shortcuts such as Cmd+Tab and the Spotlight shortcut

By default, these keys and key combinations are sent to, and interpreted by, the VNC Server computer.

Note

This parameter is ignored unless SendKeyEvents and the VNC Server AcceptKeyEvents parameter are both TRUE.


ServerClipboardGraceTime

Platform Default Value
All 1000

Specify a number of milliseconds to wait before discarding text copied from the VNC Server computer if VNC Viewer no longer has focus.

See also: ServerCutText


ServerCutText

Platform Default value
All TRUE

Specify FALSE to prevent a connected user copying text on the VNC Server computer and pasting it to the VNC Viewer computer.

Note

This parameter is ignored unless the VNC Server SendCutText parameter is TRUE.

See also: ClientCutText


Shared

Platform Default values
All TRUE

Specify FALSE to request that other VNC Viewer users be disconnected when a connection is established.

Note

A newly-connected user cannot prevent disconnected users reconnecting, and may be disconnected in turn.

VNC Server complies with this request providing the VNC Server DisconnectClients parameter is TRUE.

Note

This parameter is ignored unless both the VNC Server AlwaysShared and NeverShared parameters are FALSE.


ShareFiles

Platform Default value
All TRUE

Specify FALSE to prevent a connected VNC Viewer user transferring files to and from the VNC Server computer.

Note

This parameter is ignored unless the VNC Server ShareFiles parameter is TRUE.

See also: FetchDir


SingleSignOn

Platform Default value
All TRUE

Specify FALSE to prevent a user authenticating automatically to VNC Server using credentials already supplied to log on to the VNC Viewer computer (even if VNC Server is set to use the single sign-on authentication scheme, and all the necessary network infrastructure is in place).


ToolbarIconSize

Platform Default value
All 24

Specify one of:

  • 16
  • 24
  • 32

to determine the size in pixels of the icons on the VNC Viewer toolbar.

See also: EnableToolbar


UpdateScreenshot

Platform Default value Since
All TRUE 6.0.0

Specify FALSE to prevent VNC Viewer updating desktop preview screenshots.

See also: HideScreenshots


UseAddrBook

Platform Default value Not after
All TRUE 5.3.2

Specify FALSE to prevent a connected VNC Viewer user saving connections to VNC Address Book.

The user is prompted to save connections to an (less secure) .vnc desktop file instead.


UseAllMonitors

Platform Default value
Windows, Mac FALSE

Specify TRUE to display the VNC Server computer’s desktop across all available monitors if FullScreen is TRUE.

Note

This parameter always affects Mac OS X 10.6 computers, but only affects 10.7+ if UseLegacyFullScreenMode is TRUE.


UseDisplayCapture

Platform Default value
Mac TRUE

Specify FALSE to cause key combinations such as Cmd+Tab to be interpreted by the VNC Viewer computer if FullScreen is TRUE. By default, key combinations are sent to the VNC Server computer.

Note

This parameter always affects Mac OS X 10.6 computers, but only affects 10.7+ if UseLegacyFullScreenMode is TRUE.


UseLegacyFullScreenMode

Platform Default value
Mac FALSE

Specify TRUE on Mac OS X 10.7+ computers to use legacy VNC rather than platform-native full screen mode if FullScreen is TRUE. Note VNC Viewer must be restarted in order for a change to this parameter to take effect.

This might be useful if UseAllMonitors is TRUE to display the active VNC Viewer session window across multiple monitors.


UseLocalCursor

Platform Default value
All TRUE

Specify FALSE to display the cursors of both the VNC Viewer and VNC Server computer (the former is represented by a dot). This may be useful if the connection suffers from high latency, though note VNC Server may be required to send more screen updates.

Note

This parameter is ignored unless SendPointerEvents and the VNC Server AcceptPointerEvents parameter are both TRUE.


UserName

Platform Default value Not after
All <user-account-name> 5.3.2

Specify the user name to use to authenticate to VNC Server.


VerifyID

Platform Default value
All 2

Specify one of the following values to determine whether or not to warn a connecting user that VNC Server’s signature status has changed (note that in particular, a different signature may indicate a man-in-the-middle attack):

  • 0 to suppress signature warnings.
  • 1 to ensure warnings appear for different signatures, and for computers that no longer have a signature.

By default, warnings appear for new and for different signatures, and for computers that no longer have a signature.

See also: Identities


WarnUnencrypted

Platform Default value
All TRUE

Specify FALSE to prevent a connecting VNC Viewer user being warned that the connection will be unencrypted before it is established.

×