Chapter 2. SX.25 Pad Program Commands

This chapter contains the following sections:

This chapter is an alphabetical list of the commands available to users of the SX.25 pad program. Most commands have abbreviations, which are shown in parentheses after the command name. A command summary is presented in the last section.

In this chapter, commands are presented in uppercase. You can enter commands in uppercase or lowercase. Where a command has an optional parameter, this is shown in lowercase in square brackets. The command may be entered without a parameter, to report the current value, or with one of the parameter values indicated. Where two values are alternatives, these are shown separated by the symbol `|'.

The full command and the appropriate abbreviation are the only commands accepted; these are exact equivalents.

In addition to the X.28 standard interface, the SX.25 pad program has a more user-friendly command interface. The rest of this chapter describes the details of each command.

BREAK (B)

This command sends a “break” signal to the currently connected host. The action depends on the setting of the BREAKACTION parameter.

BREAKACTION (BRA)

This command sets the action to be taken if you issue a BREAK command. You do not normally have to set BREAKACTION, as the host should set the value it requires.

The syntax is:

BRA [


n]

where n is one of the following settings, causing the action described to be taken:

0

no action

 

1

send an interrupt signal

 

2

send a reset

 

5

send an interrupt signal and an indication of break (the default)

 

8

exit call mode to command mode

 

21

send an interrupt signal and an indication of break, then discard output from the host

If you do not supply a parameter, the current setting is displayed.

BREAKIN

This command allows you to alter the pad program recall character (the default is <Ctrl P>). There is no abbreviation.

CALL (C)

This command attempts to set up a connection to the named host system with the requested facilities. Hosts can be specified by name or by address. The syntax is:

C 


host [


~CUD] [


facilities] [


G|


B[


CUG]] [


NNUI] [


TRPOA]

The various fields are described as follows.

The host field takes one of the following forms:

name 

The required name to address mapping must already have been set up by your system administrator; for example:

C host1

LAN addressing 


For a call to a host on the LAN, the syntax is:

C 


S.LSAP[[


.N|


X]


.NSAP] [


~CUD] [


facilities] [


G|


B[


CUG]] [


NNUI] [


TRPOA]

For example:

C C.080069021CC57E.N.9999 

In this example, the .N is not necessary.

WAN addressing 


For a call to a host on the WAN, the syntax is:

C 


S.DTE [[


.N|


X]


.NSAP] [


~CUD] [


facilities] [


G|


B[


CUG]] [


NNUI] [


TRPOA]

If your system administrator has set up hostname/address equivalences, you can use a hostname instead of explicit addressing, such as:

C host [~CUD] [facilities] [G|B[CUG]] [NNUI] [TRPOA]

Address components

The meanings of these fields are as follows:

S 

is the single character logical identifier that specifies the required subnetwork for the call.

DTE 

is an address of up to 15 decimal digits specifying the subnetwork point of attachment of the remote host. If X.25(88) TOA/NPI addressing is being used, the DTE may be up to 17 decimal digits.

N/X 

An uppercase N or X preceded by a period and followed by a period and (N) for an NSAP or (X) for a non-OSI address extension. This is not mandatory. If neither is given, the following field (if present) is read as an NSAP address.

NSAP 

is an address of up to 40 hexadecimal digits specifying the point at which the Network Service is provided on the remote host.

~CUD 

(Call User Data) is an optional parameter of up to 124 ASCII characters preceded by the character ~, which is passed to the host in the CALL request, following the X.29 protocol identifier bytes of 01000000.

Facility components

You can request any or all of the following facilities for the call. All these parameters are optional and your system administrator will have set up general default values or specific defaults for the host you have specified. These values are used if you leave them unspecified. See your system administrator for information on CUGs and other values for your system.

The facilities fields, entered as a string, are as follows:

Packet Size

to set both the incoming and outgoing sizes to 7, for example, use p7/7

Window Size

to set both the incoming and outgoing sizes to 2, for example, use w2/2

Fast Select

include f in the string

Reverse Charge

include r in the string

Fast Select and
Reverse Charge

include fr in the string

Thus, the string may resemble this :

p7/7w2/2fr

[ G|B] CUG  

Closed User Group. Enter a closed user group number to make a call to the specified Closed User Group on the specified host. There are two classes of Closed User Group:

  1. A multi-user closed user group: enter the CUG (a number of up to four digits) preceded by G.

  2. A bilateral closed user group. This type of CUG has only two members. You can be a member of more than one bilateral CUG. Enter the CUG (a four-digit number preceded by B).

NNUI 

Network User Identifier. NUI is a string of up to 64 alphanumeric characters, preceded by an N, used to identify your call for the purposes of security or billing.

TRPOA  

Recognized Private Operating Agency. This provides the network with additional routing information about your call. Enter T, followed by up to four RPOA numbers of four digits each with no spaces.

CLEAR (CLR)

This command closes the current connection.

ECHO (E)

The syntax is:

E [


on|


off] 

where:

on

makes the pad program echo

off

means all echoing must come from the remote host

If you do not supply a parameter, the current setting is displayed. The default setting is on.

EMASK (EM)

Use this command to choose which characters are not echoed to the screen. The profile set by your system administrator also determines which characters are echoed to the screen. You should not need to change the echo mask.

The syntax is:

EM [


n]

where n is a mask that stops specified characters being echoed as shown in Table 2-1.

Table 2-1. Mask Commands for Specified Characters


Mask

Characters
Affected

1

CR

2

LF

4

VT, HT, FF

8

BEL, BS

16

ESC, ENQ

32

ACK, NAK, STX, SOX, EOT, ETB, ETX

64

DEL, CAN, DC2

128

all other control characters

For example, to instruct the pad program not to echo the BEL and BS characters, use:

EM 8

To instruct the pad program not to echo a larger set of characters, add the values of the parameters. For example, if you do not want to echo VT, HT, FF or BEL or BS enter the following:

EM 12 

If no parameter is specified, the current value of the Echo Mask is reported. The default is 192 (128 + 64) so that “all other control characters” and DEL, CAN, and DC2 are not echoed.

FLOW (F)

This enables or disables the local flow control processing of IXOFF and IXON characters by the pad program. The syntax is:

F [


on|


off] 

where:

on

If flow control is set on, you can use an IXOFF character (for example, <Ctrl s>) to halt output to the terminal, and the IXON character (for example, <Ctrl q>) to restart it.

off

Flow control must be set to off if you wish to use these control characters for any other purposes, such as for EMACS type editors.

If you do not supply a parameter, the current state of the flow parameter is reported. The default is on, which enables the processing of IXOFF and IXON characters.

FORWARD (FOR)

This selects the data forwarding characters. You do not normally have to change the setting of this parameter; your system administrator should have decided on a sensible value for you.

The syntax is:

FOR [


n]

The possible parameter settings are as follows:

0

no data forwarding characters

1

alphanumeric characters

2

CR

4

ESC, BEL, ENQ, ACK

8

DEL, CAN, DC2

16

ETX, EOT

32

HT, LF, VT, FF

64

all other control characters not mentioned above, except BS, XON, XOFF, DEL, CAN, DC2

Add two or more numbers together to forward a combination of the sets of characters. For example, to forward on alphanumeric characters (1) and ESC, BEL, ENQ, and ACK (4) enter:

for 5 

If you do not specify a parameter, the current setting is displayed. The default is 48 (16 + 32), so that ETX, EOT, HT, LF, VT, and FF are forwarding characters.

HELP (?)

This command gives a one-line summary of a command or the full list of commands. An example screen is given later in this chapter, in the section “Command Summary”. The syntax is:

? [


command]

where command produces help for one command only. For example:

HELP breakaction 

displays the following:

BREAKACTION [n] (or BRA) - set breakaction

HOSTS (H)

This command lists all the hosts available to you when using the pad program. These are hosts that have been set up in the hosts table by the system administrator. Both standard and abbreviated names are given. The table looks something like this:

AVAILABLE 
~~~~~~~~~~~~~~~ 
Name : Thirdfloor-mini-room4 
Alias: mini34
Name : Thirdfloor-mini-room3 
Alias: mini33
Name : Secondfloor-mini-room6 
Alias: mini26

The hosts table is scrolled using pg, (or the pager you define in the PAGER environment variable) to control the display. To see more host details when the screen is full, press Return. For details, refer to the pg(1) online reference manual page.

INT

This command transmits an interrupt packet to the remote host. There is no abbreviation for this command.

LFINSERT (LF)

This command governs whether or not a linefeed (LF) is inserted after a carriage return (CR). You should not normally have to set this parameter as the host should set an appropriate value. The syntax is:

LF [


n]

where n is one of the following:

0

no LF insertion

 

1

add LF after CR in the data from the host

 

2

add LF after CR in the data to the host

 

4

add LF after CR echoed

Add two or more numbers together to set forwarding for a combination of the conditions for LF insertion. For example, to set LF insertion after CR in the data to and from the host, enter the following:

LF 3 

The value of this parameter has no effect in native mode unless echoing is on, in which case the setting of value 4 is allowed. (This is required because certain hosts operate in native mode, but leave local echo enabled.)

In transparent mode, the setting of value 1 has no effect.

If you do not supply a parameter, the current setting of the parameter is displayed. The default value is 6.

LOGHOST (LOG)

This command displays all incoming and outgoing X.29 messages to and from the host, for the purpose of fault diagnosis. You do not normally have to use this command. The syntax is:

LOG [


on|


off]

Parameter numbers and values are specified as pairs of hexadecimal numbers, separated by a space. The format of the message displayed is as follows:

X29 TX|RX Code <Parameter Value Parameter Value ....> 

TX is used to display values for transmitted messages, RX for received messages. For example:

The following message reads parameters 02, 04, and 0F hex:

X29 RX 4: 02 00 04 00 0F 00

The following message sets parameters 02, 04, and 0F hex to 01:

X29 RX 2: 02 01 04 01 0F 01

Messages beginning like the following are parameter indication messages, showing the current values of specified parameters:

X29 TX 0

MESSAGE (MES)

The MESSAGE command sets the mode of operation to message mode. The parameter settings for message mode are shown in Table 2-2.

Table 2-2. Parameter Settings for Message Mode


Mode

Parameter
Number

 

 

 

 

2

4

10

15

Message

1

0

80

1

This means that echoing is on, the data forwarding timeout is off, the line folding width is 80, and local editing is allowed. For details of the modes see the subsection “Selecting an Operating Mode” in Chapter 1.

This is the default mode of operation. Refer to the NATIVE and TRANSPARENT commands for other operating modes.

NATIVE (NAT)

This sets the mode of operation to native mode. The parameter settings for native mode are shown in Table 2-3.

Table 2-3. Parameter Settings for Native Mode


Mode

Parameter
Number

 

 

 

 

2

4

10

15

Native

0

1

0

0

This means that echoing is disabled, data forwarding timeout is enabled, there is no line folding, and local editing is disabled. For more information about the different types of operating mode, see the subsection “Selecting an Operating Mode” in Chapter 1.

The default operating mode is message mode.

PAGEWAIT (PW)

Use this command to make the display pause after n lines. The syntax is:

PW [


n]

where n is the range for the pagewait parameter, 0 - 255. If n is set to 0, there is no pagewait and the display scrolls off the screen.

To continue after a pagewait, press the space bar. All other characters, with the exception of the BREAKIN character, are ignored.

If you do not supply a parameter, the current setting is displayed. The default is 0, meaning that any display that is too long will scroll off the screen.

PARAM (PAR)

This command displays the current values of all the X.3 parameters in parameter number:value pairs. For example, when the default settings for the V5 profile are being used, the PARAM command returns:

1:1 2:1 3:48 4:0 5:0 6:1 7:5 8:0 9:0 10:80 11:14 12:1 13:6 14:0 15:1 16:127 17:24 18:18 19:2 20:192 21:0 22:0

For an explanation of each of the parameters and their commonly used values, refer to the section“Parameter Values” in Chapter 3.

PAR?

This command displays the current values of the parameters you specify in number:value pairs. This call has no abbreviation. The syntax is:

PAR? 


<par list> 

where <par list> is one or more numbers from the list presented in Chapter 3, separated by spaces or commas. For an explanation of the meaning and usage of the parameters, refer to the section “Parameter Values” in Chapter 3.

For example:

PAR? 2,4,10,15 

returns:

PAR 2:1, 4:0, 10:80, 15:1 

Separate the list of parameters you request with commas or spaces. If you do not specify parameters, all the parameters are displayed in number:value pairs.

PRINTER (PRT)

This is used to tell the pad program that you are using a hard-copy terminal. This command and the VDU command set parameter 19. If you want to see the current value, use the PAR? command. The value 1 is for a hard-copy terminal, the value 2 is for a video display unit.

PROFILE (PROF)

This command selects a set of terminal options pre-defined as a profile. These profiles contain default values for the X.3 parameters. The syntax is:

PROF [


p]

where p is the name of the profile in either uppercase or lowercase. The following example sets the V2 profile:

PROF V2 

The default profiles supplied are as detailed in “Parameter Values” in Chapter 3. Your system administrator can set the default profile and specify the set of usable profiles.

If you do not supply a parameter, the current profile will be displayed.

QUIT (Q)

The QUIT command closes the connection and you exit the pad program to the system prompt.

RESET (RST)

This command sends a Reset Request to the currently connected host.

SET

The SET command sets the parameters you specify to the values you supply. It lets you change the setting of parameters from the value used in the selected profile. Your system administrator can advise you about the profile and the parameter settings you should use. There is no abbreviation. The syntax is:

SET <parameter number:value, parameter number:value,...> 

The number of the parameter is followed by a colon and the desired parameter value. For example, to set parameters 2, 10, and 13, enter:

SET 2:1, 10:72, 13:4

Number:value pairs in a list should be separated by commas or spaces.

If you supply the name of a parameter without a value, or with an invalid value (for example 13:8 rather than 13:4 in the above example), a message in the form PAR 13:INV is returned and the value of the parameter remains unchanged.

SET?

This command sets the parameters you specify to the values you give. Unlike the SET command, this displays the parameters and the values you specify. The number of the parameter is followed by a colon and the setting you want the parameter to have. There is no abbreviation. The syntax is:

SET? 


<parameter number:value, parameter number:value,...> 

For example:

SET? 2:1,10:72,13:4 

returns:

PAR 2:1,10:72,13:4 

Number:value pairs in a list should be separated by commas or spaces.

If you supply the name of a parameter without a value, or with an invalid value (for example 13:8 rather than 13:4 in the above example), a message in the form PAR 13:INV is returned and the value of the parameter remains unchanged.

STATUS (STAT)

This command displays the status of the connection and the name of the host to which you are connected. If no parameter is specified, the current call connection status is reported. The syntax is:

STAT [


all]

where the parameter all produces further status information. For example:

Echo = ON, Echomask = 192, Flow = ON, Lfinsert = 6, Breakaction = 5 Pagewait = 0, Width = 80, Forward = 48, Timeout = 0, Message Mode Profile = V3, Vdu, Loghost = OFF
Call Status: Call Connected 
Host: centralhost

TRANSPARENT (TRA)

This command sets the mode of operation to transparent mode. The parameter settings for transparent mode are shown in Table 2-4.

Table 2-4. Parameter Settings for Transparent Mode


Mode

Parameter
Number

 

 

 

 

2

4

10

15

Transparent

1

0

0

1

This means that echoing is on, data forwarding is disabled, there is no line folding, and editing is enabled. For more details about the use of the different operating modes, see “Selecting an Operating Mode” in Chapter 1.

The default operating mode is message mode.

VDU

The VDU command (for video display unit) is used to tell the pad program that you are using a display terminal. There is no abbreviated form.

This command and the PRINTER command set parameter 19. If you want to see the current value, use the PAR? command. The value 1 is for a hard-copy terminal, and the value 2 is for a VDU (the default).

WIDTH (WID)

This is used to define the width of the terminal screen in use. On output, when this width is reached, a “newline” is inserted. The syntax is:

WID [


n]

where n is the screen width. The range for the parameter is 20 - 255. If you do not supply a parameter, the current setting is displayed. The default screen width is 80.

Command Summary

If you enter HELP or ? while using the pad program, a one-line description of each of the commands available in the current interface is displayed. The screen is scrolled using pg, (or the pager you define in the PAGER environment variable). Press Return to see the remaining display.

Table 2-5 provides a quick summary of the available commands. For more details about pg options, refer to the pg(1) online reference manual page.

Table 2-5. Command Summary

Command

Abbreviation

Description

BREAK

(or B)

send break signal to the host

BREAKACTION [ n]

(or BRA)

set breakaction

BREAKIN

 

set pad program recall character

CALL host

(or C)

set up a connection to the named host

CLEAR

(or CLR)

close the current connection

ECHO [ on| off]

(or E)

enable/disable terminal echo

EMASK [ n]

(or EM)

set terminal echo mask to n

FLOW [ on| off]

(or F)

enable/disable terminal flow control

FORWARD [ n]

(or FOR)

set data forwarding conditions

HELP

(or ?)

display help information

HOSTS

(or H)

list all the hosts available

INT

 

send an interrupt packet

LFINSERT [ n]

(or LF)

set linefeed insertion action

LOGHOST [ on| off]

(or LOG)

display X.29 messages

MESSAGE

(or MES)

enable message mode of operation

NATIVE

(or NAT)

enable native mode of operation

PAGEWAIT [ n]

(or PW)

set page wait to n lines

PARAM

(or PAR)

display current X.3 parameters

PAR? [ par list]

 

display specified X.3 parameters

PRINTER

(or PRT)

define terminal as hardcopy device

PROFILE [ p]

(or PROF)

set terminal profile

QUIT

(or Q)

exit the pad session

RESET

(or RST)

reset the current call

SET [ par list]

 

set specified X.3 parameters

SET? [ par list]

 

set and display specified X.3 parameters

STATUS [ all]

(or STAT)

list the status of the connection

TRANSPARENT

(or TRA)

enable transparent mode of operation

VDU

 

define terminal as display device

WIDTH [ n]

(or WID)

set terminal width to n characters