12. TELNET: Connecting to Remote Terminals

Introduction

The Virtual Terminal Protocol (TELNET) provides connections to remote hosts. With it, you can access remote hosts using OpenVMS commands or a UNIX style command interface.

The Client-TELNET utility is your interface to TELNET OpenVMS. You can run Client-TELNET interactively or through a startup command procedure.

Client-TELNET supports normal and TN3270 mode:

  Normal mode uses your local OpenVMS keyboard. In this mode, you can open up to ten TELNET sessions at one time.

  In TN3270 mode, Client-TELNET emulates the keyboard normally used on an IBM 3270-class terminal. It allows you to connect only one TN3270 session at a time.

Before Using TELNET

Before you use TELNET, ask your system manager if the TELNET-OpenVMS software was installed, configured, and started on your system.

To use TELNET with Kerberos version 4 authentication, your system manager must have configured TCPware's Kerberos Services.

Before you can connect to a remote host, you need to know:

  The name of the remote host to which you want to connect.

  The username and password for each account on the remote host. If the remote host does not support multiuser protection features, you may not need a username and password. If you are using TCPware's Token Authentication, you also need to enter the additional PASSCODE from your SecurID© token (see theOPEN command for details).

  How to use the operating system of the remote host.

Note!     Client-TELNET does not restrict the ASCII character set to seven-bit ASCII as the TELNET standard implies. Client-TELNET supports the full eight-bit (multinational) character set. To use the multinational character set, you must configure your terminal to support eight-bit characters. The peer TELNET implementation must also support the same.

Opening a TELNET Session

Run the Client-TELNET utility to connect to a remote host. Client-TELNET supports as many as 10 connected sessions at any one time. However, of these ten sessions, only one can be a TN3270 session. To open a TELNET session (see Example 12-1):

1   At the DCL prompt, enter:   $ TELNET

2   Use the OPEN command to open a remote TELNET session in one of the following ways:

a      To use standard authentication, at the TELNET> prompt, enter either:

TELNET>OPEN host
TELNET>OPEN host /AUTH=NULL
—host is the name of the host to which you want to connect. /AUTH=NULL explicitly specifies to use standard authentication.

b      To use Kerberos version 4 authentication, enter at the TELNET> prompt:

TELNET> OPEN host /AUTH=KERBV4 /REALM=realm

host is the name of the host to which you want to connect.

—/AUTH=KERBV4 specifies the use of Kerberos version 4 authentication.

—/REALM=realm specifies the name of the Kerberos Server realm.

You must first get a ticket-granting ticket (TGT) from the Kerberos Server. (See Chapter 4, Kerberos User Commands.)

You can specify the Kerberos realm using the /REALM qualifier. If you omit the qualifier, the contents of the TCPWARE:KRB.REALMS file determines the Kerberos realm.

To open a connection, TELNET first tries to use Kerberos version 4 authentication if requested, then reverts to standard authentication if Kerberos version 4 authentication fails.

3   Respond to the login prompts, if any, of the remote host, including any PASSCODE.

4   Open another session if desired:

a      Return to the local TELNET prompt by entering the escape sequence displayed when opening the connection (usually Ctrl/\). The previous session remains open.

b      Use the OPEN command to open the next session. Repeat steps 2 and 3.

Alternative method. You can also open a remote TELNET connection as follows:

$ TELNET host

See the OPEN, CLOSE, and EXIT commands in the Command Reference.

Example 12-1    Opening Multiple TELNET Sessions

(IRIS) $ TELNET
TELNET>OPEN BART
%TCPWARE_TELNET-I-TRYING, trying bart.nene.com,telnet(192.168.1.92,23)...
%TCPWARE_TELNET-I-ESCAPE, escape (attention) character is "^\"

(login procedure to BART)

(BART) $ Ctrl/\

TELNET> OPEN MARGE                    [BART remains open]
%TCPWARE_TELNET-I-TRYING, trying marge.nene.com,telnet
(192.168.1.91,23)...
%TCPWARE_TELNET-I-ESCAPE, escape character is "^\"

(login procedure to MARGE)

(MARGE) $ Ctrl/\

TELNET>OPEN HOMER                           [BART and MARGE remain open]
%TCPWARE_TELNET-I-TRYING, trying homer.nene.com,telnet
(192.168.1.90,23)...
%TCPWARE_TELNET-I-ESCAPE, escape character is "^\"

(login procedure to HOMER)

(HOMER) $ Ctrl/\

TELNET> OPEN LISA       [BART, MARGE, and HOMER remain open]
%TCPWARE_TELNET-I-TRYING, trying lisa.nene.com,telnet
(192.168.1.89,23)...
%TCPWARE_TELNET-I-ESCAPE, escape character is "^\"

(login procedure to LISA)

(LISA) $ Ctrl/\

TELNET> OPEN /AUTH=KERBV4 /REALM=SIMPSONS.COM MAGGIE
%TELNET-I-TRYING, trying maggie.yours.com,telnet (192.168.99.1,23)...
%TELNET-I-ESCCHR, escape (attention) character is "^\"
(MAGGIE) $

Note!     TCPware provides secure TELNET-OpenVMS logins through its Token Authentication feature, if installed and enabled. For more information, see Chapter 14, Token Authentication: Protecting Logins.

Opening a TN3270 Session

Client-TELNET supports TN3270 mode for local OpenVMS terminals. The remote IBM host must support a TELNET server.

You can only connect one TN3270 session at any one time. Client-TELNET returns an error message if you try to open more than one TN3270 session.

To open a TELNET session in TN3270 mode (see Example 12-2):

1   At the DCL prompt, enter:  $ TELNET

2   Use the OPEN command at the TELNET> prompt:    TELNET>OPEN host [/TN3270]

TELNET servers that cannot automatically negotiate this mode require the /TN3270 qualifier.

3   Enter the TN3270 escape sequence Ctrl/C instead of Ctrl/\.

4   If you want to print a screen in TN3270 mode, add the /PRINT qualifier as follows:

TELNET>OPEN host /TN3270 /PRINT=(FILE=filename | QUEUE=qname)

SeeTN3270 Screen Printing and Dumping.

5   Only one TN3270 session can be open at any given time. If you try to open more than one TN3270 session, Client-TELNET returns an error message.

Table 12-1 lists the IBM terminal models and screen sizes Client-TELNET supports. To use the emulated model, your terminal must support the minimum size (number of rows and columns) indicated. DECwindows, DECterm, and virtual workstation (VWS) windows resize accordingly.

Table 12-1     Supported IBM Models 

Emulated Model

Minimum Size (rows x columns)

IBM 3278-2

24 x 80

IBM 3278-3

32 x 80

IBM 3278-4

43 x 80

IBM 3278-5

27 x 132

 

Some Client-TELNET commands have specific meaning for TN3270 mode.

See TN3270 Keyboard Mapping.

Alternative method. You can also open a remote TELNET TN3270 connection by entering the following command:

$ TELNET host /TN3270

See the OPEN, CLOSE, and EXIT commands in the Command Reference.

Example 12-2     Opening a TN3270 Session

$ TELNET
TELNET>OPEN LOCIS.LOC.GOV
<Library of Congress menus displayed>
Ctrl/C

TELNET>CLOSE
TELNET>OPEN LOCIS.LOC.GOV /TN3270 /PRINT(=QUEUE=ENG_PRINTER_ASCII)
Ctrl/C

TELNET>OPEN BLUE.ADP.WISC.EDU /TN3270
%TCPWARE-TELNET-E-CONLOST, connection to remote host lost
%TCPWARE-TELNET-E-MAXTN3270, only one TN3270 session may be open at any
one time
%TCPWARE-TELNET-I-CURRSESSION, current session is not 1, LOCIS.LOC.GOV
TELNET>

Closing a Session

A TELNET session remains open until you log out of that session at the system prompt or use the CLOSE, EXIT, QUIT, or BYE commands or enter Ctrl/Z at the TELNET> prompt.

To close a TELNET session, use one of the following commands at the TELNET> prompt (see Example 12-3):

  TELNET>CLOSE            closes the current session, as in the following chart:

If you open a TELNET session using...

And...

Then CLOSE closes the current session and...

Telnet>OPEN host

It is the only session

There are other sessions

Keeps you in TELNET

Keeps you in TELNET with the other sessions open

$ TELNET host

It is the only session

There are other sessions

Exits TELNET

Keeps you in TELNET with the other sessions open

If you close the current session, and there are other connected sessions, Client-TELNET resets the current session to the "next" session.

  TELNET>CLOSE session-number

                                   closes only the specified session, as indicated by the

                                   SHOW STATUS command.

  TELNET> EXIT             exits TELNET

  TELNET>QUIT   exits TELNET

  TELNET>BYE      exits TELNET

  TELNET>Ctrl/Z        interrupts TELNET

See the OPEN, CLOSE, EXIT, and SHOW STATUS commands in the Command Reference.

Example 12-3     Closing TELNET Sessions

(IRIS) $ TELNET
TELNET>OPEN BART
%TCPWARE_TELNET-I-TRYING, trying bart.nene.com,telnet(192.168.1.92,23)... %TCPWARE_TELNET-I-ESCAPE, escape character is "^\"

(login procedure to BART)

(BART) $ Ctrl/\
TELNET> OPEN MARGE     [BART remains open]
%TCPWARE_TELNET-I-TRYING,trying marge.nene.com,telnet(192.168.1.91,23)... %TCPWARE_TELNET-I-ESCAPE, escape character is "^\"

(login procedure to MARGE)

(MARGE) $ Ctrl/\
TELNET>SHOW STATUS
Client-TELNET V6.0-0 Copyright (c) Process Software
Connected sessions:
     1. bart.nene.com,telnet (192.168.1.92,23).
 --> 2.  marge.nene.com, telnet (192.168.1.91,23).
"^\" is the escape (attention) character

TELNET> CLOSE 2
%TCPWARE_TELNET-I-CONNCLOSED, closing session 2, marge.nene.com
TELNET>CLOSE 1
%TCPWARE_TELNET-S-CONNCLOSED, closing session 1,bart.nene.com
TELNET>EXIT
(IRIS) $

Issuing Local Commands

You can issue commands to the Client-TELNET utility during a remote session by returning to the TELNET prompt. You can then enter one or more TELNET commands.

TELNET OpenVMS features multiline recall of up to 20 command lines using the standard OpenVMS line recall and editing keys.

You return to the remote session by entering the RESUME command.

To issue a local TELNET command while connected to a remote host and then resume the session on the host (see Example 12-4):

1   Enter the escape (attention) character to return to the TELNET prompt: for example: Ctrl/\

2   Issue a TELNET command. For example, you may want to:

     Issue the SHOW STATUS command. The SHOW STATUS command displays a list of open connections. The arrow (-->) identifies the current session.

Change the escape (attention) character using the SET ESCAPE command.

