set putty

Purpose

Configures terminal-emulation settings for ConnectPort Display, and displays current terminal-emulation settings.

ConnectPort Display can emulate a terminal connected to a host/server over a serial line or the network. When connected over the network RealPort must be installed on the server. RealPort ports appear to applications on the server as serial ports, but the data is redirected over the network to the terminal. For more information on RealPort, see the RealPort Installation Guide.

A ConnectPort Display device can emulate a terminal connected to a host/server. Data sent from the host application is processed and displayed on the terminal screen. A keyboard can also be used. If a keyboard is connected to the terminal, the terminal data is sent to the host application for it to process.

A reboot is required for the terminal-emulation settings to take effect.

Syntax

Set general terminal emulator options

set putty [state={on|off}]
  [width={80|132}]
  [height=10-60]
  [hostport={/com/0|/com/1|/vcom/0]
  [keyboardport={/com/0|/com/1}]
  [cursortype={none|block|underline|vertical}]
  [blinkcursor={on|off}]
  [blinktext={on|off}]
  [backspaceisdelete={on|off}]
  [lfimpliescr={on|off}]
  [characterset=host charset]

Set key mappings - range required

set putty
[deletekeymaprange=1-32]
[keymaprange=1-32]
[inseq=00-FF]
[outseq=00-FF]

Display terminal emulation settings

set putty

Options

General terminal emulation options

state={on|off}

Enables or disables the terminal emulator.

width={80|132}

The default width of the terminal, specified as the number of columns of text to display on the terminal emulator. The default width is 80.

height=10-60

The default height of the terminal, specified as the number of rows of text to display on the terminal emulator. The default height is 24.

hostport={/com/0|/com/1|/vcom/0}

Specifies how the terminal emulator connects to a host application, and how it reads input from the host. The terminal emulator reads input from a host application and displays it on the screen. Input can be read over one of the serial ports on the ConnectPort Display, or over the network. Network connections are achieved using Realport.

Valid values are /com/0 and /com/1 (serial ports 1 and 2) and /vcom/0 (network via RealPort). The default is /com/0.

When using a network connection, you must install the RealPort driver on the host. This will create a virtual COM port for each serial port on your ConnectPort Display (these are the traditional RealPort COM ports) as well as one additional virtual COM port that can be used for the terminal emulator connection. The host application must be configured to use this additional virtual COM port.

keyboardport={/com/0|/com/1|No Keyboard}

Specifies how a keyboard, if used, is connected to the terminal emulator. Connecting a keyboard is optional. The terminal emulator can read keyboard input from one of the serial ports. Keyboard data is then passed back up to the host application over the host connection.

Valid values are /com/0 and /com/1 (serial ports 1 and 2) and No Keyboard. The default is /com/1.

In some environments, the keyboard data should not be passed back up to the host application over the host connection. In this case, you can still connect a keyboard to a serial port, and simply treat it like any other serially connected device. To do so, you would configure the terminal emulator to use No Keyboard for the keyboard connection, and then configure the serial port for the keyboard to use the RealPort port profile. Keyboard data would then be sent to the host system over the standard RealPort COM port. In this case, the host application reads keyboard data from one COM port and writes host data to a different COM port.

cursortype={none|block|underline|vertical}

Specifies how the cursor appears on the terminal emulator display: as a block, an underline, a vertical line, or no cursor.

none

The cursor has no visible display characteristics.

block

The cursor is displayed as a block.

underline

The cursor is displayed as an underline (underscore) character.

vertical

The cursor is displayed as a vertical bar.

The default is underline.

blinkcursor={on|off}

Enables or disables blinking of the cursor. The default is on.

blinktext={on|off}

Enables or disables the use of blinking text.The terminal emulator can display text that blinks on and off. This setting allows you to turn off blinking text. When blinking text is disabled and the terminal emulator attempts to make some text blink, the text will instead be displayed with a bold background color. The default is on.

backspaceisdelete={on|off}

This option allows you to choose which code, ASCII code 8 or 127, is generated and sent to the host when the Backspace key is pressed. On some terminals, pressing the Backspace key sends the same code as Ctrl-H (ASCII code 8). On other terminals, pressing the Backspace key sends ASCII code 127 (usually known as Ctrl-? or Delete), so that the action can be distinguished from Ctrl-H. The default is on.

lfimpliescr={on|off}

Specifies whether an LF (Line Feed) character includes an implicit CR (Carriage Return) character.

Most servers send two control characters, CR and LF, to start a new line of the screen. The CR character makes the cursor return to the beginning of the current line of text. The LF character makes the cursor move one line down. Some servers only send LF, and expect the terminal to move the cursor over to the left automatically. If your server does this, you will see a stepped effect on the screen. If this happens, try enabling this setting.The default is off.

characterset=host charset

The character set for data received from the host. During a session, the terminal emulator receives a stream of 8-bit bytes from the server, and in order to display them on the screen it needs to know the character set in which to interpret these streams of bytes.

There are several character sets from which to choose. A few notable character sets are:

The ISO-8859 series are all standard character sets that include various accented characters appropriate for different sets of languages.
The Win125x series are defined by Microsoft for similar purposes. Win1252 is almost equivalent to ISO-8859-1, but contains a few extra characters such as matched quotes and the Euro symbol.
CP437 contains the old IBM PC character set with block graphics and line-drawing characters. This is also used on MS-DOS systems.
UTF-8 contains unicode data interpreted as being in the UTF-8 encoding. Not all server applications will support UTF-8.

The default is ISO-8859-1.

The complete list of allowed character sets is:

Character Set name	Description
ISO-8859-1	ISO-8859-1:1998 (Latin-1, West Europe)
ISO-8859-2	ISO-8859-2:1999 (Latin-2, East Europe)
ISO-8859-3	ISO-8859-3:1999 (Latin-3, South Europe)
ISO-8859-4	ISO-8859-4:1998 (Latin-4, North Europe)
ISO-8859-5	ISO-8859-5:1999 (Latin/Cyrillic)
ISO-8859-6	ISO-8859-6:1999 (Latin/Arabic)
ISO-8859-7	ISO-8859-7:1987 (Latin/Greek)
ISO-8859-8	ISO-8859-8:1999 (Latin/Hebrew)
ISO-8859-9	ISO-8859-9:1999 (Latin-5, Turkish)
ISO-8859-10	ISO-8859-10:1998 (Latin-6, Nordic)
ISO-8859-11	ISO-8859-11:2001 (Latin/Thai)
ISO-8859-13	ISO-8859-13:1998 (Latin-7, Baltic)
ISO-8859-14	ISO-8859-14:1998 (Latin-8, Celtic)
ISO-8859-15	ISO-8859-15:1999 (Latin-9, “euro”)
ISO-8859-16	ISO-8859-16:2001 (Latin-10, Balkan)
CP437	CP437 (IBM-437/MS-DOS Latin, United States)
CP850	CP850 (IBM-850/MS-DOS Latin 1, West Europe)
CP1250	Win1250 (Central European)
CP1251	Win1251 (Cyrillic)
CP1252	Win1252 (Western)
CP1253	Win1253 (Greek)
CP1254	Win1254 (Turkish)
CP1255	Win1255 (Hebrew)
CP1256	Win1256 (Arabic)
CP1257	Win1257 (Baltic)
CP1258	Win1258 (Vietnamese)
KOI8-R
KOI8-U
Mac Roman
Mac Turkish
Mac Croatian
Mac Iceland
Mac Romanian
Mac Greek
Mac Cyrillic
Mac Thai
Mac Centeuro
Mac Symbol
Mac Dingbats
Mac Ukraine
Mac VT100
VISCII
HP ROMAN8
DEC MCS
UTF-8

Key mapping terminal emulation options

Character codes received from a keyboard can be converted to different character codes before being sent to the host. This conversion, known as key mapping, can be useful when you have different types of keyboards that need to be mapped to the same set of character codes.

A key mapping consists of an input sequence of character codes and the output sequence of codes to which they will be converted. Generally, you would specify both the input and output sequences as single character codes, although you can define up to 5 character codes for each. A character code is entered as two hexadecimal digits. For example:

To convert the ASCII character A to B, you would define the input and output sequences as 41 and 42 respectively, which are the hexadecimal representations of the ASCII characters.
To convert a code of decimal 10 to 0, you would define the input and output sequences as 0A and 00, respectively.

Note that character codes are always two hexadecimal digits, which means that leading zeroes must be provided.

A key mapping entry requires a range, specified by keymaprange, and at least an input sequence, specified by inseq. The output sequence (outseq) is optional. When removing a key mapping entry, only deletekeymaprange is required.

The keymap entries are held in a table, as are other device settings such as UDP, serial destinations, and alarms. When adding a new entry (an inseq/outseq pair), you specify at what index in the table to add it using keymaprange.To delete an entry (or range of multiple entries) you specify the index/range with deletekeymaprange. Note that the Terminal Emulation settings in the web interface manages the indexes for you. If you do not want to deal with the key mappings at an index level, you can configure the key mapping through that interface.

Options specified for key mapping include:

deletekeymaprange=1-32

Removes the key mapping entry at the specified index or range of indexes.

keymaprange=1-32

The index/range used when adding new key mapping entries or replacing existing ones.

inseq=00-FF

The input key sequence, specified as two hexadecimal digits.

outseq=00-FF

The output sequence, specified as two hexadecimal digits.

Example

Display current terminal emulation settings

#> show putty
Terminal Configuration :

state = on
width = 80
height = 24
hostport = /com/0
keyboardport = /com/1
cursortype = underline
blinkcursor = on
blinktext = on
backspaceisdelete = on
lfimpliescr = off
characterset = ISO-8859-1
Key Map: range 		inseq      outseq
	1 	                              A1           F1
	2        	                      A2           F2
	3        	                      A3           F3

Configure general terminal emulation settings

Given the above settings, to adjust the screen height and cursor type, you would enter:

# set putty height=30 cursortype=vertical

Add, replace, and delete entries in the key mapping table

To add/replace the first 3 entries in the table you would use the following commands:

#> set putty keymaprange=1 indeq=A1 outseq=F1

#> set putty keymaprange=2 indeq=A2 outseq=F2

#> set putty keymaprange=3 indeq=A3 outseq=F3

Now, to delete the first 2 entries:

#> set putty deletekeymaprange=1-2

You are left with one keymap entry, and it is at index 3, so to delete this last one enter:

#> set putty deletekeymaprange=3