Terminal (PuTTY)

The Terminal connection based on PuTTY can be used to connect to remote computers using Telnet, Secure Shell (SSH) (incl. Tunneling support), RAW or rlogin. It can also be used to connect to devices using the Serial Port.

Note

In order to drag tabs of a connection based on external applications (such as PuTTY or VNC), you need to hold the SHIFT key.

Dashboard

The Terminal Dashboard is shown in the Dashboard panel when you select a Terminal connection based on the PuTTY plugin in the Navigation panel. The dashboard will show files with the extension .log. Logging and recording configuration can be found in Logging.

PuTTY_Dashboard

Dashboard Features

Click the Open in Explorer button to open the folder containing the selected file in Windows Explorer.
Copy path to clipboard context menu.
Grid search and customization, including sort, filter and group.
Delete File allows you to directly delete a log file from the Dashboard.
The Export drop down menu allows you to export a recording to a different file format.
Click Refresh to refresh the file list.

Dashboard Settings

To configure the application default settings for the included dashboard, open the Plugins Management and click on Dashboard for the Terminal plugin based on PuTTY.
To configure individual dashboard settings for a connection, use the Dashboard property page.

Plugin Settings

To configure the plugin settings, open the Plugins Management and click on Settings for the Terminal plugin based on PuTTY:

Executable

Specify your own PuTTY executable. If no executable is specified or if the configured executable cannot be found, the PuTTY.exe included in Royal TS will be used.

Registry Base Path

Enter the registry base path without the hive.

For KiTTY use: Software\9bis.com\KiTTY
Leave empty for the default PuTTY base path: Software\SimonTatham\PuTTY

Window Title Match

Enter the window title Royal TS should look for to identify the session window.
For KiTTY use: - KiTTY
Leave empty for the default PuTTY window title match: - PuTTY

Connection Properties

The Terminal (PuTTY) Properties dialog is shown:

for a new Terminal connection by clicking the Terminal menu item in the Add drop down menu in the Edit group on the Home ribbon tab when the PuTTY based plugin is set as the default plugin.
for a new Terminal connection by clicking the More... menu item in the Add drop down menu in the Edit group on the Home ribbon tab and selecting the Terminal (based on PuTTY) entry from the list of available objects.
for an existing Terminal connection by selecting a Terminal connection which is configured to use the PuTTY based plugin and clicking on the Properties command in the Edit group on the Home ribbon tab.
as a bulk-edit dialog when multiple Terminal connections which are configured to use the PuTTY based plugin were selected in the Folder / Document Dashboard and the Properties command in the Edit group on the Home ribbon tab is clicked. See also: Bulk Operations

Terminal Properties

The The Terminal Connection page allows you to configure basic connection settings, such as host name and the connection type (Telnet, SSH or Serial Port). page allows you to configure basic connection settings, such as host name and the connection type (Telnet, SSH, RAW, rlogin or Serial Port). You can also configure the connection to use an existing PuTTY connection or import an existing PuTTY connection.

Display Name (required)

Enter a display name for object.

Color

Click the color picker button in the display name text box to select a color. In the User Interface settings you can configure to show the color in the navigation tree, the connection tab or as connection border.

Icon

Click the icon picker button next in the display name text box to select and assign a custom icon to the object.

Connection Type

Select one of the supported connection types: Existing PuTTY Session, SSH Connection, Telnet Connection, Serial Port Connection, Raw or Rlogin.

Note

Depending on the selected connection type, availability of some property pages may change.

PuTTY Session (only available when Existing PuTTY Session is selected)

The drop down list will show all available PuTTY sessions.

Important

If you specify an existing PuTTY session, it will only use the Computer Name, Port and configured credentials of your connection. All other settings will actually be used from the saved PuTTY session.

Computer Name (required)

Enter the computer name or the IP address.

Tip

Click on the browse button (...) to open the Entry Editor dialog. The entry editor can be used to search for computers in your network and to add multiple entries for different servers with the same settings at the same time (when supported).

Alternatively, you can also just specify more computer names by separating them with a semicolon for bulk-add operations.

Replacement tokens are supported.

Port

Specify the TCP port for the connection.

Close on Exit

If PuTTY is not closed, the connection can be re-established using the System Menu on the Actions tab.

Description

Enter a description for the object.

MAC Address

Use this optional field to record the remote computer's MAC address. You can then use this field in templates or tasks, like a wake-on-lan task, for example.

Display Options

The Display Options page allows you to configure font settings and appearance settings.

Font

Select the font used for the terminal control.