3   Return to the remote host by entering:  TELNET>RESUME

This command resumes to the current remote host. Pressing Return or entering the OPEN command also resumes to the current remote host.

To resume to a different session, enter:   TELNET>RESUME session-number

     session-number is the number of the session which you want to resume. The session-number refers to a particular connection, as displayed by the SHOW STATUS command.

You can switch between local TELNET command mode and the remote host as often as you like.

See the RESUME, SET ESCAPE, and SHOW STATUS commands in the Command Reference.

Example 12-4     Issuing TELNET Commands and Resuming a Session

(BART) $ Ctrl/\

TELNET>SHOW STATUS                                                   2
Client-TELNET V6.0-0 Copyright (c) Process Software
Connected sessions:
          1. BART.nene.com,  telnet  (192.168.1.92,23).
                 2. HOMER.nene.com, telnet  (192.168.1.90,23).
                 3. MARGE.nene.com, telnet  (192.168.1.91,23).
          -->    4. LISA.nene.com,  telnet  (192.168.1.89,23).

"^\" is the escape (attention) character.

TELNET>SET ESCAPE "^A"
escape (attention) character is "^A"

TELNET>RESUME
(BART) $

(BART) $ Ctrl/\

TELNET>RESUME 2
%TCPWARE_TELNET-I-RESUME, resuming session 2, HOMER.illiad.com
(HOMER) $

Running Applications over TELNET

You can run applications over a TELNET connection by creating an NTA terminal on the local client. You can only create such devices from TELNET with no other escaped connection. This section describes how to create non-permanent NTA devices. To create permanent NTA devices, see the next section.

Normally, Client-TELNET connects to an NTA device at the TCPware server end of the connection. It does not usually create a local NTA device. However, you can create a local NTA device so that you can run applications over the TELNET connection. To create a local NTA device (see Example 12-5):

1   Enter at the DCL prompt one of the following:

     $ TELNET host /CREATE

     TELNET>OPEN /CREATE

Use the second method if you already logged in to a host, and escaped from the session (using Ctrl/\ or some other defined escape sequence).

In both cases, this associates a pre-allocated local NTAx: terminal device to your TELNET connection; x is the next available unit number. No other escaped connection can exist during your TELNET session for this to work. (If one exists, the %TCPWARE_TELNET-E-CONNOPN error message appears.)

2   Run your application at the DCL prompt. Use the allocated terminal device as desired.

3   When your application ends, clean up by deallocating the NTA device you created using the following command at the DCL prompt:   $ DEALLOCATE device

See your OpenVMS documentation for details on the DEALLOCATE command.

Note!     Using /CREATE in this way creates a non-permanent NTA device, which has certain ramifications. See the next section for details on how to create a permanent NTA device. Using the OPEN /CREATE command as part of a TELNET command file creates an NTA device and exits TELNET right away without passing any further commands in the file to TELNET.

You can also invoke TELNET and use OPEN/CREATE non-interactively, such as with a batch file. The batch file cannot open an interactive connection. For applications run by the creating process, use the /LOGICAL qualifier to create a predefined name for the device. If this device is to be used by another process, the qualifier /LOGICAL=... /TABLE= may help reference it.  For example:

$ TELNET SIGMA /CREATE /LOGICAL=TELNET_NTA /TABLE=SYSTEM /MODE=EXEC

See the OPEN command in the Command Reference for other parameters you can use with the
/CREATE qualifier.

Example 12-5     Opening a TELNET Connection to a Terminal Device

$ TELNET MARGE /CREATE
%TCPWARE_TELNET-I-TRYING, trying marge.nene.com,telnet
(192.168.1.91,23)...
%TCPWARE_TELNET-I-ALOC,_MARGE$NTA1: allocated

$ SET HOST/DTE NTA1:
$ DEALLOCATE NTA1:

$ TELNET BART
%REM-I-TOQUIT, connection established

Press Ctrl/\ to quit, Ctrl/@ for command mode

OpenVMS VAX 5.-2 with TCPware for OpenVMS 5.6

Username: Ctrl/\
TELNET>OPEN /CREATE
%TCPWARE_TELNET-I-ALLOC, _NTA1: allocated
$ SET HOST/DTE NTA1:
$ DEALLOCATE NTA1:

Creating a Permanent NTA Device

You can also run applications over a TELNET connection by creating a permanent NTA terminal on the local client. This permanent device acts more like a LAT device; it is not automatically deleted when there are no process channels assigned to it, it can be handed off to other applications, and it has reconnect capabilities in case of a connection break. This section describes how to create permanent NTA devices. To create non-permanent NTA devices, see the previous section.

Using TELNET /CREATE by itself to create a non-permanent NTA device, such as in the previous section, has the following limitations:

  An application using this NTA device may be written to deassign and thus delete the device if the connection goes down. This could cause a conflict when rerunning the application if, meanwhile, another NTA connection with the same unit number is created.

  Handing off the NTA device to another process may require setting up the device as NOHANGUP.

  Recovery is not possible in case of a broken connection.

You can bypass these limitations and make the NTA device a permanent one by adding the PERMANENT keyword to the TELNET /CREATE command, as follows (see Example 12-6):

Note!     Creating a permanent NTA device requires OPER privilege.

1   Enter at the DCL prompt:

$ TELNET host port /CREATE=PERMANENT

or:

TELNET>OPEN host port /CREATE=PERMANENT

This creates a permanent local NTAx: terminal device with the next available unit number. However, unlike non-permanent NTA devices, the TELNET utility does not pre-allocate it. Likewise, you can specify the /LOGICAL qualifier to set up a logical name for the device so that other applications can use it.

It is advisable that you specify a port other than the default TELNET port 23.

See the OPEN command in the Command Reference section for other parameters you can use with the /CREATE=PERMANENT qualifier.

2   Run your application at the DCL prompt, as with a non-permanent NTA device. The difference is that handing off the NTA device to another process and recovery of a broken connection are enhanced.

3   In handing off the NTA device to another process, you may wish to change its protection:

     In VMS 5, use SET PROTECTION, or SET DEVICE /ACL.

     VMS 6 replaces these commands with SET SECURITY /PROTECTION= /ACL.

Example 12-6     Setting up a Permanent NTA Device

TELNET>OPEN MARGE 7 /LOGICAL=MY_PORT -
_TELNET>/CREATE=(PERMANENT,INTERVAL=10,RETRIES=10)
%TCPWARE_TELNET-I-CREATED, _NTA1: created

$ @MY_APPLICATION MY_PORT

Note!     For information on /LOGICAL= qualifier, see 12-33.

Handling a Broken Connection

