home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Chip 1994 February
/
CHIP0294.ISO
/
digital
/
dfue
/
terminal
/
commo
/
addendum.doc
next >
Wrap
Text File
|
1994-04-09
|
35KB
|
940 lines
{COMMO} 6.0 Addendum
____________________
This Addendum contains the major additions and/or changes to the
{COMMO} 5.52 documentation. Print out this file and keep it with your
printed manual. There is a complete list of changes (major and minor)
in the file HISTORY.
===============================
In the User Guide and Reference
===============================
Under "Alt-D Dialing Directory"
--------------------------------
---------- 5. Linked Macro: {fcbbs}
The general form for this item is:
{label,filename}
label
A macro label where execution is to start
(optional). The label may be located in the
resident Macro File or in the current auxiliary
file.
filename
The filename of a Macro File (optional). If the
file is not already in memory (resident or
auxiliary), it will be loaded as the auxiliary
prior to searching for the label.
Examples:
{fcbbs}
Start at the label "fcbbs".
{mailrun,fcbbs.mac}
Start at the label "mailrun" after loading the
auxiliary Macro File "fcbbs.mac".
{,fcbbs.mac}
Load the auxiliary Macro File "fcbbs.mac" and enter
manual mode.
If a valid label is specified, the Linked Macro will be started
when a connection is established with the remote system. If no
macro is specified (or the macro label is not found), {COMMO}
will enter the Terminal Screen in manual mode.
Additional options are available when using the DIAL macro
function. See Part II for details.
Under "Alt-G Edit Setup File"
------------------------------
___________________________________________________
{ncr=nocar} Macro to execute when carrier is lost
___________________________________________________
{COMMO} will execute the macro specified here when the Carrier
Detect signal is lost. This signal normally comes on when your
modem connects with a host system, and goes off when the call is
terminated.
If a command window is on screen, the macro will activate when
the window is exited. If a macro is running when carrier is
lost, the macro will be STOPped and {COMMO} will GOTO the label
specified.
{COMMO} will search for the label first in the auxiliary Macro
File, then in the resident file. If the label is not found,
{COMMO} will continue as usual.
TIPS on using the carrier lost macro:
> IMPORTANT! This feature is enabled only when a connection
is made using {COMMO}'s Auto Dialer.
> The macro will not activate if carrier is lost while in the
Swap to Disk (serial port is closed).
> The macro label can be changed or cancelled using the
NOCArrier macro function. See Part II for details.
> Be sure that you have your modem configured to provide the
carrier detect signal. See Appendix A for modem
information.
______________________________________________
{dcn=c} Method to cancel dialing (c/d/s,...)
______________________________________________
This item defines the method that {COMMO} will use to cancel a
dialing attempt in progress. Dialing is cancelled when you press
Esc or when {COMMO} times out. Options are:
c Send a carriage return
d Drop DTR
s Send a user-defined string
The "s" option lets you define your own string. The string can
be up to 8 characters in length, including any carets or tildes
(see Appendix D). Here's an example that sends a Ctrl-X,
followed by a half-second delay and a carriage return:
{dcn=s,^x~|} Fictitious example
_________________________________________________________
{set protodir,c:\commo} Path to find external protocols
_________________________________________________________
This is the path where you keep your external protocol programs.
Copy the executable programs, such as DSZ.COM and HSLINK.EXE,
into this directory and {COMMO} will know where to find them. Do
not use a "\" at the end of the path.
__________________________________________________
{dmk=8300}
Scan code for Doorway Mode key (see COMMO.DOC)
__________________________________________________
This item defines the key used to enter and exit Doorway Mode.
The default key is Alt-=. The scan code (such as "8300") is
obtained by pressing Alt-K in {COMMO}'s Internal Editor, then
pressing the key you wish to use.
Note that a corresponding macro must exist in the Macro File.
The macro (provided in COMMO.MAC) to use with Alt-= is:
{:al=} {doorway} {}
If you change the key definition in COMMO.SET, be sure to change
the key-label in COMMO.MAC.
_____________________________________
{mky=} User-defined macro key-label
_____________________________________
(Note that this feature is unavailable during shareware
evaluation.)
This item allows you to assign a macro key-label to almost any
key or key combination on your keyboard. Up to 32 "mky" items
may be used (any more will be ignored). Here are some examples:
{mky=cta,1e01} Ctrl-A
{mky=bsh,2b5c} Backslash
Any valid, three character label may be used as a user-defined
key-label (such as "cta" in the example). The scan code (such as
"1e01") is obtained by pressing Alt-K in {COMMO}'s Internal
Editor, then pressing the key you wish to use.
For additional information and certain restrictions, see Appendix
H "{COMMO} Macro Key-labels."
______________________________________________
{avm=} Alternate video mode (mode,rows,cols)
______________________________________________
You can toggle between two video modes (text modes only) if this
item is defined. One important application for this is the 132
column feature in VT102 emulation. It can also be used to toggle
between any two different video modes using the VIDEo macro
function.
The "normal" video mode is the mode that is in effect when
{COMMO} is started. That mode will always be restored
automatically when you exit the program. If you Shell to DOS or
use the EXECute macro function, the current mode will remain in
effect.
The mode field must be expressed as a hexadecimal number, while
the rows and columns are decimal numbers (minimum dimensions are
25x80). As an example, suppose that your video adapter uses mode
23h (hexadecimal) to support a 25x132 screen. Then you would
write this item as:
{avm=23,25,132} Alternate video mode
Set mode "3" to use the standard 50 line mode supported by VGA
adapters or the standard 43 line mode supported by EGA adapters.
For example:
{avm=3,50,80} Alternate video mode
The following macro will restore the "normal" mode when Shelling
to DOS and bring back the alternate mode upon return (press Alt-S
to activate):
{:als} {video-m0} {shell} {video-m1} {}
Note that some screen "modes" are not hardware modes and cannot
be toggled using this feature. Consult your video adapter manual
for a list of hardware modes supported (or contact the
manufacturer).
________________________________________________
{set sel_up,no}
Go directly to picklist for uploads (yes/no)
________________________________________________
Set this item to "yes" and {COMMO} will skip the input prompt for
a filename. Instead you will see the file picklist immediately.
Under "[Alt-=] Doorway Mode Toggle"
------------------------------------
Definition: "Extended" keys are function keys, Alt keys, cursor keys,
etc. In other words, keys that do not generate ASCII characters.
In Doorway Mode all extended keys will send their key codes to the
remote (instead of activating {COMMO} functions). Thus Doorway Mode
can be used to operate most application software on the remote system
when used with a host program such as Marshall Dudley's DOORWAY. In
addition, some BBS full-screen editors use Doorway Mode.
TIPS on using Doorway Mode:
> The Alt-= key is the default, but the "dmk" item in the Setup
File may be used to define any key. The defined key is
necessarily reserved for exiting Doorway Mode and thus cannot be
sent to the remote. Be sure to configure remote applications
accordingly.
> A macro must be present in the Macro File to toggle Doorway Mode.
The supplied macro is:
{:al=} {doorway} {} Toggle Doorway Mode
If you redefine the key with "dmk", don't forget to change the
key-label on the macro.
> When used with DOORWAY 2.22 or later, the Doorway Mode macro will
execute automatically when the DOORWAY program (on the host
system) starts up and when it exits back to DOS -- no keypress is
necessary.
(Note that this feature is unavailable during shareware
evaluation.)
> The display should be set to the number of lines expected by the
host program. Usually this is 25 lines of text. If your display
is not in the proper mode, the results will be unpredictable.
> The Status Line is normally suppressed in Doorway Mode, but may
be turned on by using the "S" switch in the Doorway macro:
{:al=} {doorway-s} {}
The "s" switch is ignored when exiting Doorway Mode and the
Status Line will be restored to its previous state. Remember
that when the Status Line is on, there is one less usable line on
the Terminal Screen.
> If it is necessary to clear the screen or to reset the terminal
emulation mode parameters when starting Doorway Mode, modify the
Doorway macro. For example:
{:al=} {clear} {parms ,,,a} {doorway} {}
This macro will execute when entering or exiting Doorway Mode.
> For most applications you will want Terminal-type set to
ANSI-BBS. It's a good idea to enter Doorway Mode before starting
the host program. The host may send commands to initialize the
terminal.
> If Software Flow Control is enabled, the ASCII character values
17 and 19 (XON and XOFF) will not display. If these characters
are needed, Software Flow Control should be turned off.
==============================
In the Macro Programming Guide
==============================
------------------------------------
New or Changed Function Descriptions
------------------------------------
=== CALL ===
Default key: none
Description: Execute a macro subroutine.
General form:
{CALL label,filename}
label
The label that begins the subroutine to be executed.
filename
The name of the Macro File where the label is to be
found. This argument is OPTIONAL and is normally used
only if the file is not already loaded. Do NOT specify
a path; the {COMMO} home directory will be used.
Switches:
F1 or F
Force loading of the specified file (as the auxiliary
file). No filename comparison will be made.
F0
Compare filenames. If the file is already loaded
(resident or auxiliary), it will not be reloaded
(default).
Examples:
{call abc}
Execute subroutine "abc".
{call abc,other.mac}
Execute subroutine "abc" in the auxiliary Macro File
"other.mac".
CALL will push the return location onto the macro stack; then it will
transfer control to the given label. When a RETUrn is executed, the
location will be popped and control will return to the function
following the CALL. If the CALL is located in the auxiliary Macro
File, the filename will be saved on the macro stack along with the
return location.
If a filename is specified, {COMMO} will check to see if the file is
already loaded (resident or auxiliary). If not, the file will be
loaded as the auxiliary (the current auxiliary will be saved to disk
if there are any outstanding changes).
TIPS on using CALL:
> It isn't necessary to specify a filename if the target label is
in the resident Macro File or in the current auxiliary file.
> A macro error will result if either the label or the file do not
exist.
> CALLs may be nested up to 32 deep.
> Use GOTO when you want to load or execute macros in another file
and you do not need to return. This will prevent the macro stack
from filling with "dead" entries.
> Do not modify a Macro File while a CALL from that file is active
(the return location may be invalidated).
See also RETUrn, GOTO, PUSHstack, POPStack, UNLOad, Appendix K.
=== GOTO ===
Default key: none
Description: Transfer control of macro execution.
General form:
{GOTO label,filename}
label
The label to which control will be transferred.
filename
The name of the Macro File where the label is to be
found. This argument is OPTIONAL and is normally used
only if the file is not already loaded. Do NOT specify
a path; the {COMMO} home directory will be used.
Switches:
F1 or F
Force loading of the specified file (as the auxiliary
file). No filename comparison will be made.
F0
Compare filenames. If the file is already loaded
(resident or auxiliary), it will not be reloaded
(default).
Examples:
{goto mail_run}
Control transferred to label "mail_run".
{goto mail_run,ginger.mac}
Control transferred to label "mail_run" in the auxiliary
Macro File "ginger.mac".
{goto ,ginger.mac}
The auxiliary Macro File "ginger.mac" is loaded; macro
execution STOPs (no label given).
If a filename is specified, {COMMO} will check to see if the file is
already loaded (resident or auxiliary). If not, the file will be
loaded as the auxiliary (the current auxiliary will be saved to disk
if there are any outstanding changes).
TIPS on using GOTO:
> It isn't necessary to specify a filename if the target label is
in the resident Macro File or in the current auxiliary file.
> A macro error will result if either the label or the file do not
exist.
See also CALL, UNLOad, Appendix K.
=== RETUrn ===
Default key: none
Description: Return from a CALLed macro.
Example:
{return}
No arguments.
This function will return control to the last location pushed onto the
macro stack (by CALL, PUSHstack, etc.). The location may reside in a
Macro File that is not currently loaded (loading will occur
automatically).
TIPS on using RETUrn:
> If a RETUrn is encountered and no elements remain on the macro
stack, a STOP will occur. This is useful in macros that are
CALLed and also used standalone (such as protocol file transfer
macros).
> If the macro filename popped from the macro stack is the same as
the current auxiliary file, no load will occur.
See also CALL, CALOok, DIAL, PUSHstack, POPStack.
=== FONFile ===
Default key: none
Description: Load a new Dialing Directory file.
Example:
{fonf local.fon}
The Dialing Directory is replaced with the file LOCAL.FON.
(Note that this feature is unavailable during shareware evaluation.)
The current Dialing Directory file will be saved to disk if there are
any outstanding changes. Dialing marks in the new file will be erased
if {cdm=yes} in the Setup File.
=== SFICtrl ===
Default key: none
Description: Speech Friendly Interface control.
Examples:
{sfic}
Toggle Speech Friendly Interface on/off.
{sfic y}
Turn on Speech Friendly Interface.
{sfic n}
Turn off Speech Friendly Interface.
=================
In the Appendices
=================
========== Appendix E Terminal Emulation
Terminal Emulation Type is indicated on the Status Line (in the
Terminal Parameters string). Available types are:
A ANSI-BBS
Used on bulletin boards and other systems.
V VT102 (VT100 compatible)
Used on minicomputers and mainframes.
T TTY
Supports only the basic control characters.
The Terminal Emulation Type (as defined by the Default Dialing
Parameters string) will be set whenever a system is dialed. It may be
overridden for the current call by using the Parms field in the
Dialing Directory entry. It may also be changed temporarily using the
Alt-P key command or the PARMs macro function. The Default Dialing
Parameters may be changed using the Alt-P key command or the DPARms
macro function.
IMPORTANT! The Terminal Emulation Type affects only received data (as
displayed to the screen). The proper macros must be installed to
obtain the correct keyboard simulation. The following sections
describe how to do this.
-----===== ANSI-BBS Keyboard Support
The sample Macro File, COMMO.MAC, includes macros to use the PC keypad
keys (arrow keys, PgUp, PgDn, etc.) with most BBS full-screen editors.
If these keys do not seem to work properly, especially if the left
arrow seems to hang the host, you should try the VT102 keyboard file
(see instructions below). Do not set the "V" for display emulation
unless the host requires it.
-----===== VT102 Keyboard Simulation
The VT102 keyboard simulation macro file, VT102.MAC, works best with
the enhanced 101-key keyboard (turn on Numlock to use digits 0-9 and
the period).
IMPORTANT! The PgUp and PgDn keys are part of VT102 emulation. To
bring up the upload or download protocol menus while VT102.MAC is
loaded, press Alt-Z.
VT102.MAC will load automatically if "vt102" is specified as the
Linked Macro in a Dialing Directory entry. For example:
University UNIX {555-1234} {password} {vt102} {,,,V}
Notice also the presence of the "V" in the parms field, which enables
the display portion of the VT102 emulation. VT102 is a superset of
VT100.
The following special VT102 keyboard functions are supported. The
first column is the PC key; the second column is the corresponding
VT102 function (^ indicates the Ctrl key):
F1 ... F4 PF1 ... PF4
Arrows Four cursor keys
Home Home cursor
^Home Insert line
PgUp Page up
^PgUp Delete line
PgDn Page down
^PgDn Clear screen
End End of line
Ins Insert mode
Del DEL
^(BS) Ctrl backspace (DEL)
Keypad * Keypad ,
Keypad - Keypad -
Keypad + Keypad Enter
VT102 numeric keypad keys are auto-switched by the host system between
numeric mode and application mode. The four cursor keys are auto-
switched between cursor mode and application mode.
This file may be modified to create any keyboard support you desire
(see description of VTCUr and VTPAd functions in the section "{COMMO}
Macro Functions."
-----===== VT220 Keyboard Simulation
VT220 keyboard simulation uses the file VT220.MAC. All of the
statements in the previous section apply (substitute the term VT220
for VT102).
Note that {COMMO} does NOT support the enhanced display functions of
the VT220 terminal (it supports VT102). Therefore the results may not
be satisfactory in all cases.
The following special VT220 keyboard functions are supported:
F1 ... F4 PF1 ... PF4
F5 Break
F6 ... F12 F6 ... F12
Alt-F11 ... Alt-F14 F11 ... F14
Alt-F15 Help
Alt-F16 Do
Alt-F17 ... Alt-F20 F17 ... F20
Arrows Four cursor keys
Home Find
Ins Insert here
Del Remove
End Select
PgUp Prev screen
PgDn Next screen
Keypad * Keypad ,
Keypad - Keypad -
Keypad + Keypad Enter
Backspace DEL
-----===== Printer Support
{COMMO} supports the ANSI/VT102 printer functions, controlled by the
remote system:
The "Printer ON/OFF" function will turn {COMMO}'s Print Log
ON/OFF.
The "Dedicated Printing" function will send all input from the
serial port directly to the printer. This allows for
"transparent" transmission of printer data, including control
codes.
The "Print Screen" function will print the entire current screen.
The printer should be on and ready to print when these functions are
used. When "Dedicated Printing" is active no characters will be
displayed on the screen.
TIPS on using terminal emulation:
> Whenever a change is made, a reset of mode parameters will be
performed. It is therefore important that the change be made
BEFORE (or at the time of) connecting with a host (mode settings
may be transmitted by the host).
> If some screens do not look right when VT102 emulation is used,
you may need to turn LINEWRAP off (it defaults to on).
Linewrap may be turned on/off locally using the DISPlay macro
function. Place one of the following in your login macro (or
assign one of them to a key and execute it manually):
{display ,,,^[[?7h} linewrap ON
{display ,,,^[[?7l} linewrap OFF
> {COMMO} will support auto-switching to 132 column mode, but you
must define the hardware video mode that causes your video
adapter to switch to 25x132 (rows, columns). See the item {avm=}
under "[Alt-G] Edit Setup File" for details. Note that your
video adapter should be in 25x80 when you start {COMMO}.
> If colors do not always look right, it may be necessary to set
the Terminal Screen colors in the Setup File to {07}. See the
note under "Colors" in the section "[Alt-G] Edit Setup File."
========== Appendix H {COMMO} Macro Key-labels
Key-labels are special macro labels that let you start a macro by
pressing the associated key (they can also be the targets of GOTO,
CALL, etc.). They fall into two general categories: predefined and
user-defined.
---------- Table of PREDEFINED Key-labels
The caret (^) indicates the Ctrl key. "Normal" means unshifted.
Key Name Key-label Key Name Key-label
________ _________ ________ _________
Normal-F1 nf1 ... Normal-F10 nf0
Normal-F11 nfa Normal-F12 nfb
Ctrl-F1 cf1 ... Ctrl-F10 cf0
Ctrl-F11 cfa Ctrl-F12 cfb
Shift-F1 sf1 ... Shift-F10 sf0
Shift-F11 sfa Shift-F12 sfb
Alt-F1 af1 ... Alt-F10 af0
Alt-F11 afa Alt-F12 afb
Alt-A ala ... Alt-Z alz
Alt-1 al1 ... Alt-0 al0
Alt = al= Alt - al-
Escape esc Grey * gr*
Grey - gr- Grey + gr+
Backspace bsp ^Backspace cbs
Tab tab Shift-tab stb
Enter ent ^Enter cen
Home hom End end
PgUp pgu PgDn pgd
Up-Arrow upa Down-Arrow dna
Left-Arrow lfa Right-Arrow rta
Insert ins Delete del
^Home chm ^End cnd
^PgUp cpu ^PgDn cpd
^Right-Arrow cra ^Left-Arrow cla
Keypad-0 kp0 ... Keypad-9 kp9
Keypad-. kp. ^PrtSc cpr
Alt-[ al[ Alt-] al]
Alt-; al; Alt-' al'
Alt-, al< Alt-. al.
Alt-/ al/ Alt-\ al\
Alt-* al* Alt-` al`
Alt-Kp(-) ak- Alt-Kp(+) ak+
Alt-Return art Center Key cky
TIPS on using key-labels:
> Key-labels are always three characters in length.
> Some key-labels are not available on systems with an older BIOS.
And some keys do not exist on the 83-key keyboard.
> If the same key-label appears more than once, the first
occurrence will be used (as with any macro label).
> Key-labels are not case sensitive.
> The Center Key is the Keypad 5 with Numlock off.
---------- USER-DEFINED Key-labels
(Note that this feature is unavailable during shareware evaluation.)
Almost any key combination on the keyboard may be defined with the
"mky" item in the Setup File (see "[Alt-G] Edit Setup File" in Part
I).
TIPS on using user-defined key-labels:
> You may have up to 32 user-defined key-labels.
> Keys with predefined key-labels may not be user-defined. Check
the list above before defining a key.
> Use Alt-K in the Internal Editor to obtain the scan code for any
key. When a scan code ends in "E0", change the "E0" to "00" to
define the key.
> Beware that some keys give the same scan code when used with
various shift keys (Ctrl, Alt or Shift) as when unshifted. Some
examples are: Space, Esc, Return and Backspace.
> You cannot define keys formed with multiple shift keys. For
example, you cannot use Ctrl-Alt-F1 or Ctrl-Shift-Home.
========== Appendix K {COMMO} Support Files
The {COMMO} support files are standard ASCII text files and may be
modified with any editor (or word processor in "non-document" mode).
From within {COMMO} they may be edited with {COMMO}'s Internal Editor.
Each support file may be up to 64k in size (if there is enough
memory).
The only control characters (below ASCII 28) allowed in support files
(or in the Internal Editor) are CR/LF pairs and an EOF at the end.
Where necessary, control characters may be represented symbolically as
shown in Appendix D. For example, an ASCII 16 would be written as ^P.
TIPS on using {COMMO} support files:
> All support files must reside in the {COMMO} home directory.
> A file currently in memory may be different from the file on disk
(files are saved automatically at certain times). Therefore it
is advisable to use an external editor ONLY in the Swap to Disk
(files are saved prior to -- and reloaded after -- the Swap to
Disk).
---------- The Internal Editor
{COMMO}'s Internal Editor is provided for your convenience. It is not
intended to be a comprehensive text editor. An external editor should
be used if more editing power is desired. The Internal Editor may be
used to edit {COMMO} support files or any other text file smaller than
64k.
When a file that can be edited is loaded, a fixed amount of expansion
space is allocated (no more than 64k total). The amount of expansion
space is determined by the {esf=...} item in the Setup File. The
Internal Editor will warn you while editing if the expansion space
fills up, at which point you may reload the file or restart {COMMO} if
you wish to continue editing (the file will be saved automatically).
Key assignments for the Internal Editor are given in Online Help. A
Color Chart will be displayed in the editor when F7 is pressed (useful
in the Setup File and for the DISPlay function in Macro Files).
---------- The Setup File, COMMO.SET
The Setup File contains settings for many important parameters. The
first time you run {COMMO} you should use the Alt-G key command to
edit this file to your own needs.
IMPORTANT! If you edit the Setup File, the changes will not take
effect until you restart {COMMO}.
See "[Alt-G] Edit Setup File" for details on each item.
---------- The Dialing Directory, COMMO.FON
The Dialing Directory file contains information about each system that
you will be calling, including the telephone number, password, Linked
Macro and Terminal Parameter overrides. Use the Alt-D key command to
dial numbers and to edit this file.
A new Dialing Directory file may be loaded at any time using the
FONFile macro function, or manually within the Dialing Directory
window. This feature may result in somewhat higher memory usage
during a {COMMO} session. (Note that this feature is unavailable
during shareware evaluation.)
See also "[Alt-D] Dialing Directory."
---------- The Resident Macro File, COMMO.MAC
The resident Macro File is loaded when you start {COMMO} and contains
macros that are available at all times. Use the Alt-M key command to
select a macro for execution and to edit the resident Macro File. A
complete description of {COMMO} macros is given in Part II. Summary
lists of macro functions and key designators can be found in the
appendices and also in Online Help.
---------- The Auxiliary Macro File
An auxiliary Macro File may be loaded (or replaced) at any time using
the CALL and GOTO macro functions. A new auxiliary file may be loaded
manually within the Macro File window. An auxiliary may also be
specified in a Dialing Directory entry and will load when a connection
is made with the remote system.
When an auxiliary is loaded, the auxiliary and resident files behave
as one Macro File. Note that the auxiliary is positioned logically
AHEAD of the resident, allowing macros in the resident to be
overridden when necessary. You can CALL and GOTO between the files,
but a macro cannot span the two files.
The current auxiliary may be released from memory using the UNLOad
macro function.
---------- The Online Help File, COMMO.HLP
The Online Help File contains the information for {COMMO}'s context-
related Online Help. This file can be customized.
See "F1 How to Use Online Help."
---------- Changes to the Support Files
Whenever a change is made to any file, the internal change flag is set
for that file (indicated by an "*" next to the column number in the
Internal Editor). Changes are normally saved automatically at program
exit or if another file is loaded, but you may press Alt-F in the
Internal Editor to immediately save any file to disk.
If you do not wish to save your changes, you may press Alt-Q while in
the Internal Editor. This will reset {COMMO}'s change flag and the
file will not be saved automatically (however, any subsequent changes
to the file will set the change flag again).
- end -