Font is Bold

If checked, the terminal will print all characters bold.

Font Quality

Specify the font quality (anti-aliasing mode).

Cursor Appearance

Configure the appearance of the cursor.

Hide Mouse Pointer when Typing

If checked, the mouse pointer is hidden while you type.

Blink Cursor

Enable or disable cursor blinking.

Enable Blinking Text

Enable or disable blinking text.

Display

Terminal Columns

Enter the number of columns for the terminal. This setting will only be applied on specific window resize actions.

Terminal Rows

Enter the number of rows for the terminal. This setting will only be applied on specific window resize actions.

Window Resize Action

Configure how PuTTY should behave when the window is resized.

Display Scrollbar

Shows or hides the scrollbar in the terminal.

Sunken-Edge Border

Show or hide a sunken-edge border.

Gap between Text and Window Edge

Configure the gap between text and border.

External Window

Window Title

By default the window title will contain the host name followed by ‘PuTTY’, for example server1.example.com - PuTTY. If you want a different window title, this is where to set it. The title string set here is therefore only the initial window title. Replacement tokens are supported.

Separate Window and Icon Titles

If you want to see window and icon titles, enable this option.

Warn before closing Window

When checked, a warning is shown before the window is closed.

Close Window on Alt-F4

Control whether Alt-F4 will close the window or not.

If checked, Alt-Space will bring up the system menu.

If checked, pressing Alt will bring up the system menu.

Ensure Window is Always on Top

If checked, the PuTTY window will be always on top.

Full Screen on Alt-Enter

If checked, Alt-Enter will change the PuTTY window into Full Screen mode.

Colors

The Colors page allows you to modify the terminal palette and colors for different text styles.

Color Usage

Use Background Color to Erase Screen

Not all terminals agree on what color to turn the screen when the server sends a ‘clear screen’ sequence. Background-color erase can be turned on and off by control sequences sent by the server. This configuration option controls the default state.

Allow Terminal to Specify ANSI Colors

If it is disabled, PuTTY will ignore any control sequences sent by the server to request colored text.

Allow Terminal to Use xterm 256-Color Mode

If disabled, PuTTY will ignore any control sequences sent by the server which use the extended 256-color mode supported by recent versions of xterm.

Bold Text is a Different Color

If disabled, bold and non-bold text will be displayed in the same color, and instead the font will change to indicate the difference.

Attempt to Use Logical Palette

If you are not getting the colors you ask for on an 8-bit display, you can try enabling this option.

Use System Colors

Enabling this option will cause PuTTY to ignore the configured colors for ‘Default Background/Foreground’ and ‘Cursor Color/Text’, instead going with the system-wide defaults.

Normal and Bright Colors

Adjust the ANSI color palette for individual colors.

Palette

The drop-down button allows you to apply built-in or custom terminal color schemes. It also allows you to export and manage terminal palettes for easy sharing.

Tip

You can read more about this topic here

Credentials

The Credentials page allows you to assign a credential to the object. You can specify username and password, assign a predefined credential or you specify a credential by name (ideal when you share your configuration). You can also use the credentials defined in the parent folder.

Do not use any credentials

When selected, no credentials are configured for the object. Connections that require credentials may prompt to enter credentials or fail to connect.

Use credentials from the parent folder (not always available)

When selected, Royal TS will look for a configured credential in the parent folder.

Note

Not available for Royal Server objects, Secure Gateway objects, Remote Desktop Gateway objects and Key Sequence Tasks

Use from this connection (not always available)

When selected, the username and password is used from the context connection object.

Specify username and password

When selected, a username and password can be provided. For domain accounts use the syntax "domain\username" (without the quotes).

Use an existing credential

When selected, assign an existing credential to the object using the drop-down list. Use the add button to add a new credential. Use the edit button to edit the selected credential.

Tip

The drop-down list supports sorting and filtering "as you type" to easily find the correct credential.

Specify a credential name

When selected, enter or choose a credential name you want to assign to the object during connect-time.
If you enter '?' (without the quotes) as credential name, Royal TS will prompt for credentials by showing the credential picker dialog.

Note

Assigning a credential by name is recommended when a team of users share the same configuration file. Each user can define his own credential as long as it is using the same name and saves the credential in his own personal and protected document. This makes sharing files across team members very easy while keeping credentials safe.

Omit Domain

When checked, Royal TS will omit the domain portion of the username (domain\username or username@domain).

Note

The Omit Domain checkbox is not available for all object types!

Automatic Logon