If the connection to the remote port is broken, a temporary NTA device is reported as "Offline" with $QIO's failing with a SS$_DEVOFFLINE status. For a permanent NTA device, however:

  The NTA devchar is marked UNAVAILABLE (which can be viewed by using SYS$GETDVI to check if DVI$_DEVCHAR's DEV$V_AVL = 0).

  If a terminal Ctrl/Y AST is set up, the AST fires up. (Setup: Disable Ctrl/Y handling by DCL using LIB$DISABLE_CTRL( &LIB$M_CLI_CTRLY, 0 ), and set up the AST using SYS$QIOW with IO$_SETMODE | IO$M_CTRLYAST.)

  Terminal I/Os queued in the TTdriver are completed with the I/O Status Block (IOSB) having a status of SS$_HANGUP.

  A new write $QIO buffers the data so that it can be sent when reconnected. If no reconnection is being done, then one is set up.

  Data sent at the time of the broken connection may be lost.

  The client attempts to reconnect to the remote port as described in the
OPEN /CREATE=PERMANENT command section.

  The permanent NTA handles reconnects internally instead of allowing the program to issue the LAT SYS$QIOW with IO$TTY_PORT | IO$M_LT_CONNECT.

Closing the Connection After a Deassign

You can use the CLOSE_DASSGN keyword to the /CREATE=(PERMANENT) qualifier to close the underlying TCP connection when the last channel assigned to the NTA device is dropped using SYS$DASSGN. The default is not to close the TCP connection.

Startup Command File

You can have a startup file executed each time you invoke Client-TELNET. The TELNET_STARTUP logical specifies a file that contains commands you want performed at the beginning of each TELNET session.

To set up and run a startup command file (see Example 12-7):

1   Create a TELNET_STARTUP.COM file in your login directory.

2   In the file, include the TELNET command or commands you want executed each time you start Client-TELNET.

3   Edit your LOGIN.COM file and define the TELNET_STARTUP logical name to point to the startup file. For example, add the following line to your login file:

$ DEFINE/PROCESS TELNET_STARTUP "SYS$LOGIN:TELNET_STARTUP.COM"

4   Rerun LOGIN and run TELNET.

Whenever you run TELNET OpenVMS, it first looks for the file to which the TELNET_STARTUP logical points. It then processes all the commands contained in that file until it processes the EXIT command or reaches the end of the file.

If the OPEN command appears in this file, TELNET establishes the connection and all further input comes from the terminal. When you return to command mode, TELNET processes the rest of the commands in the startup file (if any).

If the EXIT command appears in the startup file, Client-TELNET ignores all commands following the EXIT command and continues TELNET operations, leaving the user at the TELNET prompt.

Example 12-7     Setting Up a Startup Command File

$ CREATE TELNET_STARTUP.COM
SET TRANSLATION /SEND=CR
OPEN IRIS
OPEN HOMER
SHOW STATUS
Ctrl/Z

$ EDIT SYS$LOGIN:LOGIN.COM
$ DEFINE/PROCESS TELNET_STARTUP "SYS$LOGIN:TELNET_STARTUP.COM"
Ctrl/Z

$ @SYS$LOGIN:LOGIN
$ TELNET
TELNET>SET TRANSLATION /SEND=CR
%TCPWARE_TELNET-I-TRNSNEWLN, will translate CR to CRLF when sent
TELNET>OPEN IRIS
%TCPWARE_TELNET-I-TRYING, trying IRIS.plants.com,telnet
 (192.168.1.93,23) ...
%TCPWARE_TELNET-I-ESCCHR, escape (attention) character is "^\"

(login procedure to IRIS)

(IRIS)$ Ctrl/\
TELNET>OPEN HOMER
%TCPWARE_TELNET-I-TRYING, trying HOMER.illiad.com,telnet
(192.168.1.90,23) ...
%TCPWARE_TELNET-I-ESCCHR, escape (attention) character is "^\"

(login procedure to HOMER)

(HOMER)$Ctrl/\
TELNET>SHOW STATUS

Connected sessions:
1. IRIS.plants.com, telnet         (192.168.1.93,23).
-->2. HOMER.illiad.com, telnet     (192.168.1.90,23).
"^\" is the escape (attention) character.

No characters are translated to CRLF when received.
CR is translated to CRLF when sent.
TELNET>RESUME
(HOMER)$

TN3270 Keyboard Mapping

When the current Client-TELNET session is in TN3270 mode, Client-TELNET lets your local OpenVMS keyboard emulate the keyboard normally used on an IBM 3270-class terminal. The TCPWARE:MAP3270.DAT file defines the  key mappings. The MAP3270.DAT file supports all the standard HP terminal types.

If you have a non-standard terminal, make sure the TCPWARE:MAP3270.DAT file and the OpenVMS SYS$SYSTEM:TERMTABLE.TXT file contain the appropriate keyboard definitions. If you need to alter definitions in the MAP3270.DAT file, note the following:

  MAP3270.DAT is not case-sensitive. IBM-to-OpenVMS Keyboard Map  lists the key mapping in this file.

  One entry contains all key definitions for a particular terminal.

  Use this format to define each key:

        key-name = 'key-sequence' ['key-sequence'];

  key-name is a key name defined in the MAP3270.DAT file.

  key-sequence is the sequence of OpenVMS keys used to perform the IBM function.

  Use the following conventions when you alter key map definitions:

Convention

Meaning

{ }

Encloses each entry

’ ’

Encloses key sequences.  For example: ’^m’

|

"or." For example: ’^z’’\EOM’

^

Introduces a control character.  For example: ’^z’

\n

Newline

\t

Tab

\r

Carriage return

/E

Escape

\

Represents a single quote when used in a key definition

;

Ends a key definition.  For example: ’^z’|  ’\EOM’;

#

Begins a comment

 

SeeTN3270 Keypad Graphics Characters.

Alternative key mappings

Client-TELNET provides an alternative mapping file that closely resembles the keyboard mappings provided by the OpenVMS DECwindows DECnet/SNA 3270 Terminal Emulator. To use these mappings, redefine the TCPWARE_TELNET_KEYBOARD_MAP logical to point to the MAP3270_DECSNA.DAT file. By default, this logical points to the MAP3270.DAT file.

You can also define your own key mapping file. Just make sure you redefine the TCPWARE_TELNET_KEYBOARD_MAP logical so that it points to the new file.

Table 12-2     IBM-to-OpenVMS Keyboard Map 

IBM Function

OpenVMS Keys

IBM Function

OpenVMS Keys

Enter

Ctrl/M or <CR>

PF15

Ctrl/F-1-5 or PF1-KP5

Clear

Ctrl/Z or Enter

PF16

Ctrl/F-1-6 or PF1-KP6

Newline

Ctrl/N

PF17

Ctrl/F-1-7 or PF1-KP7

Tab

Ctrl/I or Tab

PF18

Ctrl/F-1-8 or PF1-KP8

Backtab

Ctrl/B

PF19

Ctrl/F-1-9 or PF1-KP9

Left arrow

Ctrl/H or left arrow

PF20

Ctrl/F-2-0 or PF2-KP0

Right arrow

Ctrl/L or right arrow

PF21

Ctrl/F-2-1 or PF2-KP1

Up arrow

Ctrl/K or up arrow

PF22

Ctrl/F-2-2 or PF2-KP2

Down arrow

Ctrl/J or down arrow

PF23

Ctrl/F-2-3 or PF2-KP3

Home

KP. (keypad period)

PF24

Ctrl/F-2-4 or PF2-KP4

Delete

DEL or Remove

PA1

Ctrl/P-1 | ESC/PF1 | PF4

Erase to EOF

Ctrl/E

PA2

Ctrl/P-2 | ESC/PF2 | KP- (keypad dash)

Erase input

Ctrl/W

PA3

Ctrl/P-3 | ESC/PF3 | KP, (keypad comma)

Insert

Ctrl-space, ESC-space or Insert Here

Escape to TELNET command

Ctrl/C

PF1

ESC/1 or KP1

Master reset

Ctrl/G

PF2

ESC/2 or KP2

Set tab

ESC/;

PF3

ESC/3 or KP3

Delete tab

ESC/’

PF4

ESC/4 or KP4

Clear tabs

ESC/:

PF5

ESC/5 or KP5

Set margin

ESC/,

PF6

ESC/6 or KP6

Set home

ESC/.

PF7

ESC/7 or KP7

Column tab

ESC/¯

PF8

ESC/8 or KP8

Column back tab

ESC/­

PF9

ESC/9 or KP9

Indent

ESC/®

PF10

ESC/0 or PF1-KP0

Unindent

ESC/Ø

PF11

ESC/-or PF1-KP1

Indent

ESC/®

PF12

ESC/ = or PF1-KP2

Indent

ESC/®

PF13

Ctrl/F-1-3 or PF1-KP3

Indent

ESC/®

PF14

Ctrl/F-1-4 or PF1-KP4

Indent

ESC/®

 

TN3270 Internationalization

International character set support adds functionality to convert the Western European EBCDIC character set to the corresponding terminal character sets (multinational or national replacement).

Since current TCPware TN3270 does not support the structured field of the extended terminals, this support does not add the simultaneous multiple character set functionality the extended terminals provide.

The TELNET command line and OPEN command include two qualifiers to support TN3270 Internationalization:

/HOST_CHARACTER_SET=host-character-set-name
/TERMINAL_CHARACTER_SET=terminal-character-set-name

  /HOST_CHARACTER_SET lets you specify the national EBCDIC character set. Table 12-3 contains the supported character sets and their corresponding IBM code page numbers.

  /TERMINAL_CHARACTER_SET lets you specify the character set used on the terminal (OpenVMS system) side. Table 12-4 includes the supported Multinational and National Replacement character set values.

You can also use logicals to specify the host/terminal character set selection. The system manager may choose to set up a system logical to specify the default character set for his site. The logicals are:

TCPWARE_TN3270_HOST_CHARSET—Host character set
TCPWARE_TN3270_TERMINAL_CHARSET—Terminal character set

You can specify the same values as you do with the corresponding qualifiers. For example:

$ DEFINE/SYSTEM/EXEC TCPWARE_TN3270_HOST_CHARSET CANADIAN
$ DEFINE/SYSTEM/EXEC TCPWARE_TN3270_TERMINAL_CHARSET LATIN1

The TELNET SHOW STATUS command displays the currently selected character set for TN3270. For example:

TELNET>SHOW STATUS
Client-TELNET V6.0-0  Copyright (c) Process Software
Connected session:

  -->1. LOCIS.LOC.GOV, telnet (140.147.254.3,23). [TN3270 mode]

Current session is operating in 3270 mode.
Terminal type:  IBM-3278-2

Keyboard Map File:  TCPWARE:MAP3270.DAT

Host Character Set: CANADIAN
Terminal Character Set: LATIN1

Print key function:
Output File: SYS$LOGIN:TN3270.TXT

"^C" is the escape (attention) character.

Table 12-3     TN3270 Internationalization Character Sets 

Character Set

Code Page

Character Set

Code Page

AUSTRIAN

273

INTERNATIONAL

038

BELGIAN

274

NORWEGIAN

277

CANADIAN

037

PORTUGUESE

037

DANISH

277

SPANISH

284

DUTCH

037

SWEDISH

278

ENGLISH_UK

285

SWISS

500

ENGLISH_US

037

FRENCH

297

FINISH

278

ITALIAN

280

 

Note!     Some of the character sets in this table correspond to the same coded page.  If omitted, the code page defaults to 037.

Table 12-4     OpenVMS Character Sets

Multinational Character Sets

National Replacement Character Sets

DECMCS (default)

NORTH_AMERICA

LATIN1

FLEMISH
CANADIAN_FRENCH
BRITISH
DANISH
AUSTRIAN_GERMAN
DUTCH
ITALIAN
SWISS_FRENCH
SWISS_GERMAN
SWEDISH
NORWEGIAN
BELGIAN_FRENCH
SPANISH
PORTUGUESE

 

TN3270 Keypad Graphics Characters

The TN3270 keyboard mapping key definitions permit mapping keypad graphics characters (0-9 . , -) to themselves rather than to other 3270 functions. Modify the MAP3270.DAT file if you emulate a TN3270 keyboard but want to use the graphics keypad characters as they are on OpenVMS keys.

When you modify the MAP3270.DAT file to map the graphics keypad, use the key naming conventions shown in Table 12-5. Then make the keypad map to the graphics on the keys, as follows:

1   Modify TCPWARE:MAP3270.DAT (or a variant of it) to include the entry as shown in Example 12-8.

2   Search through the file and delete any other occurrences of these escape sequences.

3   The enter key (\EOM) maps to the HOME function by default. Change it to ENTER if desired.

Table 12-5     Graphics Keypad Naming Conventions

Use...

To represent OpenVMS Keypad Key...

NUM0 (through) NUM9

graphics 0 through 9

PERIOD

period (.)

COMMA

comma (,)

HYPHEN

hyphen (-)

 

Example 12-8     Sample Keypad Graphics Characters Definitions in the MAP3270.DAT File

# Use keys on numeric keypad as themselves (numbers)
hyphen = '\EOm'; comma = '\EOl'; period = '\EOn';
num0 = '\EOp';
num1 = '\EOq'; num2 = '\EOr'; num3 = '\EOs';
num4 = '\EOt'; num5 = '\EOu'; num6 = '\EOv';
num7 = '\EOw'; num8 = '\EOx'; num9 = '\EOy';

TN3270 Screen Printing and Dumping

You can print or dump to a file a TN3270 session screen by using additional qualifiers with the TELNET /TN3270 or OPEN /TN3270 command. You can specify a screen print or dump either during or after opening a connection to a host.

To print a screen in TN3270 mode or dump a screen into a specified file (see Example 12-9):

1   If you want to print the ensuing TN3270 screen while opening a TN3270 host connection, specify at the DCL prompt:

$ TELNET host /TN3270 /PRINT=(QUEUE=qname)

Or specify at the TELNET> prompt:

TELNET>OPEN host /TN3270 /PRINT=(QUEUE=qname)

You can also add the FORM parameter, which specifies the form name for the print queue, as in:

TELNET>OPEN host /TN3270 /PRINT=(QUEUE=qname, FORM=form-name)

2   If you want to print the current TN3270 session screen when already in TN3270 mode,  Ctrl/C out of the session and specify at the TELNET> prompt:

TELNET> SET PRINT /QUEUE=qname [/FORM=form-name]

The /QUEUE qualifier is like the QUEUE parameter and the optional /FORM qualifier is like the FORM parameter in step 1 previously.

3   If you want to dump the ensuing TN3270 screen into a file while opening a TN3270 host connection, specify at the DCL prompt:

$ TELNET host /TN3270 /PRINT=(FILE=filename)

Or specify at the TELNET> prompt:

TELNET>OPEN host /TN3270 /PRINT=(FILE=filename)

The default print setting is /PRINT=(FILE=SYS$LOGIN:TN3270.TXT, NOAPPEND). You can also use the APPEND keyword that appends the current screen dump onto an existing filename (NOAPPEND is the default):

TELNET>OPEN host /TN3270 /PRINT=(FILE=filename, [NO]APPEND)

4   If you want to dump the ensuing TN3270 screen into a file when already in TN3270 mode,  Ctrl/C out of the session and specify at the TELNET> prompt:

TELNET>SET PRINT /FILE=filename[/[NO]APPEND]

The default print setting is SET PRINT /FILE=SYS$LOGIN:TN3270.TXT /NOAPPEND. The /FILE qualifier is like the FILE parameter and the optional /APPEND qualifier is like the APPEND keyword in step 3.

5   Resume the current session. When you are at the desired screen, press the "Escape" character (however it is defined) together with the character P (uppercase or lowercase). (In the example, the "Escape" character is defined as F11 so that the print key sequence is F11/P.) Exit the session and check for the existence of the print queue or file.

Example 12-9     Printing and Dumping TN3270 Screens

$ TELNET LOCIS.LOC.GOV /TN3270 /PRINT=(QUEUE=ENG_PRINTER_ANSI)
L O C I S :  LIBRARY OF CONGRESS INFORMATION SYSTEM

      Choice: F11/Pquit

$ SHOW QUEUE ENG_PRINTER_ANSI
<shows active printer queue>

$ TELNET LOCIS.LOC.GOV /TN3270
L O C I S :  LIBRARY OF CONGRESS INFORMATION SYSTEM

      Choice: Ctrl/C
TELNET>SET PRINT /QUEUE=ENG_PRINTER_ASCII
TELNET>RESUME

      Choice: F11/Pquit
TELNET>QUIT
$ SHOW QUEUE ENG_PRINTER_ANSI
<shows active printer queue>
$ TELNET LOCIS.LOC.GOV /TN3270 /PRINT=(FILE=PRINTFILE.TXT, APPEND)
L O C I S :  LIBRARY OF CONGRESS INFORMATION SYSTEM

      Command ===>F11/Pquit
TELNET>QUIT
$ DIR PRINTFILE.TXT
<shows filename in directory; screen is appended onto existing file>

.TELNET>OPEN LOCIS.LOC.GOV /TN3270

      Command ===>Ctrl/C
TELNET>SET PRINT /FILE=PRINTFILE.TXT /APPEND
TELNET>RESUME

     Command ===> quit F11/P
TELNET>QUIT
$ TYPE PRINTFILE.TXT
<shows file; screen is appended onto existing file>

Sample Session

This section shows a sample Client-TELNET session.

See Example 12-10 for the corresponding numbered steps. In this sample session, a user on IRIS:

1   Starts TELNET.

2   Enters the SHOW STATUS command.

3   Connects to TULIP.

4   Logs in and does some work. (Note the appearance of the PASSCODE: prompt, since this user is protected using TCPware's Token Authentication.)

5   Enters the escape (attention) character to return to the TELNET prompt.

6   Changes the escape (attention) character and enters a SHOW STATUS command.

7   Enters the RESUME command to return to TULIP.

8   Logs out of TULIP.

9   Exits TELNET.

Example 12-10     Sample Client-TELNET Session

(Iris) $ TELNET
TELNET>SHOW STATUS
Client-TELNET V6.0-0 Copyright (c) Process Software
No connection established.
Terminal type list: VT300, DEC-VT300, IBM-3278-2
"^\" is the escape (attention) character

TELNET>OPEN TULIP
%TCPWARE_TELNET-I-TRYING, trying tulip.flower.com,telnet
(192.168.1.56,23)...
%TCPWARE_TELNET-I-ESCCHR, escape (attention) character is "^\"

SunOS UNIX 4.1 (tulip.flower.com)(ttyp2)

login: root
Password:

PASSCODE:

Last login: Wed Feb 21 10:57:25 from 198.168.1.105
Sun Microsystems Inc.   SunOS 5.9       Generic May 2002

tulip>ls
bin      mnt     notes     test.c     test_def.h
tulip>^ \

TELNET>SET ESCAPE "^A"
%TCPWARE_TELNET-I-ESCCHR, escape (attention) character is "^A"
TELNET>SHOW STATUS
Client-TELNET V6.0-0 Copyright (c) Process Software
Connected session:
     --1. tulip.flower.com,telnet (192.168.1.56,23).
"^A" is the escape (attention) character
TELNET>RESUME
tulip ls -A
.             .forward    bin         test.c
..            .login      mnt         test_def.h
.cshrc        .profile    notes
TELNET>EXIT
(Iris)$

Command Reference

The following pages consist of command descriptions for the available Client-TELNET commands.

You interact with Client-TELNET by typing commands at the TELNET> prompt. Client-TELNET supports the following OpenVMS-style commands:

CLOSE

SET [NO] BINARY

SET [NO]LOCAL_FLOW

DEFINE/KEY

SET [NO]BRK

SET LOG

EXIT

SET DEBUG

SET PRINT

FLUSH

SET DELETE_ALLOWED

SET TERMINAL_TYPE

HELP

SET [NO]EC

SET TRANSLATION

OPEN

SET [NO]EL

SET [NO]XDISPLOC

RESUME

SET [NO]ESCAPE

SHOW OPTIONS

SEND

SET [NO]FLUSH

SHOW STATUS

SET [NO]AO

SET [NO]FORWARD

SHOW TRANSLATION

SET [NO]AYT

SET [NO]GA

SPAWN

SET [NO]BACKWARD

SET [NO]IP

 

 

Table 12-6     TELNET Command Synonyms 

Synonym

Equivalent

Synonym

Equivalent

BYE or QUIT

EXIT

SET HOST

OPEN

CONNECT

OPEN

STATUS

SHOW STATUS

DISCONNECT

CLOSE

Z

SPAWN

ESCAPE

SET ESCAPE

 

 

 

This command reference includes:

Name of the command

Format of the command

Qualifiers, if applicable

Synonym, if available

Parameters, if applicable

Examples of usage

 


 

CLOSE

Closes the current connection or the session specified by the session number. If you are not connected to a remote host, this command has no effect.

When you open a session using the alternate TELNET host format, the CLOSE command:

  Exits TELNET if the connection is the only session.

  Keeps you in TELNET with the other session(s) open if there is at least one other session.

Format

CLOSE [session-number]

Synonym

DISCONNECT [session-number]

Parameter

session-number

Session number to close, based on the session number displayed by the SHOW STATUS command. If omitted, closes the current session. If there are any other connections open, Client-TELNET resets the current session to the "next" one.

Examples

You can use the SHOW STATUS command to display a list of open connections. These examples start with HOMER as the current session. There are three TELNET connections, as follows, with the current session being on HOMER:

     1. BART.nene.com,  telnet (192.168.1.92,23).
     2. MARGE.nene.com, telnet (192.168.1.91,23).
  -->3. HOMER.nene.com, telnet (192.168.1.90,23).

1   This example ends the session on MARGE. The current session is still HOMER. You can close any other session without affecting the status of the current session.

TELNET>CLOSE 2
%TELNET-S-LCLCLOSED, Local connection closed
-TELNET-I-SESSION, Session 02, host marge.nene.com, port 23
%TELNET-I-CURRSESSION, current session is now 3, homer.nene.com

2   This example ends the current session on HOMER and defaults to the session on BART. Because you are closing the current session, Client-TELNET resets the current session to the "next" connected session.

TELNET>CLOSE
%TELNET-S-LCLCLOSED, Local connection closed
-TELNET-I-SESSION, Session 03, host homer.nene.com, port 23
%TELNET-I-CURRSESSION, current session is now 1, bart.nene.com


 

DEFINE/KEY

Associates an equivalence string and a set of attributes with a key on the terminal keyboard.

Format

DEFINE/KEY key-name ["]equivalence-string["]

Parameters

key-name

Name of the key to define. Table 12-7 lists key designations for three terminal types:

  On LK201 terminals, the numeric keypad, editing keypad (except the $ and ^ arrow keys), or function key row (except F1 through F5).

  On VT52 terminals, all definable keys are on the numeric keypad.

  On VT100-type terminals, you can also define the Ü and Þ keys. On VT200 terminals, the Ü, Þ, and F6 through F14 keys are for command line editing. Issue the DCL command SET TERMINAL/ NOLINE_EDITING to define these keys before you run Client-TELNET. You can also press Ctrl/V to enable keys F7 through F14.

Table 12-7     Key Designations for Three Terminal Types 

Key Name

LK201

VT100-type

VT52

PF1

PF1

PF1

[blue]

PF2

PF2

PF2

[red]

PF3

PF3

PF3

[gray]

PF4

PF4

PF4

n/a

KP0,...KP9

0,...,9

0,...,9

0,...,9

PERIOD

.

.

.

COMMA

,

,

,

MINUS

-

-

-

ENTER

Enter

ENTER

ENTER

LEFT

RIGHT

Find (E1)

Find

 

 

Insert_Here (E2)

Insert_Here

 

 

Remove (E3)

Remove

 

 

Select (E4)

Select

 

 

Prev_Screen (E5)

Prev_Screen

 

 

Next_Screen (E6)

Next_Screen

 

 

HELP

Help

 

 

DO

Do

 

 

F6,...,F20

F6,...,F20

 

 

 

equivalence-string

String to substitute when you press the key. If the string contains spaces, enclose it in quotes.

Qualifiers

/ECHO (default)
/NOECHO

/ECHO (the default) displays the equivalence string on your screen after you press the key.
/NOECHO disables this. Use /NOECHO with /TERMINATE only.

/IF_STATE=(state-name[,state-name,... ])
/NOIF_STATE (default)

/IF_STATE specifies one or more state-names (alphanumeric strings separated by commas) for the key definition to be in effect. You can omit the parentheses if you specify only one state-name.
/NOIF_STATE is the default, where the current state applies.

Establish states using the /SET_STATE qualifier (see below). If you specify several state-names, you can define a key to have the same function in all the specified states.

/LOCK_STATE
/NOLOCK_STATE
(default)

/LOCK_STATE specifies that the state set by the /SET_STATE qualifier remains in effect until explicitly changed. /NOLOCK_STATE is the default, where the state set by /SET_STATE is in effect only for the next definable key that you press or for the next read terminating character that you type.

You can only specify /LOCK_STATE with /SET_STATE.

/SET_STATE=state-name
/NOSET_STATE (default)

/SET_STATE specifies the state-name (an alphanumeric string) to set when pressing the key. State-name is an alphanumeric string. The default is /NOSET_STATE, where the current locked state, if any, remains in effect.

/TERMINATE
/NOTERMINATE
(default)

Specifies whether to terminate (execute) the current equivalence string when you press the key.
/NOTERMINATE (the default) lets you create key definitions that insert text into command lines, at prompts, or into other text you type.


 

EXIT

Exits the Client-TELNET utility and returns to the DCL level.

If there is an open connection or log file, Client-TELNET closes it before exiting.

Once you exit, all connections to remote hosts are disconnected.

Format

EXIT

Synonyms

QUIT

BYE

Ctrl/Z


 

FLUSH

Discards all characters currently in the output stream from the server.

Ignored if no connection is open.

Note!     Unlike the flush character (see theSET  command), the FLUSH command does not use the timing-mark option.

Format

FLUSH


 

HELP

Obtains help on using the Client-TELNET utility.

TELNET help uses the OpenVMS interactive help facility.

To exit the help facility, press the RETURN key until you return to the TELNET> prompt.

Format

HELP [topic]

Parameter

topic

Topic on which you want help. Optional.


 

OPEN

Opens a connection to a remote host. You can open up to ten connections at any one time. The connection remains open until you log out of the remote host, or use the CLOSE or EXIT command at the TELNET> prompt.

To use Kerberos version 4 authentication with TELNET, you must first get a ticket-granting ticket (TGT) from the Kerberos Server. (See Chapter 4, Kerberos User Commands.)

If you are designated by the system administrator as having password authentication through Token Authentication, you need to enter the PASSCODE in addition to the username and password at a separate PASSCODE: prompt (see Setting Up a Startup Command File). Depending on which type of SecurID card you were assigned:

  Enter a combination of your memorized personal identification number (PIN) and the tokencode that appears on the card (with no separating space) at the PASSCODE: prompt, or

  Enter your memorized PIN on the PINPAD™ card and the resulting tokencode that appears on the card at the PASSCODE: prompt.

See Chapter 14, Token Authentication: Protecting Logins, for details on obtaining PASSCODEs.

Note!     The same parameters and qualifiers apply to the TELNET command on the DCL level as apply to the OPEN command within TELNET.

Format

OPEN [host [port]]

Synonyms

CONNECT[host [port]]
SET HOST[host [port]]

Parameters

host

Name of the remote host to which you want to connect. The host must exist on the network.

Enter OPEN host to open a remote connection and start the login sequence, if any. If you omit host and a connection is open, Client-TELNET resumes the session to that host.

port

Nonstandard service name or number of the remote port to which you want to connect. The default is TELNET or 23 (for the TELNET Server). Use only to connect to a nonstandard server. ALTERNATIVE: Use the /PORT qualifier (DO NOT use both in the same command; see Example 6).

Qualifiers

/AUTHENTICATION[=auth-type]

Determines the authentication method. If auth-type is KERBV4 (or the value is omitted), Kerberos version 4 authentication is used. If auth-type is NULL (or the entire qualifier is omitted), standard authentication is used.

/CREATE [=(PERMANENT, BROKE_TIMO=seconds, CLOSE_DASSGN,
INTERVAL=
seconds, [NO]KEEPALIVE, NOOPCOM, NOTCONNECTED_OK, RETRIES=number), SHUT_ABORT) ]

Associates the local client end of the TELNET connection to an NTA device. Lets you use the connection for terminal activities such as printing or running applications. Supports /RAW,
/LOGICAL, and /TIMEOUT.

The /CREATE keyword creates the NTA device as pre-allocated so that it is not deleted when exiting TELNET. However, deallocating the device deletes it automatically when there are no process channels assigned to it (the reference count drops to zero). The PERMANENT keyword causes the client NTA device NOT to be deleted automatically when there are no process channels assigned to it, thus creating a permanent connection similar to an application LTA device for LAT. As with LAT, if the TELNET connection is broken, the Client-TELNET device tries to reconnect to the specified host and port. Further parameters control the broken connection and reconnection algorithms:

BROKE_TIMO=seconds

Used to determine when a connection is broken. (Note that the OPEN /TIMEOUT qualifier value is used in establishing the connection, and another timeout of eight minutes is used when sending data.) If omitted, the /TIMEOUT value is used. Also applies to non-permanent NTA devices (when using OPEN/CREATE without the PERMANENT keyword).

CLOSE_DASSGN

Specifies that when the last channel is deassigned from the NTA device, the underlying TCP connection is closed. The default is NOT to close the TCP connection. Use with the PERMANENT keyword only.

INTERVAL=seconds

Connection retry interval, the minimum time to wait until another connect is attempted. The default is 120 seconds (two minutes). Use with the PERMANENT keyword only.

KEEPALIVE or NOKEEPALIVE

Controls whether keep-alive segments are sent to the remote port. The default is KEEPALIVE. Also applies to non-permanent NTA devices (when using OPEN/CREATE without the PERMANENT keyword).

NOOPCOM

Specifies that no OPCOM messages are used when a permanent NTA device fails to reconnect or reconnects after an initial failure. OPCOM messages are sent by default.

NOTCONNECTED_OK

A permanent NTA device is created even if a TCP connection cannot initially be set up.

RETRIES=number

Number of times to try to reconnect after a connection breaks; the default is -1, handled as an unsigned number and thus actually 4,294,967,295, which is, in effect, infinite. Use with the PERMANENT keyword only.

SHUT_ABORT

Specifies that a permanent NTA device will do extra TCP device cleanup after the underlying TCP connection is shutdown. This is similar to doing NETCU> KILL CONNECTION for a closed TCP device.

 

Setting RETRIES to 0 means that when either end closes the TCP connection, no reconnects automatically occur. However, a reconnection attempt is made without delay when a write operation to the permanent NTA device occurs. If RETRIES is not set to 0, automatic retries occur when the connection closes. If all those retries fail, and a write is done later to the NTA device, then the specified number of retries is attempted.

Here is a typical command to create a TELNET connection to a printer (note the use of /RAW to avoid sending TELNET options negotiation data):

TELNET /RAW /CREATE=(PERM, RETRIES=0, CLOSE) host port

After TELNET creates a permanent NTA device with an underlying TCP connection, the NTA device's reference count drops to 0; thus the TCP connection is closed. When a write operation occurs to the NTA device, an attempt is made to re-establish the TCP connection. Meanwhile the data being written is held so that it can be sent when reconnected. If all reconnects fail, the write data is dropped. When the application deassigns its channels to the NTA device, its TCP connection is again closed.

To specify that the permanent NT device should be treated as a local terminal rather than a remote terminal (to allow for spooling of the device), add the 'local' keyword to the TELNET “create” qualifier:

TELNET /CREATE=(PERM,LOCAL)

/HOST_CHARACTER_SET=name

Use with the /TN3270 qualifier to set the national EBCDIC character set for TN3270 Internationalization. Table 12-3 shows  the supported character sets and their corresponding IBM code page numbers.

/LOGICAL=name [/TABLE=table][/MODE=mode]

Logical name defined for the allocated NTA device. Use only with the /CREATE qualifier. The table values are PROCESS (the default), JOB, GROUP, or SYSTEM. The mode values are SUPERVISOR (the default) or EXECUTIVE.

/PORT=port

Nonstandard service name or number of the remote port to which you want to connect. The default is 23 (for the TELNET Server). Use only to connect to a nonstandard server. ALTERNATIVE: Use the port command parameter (DO NOT use both in the same command; see Set).

/PRINT=[(]{FILE=file[, [NO]APPEND]} | {QUEUE=qname[, FORM=form]}[)]

Prints a TN3270 screen or dumps it into a file. Use only with the /TN3270 qualifier. Provides the functionality of the PRINT key, which the TCPWARE:MAP3270.DAT file defines by default as follows:

lprt = '\Ep' | '\EP'; # ESCAPE-p, ESCAPE-P

Use either FILE or QUEUE, but not both:

FILE=file

Output file (the default is SYS$LOGIN:TN3270.TXT). APPEND appends each print page onto the file; NOAPPEND (the default) creates a new file for each page.

QUEUE=qname

Location of the print queue. FORM=form specifies the form to use when sending the page output to a print queue.

 

/RAW

Specifies a raw, binary connection that does not adhere to the TELNET protocol. Use only with the /CREATE qualifier.

/REALM=realm

Assigns the name of the Kerberos realm. If the Kerberos Server resides in a different realm than the local host, use this qualifier. Use with the /AUTHENTICATION=KERBV4 qualifier and value. The realm is converted to lowercase unless you enclose it in quotes.

/TERMINAL_CHARACTER_SET=name

Use with the /TN3270 qualifier to set the OpenVMS terminal character set for TN3270 Internationalization. Table 12-4 shows the supported Multinational and National Replacement character set values.

/TIMEOUT=seconds

Timeout time for establishing the TELNET control connection. If not specified, the default value of 120 seconds (2 minutes) applies. The minimum allowable value is 20.

/TN3270
/NOTN3270

/TN3270 enables TN3270 mode. Use this qualifier when you want your OpenVMS terminal to emulate an IBM 3270-class terminal but the server cannot negotiate this mode automatically. (If the server can negotiate TN3270 mode automatically, you can omit this qualifier.) Only one TN3270 session can be open at any one time. Use the /PRINT qualifier for printing or file-dumping a TN3270 screen.

Use /TN3270 with the /HOST_CHARACTER_SET and /TERMINAL_CHARACTER_SET qualifiers to support TN3270 Internationalization.

/NOTN3270 disables TN3270 mode. Use this qualifier if you connect to a remote terminal that supports both IBM 3270 mode and non-IBM 3270 connections.

Examples

1   This example opens a connection to host DAISY and enables TN3270 mode. Use /TN3270 only if the server cannot negotiate TN3270 mode automatically. Client-TELNET allows only one TN3270 session at any one time.

TELNET>OPEN /TN3270 DAISY

<login procedure to daisy....>

(daisy)$ Ctrl/\
TELNET>OPEN /TN3270 ROSE
%TCPWARE_TELNET-E-MAXTN3270, only one TN3270 session may be open at any time
TELNET>

2   This example opens a connection to host DAISY in TN3270 mode and specifies a Danish TN3270 Internationalization host character set:

TELNET>OPEN /TN3270 /HOST_CHARACTER_SET=DANISH DAISY

<login procedure to daisy....>

(daisy)$

3   This example opens three sessions. The first two use Kerberos version 4 authentication; the third uses standard authentication. The Kerberos Server realm is determined by the contents of the TCPWARE:KRB.REALMS file.

TELNET>OPEN /AUTH=KERBV4 BART

(bart)$ ^\
TELNET>OPEN /AUTH MARGE
(marge)$ ^\
TELNET>OPEN LISA

<login procedure to LISA....>

(lisa)$

4   This example opens a TN3270 connection and prints the next screen that appears to the print queue ENG_PRINTER_ASCII:

TELNET>OPEN DAISY /TN3270 /PRINT=(QUEUE=ENG_PRINTER_ASCII)

<login procedure to daisy....>

5   This example creates a permanent NTA device for the connection to MARGE port 7 for the user application. In case the connection goes down, it is set up so that automatic reconnection retries occur every 10 seconds for a total of 10 retries.

TELNET>OPEN /LOGICAL=MY_PORT -
_TELNET>/CREATE=(PERMANENT,INTERVAL=10,RETRIES=10) MARGE 7
%TCPWARE_TELNET-I-CREATED, _NTA2: created
$ @MY_APPLICATION MY_PORT

6   This example displays the results of using the port parameter value (telnet) together with the
/PORT qualifier and value in a single command:

TELNET>OPEN DAISY TELNET /PORT=23
%TCPWARE_TELNET-W-CONFLICT illegal combination of command elements - check documentation

7   This example displays a login session to DAISY that uses Token Authentication for password protection:

TELNET>OPEN DAISY
%TCPWARE_TELNET-I-TRYING, trying
DAISY.nene.com,telnet (192.168.142.7,23) ...
%TCPWARE_TELNET-I-ESCCHR, escape (attention) character is "^\"

           ** AUTHORIZED USE ONLY **   PHI (VAX/VMS V5.-2)

Username: PETER
Password:

Enter PASSCODE:
PASSCODE Accepted


 

RESUME

Resumes the current connection if you do not specify a session number. If you specify a session number, resumes the connection associated with the session number, as displayed by the SHOW STATUS (or STATUS) command.

Format

RESUME [session-number]

Parameter

session-number

Session number to resume, based on the session number the SHOW STATUS command displays. If omitted, resumes the current connection.

Examples

1   This example resumes the session on BART. Client-TELNET does not display a message if the user resumes the current session:

TELNET>SHOW STATUS
Connected session:
-->1. BART.humor.com, telnet (192.168.1.92,23).

TELNET>RESUME
(bart)$

2   This example resumes session 2 on MARGE:

TELNET>STATUS
Connected sessions:
   1. BART.humor.com,  telnet (192.166.1.92,23).
   2. MARGE.humor.com, telnet (192.166.1.91,23).
-->3. HOMER.illiad.com, telnet (192.162.1.90,23).

TELNET>RESUME 2
%TCPWARE_TELNET-I-RESUME, resuming session 2, MARGE.humor.com
(marge)$


 

SEND

Sends TELNET control functions or option negotiations to a remote host.

Format

SEND {control-function | {command  option}}

Parameters

control-function

Table 12-8 lists the available TELNET control functions. Send a control function to gain access to functions of the remote host that are not available from the keyboard.

Table 12-8     TELNET Control Functions

Control Function

Definition

AO

Abort Output

AYT

Are You There

BACKWARD

Sends the current Client-TELNET Backward character

BRK

Break

EC

Erase Character

EL

Erase Line

ESCAPE

Sends the current Client-TELNET Escape character

FORWARD

Sends the current Client-TELNET Forward character

GA

Go-Ahead

IP

Interrupt Process

NOIP

Do Not Interrupt Process

SYNCH

SYNCH signal

 

Command

One of the following TELNET protocol commands used in options negotiation:

DO

WILL

DONT

WONT

 

Option

Negotiated TELNET option. Client-TELNET supports the following option keywords:

ECHO

for the ECHO option

SEND WILL ECHO is an invalid command. Client-TELNET does not allow the user to send this option negotiation to the TELNET Server.

BINARY, or TRANSMIT_BINARY

for the TRANSMIT-BINARY option

SGA, or SUPPRESS_GO_AHEAD

for the SUPPRESS-GO-AHEAD option

 


 

SET [NO]AO

Defines, changes, or disables the "abort output" (AO) character. During a TELNET session, if you enter the defined AO character, Client-TELNET sends the TELNET AO control function to the server instead of the actual character.

Ignored if TN3270 mode is active.

Format

SET AO char
SET NOAO

Parameter

char

When entered, this character sends the TELNET AO control function to the server. You can specify this character in either of the following formats:

Numeric

ASCII value of the character.

String

Character string enclosed in quotes. Specify control characters by typing a caret (^) before the character.

 

There is no default AO character. Define the initial AO character using the TCPWARE_TELNET_AO logical name (in the process, job, group, or system logical name tables). To define the logical, use one of the following formats:

  $ DEFINE/PROCESS TCPWARE_TELNET_AO 15

  $ DEFINE/PROCESS TCPWARE_TELNET_AO """^O"""

Both commands set the AO character to Ctrl/O (ASCII 15). They are equivalent.

Qualifiers

/FLUSH (default)
/NOFLUSH

If you specify /FLUSH, Client-TELNET discards all characters currently in the output stream from the server when sending the AO control function. Client-TELNET uses the TELNET timing-mark option to accomplish this (the Server does not have to support this option for this feature to work). If you specify /NOFLUSH, Client-TELNET sends only the AO control function. If you omit both, the previous setting remains. The initial default is /FLUSH.

If there is no response to the timing-mark option, Client-TELNET may continue to discard output from the server. Use the FLUSH command to resume normal operation.

/SYNCH
/NOSYNCH
(default)

Sends the AO command followed by the SYNCH signal.

Examples

1   Each of these equivalent commands sets the AO character to Ctrl/O (ASCII 15):

TELNET>SET AO "^O"
TELNET>SET AO 15

2   This example removes the previous character definition, if any, for the AO control function:

TELNET> SET NOAO


 

SET [NO]AYT

Defines, changes, or disables the "are you there" (AYT) character. If you enter the defined AYT character during a TELNET session, Client-TELNET sends the TELNET AYT control function to the server instead of the actual character.  Ignored if TN3270 mode is active.

Format

SET AYT char
SET NOAYT

Parameter

char

When entered, this character sends the TELNET AYT control function to the server. You can specify this character in either of the following formats:

Numeric

ASCII value of the character.

String

Character string enclosed in quotes. Specify control characters by typing a caret (^) before the character.

 

There is no default AYT character. Define the initial AYT character using the TCPWARE_TELNET_AYT logical name (in the process, job, group, or system logical name tables). To define the logical, use one of the following formats:

  $ DEFINE/PROCESS TCPWARE_TELNET_AYT 7

  $ DEFINE/PROCESS TCPWARE_TELNET_AYT """^G"""

Both commands set the AYT character to Ctrl/G (ASCII 7). They are equivalent.

Qualifiers

/SYNCH
/NOSYNCH
(default)

Sends the AYT command followed by the SYNCH signal.

Examples

1   Each of these equivalent commands sets the AYT character to Ctrl/G (ASCII 7):

TELNET>SET AYT "^G"

TELNET>SET AYT 7

2   This example removes the previous character definition, if any, for the AYT control function:

TELNET>SET NOAYT


 

SET [NO]BACKWARD

Defines, changes, or disables the "backward (one session)" (BACKWARD) character. If you enter the BACKWARD character during a TELNET session, the "previous" numbered session becomes active. The previous numbered session is the session with the next lowest session number than the current session.

If the current session already has the lowest session number, the session with the highest session number becomes active. If there is only one active session available, that session remains active. In this case SET BACKWARD has no effect.

Ignored if TN3270 mode is active.

Format

SET BACKWARD char
SET NOBACKWARD

Parameter

char

When entered, this character causes the "previous" numbered session to become active. You can specify this character in either of the following formats:

Numeric

ASCII value of the character.

String

Character string enclosed in quotes. Specify control characters by typing a caret (^) before the character.

 

There is no default BACKWARD character. Define the initial BACKWARD character using the TCPWARE_TELNET_BACKWARD logical name (in the process, job, group, or system logical name tables). To define the logical, use one of the following formats:

  $ DEFINE/PROCESS TCPWARE_TELNET_BACKWARD 2

  $ DEFINE/PROCESS TCPWARE_TELNET_BACKWARD """^B"""

Both commands set the BACKWARD character to Ctrl/B (ASCII 2). They are equivalent.

Examples

1   Each of these equivalent commands sets the BACKWARD character to Ctrl/B (ASCII 2):

TELNET>SET BACKWARD "^B"

TELNET>SET BACKWARD 2

2   This example removes the previous character definition, if any, for the BACKWARD control function:

TELNET>SET NOBACKWARD


 

SET [NO]BINARY

Initiates negotiations to enable the TRANSMIT BINARY option for the client and server. This command:

  Pertains only to the current session.

  Automatically resumes the current session.

Use the SET NOBINARY command to initiate negotiations to disable the TRANSMIT BINARY option for the client and server.

Format

SET BINARY
SET NOBINARY


 

SET [NO]BRK

Defines, changes, or disables the break (BRK) character. If you define the BRK character during a TELNET session, Client-TELNET sends the TELNET BRK control function to the server instead of the actual character.

Ignored if TN3270 mode is active. The Server ignores the break character.

Format

SET BRK char
SET NOBRK

Parameter

char

When entered, this character sends the TELNET break control function to the server. Specified in either of the following formats:

Numeric

ASCII value of the character.

String

Character string enclosed in quotes. Specify control characters by typing a caret (^) before the character.

 

There is no default BRK character. Define the initial BRK character using the TCPWARE_TELNET_BRK logical name (in the process, job, group, or system logical name tables). To define the logical, use one of the following formats:

  $ DEFINE/PROCESS TCPWARE_TELNET_BRK 29

  $ DEFINE/PROCESS TCPWARE_TELNET_BRK """^]"""

Both commands set the break character to Ctrl/] (ASCII 29). They are equivalent.

