HP OpenVMS Systems Documentation

OpenVMS DCL Dictionary

The escape character can be any ASCII character between @ and z, except C, M, Q, S, Y, or the left bracket ([). You cannot select a character currently defined as either the break character (see the description of the /BREAK=break-character qualifier) or the command character (see the description of the /COMMAND=command-character qualifier).

By default, the escape character is a backslash (\).

The ASCII characters between @ and z include the alphabetic characters in both upper and lower cases, the at sign (@), the backslash (\), the right bracket (]), the circumflex (^), the underscore (_), and the grave accent (`).

/FLOW_CONTROL (default)

/NOFLOW_CONTROL

Determines whether XON/XOFF flow control is enabled. By default, flow control is enabled.

XON/XOFF flow control is a means of preventing data-overrun errors. Incoming data is stored in receive buffers; when these buffers are full, a signal is sent to the remote system to stop transmission. Once there is sufficient space in the receive buffers, another message is sent to restart transmission.

You should disable XON/XOFF flow control when the remote system has no XON/XOFF flow control.

/INIT[=filespec] (default)

/NOINIT

Sets the configurable characteristics of DTEPAD according to values contained in the specified initialization file.

If you use qualifiers in the command line to define the values of any of the configurable characteristics, these will supersede the values contained in the initialization file.

By default, DTEPAD tries to translate the logical name DTEPAD$INI in order to find the appropriate initialization file. If you use the /INIT qualifier and omit the file specification, DTEPAD translates the logical name DTEPAD$INI and finds the appropriate file. If DTEPAD$INI is not defined, then DTEPAD uses /NOINIT as the default.

An initialization file can contain any combination of any of the following DTE commands:

SAVE
SEND BREAK
SET DTE
SPAWN

The following is an example of an initialization file:

SET DTE/MAX_BUFFERS=150
SET DTE/READ_DELAY=100
SEND BREAK

/LOG[=filespec]

/NOLOG (default)

Controls whether a log file of the session is kept.

If you use the /LOG qualifier and omit the file specification, then the log information is written to the file DTEPAD.LOG.

When used to log a modem session, the log file contains any noise that occurred on the phone line. For example, typing a file in order to get it recorded in the log file could result in noise being recorded along with the file data. Therefore, the use of a log file is not recommended for the purpose of file transfers.

Compaq recommends that you use asynchronous DECnet to transfer files.

/MAX_BUFFERS=number-buffers

Specifies the maximum number of receive buffers. Receive buffers are buffers used to receive incoming data from the modem port. They are allocated as they are required.

By default, the maximum number of receive buffers is 100. The minimum number you can specify is 20.

/PARITY=NONE (default)

/PARITY=ODD

/PARITY=EVEN

Selects parity on the outgoing terminal line.

/READ_DELAY=delay

Specifies the modem port read delay in milliseconds. The modem port read delay is the time interval during which data in the modem port is transferred into receive buffers at the terminal.

By default, the modem port read delay is 50 milliseconds. This is also the minimum value.

A long modem port read delay slows the rate at which data is displayed at your terminal, and also increases the risk of data-overrun errors; however, a longer read delay requires less CPU overhead.

/SPEED=(output-rate,input-rate)

Sets the baud rate at which the terminal receives and transmits data. If the input and output rates are the same, specify the qualifier as /SPEED=rate.

Not all terminals support different input and output baud rates. For specific information on baud rates for your terminal, consult the manual for that terminal.

The default transmission rates are installation dependent.

The valid baud rates are as follows:

 50       150       1800       4800       38400
 75       300       2000       7200       57600
110       600       2400       9600       76800
134      1200       3600      19200      115200

If you select an invalid or unsupported speed, then the terminal line speed will remain set at its previous value.

Examples

#1
$ SET HOST/DTE TTA2:/DIAL=NUMBER:5551234 Username: SMITH Password:

This command connects the user terminal to the outgoing terminal line TTA2:, which is attached to a modem (type DF03 by default) set to autodial the phone number 555-1234. The remote processor then prompts for user name and password. Use the normal login procedure to log in to the remote system.

#2
$ SET HOST/DTE/DIAL=(NUMBER:5551234#,MODEM_TYPE:DF112) TTA2: Username: SMITH Password:

This command accomplishes the same thing as in the first example, except that it uses the DF112 modem. The number sign (#) is required to activate the autodialer in the DF112.

#3
$ SET HOST/DTE/NOEIGHTBIT TTA2

This command sets the outgoing terminal port, TTA2, to support 7-bit characters.

#4
$ SET HOST/DTE/NOFLOW_CONTROL TTA2

This command disables the XON/XOFF flow control.

#5
$ SET HOST/DTE/ERROR_ACTION=EXIT TTA2

This command sets the error action to EXIT.

#6
$ SET HOST/DTE/MAX_BUFFERS=150 TTA2

This command sets the maximum number of receive buffers to 150.

#7
$ SET HOST/DTE/ESCAPE=E TTA2

This command defines the letter E as the escape character. Note that DTEPAD is not case sensitive.

#8
$ SET HOST/DTE/LOG TTA2

This command enables logging of the session. Since no log file is specified, the log is written to the default log file, DTEPAD.LOG.

#9
$ SET HOST/DTE/INIT=MYFILE.INI TTA2

This command uses the initialization file MYFILE.INI.

#10
$ `[Ctrl/]`@ DTEPAD>

This example shows you how to access DTE command mode by pressing Ctrl/@, where @ is the command character.

#11
DTEPAD> SAVE MYFILE.INI

This command saves the information on the current configuration in the file MYFILE.INI.

#12
DTEPAD> SET DTE/BREAK=G

This command defines the letter G as the break character.

#13
DTEPAD> SET DTE/ECHO

This command sets the terminal port so that echoing is performed by the local system.

#14
DTEPAD> SET DTE/SPEED=4800

This command sets the input and output baud rates to 4800.

#15
DTEPAD> SET DTE/LOG=myfile.log

This command directs logging to the file MYFILE.LOG.

#16

DTEPAD> SHOW DTE
  Port TXA0              EIGHT_BIT ECHO
  Flow control           XON/XOFF
  Parity                 NONE
  Transmit Speed         4800
  Receive Speed          4800
  Error action           CONTINUE
  Break character        B
  Escape character       \
  Command character      @
  Maximum buffers        100
  Read delay             50 milliseconds
  Log file               MYFILE.INI
  Number dialed          12345678
  Modem type             DF03
  Bytes transmitted      75
  Bytes received         132
  Errors                 0

This command displays all the current settings of the configurable characteristics, the number of bytes transmitted and received, and the number of errors detected.

SET HOST/DUP

Connects your terminal to a storage controller through the appropriate bus for that controller. The /SERVER and /TASK qualifiers are required.
For use only with storage controllers. Requires the DIAGNOSE privilege.

Format

SET HOST/DUP/SERVER=server-name
/TASK=task-name node-name

Parameter

node-name
Specifies the node name of the storage controller.

Description

The SET HOST/DUP command creates a virtual terminal connection and executes a utility or diagnostic program on a storage controller that uses the Diagnostic and Utilities Protocol (DUP) Standard Dialogue.
Once the connection is established, operations are performed under the control of the utility or diagnostic program.
When the utility or diagnostic program terminates, control is returned to the local system.
To abort or prematurely terminate the connection and return control to the local system, press Ctrl/\.
Further information regarding the operation of the utility and diagnostic programs available on a particular controller may be obtained from the appropriate documentation set for that controller.
Preparing for Use

To use the SET HOST/DUP facility, you must first install FYDRIVER, the DUP class driver. To load FYDRIVER, add the following commands to the SYSTARTUP.COM command procedure in the SYS$MANAGER directory.
On Alpha, specify the following commands:
$ RUN SYS$SYSTEM:SYSMAN SYSMAN> IO CONNECT FYA0/NOADAPTER/DRIVER=SYS$FYDRIVER
On VAX, specify the following commands:
$ RUN SYS$SYSTEM:SYSGEN SYSGEN> CONNECT FYA0/NOADAPTER
This operation requires CMKRNL (change mode to kernel) privilege.

Qualifiers

/LOG[=filespec]

/NOLOG (default)
Controls whether a log file of the entire session is kept. If you use the /LOG qualifier without the file specification, the log information is stored in the file HSCPAD.LOG.
/SERVER=server-name
Specifies the server name for the target storage controller.
This qualifier is required.
/TASK=task-name
Specifies the utility or diagnostic name to be executed on the target storage controller under direction of the server.
This qualifier is required.

Example


$ SET HOST/DUP/SERVER=MSCP$DUP/TASK=DIRECT R2DH5Y %HSCPAD-I-LOCPROGEXE, Local program executing - type ^\ to exit utility

The SET HOST/DUP command in this example connects the user terminal to the utility program called DIRECT executing on a storage controller named R2DH5Y under direction of the MSCP$DUP server.

SET HOST/HSC

Connects your terminal to an HSC disk and tape controller through the computer interconnect (CI) bus.
Used only with HSC controllers. Requires the DIAGNOSE privilege.

Format

SET HOST/HSC node-name

Parameter

node-name
Specifies the node name of the HSC.

Description

The SET HOST/HSC command establishes a connection to an HSC disk and tape controller by way of the CI bus. (The SHOW CLUSTER command lists the names of HSC controllers that are accessible to your node.) No password is required to access the HSC; however, only SHOW commands are accepted when the HSC Secure/Enable switch is in the Secure position.
Once the connection is made to the HSC, operations can be performed as if you were attached to the local terminal of the HSC; however, access to ODT (Octal Debugging Tool) and offline diagnostics are not permitted.
Press Ctrl/C to obtain a prompt from the HSC before entering commands. To exit from the HSC and return to the local system, press Ctrl/\.
A description of HSC commands and utilities can be obtained from the HSC documentation.
Preparing for Use

To use the SET HOST/HSC facility, you must first install FYDRIVER, which is the Diagnostic and Utilities Protocol (DUP) driver associated with the CI. To load FYDRIVER, add the following commands to the SYSTARTUP.COM command procedure in the SYS$MANAGER directory:
$ RUN SYS$SYSTEM:SYSGEN CONNECT FYA0/NOADAPTER
This operation requires CMKRNL (change mode to kernel) privilege.

Qualifier

/LOG[=filespec]

/NOLOG (default)
Controls whether a log file of the entire session is kept. If you use the /LOG qualifier without the file specification, the log information is stored in the file HSCPAD.LOG.

Example


$ SET HOST/HSC HSC001 %HSCPAD-I-LOCPROGEXE, Local program executing - type ^\ to exit, ^Y for prompt HSC>

This SET HOST/HSC command connects the user terminal to the HSC named HSC001.

SET HOST/LAT

Connects your terminal to a specified service available on the local area network (LAN), establishing one session for communication between your terminal and that service.
The service node that provides the service must be on a remote node, must be on the same extended LAN, and must be running at least Version 5.0 of the LAT protocol.

Format

SET HOST/LAT service-name

Parameter

service-name
Specifies the name of the service to which you want your terminal connected. A service is a resource on the LAN. A service often consists of all of the resources of a computer system. Other examples of services are a file storage system and an application program running on a computer system. A computer system that offers one or more services is called a service node.
If several service nodes offer the same service, and you do not specify the /NODE=node-name qualifier, your terminal connects to the service node that is the least busy.
To display a list of services on your LAN, use the LAT Control Program (LATCP) SHOW SERVICES command. Refer to the OpenVMS System Management Utilities Reference Manual.

Description

The SET HOST/LAT command allows you to connect your terminal to a specified service, establishing one LAT session for communication between your terminal and that service. (For an overview of the LAT protocol and its advantages, see the OpenVMS System Manager's Manual.)
The service node that provides the service must be on a remote node, must be on the same extended LAN, and must be running at least Version 5.0 of the LAT protocol.
Some services are password protected. You are prompted for a password unless you specify the password with the /PASSWORD qualifier.
Once the connection to the service is made, you can interact with the service as if your terminal is directly connected to it. Some services will prompt you. For example, if the service is an OpenVMS system, it prompts you for a user name and password. You must have an account on the service node to log in.
Press the disconnect character to end the LAT session and return to DCL command level on your local system. With some services, such as general timesharing services like OpenVMS, you can end the LAT session by logging out of the service. The default disconnect character is Ctrl/\. Use the /DISCONNECT qualifier to change the default disconnect character.
You cannot use SET HOST/LAT to connect to the local node.

Qualifiers

/AUTOCONNECT

/NOAUTOCONNECT
Specifies whether connection attempts should be retried automatically when a connection fails because a service is unknown or unavailable, or because a node is unknown or unreachable. Also specifies that reconnects should be attempted automatically if a service has disconnected abnormally. The default is /NOAUTOCONNECT.
/AUTOPROMPT (default)

/NOAUTOPROMPT
Causes an OpenVMS Username: prompt to appear with no user action when a SET HOST/LAT command is issued.
On a terminal server port, you can configure the port to have AUTOPROMPT disabled (/NOAUTOPROMPT) so that you are required to press Return when connecting to a node to get the Username: prompt; however, when connecting to a reverse LAT service, the AUTOPROMPT characteristic should be disabled.
/BREAK=break-character
Defines a character that generates a break on lines that expect a break rather than a carriage return. To generate a break, press the Ctrl and break-character keys together. The default break-character value is the tilde (~).
You can select any ASCII character between @ and Z, except C, M, Q, S, Y, and the left bracket ([). You cannot select a character that is already defined as the disconnect character.
/DESTINATION_PORT=port-name
Specifies the port on a node to which you want to connect. The /NODE qualifier is required when you specify the /DESTINATION_PORT qualifier. The port must be available and must offer the service you specify. OpenVMS and certain other LAT service node systems ignore the /DESTINATION_PORT qualifier.
/DIAL=(NUMBER:number[,MODEM_TYPE:modem-type])
Allows a modem attached to the outgoing terminal line to be autodialed using the autodial protocol of that modem. The NUMBER keyword is the telephone number to be autodialed and is a required parameter.
The MODEM_TYPE keyword is optional. It can be used to specify any of the following modem types:

DMCL (any modem that uses the DEC Modem Command Language)
DF03 (default)
DF112

Each modem type requires a specific modem dialer code. Check with your system manager to see which modem dialer codes are installed on your system.
In addition, the MODEM_TYPE keyword can be used to specify a modem type other than DF03, DF112, or DMCL. A template is provided for users interested in supporting other modems with autodial capabilities (see SYS$EXAMPLES:DTE_DF03.MAR).
/DISCONNECT=disconnect-character
Defines the character that you can use to disconnect from a remote session. To generate a disconnect, press the Ctrl and disconnect-character keys together. The default disconnect-character is the backslash (\).
You can select any ASCII character from @ through Z, except C, M, Q, S, Y, and the left bracket ([). For example, if you specify /DISCONNECT=A, Ctrl/A will be the disconnect character. You cannot select a character that is already defined as the break character.
/EIGHT_BIT (default)

/NOEIGHT_BIT
Determines whether the outgoing terminal line supports 8-bit or 7-bit characters. By default, 8-bit characters are supported. If you specify /NOEIGHT_BIT, then 7-bit characters are supported.

Note
To change the number of bits per character on the remote terminal server port, that port must have the REMOTE MODIFICATION characteristic enabled.

/FRAME=n
The /FRAME=n qualifier allows a user making a LAT connection to a remote system to specify the number of data bits that the terminal driver expects for every character that is input or output. The value of n can be from 5 to 8. The default value depends on the settings for the terminal established by the /PARITY and /EIGHT_BIT qualifiers. The following example specifies a character frame size of 7 bits per character:
$ SET HOST/LAT /FRAME=7 DIAL_OUT_SVC
/LOG[=log-file]
Logs all data that is delivered during the LAT session. If you do not specify a log file, the data is stored in the file SETHOST_LAT.LOG.
/NODE=node-name
Specifies the node that offers the service to which you want to connect. The node you specify must be a remote node. Failover is not performed if the connection fails.
/PASSWORD=password
Specifies the password required by a service that is password protected. If you do not specify the /PASSWORD qualifier when requesting a connection to a password-protected service, you are prompted for a password.
/QUEUE

/NOQUEUE (default)
When connecting to a reverse LAT service that is already in use (such as a dial out modem), you are notified that the service is in use and the SET HOST/LAT command terminates. However, LAT can allow incoming connections to be queued to any reverse LAT service that supports service queueing, which enables users to be placed on a queue when using reverse LAT services.
LAT reports your position in the queue. When the resource becomes available, you are immediately notified. You can cancel the queued connection by pressing Ctrl/Y and terminating the SET HOST /LAT command.
/SPEED=(output-rate,input-rate)
Sets the baud rate at which the terminal receives and transmits data. If the input and output rates are the same, specify the qualifier as /SPEED=rate.
Not all terminals support different input and output baud rates. For specific information on baud rates for your terminal, consult the manual for that terminal.
The default transmission rates are installation dependent.
The valid values for input and output baud rates are as follows:
300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600
If you select an invalid or unsupported speed, the terminal line speed will remain set at its previous value.

Note
To change the speed on the terminal server port, the REMOTE MODIFICATION characteristic must be enabled on that terminal server port.
When initiating a connection, SET HOST/LAT may attempt to set terminal server port characteristics, such as the speed and the default speed for a LAT device. If the device connected to the terminal server port has a fixed speed (such as a dial-out modem) and you do not want the host to try to change this, disable the REMOTE MODIFICATION characteristic on that port using the following command:

Local> DEFINE PORT x REMOTE MODIFICATION DISABLE Local> LOGOUT PORT x

Use the following command for terminal servers that support the CHANGE command:

Local> CHANGE PORT x REMOTE MODIFICATION DISABLE

Examples

$ SET HOST/LAT SORTER
%LAT-S-CONNECTED, session to SORTER established
%LAT-I-TODISCON, type ^\ to disconnect the session
Username: BARKER
Password:
   .
   .
   .

$ LOGOUT
BARKER logged out at 30-DEC-2001  11:04:51.45
%LAT-I-DISCONNECTED, session disconnected from SORTER
-LAT-I-END, control returned to node HOME
$

This SET HOST/LAT command connects the user to the service SORTER, which is a computer system. The first message confirms that the user has been connected to that service. The second message informs the user how to disconnect the session. (The user can also disconnect the session by logging out from SORTER.) SORTER then prompts for the username and password. Use the normal login procedure to log in to the system. When the user logs out of the service SORTER, the terminal displays the DCL command prompt of the user's local processor system (HOME).

#2
$ SET HOST/LAT/DESTINATION_PORT=BOSTON- _$ /NODE=STATE/DISCONNECT=F BUDGET

This command connects the user's terminal to the service BUDGET that is offered on port BOSTON, on service node STATE. The user can disconnect the session by pressing Ctrl/F.

#3
$ SET HOST/LAT PURSE Password:

This command attempts to connect the user's terminal to the service PURSE. The service PURSE is password protected, so the user is prompted for a password. The user could have specified the password within the SET HOST/LAT command, as shown in the next example.

#4
$ SET HOST/LAT/PASSWORD=BEOR PURSE

Previous Next Contents Index