When checked, Royal TS will use the credentials to log on to the connection automatically. This setting applies only to connection types supporting automatic logon and is ignored if a connection doesn't support automatic logon.

Note

To access the configured credentials through replacement tokens (for example in Auto Fill or Key Sequence Task configurations), use the replacement tokens \(EffeciveUsername\) and \(EffectivePassword\).

Edit Source

Opens the properties dialog of the source object for the configuration. This button will only be available when the object is configured to use the parent configuration.

Private Key File

Save Mode

Path to Private Key Fie
Embed Private Key File

Private Key File

Specify the full path to the private key file or click on browse button to browse for the file.

Passphrase

Enter a passphrase.

Tasks

You can specify a task to be executed before a connection is established and after it has been disconnected. For example: establish a VPN connection before you connect and close it after disconnect.

Connect Task

Do not execute a task

Royal TS will not execute a command task when a connection is established.

Use task from parent folder

Royal TS will look for a configured connect task in the parent folder. This option is not available on the document level.

Use an existing task

Choose a command task from the drop-down list. Use the add button to add a new credential. Use the edit button to edit the selected credential.

Note

The drop-down list supports sorting and filtering "as you type" to easily find the task you are looking for.

Specify a task name

When selected, enter or choose a task name you want to assign to the object during connect-time.

Note

Assigning a task by name is recommended when a team of users share the same configuration file. Each user can define his own task as long as it is using the same name and saves the task in his own personal and protected document. This makes sharing files across team members very easy.

Wait for connect task completion

If checked, Royal TS will wait for the selected task to finish before the connection will be established.

Execute for first connection in folder

If checked, the task will only be executed if no other connection in the same folder is active.

Note

This setting might be useful if you need to setup a VPN connection. Put all your connections which require you to setup this VPN in one folder and Royal TS will establish the VPN connection only for your first connection.

Abort when connect task fails

If checked, the connection will not be established when the configured task fails and returns an Exit Code other than 0.

Disconnect Task

Do not execute a task

Royal TS will not execute a command task when a connection is disconnected.

Use task from parent folder

Royal TS will look for a configured disconnect task in the parent folder. This option is not available on the document level.

Use an existing task

Choose a command task from the drop-down list. Use the add button to add a new credential. Use the edit button to edit the selected credential.

Note

The drop-down list supports sorting and filtering "as you type" to easily find the task you are looking for.

Specify a task name

When selected, enter or choose a task name you want to assign to the object during disconnect-time.

Note

Wait for disconnect task completion

If checked, Royal TS will wait for the selected task to finish before the connection will be disconnected.

Execute for last connection in folder

If checked, the task will only be executed if it is the last active connection in the folder.

Note

This setting might be useful if you need to setup a VPN connection. Put all your connections which require you to setup this VPN in one folder and Royal TS will disconnect the VPN connection after the last connection is disconnected.

Key Sequence

The Key Sequence page allows you to configure a sequence of key strokes (simulating keyboard events) to be sent to the connection after the connection has been established.

Do not send a key sequence

This is the default value. If selected, no key sequence is sent to the remote session after connect.

Use key sequence task from parent folder

Royal TS will look for a configured key sequence task in the parent folder. This option is not available on the document level.

Specify a key sequence

If selected, a key sequence can be specified for this connection.

Note

Use the fly-out button to the right to show a list of available replacement tokens and special key commands. Use the WAIT command anywhere in the sequence to delay the sequence.

Examples for Key Sequences:

A group policy is set to show a message whenever a user is attempting to log on interactively. Create a key sequence "{WAIT:1000}{ENTER}" which will wait 1 second (1000ms) after successfully connected to the remote desktop session and sends the ENTER key to the remote session to confirm the message.
A web page connection to a flash based application which requires you to log on using a username and password can be configured to send the appropriate key sequence after the connection has been established.

Use an existing key sequence task

If selected, a key sequence task can be specified for this connection.

Note

If a key sequence is in progress, do not interact with Royal TS or any other application after you connect. The status bar message indicates when a key sequence is in progress and when it has finished.

Specify a key sequence task name

When selected, enter or choose a key sequence task name you want to assign to the object during connect-time.

Note

Edit Source

Opens the properties dialog of the source object for the configuration. This button will only be available when the object is configured to use the parent configuration.

Window Mode

The Window Mode page allows you to control where the connection should open. Most connection types support Main Window (Embedded) mode and External Window mode. Remote Desktop connections, for example, additionally support External Window (Full Screen) mode.

Open connection in