Qualifiers

/FLUSH (default)
/NOFLUSH

If you specify /FLUSH, Client-TELNET discards all characters currently in the output stream from the server when sending the BRK function. Client-TELNET uses the TELNET timing-mark option to accomplish this (the server does not have to support this option for this feature to work).

If you specify /NOFLUSH, Client-TELNET sends only the BRK function. If you omit both, the previous setting remains. The initial default is /FLUSH.

Note!     If a server fails to respond properly to the timing-mark option, Client-TELNET may continue to discard output from the server. In this case, use the FLUSH command to resume normal operation.

Examples

1   Each of these equivalent commands sets the break character to Ctrl/] (ASCII 29):

TELNET>SET BRK "^]"
TELNET>SET BRK 29

2   This example removes the previous character definition, if any, for the break control function:

TELNET>SET NOBRK


 

SET DEBUG

Enables or disables the display of debugging information.

Format

SET DEBUG /CLASS=[(]keyword[,...)]

Qualifier

/CLASS[=keyword]

SET DEBUG requires the /CLASS qualifier. The optional keyword specifies the classes of debugging information to enable or disable. Use parentheses for multiple keywords separated by commas. Table 12-9 lists the supported keywords.

Table 12-9     Class Keywords

Keyword

Description

ALL

Enables the display of all classes.

