PicLan - Networking for Pick
(C) Copyright 1990-1998 Modular Software Corporation. All rights reserved.
Version 2.0.0.17 - February 28, 1998
Goto: Table of Contents Index
Chapter: 1 2 3 4 5 6 7 8 9 10 11 12 13 14
PicLan provides extension to terminal emulation sequences that provide DOS workstation specific functions. These sequences operate with all available PicLan terminal emulations.
The PicLan terminal emulator can "shell" DOS commands under Pick application control. By sending an escape sequence to the terminal, a Pick application can cause the execution of DOS commands. This allows DOS applications to appear to be under the control of a Pick application. An example of this would be the entry of a DOS word processing program by making a selection from a Pick application menu.
The format for this escape sequence is:
ESC BS {option} delimiter command delimiter
"option" is a single character that controls the manner in which the command is executed. Available options are:
- null or 0 - Execute the command full-screen and prompt for "press any key" when the DOS command terminates. This is typically used for DOS command such as directory commands which do not prompt for user input.
- 1 - Execute the command full-screen and do not prompt for "press any key" when the DOS command terminates. This is typically used for DOS applications that involve user input such as word processors, etc.
- 2 - Execute the command without clearing the screen. This is typically used for DOS applications that do not perform screen I/O.
"delimiter" refers to a single character that is used to delimit the DOS command from surrounding characters. The delimiter may be any character that does not appear in the DOS command itself.
"command" is the actual DOS command to be executed. The command is executed relative to the current directory that the PL-TERM.EXE terminal emulator is running out of. You can specify any DOS command desired including the use of drive letters and paths. You can also execute the command "COMMAND" (with suitable path) to invoke a DOS command-prompt shell.
Examples of shelling DOS commands would be the following BASIC commands:
EQUATE ESC TO CHAR(27)
EQUATE BS TO CHAR(8)
*
* Execute a DOS directory command pausing after the display
PRINT ESC : BS : "%DIR C:\*.EXE%" :
*
* Execute a Word processor
PRINT ESC : BS : "1%D:\WP\WP%" :
*
* Execute a Data Compression utility that does not screen output
PRINT ESC : BS : "2%PKUNZIP WORK.ZIP TEST.TXT > NUL%" :
The PicLan DOS terminal emulator allows you to capture terminal output to a DOS file. Turning on DOS file capture involves printing an escape sequence to initiate the capture function, printing the data to be captured, and then printing an escape sequence to end capturing. The escape sequence to begin capturing is:
ESC BS "O" {option} delimiter dos_file_name delimiter
The sequence to end capturing is:
ESC BS "C"
"option" refers to an option that controls how screen updates proceed and how the DOS file is created. Option is a single character and may be:
- null or 0 - Overwrite an existing output file and do not simultaneously send output to the screen.
- 1 - Overwrite an existing output file and do simultaneously send output to the screen.
- 2 - Append to an existing output file and do not simultaneously send output to the screen.
- 3 - Append to an existing output file and do simultaneously send output to the screen.
The "delimiter" is a single character that delimits the DOS file name from surrounding characters. This character may be any character that is not included in the actual file name.
An example of capturing to a DOS file would be:
EQUATE ESC TO CHAR(27)
EQUATE BS TO CHAR(8)
*
* Begin appending to DOS file TEST.TXT while still updating the screen
PRINT ESC : BS : "O3%test.txt%" :
*
* EXECUTE a LISTU command which will be captured
EXECUTE "LISTU"
*
* Stop the capturing
PRINT ESC : BS : "C" :
The PL-TERM terminal emulator is also capable of transferring the terminal's screen contents to a DOS text file. This function causes characters currently displayed within the sessions "porthole" (the terminal display size setup when you opened a new session) to be written as text to a selected DOS file. The sequence used to perform this function is:
ESC BS "P" {option} delimiter dos_file_name delimiter
"options" are:
- null or 0 - Overwrite an existing DOS file.
- 1 - Append to an existing DOS file.
The terminal emulator may be used to delete DOS files. This function is typically used to delete files that are created with terminal emulator capture functions. These file deletions occur without user intervention or configuration, so care should be exercised. To delete a DOS file, send the following escape sequence to the terminal:
ESC BS "D" delimiter dos_file_name delimiter
Both the PLT.EXE and PL-TERM.EXE terminal emulators recognize an escape sequence to exit the current emulator session.
ESC CTRL-D {the ASCII codes 27 and 4}
This sequence will cause the terminal emulator to close the connection. PL-TERM.EXE will also exit if that connection was the only one open. PLT.EXE will always exit after closing the connection.
- CHAR(7)
- Bell
- CHAR(8)
- Cursor left (BS)
- CHAR(10)
- Cursor down (LF)
- CHAR(13)
- Carriage return
- CHAR(12)
- Clear screen and home (FF)
- CHAR(8)
- Cursor left (BS)
- ESC "=" CHAR(x) CHAR(y)
- X,Y cursor positioning.
- ESC "=" CHAR(x) CHAR(127)
- X-only cursor positioning
- ESC "*' CHAR(1)
- Clear screen and home
- ESC "*" CHAR(2)
- Cursor home
- ESC "*" CHAR(3)
- Clear to end-of-page
- ESC "*" CHAR(4)
- Clear to end-of-line
- ESC "*" CHAR(5)
- Blink on
- ESC "*" CHAR(6)
- Blink off
- ESC "*" CHAR(7)
- Dim
- ESC "*" CHAR(8)
- Bright
- ESC "*" CHAR(9)
- Cursor left
- ESC "*" CHAR(10)
- Cursor up
- ESC "*" CHAR(13)
- Reverse Video on
- ESC "*" CHAR(14)
- Reverse Video off
- ESC "*" CHAR(15)
- Underline on
- ESC "*" CHAR(16)
- Underline off
- ESC "*" CHAR(19)
- Cursor right
- ESC "*" CHAR(20)
- Cursor down
- ESC "*" CHAR(33)
- Set background color 0x07
- ESC "*" CHAR(34)
- Set background color 0x06
- ESC "*" CHAR(35)
- Set background color 0x05
- ESC "*" CHAR(36)
- Set background color 0x04
- ESC "*" CHAR(37)
- Set background color 0x03
- ESC "*" CHAR(38)
- Set background color 0x02
- ESC "*" CHAR(39)
- Set background color 0x01
- ESC "*" CHAR(40)
- Set background color 0x00
- ESC "*" CHAR(41)
- Set foreground color 0x0F
- ESC "*" CHAR(42)
- Set foreground color 0x0E
- ESC "*" CHAR(43)
- Set foreground color 0x0D
- ESC "*" CHAR(44)
- Set foreground color 0x0C
- ESC "*" CHAR(45)
- Set foreground color 0x0B
- ESC "*" CHAR(46)
- Set foreground color 0x0A
- ESC "*" CHAR(47)
- Set foreground color 0x09
- ESC "*" CHAR(48)
- Set foreground color 0x08
- ESC "*" CHAR(57)
- Set foreground color 0x07
- ESC "*" CHAR(58)
- Set foreground color 0x06
- ESC "*" CHAR(59)
- Set foreground color 0x05
- ESC "*" CHAR(60)
- Set foreground color 0x04
- ESC "*" CHAR(61)
- Set foreground color 0x03
- ESC "*" CHAR(62)
- Set foreground color 0x02
- ESC "*" CHAR(63)
- Set foreground color 0x01
- ESC "*" CHAR(64)
- Set foreground color 0x00
-
- CHAR(1)
- Cursor home
- CHAR(6)
- Cursor right
- CHAR(7)
- Bell
- CHAR(8)
- Cursor left (BS)
- CHAR(9)
- Tab
- CHAR(10)
- Cursor down (LF)
- CHAR(12)
- Clear screen and home (FF)
- CHAR(13)
- Carriage return
- CHAR(26)
- Cursor up
- CHAR(11) n
- X-only cursor positioning
- CHAR(16) n
- Y-only cursor positioning
- ESC "Y" n n
- X,Y cursor positioning
- ESC "k"
- Clear to end-of-page
- ESC "J"
- Clear to end-of-page
- ESC "K"
- Clear to end-of-line
- ESC "0@"
- Begin "normal" video attribute
- ESC "0`"
- Begin "xxx" video attribute
- ESC "0B'
- Begin "xxx" video attribute
- ESC "0P"
- Begin "xxx" video attribute
- ESC "H" CHAR(2)
- Wyse graphics mode on
- ESC "H" CHAR(3)
- Wyse graphics mode off
- CHAR(7)
- Bell
- CHAR(8)
- Cursor left (backspace)
- CHAR(10)
- Cursor down (line feed)
- CHAR(13)
- Carriage return
- CHAR(14)
- Shift 1
- CHAR(15)
- Shift 0
- ESC "D"
- Scroll down
- ESC "M"
- Scroll up
- ESC "7"
- Save cursor position
- ESC "8"
- Restore cursor position
- ESC "n"
- Character set 2
- ESC "o"
- Character set 3
- ESC "[" {n} "A"
- Cursor up
- ESC "[" {n} "B"
- Cursor down
- ESC "[" {n} "C"
- Cursor right
- ESC "[" {n} "D"
- Cursor down
- ESC "[" {n {";" n} "H"
- X,Y cursor positioning
- ESC "[" {n} "@"
- Insert character
- ESC "[" {n} "L"
- Insert line
- ESC "[" {n} "P"
- Delete character
- ESC "[" {n} "M"
- Delete line
- ESC "[" {n} "J"
- Clear to end-of-page
- ESC "[" {n} "K"
- Clear to end-of-line
- ESC "[" {n} "m"
- Begin attribute setting
- ESC "[?1h"
- Use application cursor keys
- ESC "[?1l"
- Use normal cursor keys
- ESC "OA"
- Cursor up
- ESC "OB"
- Cursor down
- ESC "OC"
- Cursor right
- ESC "OD"
- Cursor left
- ESC "(B"
- Use character set 0 - ascii
- ESC "(0"
- Setup char set 0 - graphics
- ESC ")B"
- Setup char set 1 - ascii
- ESC ")0"
- Setup char set 1 - graphics
- ESC "*B"
- Setup character set 2 - ascii
- ESC "*0"
- Setup char set 2 - graphics
- ESC "+B"
- Setup character set 3 - ascii
- ESC "+0"
- Setup char set 3 - graphics
PL-TERM keyboard definitions are user-programmable and are controlled by configuration information contained in the PL-CFG.INI file. The following keys are programmable:
Enter (1)
Tab (1)
ShiftTab
CtrlTab
AltTab Backspace (1)
ShiftBackspace
CtrlBackspace
AltBackspace
Home
End
PgUp
PgDn
Left
Right
Up
Down
Insert
Delete
Five (3)
CtrlHome (4)
CtrlEnd (4)
CtrlPgUp (4)
CtrlPgDn (4)
CtrlLeft (4)
CtrlRight (4)
CtrlUp (4)
CtrlDown (4)
CtrlInsert
CtrlDelete
CtrlFive (3)
GreyPlus
GreyMinus
GreyStar
GreyDivide
F1
F2
F3
F4
F5
F6
F7
F8
F9
F10
F11
F12
ShiftF1
ShiftF2
ShiftF3
ShiftF4
ShiftF5
ShiftF6
ShiftF7
ShiftF8
ShiftF9
ShiftF10
ShiftF11
ShiftF12
CtrlF1
CtrlF2
CtrlF3
CtrlF4 (2)
CtrlF5
CtrlF6 (2)
CtrlF7
CtrlF8
CtrlF9
CtrlF10
CtrlF11
CtrlF12
AltF1
AltF2
AltF3
AltF4 (2)
AltF5
AltF6
AltF7
AltF8
AltF9
AltF10
AltF11
AltF12
AltA
AltB
AltC
AltD
AltE
AltF
AltG
AltH
AltI
AltJ
AltK
AltL
AltM
AltN
AltO
AltP
AltQ
AltR
AltS (2)
AltT (2)
AltU
AltV
AltW (2)
AltX
AltY
AltZ
(1) Key sends its normal value if not programmed (or if programmed to an empty string).
(2) Key's menu definition supersedes any programming - these keys are recognized while processing the PL-CFG.INI file, but they are effectively non-programmable.
(3) The standard PC BIOS does not allow this key to be recognized.
(4) When <SCROLL LOCK> is off, sends the program sequence. When <SCROLL LOCK> is on, scrolls the terminal porthole.
Goto: Table of Contents Index
Chapter: 1 2 3 4 5 6 7 8 9 10 11 12 13 14