Main Window (Embedded)
When selected, the connection will be embedded in the main window.
External Window When selected, the connection will open in an external window.
External Window (Full Screen)
When selected, the connection will open in an external window in full screen mode (no window title bar and borders).

Use Multiple Monitors

If checked, the connection will use all monitors if connected in Full Screen mode or if the connection is changed to use Full Screen mode while connected.

Note

This option is only available for connections supporting full screen and multiple monitors (like Remote Desktop).

Don't show the connection bar

If checked, the connection bar will not be shown in full screen mode.

Note

This option is only available for Remote Desktop connections. To display the connection bar, use the Ctrl + Alt + Home keyboard shortcut.

External Window Settings

The following settings can be configured when the window mode configuration is set to external window.

Screen

Remember Screen
Royal TS remembers which screen the connection was on after you've disconnected the connection and tries to open the external connection window on the same screen the next time you connect.
Screen 1 ... 9
Choose on which screen you want the external connection to be opened.

Note

Setting the Screen configuration to a screen which is currently not available on your computer will be ignored as long as the screen is not available. A common scenario for this is, working with the same file on a laptop computer with only one screen and a workstation with multiple screens connected. Setting connections to open on the Screen 3 will open on the main display on your laptop while the same connection will open on your workstation on Screen 3.

Position

Remember Position
Royal TS will remember the last window position after you've disconnected the connection and tries to open the external connection window at the same position the next time you connect.
Custom Left and Top
Specify the left and top coordinates (in pixels) where the external connection window should be positioned.

Size

Remember Size
Royal TS will remember the last window size after you've disconnected the connection and tries to open the external connection window with the same size the next time you connect.
Custom Width and Height
Specify the width and height (in pixels) of the external connection window.
Maximize
The external connection window will be maximized.
Preferred Size
The external connection window will use the sized configured in the connection. This setting will only be effective for connection types supporting a custom client size (for example the Desktop Size in the Display Options of a Remote Desktop Connection). If a connection type doesn't support a custom client size the setting will be ignored and the external window will be maximized.

Minimize Main Window

When checked, Royal TS will minimize the main window after the connection was established.

Open Display Properties

Opens the display properties control panel. With the control panel you can identify your screens.

Dashboard

The Dashboard page allows you to setup the default dashboard behavior for this connection. Dashboards are updated when a selection has changed. By default, the dashboard tab is shown and activated for inactive connections.

Use the plugin default settings

If selected, Royal TS will use the plugin default settings for the dashboard. You can change the plugin default settings by clicking on the Settings... button. Changes to the plugin default settings will affect all connections using the same plugin and the default settings. See also: Plugins

Use connection specific settings

If selected, Royal TS allows you to configure the dashboard settings for the connection.

Secure Gateway

The Secure Gateway page allows you to configure a Secure Gateway object for supported connections or choose to use a Secure Gateway configuration from the parent folder.

The following object types can be assigned:

Secure Gateway
Royal Server
Azure Bastion Gateway

Use Secure Gateway from the parent folder

If checked, Royal TS will look for a configured Secure Gateway in the parent folder. This option is not available on the document level.

Gateway Usage

Never
The Secure Gateway is never used and Royal TS will directly connect to the remote computer.
Always
The Secure Gateway is always used and Royal TS will tunnel all communication to the remote computer through the gateway.
On Demand
The Secure Gateway will be used if the target machine cannot be reached directly.

Direct Connect (No Secure Gateway)

This is the default value. If selected, no Secure Gateway is used and Royal TS will directly connect to the remote computer.

Specify a Secure Gateway object

The selected Secure Gateway object is used for supported connections.

Note

A Secure Gateway is a component included in Royal Server and can be used to connect through an SSH tunnel (port forwarding).

Edit Source

Opens the properties dialog of the source object for the configuration. This button will only be available when the object is configured to use the parent configuration.

Active Plugin

The Active Plugin page allows you to setup which plugin should be used for this connection.

Use Application Default Setting

If checked, the application default plugin is used for this connection. Clear the check box to configure a specific plugin for this connection.

Click on Open Plugin Management to change the default plugin for this connection type.

Active Plugin

Select the plugin which should be used for this connection.

Information

Click on the information button to open the selected plugin information page.

Settings

Click on the settings button to open the selected plugin settings page.

Open Plugin Management

Click to open the Plugin management dialog.

Advanced

The Advanced page allows you to configure advanced Terminal settings.

General

Encoding

Select one of the supported encoding settings.

^E Response

Configure how PuTTY should answer back to the ^E sequence.

Local Echo

Specify the local echo discipline.

Local Line Editing