OPTIONS

Enables the display of options negotiation information. Client-TELNET displays messages when it sends or receives TELNET options.

NETINPUT

Logs data that Client-TELNET receives and sends while in TN3270 mode.

NETOUTPUT

Logs data that Client-TELNET sends while in TN3270 mode.

NONE

Disables the display of all classes.

TTYINPUT

Logs data entered by the user at the terminal.

 

The initial setting is NONE.

SET DEBUG alone, or SET DEBUG /CLASS without the keyword, shows the current debug classes.

Examples

1   This example enables the display of options negotiation information:

TELNET>SET DEBUG/CLASS=OPTIONS

2   This example enables the display of options negotiation information and log-data sent and received while in TN3270 mode:

TELNET>SET DEBUG/CLASS=(OPTIONS, NETINPUT)


 

SET DELETE_ALLOWED

Allows deletion of an NTA device originally set up as permanent. The deletion occurs when there are no process channels assigned to the device.

See the OPEN /CREATE command for details on creating permanent NTA devices.

Format

SET DELETE_ALLOWED nta-device

Parameter

nta-device

NTA device set up using OPEN /CREATE=(PERMANENT...).

Example

This example allows the NTA33: device to be deleted when no channels are assigned to it:

TELNET>SET DELETE NTA33:


 