Specify the line editing discipline.

Auto Wrap

Specify whether or not to turn on auto wrap mode for the connection.

DEC Origin Mode

Specify whether or not to turn on DEC origin mode for the connection.

Implicit CR in LF

If checked, the PuTTY connection implies a carriage return in every received linefeed.

Implicit LF in CR

If checked, the PuTTY connection implies a linefeed in every received carriage return.

Force Non-Destructive Backspace

If checked, PuTTY will treat incoming destructive backspace characters (7F) as non-destructive backspace characters (08).

Terminal Speeds

Set the speeds for the data connection.

Printer

Select a printer to select ANSI printer output for remote-controlled printing.

Bell

Bell Action

Action to happen when a bell occurs.

Sound File

Specify a custom sound file (.wav file) to play as a bell.

Taskbar Indicator

Taskbar caption indicator on bell.

Bell Overload (Temporary)

Temporarily disable bell when over-used.

Number of Bells

Specify the number of bells threshold used to determine bell over-use.

Bell Overload Timespan

Specify the number of seconds for the over-use threshold.

Seconds of Silence

Specify the number of seconds silence is needed to re-enable the bell after it was temporarily disabled.

Features

Remote Window Title Query

PuTTY can optionally provide the xterm service of allowing server applications to find out the local window title. This feature is disabled by default, but you can turn it on if you really want it.

Disable Remote-Controlled Terminal Resizing

If checked, PuTTY will not respond to server commands which may cause terminal resizing.

Disable Remote-Controlled Window Title Change

If checked, PuTTY will ignore server commands which would update the window title.

Disable Remote-Controlled Character Set Configuration

PuTTY has the ability to change its character set configuration in response to commands from the server. If checked, PuTTY will ignore those server commands.

Disable Switching to Alternate Terminal Screen

Many terminals, including PuTTY, support an ‘alternate screen’. If checked, the alternate screen is disabled.

Disable Arabic Text Shaping

If checked, Arabic text shaping is disabled.

Disable Bidirectional Text Display

If checked, bidirectional text display is disabled.

Connection

Logical Name for Remote Host

Enter the logical name for the remote host for SSH key lookup or similar.

Internet Protocol Version

Choose which IP version PuTTY should use.

Keep Alive Interval (sec.)

Interval between sending of null packets to keep the session active. Set to 0 to turn keepalive off.

Disable Nagle's Algorithm (TCP_NODELAY Option)

The Nagle algorithm is disabled by default for interactive connections.

Enable TCP Keepalives (SO_KEEPALIVE Option)

TCP keepalives may be more useful for ensuring that half-open connections are terminated than for keeping a connection alive. TCP keepalives are disabled by default.

Translation

Line drawing handling

Configure how PuTTY should handle line drawing.

Treal CJIK Ambiguous Characters as Wide

If checked, PUTTY will treat CJIK ambiguous characters as wide.

Caps Lock acts as Cyrillic Switch

If checked, PuTTY will treat the Caps Lock key to switch to and back from Cyrillic.

Copy and Paste Line Drawing Characters as lqqqk

If checked, PuTTY will use lqqqk characters in clipboard operations.

VT100 Line Drawing even in UTF-8 Mode

If checked, VT100 line drawing is enabled even in UTF-8 mode.

Environment

The Environment tab can be used to set specific variables and values for the connection.

SSH Settings

The SSH Settings page allows you to configure settings specific for SSH connections.

General

Use Hostkey

If checked, PuTTY's hostkey command line option will be set with the value specified in the Fingerprint property.

Fingerprint

Specify an MD5-based host key fingerprint of the form displayed in PuTTY's Event Log and host key dialog box or a base64-encoded blob describing an SSH-2 public key in OpenSSH's one-line public key format. Pre-populating the fingerprint can be helpful when connecting through SSH tunnels, proxy servers or secure gateways.

SSH Remote Command

In SSH, you don't have to run a general shell session on the server. Instead, you can choose to run a single specific command (such as a mail user agent, for example). Replacement tokens are supported.

Preferred Protocol Version

PuTTY will attempt to use protocol 1 if the server you connect to does not offer protocol 2, and vice versa.
If you select ‘1 only’ or ‘2 only’ here, PuTTY will only connect if the server you connect to offers the SSH protocol version you have specified.

Don't Start a Shell or Command

If checked, a session is started but without a pseudo-terminal.

Enable Compression

This enables data compression in the SSH connection. This can help make the most of a low-bandwidth connection.

Encryption

Encryption Cipher Policy

When you make an SSH connection, PuTTY will search down the list from the top until it finds an algorithm supported by the server, and then use that. If the algorithm PuTTY finds is below the ‘warn below here’ line, you will see a warning box when you make the connection.

Enable Legacy Single-DES (SSH-2)

Single-DES is not recommended in the SSH 2 draft protocol standards, but one or two server implementations do support it.

Kex

Key Exchange Algorithm Policy

PuTTY supports a variety of SSH-2 key exchange methods, and allows you to choose which one you prefer to use. If the first algorithm PuTTY finds is below the ‘warn below here’ line, you will see a warning box when you make the connection.

Max Minutes before Rekey

Configure the timespan between rekey attempts. Set to 0 to disable rekey.

Max Data before Rekey

Use 1M for 1 megabyte, 1G for 1 gigabyte, etc.

Auth

Bypass Authentication (SSH-2)

In SSH-2, it is possible to establish a connection without using SSH's mechanisms to identify or authenticate oneself to the server.

SSH-2 servers can provide a message for clients to display to the prospective user before the user logs in.

Attempt Authentication using Pageant

If this option is enabled, then PuTTY will look for Pageant (the SSH private-key storage agent) and attempt to authenticate with any suitable public keys Pageant currently holds.

Attempt TIS or CryptoCard Authentication (SSH-1)

TIS and CryptoCard authentication are (despite their names) generic forms of simple challenge/response authentication available in SSH protocol version 1 only.

Attempt Keyboard-Interactive Authentication (SSH-2)

The SSH-2 equivalent of TIS authentication is called ‘keyboard-interactive’.

Note

You may need to enable this option when your servers requires multi-factor authentication (MFA).

Allow Agent Forwarding

This option allows the SSH server to open forwarded connections back to your local copy of Pageant. If you are not running Pageant, this option will do nothing.

Allow attempted Changes of Username (SSH-2)

The SSH-2 protocol does allow changes of username, in principle, but does not make it mandatory for SSH-2 servers to accept them. If you know your server can cope with it, you can enable this option.

Credentials

Certificate to use with the private key

OpenSSH certificate to use with the private key specified on the credentials page.

Plugin command to run

Enter the full command line for the authentication plugin to run.

GSSAPI

Attempt GSSAPI Authentication (SSH-2)

If it is enabled, GSSAPI authentication will be attempted, and (typically) if your client machine has valid Kerberos credentials loaded, then PuTTY should be able to authenticate automatically to servers that support Kerberos logins.

Allow GSSAPI Credential Delegation

If you enable this option, then not only will PuTTY be able to log in automatically to a server that accepts your Kerberos credentials, but also you will be able to connect out from that server to other Kerberos-supporting services and use the same credentials just as automatically.

GSSAPI Library Order

Configure the preferred order of GSSAPI libraries.

User-Supplied GSSAPI Library

Specify a custom GSSAPI library (DLL).

TTY

Don't Allocate a Pseudo Terminal

Occasionally you might find you have a need to run a session not in a pseudo-terminal.

X11

Enable X11 Forwarding

Check to enable X11 forwarding for this connection.

X Display Location

The ‘X display location’ box is blank by default, which means that PuTTY will try to use a sensible default such as :0, which is the usual display location where your X server will be installed.

X11 Authentication Protocol

Configure the X11 authentication protocol.

X Authority File for Local Display

Specify a X authentication file for the local display.

Input

The Input page allows you to configure keyboard behavior in the remote session.

Keyboard

Terminal Name

Default is xterm. Allows you to set a custom terminal name.

Function Key Mode

Specify how to encode function keys such as F1-F20, INS, Del, Home, etc.

Backspace Sequence

Specify the backspace key sequence 0x08 (^H) or 0x7F (^?).

Home and End Key

Specify the behavior of the Home and End keys.

Cursor Key Mode

Specify the initial cursor key mode Normal or Application.

Ignore Remote Cursor Key Mode

If checked, PuTTY will ignore cursor key mode changes requested by the remote server.

Numeric Keypad

Specify the numeric keyboard mode.

Disable Application Keypad Mode

If checked, PuTTY will ignore keypad mode changes from the application on the server.

Use AltGr as Compose Key

DEC terminals have a Compose key, which provides an easy-to-remember way of typing accented characters. If checked, AltGr acts as compose key.

Control-Alt is Different from AltGr

If checked, the key combination Ctrl + Left Alt is treated the same way as the AltGr key.

Mouse

Mouse Button Mode