SET [NO]EC

Defines, changes, or disables the "erase character" (EC) character. If you enter the defined EC character during a TELNET session, Client-TELNET sends the TELNET EC control function to the server instead of the actual character.

Ignored if TN3270 mode is active.

Format

SET EC char
SET [NO]EC

Parameter

char

When entered, this character sends the TELNET EC control function to the server. You can specify this character in either of the following formats:

Numeric

ASCII value of the character.

String

Character string enclosed in quotes. Specify control characters by typing a caret (^) before the character.

 

There is no default EC character. Define the initial EC character using the TCPWARE_TELNET_EC logical name (in the process, job, group, or system logical name tables). To define the logical, use one of the following formats:

  $ DEFINE/PROCESS TCPWARE_TELNET_EC 4

  $ DEFINE/PROCESS TCPWARE_TELNET_EC """^D"""

Both commands set the EC character to Ctrl/D (ASCII 4). They are equivalent.

Examples

1   Each of these equivalent commands sets the EC character to Ctrl/D (ASCII 4):
TELNET>SET EC “^D”
TELNET>SET EC 4

2   This example removes the previous character definition, if any, for the EC control function:
TELNET>SET NOEC


 

SET [NO]EL

Defines, changes, or disables the "erase line" (EL) character. If you enter the defined EL character during a TELNET session, Client-TELNET sends the TELNET EL control function to the server instead of the actual character.