Choose Compromise for right-click paste and middle-click extend. Windows for middle-click extends and right-click brings up the context menu. xtermn for right-click extend and middle click paste.

Selection Mode

Specify the initial selection mode.

Shift Overrides Applications use of Mouse

If checked, the terminal screen reverts to the last entries when you press a key.

Disable xterm-Style Mouse Reporting

When checked, the mouse will always do copy and paste in the normal way.

Clipboard

Auto-copy selected text to system clipboard If checked, PuTTY will automatically copy the selected text to the system clipboard.

Mouse paste action

Select the mouse paste action performed by PuTTY.

{Ctrl,Shift} + Ins

Select the action performed by PuTTY when pressing Ctrl, Shift and Insert.

Ctrl + Shift + {C,V}

Select the action performed by PuTTY when pressing Ctrl, Shift and C or V key.

Permit control characters in pasted te&xt

If checked, PuTTY allows you to paste text with control characters.

Paste to Clipboard in RTF as well as Plain Text

If checked, PuTTY will write formatting information to the clipboard as well as the actual text you copy.

Scrollback

Scrollback Lines

Specify the number of lines kept in the scrollback buffer.

Telnet

Telnet OLD_ENVIRON Ambiguity

This setting allows you to choose whether PuTTY claims to be BSD or RFC-compliant (OLD_ENVIRON/NEW_ENVIRON).

Telnet Negotiation Mode

In active mode, PuTTY starts to send negotiations as soon as the connection is opened. In passive mode, PuTTY will wait to negotiate until it sees a negotiation from the server.

Telnet Keyboard sends Special Commands

If this box is checked, the Backspace key on the keyboard will send the Telnet special backspace code, and Control-C will send the Telnet special interrupt code.

Telnet Return Key sends New Line (instead of ^M)

If checked, PuTTY sends Control-M instead of the Telnet New Line code when you press Return.

Tunnels

The Tunnels page allows you to configure SSH port forwarding (tunneling).

Local Ports accept Connections from other Hosts

If checked, it allows you to set up local-to-remote port forwarding in such a way that machines other than your client PC can connect to the forwarded port (this also applies to dynamic SOCKS forwarding).

Remote Ports accept Connections from other Hosts

If checked, machines other than the SSH server machine can connect to the forwarded port.

Source Port

Set the source port.

Destination

Set the destination.

Serial Port

The Serial Port page allows you to configure the port settings to connect to devices using RS232.

Port Name

Set the port for communications.

Important

The Port Name must begin with COM.

Handshake

Set the handshaking protocol for serial port transmission of data.

Baud Rate

Set the speed of the serial port communication.

Data Bits

Set the standard length of data bits per byte.

Stop Bits

Set the standard number of stop bits per byte.

Parity

Set the parity checking protocol.

Proxy Settings

The Proxy Settings page allows you to configure a proxy server used to connect to the remote server.

General

Proxy Mode

No proxy (direct connect): (No proxy server will be used to connect to the remote server)
Socks 4
Socks 4a
Socks 5
HTTP Connect
Telnet
Local

Proxy Server

Specify the proxy server name (FQDN) or IP address to use.

Port

Specify the proxy server port to use.

Credential Mode

Do not use any credentials

When selected, no credentials are configured for the object. Connections that require credentials may prompt to enter credentials or fail to connect.

Use credentials from the parent folder (not always available)

When selected, Royal TS will look for a configured credential in the parent folder.

Note

Not available for Royal Server objects, Secure Gateway objects, Remote Desktop Gateway objects and Key Sequence Tasks

Use from this connection (not always available)

When selected, the username and password is used from the context connection object.

Specify username and password

When selected, a username and password can be provided. For domain accounts use the syntax "domain\username" (without the quotes).

Use an existing credential

When selected, assign an existing credential to the object using the drop-down list. Use the add button to add a new credential. Use the edit button to edit the selected credential.

Tip

The drop-down list supports sorting and filtering "as you type" to easily find the correct credential.

Specify a credential name

Note

Advanced

Exclude Host/IPs

Enter a comma seperated list of hosts or IPs. You may also use wildcards like: 192.168.88.*, *.example.com

Consider Proxying Local Host Connections

Connections to the local host (the host name localhost, and any loopback IP address) are never proxied. You can change that by enabling this option.

DNS Lookup at Proxy End

No: PuTTY will do DNS resolution.
Auto: PuTTY will resolve depending on the proxy mode.
Yes: PuTTY will always pass host names to the proxy.

Telnet or Local Proxy Command:

You can use a command such as: %user\n%pass\nconnect %host %port\n

Logging

The Logging page allows you to configure session logging. Log files can be viewed using the Dashboard.

General Logging Options

Session Logging

Choose which type of information should be logged during a session.

Omit Known Password Fields

If checked, the content of known password fields is not logged. Applies only to SSH packet logging.

Omit Session Data

If checked, no session data is logged. Applies only to SSH packet logging.

Log File Options

Log File Name

The log file name can contain &Y, &M, &D for date, &T for time, and &H for host name. If you leave the log file name blank, Royal TS will generate a file name based on the connection name and the time stamp. Replacement tokens are supported.

Path

Specify a path where all the log files are saved. Each log file will be named automatically based on the connection name and the time stamp.

Open in Explorer

Click to open the specified folder in the Windows Explorer.

Create Sub-Directory with Connection Name

If checked, Royal TS will create a directory with the connection name and write the recording files into it.

Log File Options

Configure what to do if the log file already exists.

Flush Log File Frequently

If checked, PuTTY will flush data as soon as it is displayed, so that if you view the log file while a session is still open, it will be up to date; and if the client system crashes, there's a greater chance that the data will be preserved. If PuTTY is running slowly with logging enabled, you could try unchecking this option.

Notes

The Notes page allows you to enter notes for the selected object with HTML formatting, links and embedded images. You can also configure the notes to be inherited from the parent folder.

Use Notes from the parent folder

When selected, Royal TS will display the notes from the parent folder in the notes panel. This option is not available on the document level.

Tip

To embed images, drag them into the editor using drag & drop.

Custom Properties

The Custom Properties page allows you to enter and store additional information for the object. Various data formats are available, including protected fields. You can also group properties by using Header.

Inherit from Parent

When checked, the properties configured on the parent folder are shown but are read-only.

Custom Properties

Use the '+' icon to add a header or a Field or multiple fields based on a template. Click on the label to name the field and enter a value. Click the 'Gear' icon to remove a field or header. The 'Gear' icon also shows additional options, like moving a field up or down.

Custom Fields

The Custom Fields page allows you to enter and store additional information for the object. Custom fields can be used in tasks and templates to inject values from the context connection.

Standard custom fields are also shown in the folder dashboard views and in the properties panel. Protected custom fields can be used to store confidential data (for example when you need an additional password in a task). If you make use of protected custom fields, make sure you encrypt and password protect your document.

Note

Custom fields can be used in Tasks and in the Properties Panel. You can put web page URLs (like an iLO management address) or command lines (such as programs or batch files) in the custom fields and execute them using tasks or directly from the properties panel. Each individual custom field can also be configured to be inherited from the parent folder.

Parent Folder

The Parent Folder page allows you to view or change the parent folder of the selected object. To move multiple objects to another folder use the parent folder page in bulk-edit mode or use the move to command from the Edit tab (see Working with Connections).

Important

You cannot create connections in the Application document. Moving a folder containing connections to a folder in the Application document will fail.

Terminal (PuTTY)

Note

Dashboard

Dashboard Features

Dashboard Settings

Plugin Settings

Executable

Registry Base Path

Window Title Match

Connection Properties

Terminal Properties

Display Name (required)

Color

Icon

Connection Type

Note

PuTTY Session (only available when Existing PuTTY Session is selected)

Important

Computer Name (required)

Tip

Port

Close on Exit

Description

MAC Address

Display Options

Font

Font

Font Size

Font is Bold

Font Quality

Cursor Appearance

Hide Mouse Pointer when Typing

Blink Cursor

Enable Blinking Text

Display

Terminal Columns

Terminal Rows

Window Resize Action

Display Scrollbar

Sunken-Edge Border

Gap between Text and Window Edge

External Window

Window Title

Separate Window and Icon Titles

Warn before closing Window

Close Window on Alt-F4

Show System Menu on Alt-Space

Show System Menu on Alt Alone

Ensure Window is Always on Top

Full Screen on Alt-Enter

Colors

Color Usage

Use Background Color to Erase Screen

Allow Terminal to Specify ANSI Colors

Allow Terminal to Use xterm 256-Color Mode

Bold Text is a Different Color

Attempt to Use Logical Palette

Use System Colors

Normal and Bright Colors

Palette

Tip

Credentials

Do not use any credentials

Use credentials from the parent folder (not always available)

Note

Use from this connection (not always available)

Specify username and password

Use an existing credential

Tip

Specify a credential name

Note

Omit Domain

Note

Automatic Logon

Note

Edit Source

Private Key File

Save Mode

Private Key File

Passphrase