Ignored if TN3270 mode is active.

Format

SET EL char
SET NOEL

Parameter

char

When entered, this character sends the TELNET EL control function to the server. You can specify this character in either of the following formats:

Numeric

ASCII value of the character.

String

Character string enclosed in quotes. Specify control characters by typing a caret (^) before the character.

 

There is no default EL character. Define the initial EL character using the TCPWARE_TELNET_EL logical name (in the process, job, group, or system logical name tables). To define the logical, use one of the following formats:

  $ DEFINE/PROCESS TCPWARE_TELNET_EL 21

  $ DEFINE/PROCESS TCPWARE_TELNET_EL """^U"""

Both commands set the EL character to Ctrl/U (ASCII 21). They are equivalent.

Examples

1   Each of these equivalent commands sets the EL character to Ctrl/U (ASCII 21):
TELNET>SET EL "^U"
TELNET> SET EL 21

2   This example removes the previous character definition, if any, for the EL control function:
TELNET>SET NOEL


 

SET [NO]ESCAPE

SET ESCAPE changes the escape (attention) character. This command allows you to change the character to a key that is more convenient. The default escape character is ^\. You may want to change the escape character if the remote host uses that character to perform some function or if your terminal cannot generate the character.

SET NOESCAPE disables the escape (attention) character.

SET ESCAPE is ignored if TN3270 mode is active. However, SET NOESCAPE applies to all sessions, including TN3270 sessions.

Format

SET ESCAPE char
SET NOESCAPE

Synonym

ESCAPE = SET ESCAPE

Parameter

char

You can specify this character in either of the following formats:

Numeric

ASCII value of the character.

String

Character string enclosed in quotes. Specify control characters by typing a caret (^) before the character.

 

You can redefine the default escape (attention) character by defining the logical TCPWARE_TELNET_ESCAPE (in the process, job, group, or system logical name tables). The logical value has the same syntax as char. To define it, use one of the following formats:

  $ DEFINE/PROCESS TCPWARE_TELNET_ESCAPE 24

  $ DEFINE/PROCESS TCPWARE_TELNET_ESCAPE """^X"""

Both commands set the escape character to ASCII code 24 (Ctrl/X). They are equivalent.

  $ DEFINE/SYSTEM/EXEC TCPWARE_TELNET_ESCAPE -1

The -1 value disables the escape (attention) character.

Examples

1   Each of these equivalent commands sets the escape character to Ctrl/X (ASCII 24):

TELNET>SET ESCAPE "^X"

TELNET>SET ESCAPE 24

2   This example sets the escape character to right brace (}):

TELNET>SET ESCAPE "}"

3   This example removes the previous escape (attention) character definition, if any:

TELNET>SET NOESCAPE


 

SET [NO]FLUSH

Defines, changes, or disables the flush character.

If you enter the defined flush character during a TELNET session, Client-TELNET discards all characters currently in the output stream from the server. Client-TELNET uses the TELNET timing-mark option to accomplish this (a TELNET server need not support this option for this feature to work).

Note!     Client-TELNET ignores SET FLUSH when TN3270 mode is active.
If a Server fails to respond properly to the timing-mark option, Client-TELNET may continue to discard all output from the server. In this case, use the FLUSH command to resume normal operation.

Format

SET FLUSH char
SET NOFLUSH

Parameter

char

When entered, this character discards all characters currently in the output stream from the server. You can specify this character in either of the following formats:

Numeric

ASCII value of the character.

String

Character string enclosed in quotes. Specify control characters by typing a caret (^) before the character.

 

There is no default flush character. Define the initial flush character using the TCPWARE_TELNET_FLUSH logical name (in the process, job, group, or system logical name tables). To define the logical, use one of the following formats:

  $ DEFINE/PROCESS TCPWARE_TELNET_FLUSH 15

  $ DEFINE/PROCESS TCPWARE_TELNET_FLUSH """^O"""

Both commands set the flush character to Ctrl/O (ASCII 15). They are equivalent.

Examples

1   Each of these equivalent commands sets the flush character to Ctrl/O (ASCII 15):

TELNET>SET FLUSH "^O"
TELNET>SET FLUSH 15

2   Removes the previous character definition, if any, for the flush feature.

TELNET> SET NOFLUSH


 

SET [NO]FORWARD

Defines, changes, or disables the "forward [one session]" (FORWARD) character. If you enter the defined FORWARD character during a TELNET session, the "next" numbered session becomes active. The next numbered session is the session with the next highest session number than the current session.

If the current session already has the highest session number, the session with the lowest session number becomes active. If there is only one active session available, that session remains active. In this case SET FORWARD has no effect.

Ignored if TN3270 mode is active.

Format

SET FORWARD char
SET NOFORWARD

Parameter

char

When entered, this character causes the "next" numbered session to become active. You can specify this character in either of the following formats:

Numeric

ASCII value of the character.

String

Character string enclosed in quotes. Specify control characters by typing a caret (^) before the character.

 

There is no default FORWARD character. Define the initial FORWARD character using the TCPWARE_TELNET_FORWARD logical name (in the process, job, group, or system logical name tables). This logical value has the same syntax as char. To define the logical, use one of the following formats:

  $ DEFINE/PROCESS TCPWARE_TELNET_FORWARD 1

  $ DEFINE/PROCESS TCPWARE_TELNET_FORWARD """^A"""

Both commands set the FORWARD character to Ctrl/A (ASCII 1). They are equivalent.

Examples

1   Each of these equivalent commands sets the FORWARD character to Ctrl/A (ASCII 1):

TELNET>SET FORWARD "^A"
TELNET>SET FORWARD 1

2   This example removes the previous character definition, if any, for the FORWARD control function:

TELNET>SET NOFORWARD


 

SET [NO]GA

Defines, changes, or disables the "go-ahead" (GA) character. If you enter the defined GA character during a TELNET session, Client-TELNET sends the TELNET GA control function to the server instead of the actual character.

Ignored if TN3270 mode is active.

Format

SET GA char
SET NOGA

Parameter

char

When entered, this character sends the TELNET GA control function to the server. You can specify this character in either of the following formats:

Numeric

ASCII value of the character.

String

Character string enclosed in quotes. Specify control characters by typing a caret (^) before the character.

 

There is no default GA character. Define the initial GA character using the TCPWARE_TELNET_GA logical name (in the process, job, group, or system logical name tables). To define the logical, use one of the following formats:

  $ DEFINE/PROCESS TCPWARE_TELNET_GA 9

  $ DEFINE/PROCESS TCPWARE_TELNET_GA """^I"""

Both commands set the GA character to Ctrl/A (ASCII 9). They are equivalent.

Examples

1   Each of these equivalent commands sets the GA character to Ctrl/A (ASCII 9):
TELNET>SET GA "^I"
TELNET>SET GA 9

2   This example removes the previous character definition, if any, for the GA control function:
TELNET> SET NOGA


 

SET [NO]IP

Defines, changes, or disables the "interrupt process" (IP) character. If you enter the defined IP character during a TELNET session, Client-TELNET sends the TELNET IP control function to the server instead of the actual character.

Ignored if TN3270 mode is active.

Format

SET IP char
SET NOIP

Parameter

char

When entered, this character sends the TELNET IP control function to the server. You can specify this character in either of the following formats:

Numeric

ASCII value of the character.

String

Character string enclosed in quotes. Specify control characters by typing a caret (^) before the character.

 

There is no default IP character. Define the initial IP character using the TCPWARE_TELNET_IP logical name (in the process, job, group, or system logical name tables). To define the logical, use one of the following formats:

  $ DEFINE/PROCESS TCPWARE_TELNET_IP 25

  $ DEFINE/PROCESS TCPWARE_TELNET_IP """^Y"""

Both commands set the IP character to Ctrl/Y (ASCII 25). They are equivalent.

Qualifiers

/FLUSH (default)
/NOFLUSH

With /FLUSH, Client-TELNET discards all characters currently in the server's output stream when sending the IP control function. It uses the TELNET timing-mark option (the server does not have to support this option for this feature to work). With /NOFLUSH, Client-TELNET sends only the IP control function. If you omit both, the previous setting remains. The initial default is /FLUSH.

If a Server fails to respond properly to the timing-mark option, Client-TELNET can continue to discard all output from the server. If so, use FLUSH to resume normal operation.

/SYNCH
/NOSYNCH
(default)

Sends the IP command followed by the SYNCH signal.

Examples

1   Each of these equivalent commands sets the IP character to Ctrl/Y (ASCII 25):

TELNET>SET IP "^Y"
TELNET>SET IP 25

2   This example removes the previous character definition, if any, for the IP control function.

TELNET>SET NOIP


 

SET [NO]LOCAL_FLOW_CONTROL

Controls the handling of the XON/XOFF characters (Ctrl/S and Ctrl/Q) when connected to a remote system. Ctrl/S stops transmission and Ctrl/Q resumes TELNET transmission. Under normal conditions, the terminal driver processes Ctrl/S and Ctrl/Q locally and does not send them to the remote TELNET server.

Client-TELNET supports RFC 1372 (Telnet Remote Flow Control Option), which lets the remote server tell the client when to enable and disable local flow control. These commands are not related to that option, but rather let the user control the local flow control setting if the remote server does NOT support the Remote Flow Control Option.

Use SET NOLOCAL_FLOW_CONTROL to pass the Ctrl/S and Ctrl/Q characters to the remote TELNET server and NOT process them locally.

The default flow control setting depends on the TT$V_TTSYNC value for the terminal. You can set "TTSync" mode (local flow control) outside of TELNET by using the DCL SET TERMINAL /TTSYNC command, or set "No TTSync" mode (server flow control) by using the DCL SET TERMINAL /NOTTSYNC command; some full-screen editors also set these modes. However, if you are inside TELNET, SET NOLOCAL_FLOW_CONTROL can force the terminal into "No TTSync" mode for a particular connection.

Format

SET LOCAL_FLOW_CONTROL (default)
SET NOLOCAL_FLOW_CONTROL

Example

TELNET>SET NOLOCAL
TELNET>SHOW STATUS
Client-TELNET  V6.0-0  Copyright (c) Process Software

Connected session: -->1. beans.example.edu, telnet (192.168.0.50)

Terminal type:  VT300
Local flow control: OFF
"^D" is the escape (attention) character.


 

SET LOG

Opens or closes a log file. Client-TELNET uses a log file to save the output from a remote host. While connected to a remote host, Client-TELNET also puts all output the remote host sends your terminal into the log file.

SET LOG logs output from every connected session. If multiple connections exist, there is no way to specify that you want to log only output from a specified session to the log file.

Format

SET LOG [file]

Opens the local file file and begins logging.

To close a log file (and stop logging), enter SET LOG with no file specification.

Parameter

file

OpenVMS file specification of the file that logs the remote host's output. If omitted, Client-TELNET closes the present log file (if there is one).

Qualifiers

/DATA (default)
/NODATA

/DATA logs all data sent to the specified file (the default). /NODATA disables this.

/OPTIONS
/NOOPTIONS
(default)

/OPTIONS prints option negotiations to the specified log file, in addition to performing normal logging. /NOOPTIONS (the default) disables options printing.

Examples

1   This example opens the file TEXT.LOG and enables logging:

TELNET>SET LOG TEXT.LOG

2   This example closes a log file and stops logging:

TELNET>SET LOG

3   This example opens the file TEXT.LOG, enables normal logging, and prints options negotiations to the TEXT.LOG file:

TELNET>SET LOG TEXT.LOG /OPTIONS

4   This example opens the file TEXT.LOG and prints only option negotiations (and no data) to the TEXT.LOG file:

TELNET>SET LOG TEXT.LOG /OPTIONS /NODATA


 

SET PRINT

Sets how you want the PRINT key to work while in TN3270 mode. You must be in TN3270 mode to use this command.

If you omit the qualifiers, the default is SET PRINT /FILE=SYS$LOGIN:TN3270.TXT /NOAPPEND.

This means that the default print setting is OPEN/TN3270 /PRINT=(FILE=SYS$LOGIN:TN3270.TXT, NOAPPEND).

Format

SET PRINT[qualifiers]

Opens local file file and begins logging.

To close a log file (and stop logging), enter SET LOG with no file specification.

Qualifiers

/APPEND
/NOAPPEND
(default)

Use with the /FILE qualifier only. /APPEND appends the TN3270 screen dump onto the specified file. /NOAPPEND creates a new file or overwrites the existing one.

/FILE=filename

File in which to dump the TN3270 screen. You can use this with the optional /APPEND or /NOAPPEND qualifier.

/FORM=form-name

Use with the /QUEUE qualifier only. Specifies the form name to use in a TN3270 screen print.

/QUEUE=qname

Queue to which to print the TN3270 screen. You can use this with the optional /FORM qualifier and value.

Examples

1   This example sets the print behavior so that it prints the current TN3270 screen to a print file and appends it onto the end of the file:

TELNET>SET PRINT /FILE=PRINTFILE.TXT /APPEND

2   This example sets the print behavior so that it prints the current TN3270 screen to a print queue:

TELNET>SET PRINT /QUEUE=ENG_PRINTER_ASCII


 

SET TERMINAL_TYPE

Requests the server to support a specific terminal type or types if negotiating the terminal type option.

Normally, you do not need to use this command. Client-TELNET uses the following default list of supported terminal types: VT52, VT55, VT61, VT62, VT100, VT102, VT125, VT131, VT132, VT200, VT220, VT240, VT300, VT320, VT340, and IBM-3278-model-number.

If you specify an IBM-3278 terminal type, make sure your local terminal supports the screen size associated with the specified model number. If your terminal does not support the screen size, the data will not display properly.

See Supported I for screen sizes for each model.

Use the SHOW STATUS or SHOW OPTIONS commands to show the current terminal type used.

The TCPWARE_TELNET_TERMINAL_TYPE logical performs the same function as the SET TERMINAL_TYPE command. This logical requires the following syntax:

$ DEFINE/SYSTEM/EXEC TCPWARE_TELNET_TERMINAL_TYPE "type"

Format

SET TERMINAL_TYPE type[,type,...]

Parameter

type

A valid terminal type. Client-TELNET requests the server to support these types in the specified order.

Examples

1   This example requests the server to support the VT300 and VT100 terminal types, in that order:

TELNET>SET TERMINAL_TYPE VT300, VT100

2   This example requests the server to support the IBM-3278-3 terminal type. If possible, Client-TELNET resizes the local window to accommodate a 32 x 80 screen size for model 3 (see Supported I).

TELNET>SET TERMINAL_TYPE IBM-3278-3


 

SET TRANSLATION

Sets the carriage return/line feed (CR/LF) character translation.

Does not apply to TN3270 mode.

Format

SET TRANSLATION

Qualifiers

/RECEIVE=keyword

Specifies the mapping for characters received from the server before they become output. See SET TRANSLATION Keywords for the keywords and their meaning.

The default is /RECEIVE=NONE.

/SEND=keyword

Specifies the mapping for characters entered at the keyboard before Client-TELNET sends them to the server. See Table 12-10 for the keywords and their meaning.

The default is /SEND=CR.

Table 12-10     SET TRANSLATION Keywords

Keyword

Translation

CR

Client-TELNET translates the carriage return character to a CR/LF sequence

LF

Client-TELNET translates the line feed character to a CR/LF sequence

NONE

Client-TELNET does not translate characters to the CR/LF sequence

 


 

SET [NO]XDISPLOC

Enables or disables setting your current X display location on the remote end, when communicating with a remote TELNET server that also supports this option. Client TELNET checks whether the logical DECW$DISPLAY is defined. If it is, and if the remote server asks for the X display location, the X display server address is transmitted to the remote system.

Use SET NOXDISPLOC before making a connection to disable sending the X display location.

Format

SET XDISPLOC
SET NOXDISPLOC

Example

TELNET>SET NOXDISPLOC
TELNET>OPEN ALPHA
$ SHOW DISPLAY
Error opening DECW$DISPLAY as input
No such device available
ALPHA>


 

SHOW OPTIONS

Displays information about the options in effect.

Options modify the way TELNET handles your terminal over the network. When you first establish a connection, both hosts negotiate for the options to use based on the options that each host supports. You can also use the SEND command to change options.

Format

SHOW OPTIONS

Example

TELNET>SHOW OPTIONS

Current TELNET options status:

   Remote ECHO
   No remote TRANSMIT-BINARY (normal ASCII)
   No local TRANSMIT-BINARY (normal ASCII)
   Remote SUPPRESS-GO-AHEADS
   Local SUPPRESS-GO-AHEADS
   No remote END-OF-RECORD
   No local END-OF-RECORD
   Local TERMINAL-TYPE: VT300
   Local FLOW-CONTROL: ON
   Local WINDOW-SIZE: 80x35
   Local X-DISPLAY-LOCATION: 192.168.5.195:0.0


 

SHOW STATUS

Displays information about all open TELNET connections and your current TELNET session.

The screen displays the following information:

  Session number, name and internet address of each remote host if a connection is open. An arrow (-->) indicates the current session.

  The list of supported terminal types if no remote connection is open.

  The terminal type used, if a remote connection is open and Client-TELNET negotiated for the terminal type.

  Whether local flow control is ON or OFF.

  Name of the log file if one is open.

  Name of the host character set.

  Name of the terminal character set.

  The current "abort output" (AO), "are you there" (AYT), backward, break (BRK), "erase character" (EC), "erase line" (EL), escape, forward, flush, "interrupt process" (IP), and "go-ahead" (GA) characters (if defined).

Format

SHOW STATUS

Synonym

STATUS

Example

TELNET> SHOW STATUS

Client-TELNET V6.0-0  Copyright (c) Process Software
Connected sessions:
    1. bart.nene.com, telnet (192.168.1.92,23).
 -->2. marge.nene.com, telnet (192.168.1.91,23).
"^\" is the escape (attention) character
Current session is operating in 3270 mode.

Terminal type: IBM-3278-2
Local flow control: ON

Keyboard Map File: TCPWARE:MAP3270.DAT

Host Character Set: CANADIAN
Terminal Character Set: LATIN1

"^C" is the escape (attention) character.


 

SHOW TRANSLATION

Displays the current translation settings made using SET TRANSLATION. Both the received and sent translations appear.

Format

SHOW TRANSLATION

Example

TELNET> SHOW TRANSLATION
No characters are translated to CRLF when received.
CR is translated to CRLF when sent.


 

SPAWN

Executes DCL commands.

Note!     You cannot SPAWN with CAPTIVE accounts.

Format

SPAWN [command-line]

Synonym

Z[command-line]

Parameter

command-line

DCL command line that you want executed. If omitted, Client-TELNET spawns an interactive subprocess. To return to TELNET from an interactive subprocess, logout of that subprocess.

Examples

1   This example displays the time on your local host without leaving the TELNET utility:

TELNET>SPAWN SHOW TIME

  3-Nov-2014 14:02:48

2   This example initiates DCL command mode and returns the DCL prompt:

TELNET>SPAWN

$ SHOW TIME

  3-Nov-2014 14:02:51

$ LOGOUT

  Process SMITH_1 logged out at 3-Nov-2014 14:02:54.34

TELNET>

To exit the DCL command mode and return to TELNET, enter the LOGOUT command at the DCL prompt.