[comp.sys.cbm] MRterm Documents - Part 02 of 02

mark@unisec.UUCP (05/15/87)

    This shell archive contains a short document describing the steps
necessary to link MRterm as well as the MRterm documentation segments.
Use the "efmt" program posted prior to this posting to prepare the
documentation.
#---------------------------- c u t  h e r e ------------------------------
#! /bin/sh
# This is a shell archive, meaning:
# 1. Remove everything above the #! /bin/sh line.
# 2. Save the resulting text in a file.
# 3. Execute the file with /bin/sh (not csh) to create the files:
#	quick.fo
#	s1
#	s10
#	s11
#	s2
#	s3
#	s4
#	s5
#	s6
#	s7
#	s8
#	s9
# This archive created: Fri May 15 14:44:51 1987
export PATH; PATH=/bin:$PATH
if test -f 'quick.fo'
then
	echo shar: will not over-write existing file "'quick.fo'"
else
cat << \SHAR_EOF > 'quick.fo'
.in 10
.rm 70
.he /MRterm/Quick Notes/Page #/
.ju1
.ti +5
This small document provides some quick
reference information for re-assembling
and re-linking MRterm.  Please refer to
the program design document for more
detailed information.

.ti +5
MRterm is comprised of separately assembled
source modules, each of which has an
associated object file compatible with the
Pro-Line C-Power (tm) linker.
These source modules must
be assembled by the C-ASSM 6502 assembler
which runs in the C-Power environment.


File Naming Conventions

.ti +5
MRterm source files can be categorized
as belonging to one of several classes.
A file can be identified as belonging
to a particular class by examining the
suffix (period + 1 or more letters)
on its name.  The various file classes
are:

.in +5
Source Files - '.a' suffix.  These files
are assembled using the C/ASSM assembler.
.sp 1
Object Files - '.o' suffix.  For each source
file assembled, one of these is generated.
.sp 1
Include Files - '.i' suffix.  These contain
either system-wide definitions or fragments
of larger source modules.
.sp 1
Library File - '.l' suffix.  Use of the library
file makes the linking process (described later)
much simpler.
.sp 1
Program File - no suffix.  The program file
name is MRterm.
.sp 1
Others - various suffixes.  All files not
covered in the other classes are generally
data files used by MRterm during its normal
operation (initial screen, parameters, etc.).
.sp 2
.in -5
Rebuilding MRterm
.sp 1
.ti +5
Should you wish to add your own features
to MRterm (go ahead, just name it something
else), you will first have to assemble the
new or modified source module.  If a new
source module is added, you will have to
rebuild the library file, MRterm.L.  to do
this, edit the library control file,
MRterm.LCTL, adding the new object file
name to the list that appears there.
Make sure that you leave a blank line
between the new file name and the 's'
command (save library).  The blank line
terminates the 'a' (add object module)
command.
.sp 2
.ti +5
Once the edit(s) have been 
made, save the new control file.  You are
now ready to rebuild the library.  To do
this, you need a working copy of LIB.SH.
The source for this utility, LIB.C, is
supplied with the C-Power compiler.  You
will have to compile and link it, if you
haven't already done so.
.sp 2
.ti +5
To rebuild the library, invoke the LIB
utility with the control file specified
as standard input.  Be sure to remove
the old library file first:
.sp 1
.ju0
$ rm mrterm.l
$ (load lib if on separate disk)
$ lib < mrterm.lctl
.ju1
.sp2
.ti +5
To relink MRterm, use the following
steps:
.ju0
.sp1
$ rm mrterm
$ link -s 2049
> startup.o
> mrterm.l
> ^
> end.o
>
output file name: mrterm
.sp 1
.ju1
The object module 'startup.o' contains
an external reference to label START
which is in object module 'main.o', 
installed in the library.  It is important
that the module end.o be the last one
linked, since it defines the start
of the capture buffer area.
.sp 2
That's all there is to it.  The author
would like to retain rights to the name
MRterm (Mark Rinfret's terminal program).
If you want to make changes, just name
the program something else and it's
yours.
SHAR_EOF
fi # end of overwriting check
if test -f 's1'
then
	echo shar: will not over-write existing file "'s1'"
else
cat << \SHAR_EOF > 's1'
.lm 10
.rm 70
.sp10
.nf
.ce 13
MRTERM V3.0

Multi-Function

Terminal Program

for the

Commodore 64

Mark R. Rinfret

30 August, 1986
.he /MRTERM/User's Manual/Introduction/
.bp 1
.fo //Page 1-#//
.fi
.ju 1
Introduction
.sp1
.ti +5
MRTERM (Mark Rinfret's TERMinal program)
is a multi-function terminal
program for the Commodore 64.  It supports
communications with a variety of computer
systems and offers the popular Punter
file transfer protocol (used on CBM 
bulletin boards) and the ubiquitous
XMODEM protocol, developed by Ward
Christensen.
.sp2
.ti +5
MRTERM was designed to be user-friendly.
Its operation should, for the most part,
be self-explanatory.  MRTERM is also a
public domain program, distributed with
assembly language source.  I
only ask that if you make changes or
enhancements, you release the new
program under a different name, but give
credit of origin to me.  If
you have an executable copy of
MRTERM without source and you would like
the source, you can obtain it by:
.sp1
.in +5
.nf
1. Sending 2 floppy diskettes and a prepaid mailer
.sp1
or
.sp1
2. Sending a check or money order for $10.00
.sp1
.ti -5
to:
.sp1
Mark Rinfret
348 Indian Avenue
Portsmouth, RI 02871
.sp2
.fi
.in -5
.ti +5
Prior to placing your order, however, you
should be aware that MRTERM was written
using a special assembler developed by myself
and others for use with the
C-Power (tm) C language program development
system from Pro-Line, Ltd.  All source is
file-compatible with the CBM assembler, but
the syntax is quite different.  Throw in
another floppy diskette under option 1
or just indicate that you'd like the
assembler under option 2 and I'll send
that along, also.
.sp2
.ti +5
This document is divided into several
sections, according to the functional
aspect of the program being discussed.
For your ease in navigating this document,
the various sections are:
.sp1
.nf
.in +5
Section  1 - Introduction
Section  2 - General Info
Section  3 - Operation
Section  4 - Configuring MRTERM
Section  5 - Terminal Mode
Section  6 - File Transfer Protocols
Section  7 - Disk/File Utilities
Section  8 - Buffer Utilities
Section  9 - Phone Book Utilities
Section 10 - Function Key Utilities
Section 11 - Coming Attractions
.in -5
.fi
.sp2
.ti +5
This document was prepared using the
C-Power text editor and an extended
version of the  FORMAT
utility, named EFMT, which runs in the C-Power
shell.  The source and executable for
EFMT are provided with the source for
MRTERM.
.sp1
.nx /s2/ 
SHAR_EOF
fi # end of overwriting check
if test -f 's10'
then
	echo shar: will not over-write existing file "'s10'"
else
cat << \SHAR_EOF > 's10'
.lm 10
.rm 70
.fi
.ju 1
.he /MRTERM/User's Guide/Function Keys/
.bp 1
.fo //Page 10-#//
.in +5
.ti -5
Function Key Utilities
.sp1
.ti +5
The function keys at the right hand
side of your keyboard, labelled F1-F8,
have special significance when MRTERM
is in terminal mode.  Each time a key
is pressed, MRTERM checks to see if the
key is one of the function keys.  If so,
a string of characters associated with
the function key is output to the host
computer.  You, the user, define these
function key strings (macros), which may
be from zero to 20 characters long.
.sp1
.ti +5
One special character which may be
placed anywhere in a function key
definition is the up-arrow key (to the
left of the RESTORE key).  Each time
it is encountered, a carriage return
(code 13 decimal) is sent instead.
Unfortunately, this means that in the
current release of MRTERM, the up-arrow
key cannot be sent as part of a
function key string.  If this is a 
problem, let me know and I'll consider
making MRTERM a little smarter.
.sp1
.ti +5
The options available in the Function
Key Utilities menu are:
.sp2
.ti -5
Quit
.sp1
.ti +5
You guessed it!  This option exits the
Function Key Utilities.
.sp2
.ti -5
Edit Function Keys
.sp1
.ti +5
This option allows you to assign up to
20 characters to each of the function
keys.  To select a key for modification,
position the highlight bar to the
desired key, then press RETURN.  You
will be prompted at the bottom of the
screen for the new function key definition.
You may exit the Edit Function Keys
option during the key selection
operation by entering SHIFT + RUN/STOP.
The current function key definitions
may be printed by typing C=P.
.sp2
.ti -5
Load Function Keys
.sp1
.ti +5
This option allows you to redefine the
function keys from data in the file
'mrterm.fkey'.
.sp2
.ti -5
Save Function Keys
.sp1
.ti +5
This option allows you to save your
current function key definitions to
the file 'mrterm.fkey'.  Each time
MRTERM is booted up, the function key
definitions will be automatically set
to the configuration in this file.
.br
.in -5
.nx /s11/
SHAR_EOF
fi # end of overwriting check
if test -f 's11'
then
	echo shar: will not over-write existing file "'s11'"
else
cat << \SHAR_EOF > 's11'
.lm 10
.rm 70
.fi
.ju 1
.he /MRTERM/User's Guide/Coming Attractions/
.bp 1
.fo //Page 11-#//
Coming Attractions
.sp1
.in +5
Multi-drive operation
.sp1
Configurable printer parameters
.sp1
User-editable character translation tables
.sp1
Custom character sets
.sp1
Enhanced keyboard options (all caps, local
echo, etc.)
.sp1
80 Columns
.sp1
DEC terminal emulation
.sp1
.in -5
.sp2
.ti +5
If you have any comments or suggestions, please
drop me a card or call 
401-846-7639 (evenings + weekends),
401-849-4174 (workdays).
.sp1
Happy telecomputing!
.sp2
.in +10
.nf
Mark Rinfret
348 Indian Ave.
Portsmouth, RI  02871
.in -10
.nf
.bp
SHAR_EOF
fi # end of overwriting check
if test -f 's2'
then
	echo shar: will not over-write existing file "'s2'"
else
cat << \SHAR_EOF > 's2'
.lm 10
.rm 70
.fi
.ju 1
.he /MRTERM/User's Guide/General Info/
.bp 1
.fo //Page 2-#//
General Info
.sp1
.ti +5
I wrote MRTERM after I realized how
often I complained about existing
public domain terminal programs not
providing all the features I wanted
in a terminal program.  To be sure,
MRTERM is in its infancy and is in
some ways inferior to many
commercial programs, but it is
my intent to follow this version with
a series of rapid updates.
.sp1
.ti +5
I also believe that public domain
contributions should contribute in some
way to a user's learning experience and
understanding of his system - that's
why I am releasing the source as well.
If my source serves as a foundation
for something you wanted to do but had
too much inertia to get started, go
ahead - hack it up to your heart's
content!
.sp2
Menu Operation
.sp1
.ti +5
MRTERM's user interface is primarily
menu-driven.  This will eventually
give way to a combination of menus and
special key sequences (logo + other), but
I felt that the menu approach deserved
first consideration.  If you're in a hurry
and you can't remember the special keycode
required to get to an option, you can
always get there via a menu option, though
this may be more time consuming.
Each menu consists
of a title line, centered at the top of
the screen, followed by a list of options,
with three lines of instructions at the
bottom of the screen.
.sp2
.ti +5
When you activate a menu, you will
notice that the first option is highlighted
(printed in reverse video).  This indicates
that this option is currently 'selected'.
To select some other option, you may scroll
the highlight bar up or down (with wrap-around)
by depressing the CRSR-down or CRSR-up key.
To complete the selection process, just
press the RETURN key.  MRTERM will either
display another menu or perform the action
requested.  You will notice that every option
in MRTERM's menus starts with a unique first character
(e.g. there are no two options beginning
with the letter A).  This is to enable
you to select an option by simply typing
the first letter of the option (unshifted).
.sp2
Special Key Sequences
.sp1
.ti +5
Certain keys or combinations of keys have
special effects in MRTERM.  One that you
will see repeatedly is the SHIFT + RUN/STOP
combination.  To enter this key code requires
that you depress the SHIFT and
RUN/STOP keys simultaneously.  This
combination is not original and is not
arbitrary.  STOP is a likely key for
stopping or exiting what you're currently
doing.  Unfortunately, the ASCII equivalent
of the STOP key is the combination 
CTRL-C (press the CTRL and C keys simultaneously)
which is used by some systems as an
exit signal.  SHIFT + RUN/STOP, on the
other hand, generates a code which is
not likely to be used by any other
system (hex 83).  It is also not likely
that you would enter this combination by
accident.
.sp1
.ti +5
Other keycode combinations involve the
simultaneous depression of the Commdore
logo key (lower left hand corner) and
some other key.  Textually, this is
represented in this document as 'logo + key'.
Graphically, it is represented as
'C=key'.  For example, 'logo + R' is graphically
represented as 'C=R'.
.sp2
Use of Color
.sp1
.ti +5
Another feature of the program is
the use of customizable color combinations.
Outside of the background and border
colors, there are three other color
parameters which have special significance:
.sp1
.in +10
.ti -5
Offline - This color indicates that you
are interacting with MRTERM and are not
directly communicating with the remote
computer.  All of MRTERM's menus and
prompts are displayed in this color.
.sp1
.ti -5
Online - This color indicates that you
are interacting with the remote computer.
.sp1
.ti -5
Highlight - MRTERM uses this color for the
presentation of special information which
should stand out from the rest of the
display.  The color selected should
generally be the brightest of the three
colors.
.in -10
.sp2
Use of Sound
.sp1
.ti +5
MRTERM currently uses four sound effects.
The first is the bell sound which is
caused by receipt of a bell character
(control-g).  The second, a gong (lower
pitched bell), is used to signal certain
events or messages that require user
intervention.  The third, a buzz, is a
raspy tone that indicates user input
error.  The fourth is a clicking sound
(or high-pitched beep), used when the
key-click option is activated.
.sp1
.nx /s3/
SHAR_EOF
fi # end of overwriting check
if test -f 's3'
then
	echo shar: will not over-write existing file "'s3'"
else
cat << \SHAR_EOF > 's3'
.lm 10
.rm 70
.fi
.ju 1
.he /MRTERM/User's Guide/Operation/
.bp 1
.fo //Page 3-#//
Operation
.sp1
.ti +5
MRTERM is activated with the following
sequence:
.sp1
.in +10
.nf
LOAD"MRTERM",8
RUN
.fi
.in -10
.sp1
When run, MRTERM will first load and
display the initial screen (mrterm.s)
and wait for you to press any key.
MRTERM will then attempt to
load the parameter file (mrterm.parms)
which sets the
operating defaults to your preferred
settings.  If MRTERM can't load this
file, an error message will be displayed
and a set of general defaults will be
established.  You can create a new
parameter file at any time with the
CONFIGURE command (later).  MRTERM next
loads the phone book file (mrterm.phone).
.sp1
.ti +5
The initial menu will now be displayed.
The current MRTERM version number will
be displayed in the title and the
list of top-level options will appear
in the middle of the screen.  The 
function of these options is described briefly
in the following paragraphs.  You may
note that the options don't appear to
be in any particular order (certainly
not alphabetical).  The options are
arranged primarily by their expected
frequency of use, with more frequently
used options nearer the top of the screen.
If an option is discussed in greater
detail later in this manual, the appropriate
section number is referenced.
.sp2
The Main Menu
.sp1
.ti +5
The following functions are provided
by the Main Menu:
.sp2
.in +5
.ti -5
Terminal
.sp1
This option 'engages' you
with the remote computer, allowing
you to type commands and receive
responses.  You should first call
a remote system and establish a
connection prior to using this command.
Another way to enter terminal mode is
to use the Auto-Dial command.  See
section 5 for more details.
.sp2
.ti -5
Auto-Dial
.sp1
The autodialer automatically
dials a remote computer and tests for
carrier.  If a connection is established,
Auto-Dial will transition directly
to terminal mode.  See Section 5.
.sp2
.ti -5
Receive File
.sp1
This option allows you to receive a file
(download) from the remote
system.  See section 6.
.sp2
.ti -5
Send File
.sp1
The Send File option (upload) allows you to
transfer a file from your computer to
the remote computer.  See section 6.
.sp2
.ti -5
Configure
.sp1
The Configure option allows you to
modify and optionally save the operating
parameters of MRTERM.  See section 4.
.sp2
.ti -5
Disk/File Utilities
.sp1
This option provides several commands
related to disk and file management.
See section 7.
.sp2
.ti -5
Buffer Utilities
.sp1
MRTERM provides a buffer area for the
capture of data from the host computer
and for the preparation of text messages
to be transferred to the host.  The
Buffer Utilities provide tools for
managing this buffer.  See section 8.
.sp2
.ti -5
Phone Book Utilities
.sp1
To augment the auto-dialer, MRTERM
provides the ability to store up to
20 phone numbers for quick dialing.
The Phone Book Utilities allow you to
maintain the phone book.  See section
9.
.sp2
.ti -5
Function Key Utilities
.sp1
The function keys, F1-F8, can be programmed
by you to output a sequence of characters
whenever they are pressed in terminal
mode.  The Function Key Utilities provide
commands for managing these key 
definitions.
.sp2
.ti -5
Quit
.sp1
The Quit command terminates the
execution of MRTERM.  If you are
connected to a remote system, you should
first do whatever is necessary to log
off and drop carrier prior to exiting
MRTERM.
.br
.in -5
.nx /s4/
SHAR_EOF
fi # end of overwriting check
if test -f 's4'
then
	echo shar: will not over-write existing file "'s4'"
else
cat << \SHAR_EOF > 's4'
.lm 10
.rm 70
.fi
.ju 1
.he /MRTERM/User's Guide/Configure/
.bp 1
.fo //Page 4-#//
Configuring MRTERM
.sp1
.ti +5
MRTERM allows the user to customize
many of its operating parameters and
to save them to a default parameter
file (mrterm.parms) or to other files
which may be selected, depending upon
the remote system being accessed.  It
is therefore conceivable that you could
have a special parameter file for each
different class of system being accessed.
The Configure option in the main menu
supports the following secondary
options:
.sp2
.in +5
.ti -5
Quit
.sp1
This option returns the user to the
main menu.
.sp2
.ti -5
Modem/Communications Parameters
.sp1
This option presents the user with another
sub-menu which allows parameters related
to modem operation and file transfer to
be changed.  The behavior of this sub-menu
is slightly different than that of the
main menu.  Option names are highlighted with
the cursor keys only.  Settings within
an option are made by depressing the
spacebar.  By multiple depressions of the
spacebar, you can cycle through all
settings within a given option.  Pressing
the RETURN key exits this sub-menu.  To
make your settings permanent, you must
use the Save Parameters option of this
sub-menu.  The options under this sub-menu are:
.sp2
.in +5
.ti -5
Baud Rate
.sp1
This option allows you to select the rate
at which your modem communicates with the
remote system.  The allowed values for
baud rate are 1200 and 300 (I left out
the less popular settings).  This value
is dependent upon the rate that both
your modem and the remote system's modem
can support.  If a system
supports 1200 baud, it will usually
support 300 baud, also.  If you are
using a 1650 type modem, it only supports
300 baud.  Most systems use the following
settings:
.sp1
.ti +5
300/1200 baud, 8 data bits, 1 stop bit, no parity.
.sp2
.ti -5
Data Bits
.sp1
The number of data bits is usually 7 or
8, with 8 being the most popular.  Values
of 5 through 8 are possible.  To transfer
a file with either protocol, you MUST set
the number of data bits to 8.
.sp2
.ti -5
Stop Bits
.sp1
This value can be either 1 or 2, with 1
being the customary value.
.sp2
.ti -5
Parity
.sp1
Parity, which is used for single character
error checking can be one of the following:
.sp1
.ti +5
None (usual), Odd, Even, Mark, Space
.sp2
.ti -5
Protocol
.sp1
This sets the type of file transfer to
be performed by the Send File and Receive File
options.  You must know in advance what
protocols the remote system supports in
order to perform file transfer.  The protocols
currently supported are Punter and XMODEM.
XMODEM will start up in CRC mode.  If the
remote system only supports checksum mode,
MRTERM will switch to that mode after 3
retries.
.sp2
.ti -5
Modem Type
.sp1
Currently, MRTERM supports two very broad
classes of modem: Hayes compatible and Commodore
1650.  The Hayes compatible modems are also
called 'smart' modems.  They have a built-in
command processor and support a variety of
special commands.  The 1650 type modem is
not so smart, but does support pulse mode
dialing.  There are some 'in-between' models
out there that may or may not fit into either
category.  I'd appreciate any feedback on
modems that do not work (autodial) with
MRTERM, along with any technical specifics
you can pass my way.
.sp2
.ti -5
Dial Command
.sp1
If you are using a Hayes compatible modem,
this option allows you to choose the character
sequence which activates dialing for your
modem.  The dial command defaults to 'atdt'
which is used for tone dialing.  If you have
pulse dialing, you'll want to change the
dial command to 'atdp'.  The dial command
can be up to 8 characters long, so you
may embed other commands as well, such as
'e1' which enables echo.  Refer to your modem
operations manual for details.
.sp1
As with the other modem options, you
change this one by first pressing the
spacebar.  The current dial command will
be erased and you may enter a new one.
Terminate your entry with the RETURN
key.  This will not cause you to exit
the Modem/Communications Parameters
menu, but will leave you positioned at
the Dial Command option.
.sp2
.ti -5
Colors
.sp1
This option lets you choose the color
combinations that are most pleasing to
your eye.  Experiment with different
combinations until you get the one that
is most pleasing to you.  Each color
category (background, border, online,
offline, highlight) can be set with one
of the function keys, F1 through F5.  Each
time a function key is pressed, its
color assignment will cycle to the next
color code.  You may notice in some
instances that suddenly, parts 
of this sub-menu become invisible.  This
is because you've made one of the color
categories the same as the background
color.  Ooops!  That's simple to fix -
just recycle the background color or
the color in conflict until that group
becomes visible again.
.sp2
.ti -5
Load Parameters
.sp1
This option can be used to restore
MRTERM's parameters to their defaults
(like when you get it hopelessly confused)
or to load a custom parameter file that
you had saved earlier.  You will be prompted
with:
.sp1
.in +5
.nf
Enter parameter file name or RETURN for
default:
.fi
.in -5
.sp1
If you just press RETURN, the default
parameter file (mrterm.parms) will be loaded.
You may enter another filename.  Before
loading the parameter file, MRTERM attempts
to verify that the file you requested is
indeed a parameter file.  If it passes
the test, it will be loaded.
.sp2
.ti -5
Save Parameters
.sp1
This option allows you to save new
parameter settings to the default
parameter file or to a file of your
choice.  You will be prompted with the
same prompt as in Load Parameters.
Use caution, since the designated output
file is automatically scratched prior
to saving the new copy.
.sp2
.in -5
.nx /s5/
SHAR_EOF
fi # end of overwriting check
if test -f 's5'
then
	echo shar: will not over-write existing file "'s5'"
else
cat << \SHAR_EOF > 's5'
.lm 10
.rm 70
.fi
.ju 1
.he /MRTERM/User's Guide/Terminal Mode/
.bp 1
.fo //Page 5-#//
.in +5
.ti -5
Terminal Mode Operation
.sp1
.ti +5
Terminal mode is entered by selecting
the Terminal command from the main
menu.  In this mode, you may directly
converse with a remote computer.  Prior
to using terminal mode, however, you
must make sure that certain configuration
parameters, such as baud rate (the speed
at which data is transmitted), parity,
word size, etc., are correcty set.  See
section 4 for details on configuring
MRTERM.
.sp1
.ti +5
Beneath the surface, there is a fair
amount of work being carried out to
support terminal mode.  First off, 
MRTERM must constantly check the modem
for characters arriving from the host
and the keyboard for characters that
you, the user, have typed.  Equal
priority is given to each so that your
keyboard inputs are not blocked by a
'runaway' host or by an endless stream
of input caused by a severed or noisy
connection.
.sp1
.ti +5
MRTERM expects data
arriving at the modem to be ASCII
(American Standard Code for Information Interchange)
format.  It also sends data using
ASCII codes.  Since the Commodore 64
actually represents character data in
a non-standard form of ASCII, called
PET-ASCII, translations must be performed.
ASCII data arriving from the host computer is
transformed (when possible) into PET-ASCII.
Data for which a translation is undefined
is ignored.  When you press a key on the
keyboard, MRTERM not only performs an
inverse translation, but it also looks
for special key codes which do not get
sent to the remote computer but which
do cause special actions at your computer.
Currently, these special key codes include
the SHIFT + RUN/STOP combination (both keys
pressed simultaneously) and certain
combinations of the Commodore logo key
(lower left hand corner) plus other
keys.  If you press keyboard combinations
for which there is no translation or
local action will cause a buzz tone to
be generated, thus signalling you that
you have made an illegal keyboard entry.
.sp1
.ti +5
In its default configuration, MRTERM
performs the following special
translations:
.sp1
.in +5
.nf
Keyboard   Sent

INST       DEL (127) delete
DEL        BS  (8)   backspace


Received   Becomes

BS (8)     DEL (20)
FF (12)    CLR (147)

.fi
.in -5
.sp2
Special Keys
.sp1
.ti +5
Certain keys and key combinations have
special effects while in terminal mode.
Remember that the 'C=key' designation
implies simultaneous depression of the
Commodore logo key with some other key.
.sp1
.ti +5
The function keys, labeled f1-f8, are
user-programmable.  That is, you may
define each one of these keys to output
a sequence of characters whenever they
are pressed.  See the section on 
Function Key Utilities for more details.
.sp1
.ti+5
While in terminal mode, you may enable
or disable the 'capture buffer' by typing
C=B.  Each time this
sequence is entered, the buffer mode
is toggled on or off, depending upon
its current state.  When buffer mode is active,
a sprite in the image of a parachutist
(well, it IS original...) will be displayed
on the right hand side of the screen.
As the capture buffer fills, the parachutist
will 'fall' to the bottom of the screen.
Should the buffer overflow, a message
will be displayed, the sprite will be
turned off and no more information
will be captured.  See section 8 for
more information on managing the capture
buffer.
.sp1
.ti +5
You can activate/deactivate an audible
click for each keypress by typing
the logo + k combination (klick).
.sp1
.ti +5
C=P will print the current screen image
to your printer.  In this version of
MRTERM, the printer must be configured
as device #4.  A secondary address of
7 is used.  A later version of MRTERM
will enable you to reconfigure your
printer.
.sp1
.ti +5
You can transition directly from terminal
mode to either Receive File or Send File
by entering C=R or C=S, respectively.
You'll find this much more convenient than
returning to the main menu.
.sp1
.ti +5
Terminal mode is terminated or interrupted
by pressing the SHIFT and RUN/STOP
keys simultaneously.  This will be
necessary in order to get to any of
the other functions (configure,
send file, receive file, etc.) or to
exit MRTERM.
.sp2
Summary of Terminal Mode Special Keys
.sp1
.nf
     C=B   Toggle Capture Buffer
     C=K   Toggle Key-Click
     C=P   Print Screen
     C=R   Receive File
     C=S   Send File
.fi
.sp1
.bp
.ti -5
The Auto-Dialer
.sp1
.ti +5
If you are using a modem with an auto-dialer
which is compatible with MRTERM, you may
use the auto-dial feature.  The type of dialing
method used depends upon the current
modem type selected (see CONFIGURE).  Auto-Dial
currently supports Hayes-compatible,
CBM 1650 and Westridge type modems
(64 Modem from Total Telecommunications).
.sp1
When Auto-Dial is selected,
the phone book (see section 9) will be
displayed on your screen.  
The first entry is "Unrecorded",
which allows you to type in a number from
the keyboard.
The number may include punctuation characters,
such as hyphens, which are ignored.  One
special character of note is the comma.
Each occurrence of a comma in the phone
number string results in a delay of
approximately 2 seconds.  This can be
useful in situations where a 'local'
line must first be activated prior to
dialing out  (example: 9,123-4567).
.sp1
.ti +5
If you wish to dial one of the numbers
recorded in the phone book, simply
position the highlight bar to the
desired number, using the cursor keys.
press RETURN to dial the number or
press SHIFT and RUN/STOP to abort
the autodial process.
.sp1
.ti +5
Auto-Dial is designed to retry forever.  To
cancel dialing, press any key.  There is a
short time-delay between when carrier is
detected and when Auto-Dial transitions to
terminal mode.  This is to prevent false
carrier detection which can occur on some
modems when a line is busy.  You may also
notice 'garbage' characters when a
connection is made.  This behavior is
normal with some combinations of modems.
The Auto-Dialer displays everything
sent by the remote system during the
carrier-detect time-delay so you won't
miss any initial log-in messages or
info.  Unfortunately, this can cause
a messy screen at times.
.br
.in -5
.nx /s6/
SHAR_EOF
fi # end of overwriting check
if test -f 's6'
then
	echo shar: will not over-write existing file "'s6'"
else
cat << \SHAR_EOF > 's6'
.lm 10
.rm 70
.fi
.ju 1
.he /MRTERM/User's Guide/File Transfers/
.bp 1
.fo //Page 6-#//
.in +5
.ti -5
File Transfers
.sp1
.ti +5
Though certain (textual) information
can be collected in the capture buffer
and saved to disk, this is a highly
unreliable method of file transfer and
is unsuitable for the transfer of binary
information such as that contained in
data files and program files.
.sp1
.ti +5 
File transfer protocols, in general,
provide well-defined mechanisms for
the controlled transfer of file data,
providing error detection and recovery
in situations where line noise would
otherwise corrupt a file transmitted
via phone.  MRTERM offers you a choice
of two such protocols: Punter and 
XMODEM.
.sp1
.ti +5
The Punter protocol was developed by
Steve Punter, of Canada and is used
only on Commodore systems.  It provides
a reasonably fast, highly reliable
means of transferring files between
systems.  When available, it should
be used rather than XMODEM.  XMODEM,
developed by Ward Christensen, is a
'universal' protocol, supported on
just about every computer under the
sun.  It actually comes in two 'flavors':
checksum and CRC (cyclic redundancy
check).  CRC mode is more reliable
than checksum mode.  Mode selection is
an automatic process, accomplished
through an initial handshake process
carried out by the sending and receiving
computers.
.sp2
.ti -5
Receiving a File (C=R)
.sp1
.ti +5
When receiving a file,
the protocol used (Punter or XMODEM)
depends upon your current modem/communications
parameter settings (see section 4).
You must insure that the
protocol selected matches that used by
the remote system.
Prior to selecting receive mode, you must
have initiated the file transfer at the
remote system.  For both protocols, you
will be prompted with:
.sp1
.ti +5
RECEIVE file:
.sp1
Enter the name of the file to be created
on your system.  If this is an XMODEM
transfer, you will next be prompted with:
.sp1
.ti +5
File type (p or s):
.sp1
You are restricted to sending and receiving
program and sequential files only.  Enter
a 'p' for a program file or an 's' for a
sequential file.
.sp1
.ti +5
Assuming that no error occurred during
the opening of the file, the transfer
should begin.  Though the internal
behavior of both protocols is quite
different, their outward behavior should
appear similar.  You will notice that
the screen will fill with strange looking
data, some of which you may be able to
read.  This is because the screen memory
area is used as a buffer for the transfer
protocols.  This is both memory-efficient
(no special buffer area need be set aside)
and gives you something to watch while
the transfer takes place.  Both protocols
display good and bad block counts as
they occur.  Status messages, if any,
are displayed in the highlight color
at the bottom of the screen.
.sp1
.ti +5
The XMODEM protocol actually supports
two versions of XMODEM - cyclic redundancy
check (CRC) and normal checksum.  The mode
selected is determined during the
initial handshake (agreement between the
two computer systems).  The receiver will
request CRC mode.  If the sender doesn't
support it, a timeout will occur.  After
3 timeouts, MRTERM will switch to
checksum mode.  Of the two modes,  CRC mode
provides a much higher reliability factor.
This is because the checksum at the end
of each block is 2 bytes long (vs. 1) and
is computed using a sophisticated
polynomial algorithm.
.sp1
.ti +5
Upon termination of the transfer, a
flashing status message will appear at
the bottom of the screen, informing you
of the success or failure of the transfer.
Press any key (RETURN is fine) to return
to the main menu.  To return to terminal
mode, simply press the RETURN key again.
.sp2
.ti -5
Sending a File (C=S)
.sp1
.ti +5
To send a file,
you must first initiate a receive
operation at the remote computer.  When
activated, Send File will prompt with:
.sp1
.ti +5
SEND file:
.sp1
Respond with the name of the file that
you wish to send.  The screen behavior
for sending a file is nearly identical
to that for receiving a file.
.br
.in -5
.nx /s7/
SHAR_EOF
fi # end of overwriting check
if test -f 's7'
then
	echo shar: will not over-write existing file "'s7'"
else
cat << \SHAR_EOF > 's7'
.lm 10
.rm 70
.fi
.ju 1
.he /MRTERM/User's Guide/Disk & File/
.bp 1
.fo //Page 7-#//
Disk and File Utilities
.sp1
.ti +5
The Disk and File Utilities provide you
with convenient disk management features
while running MRTERM.  The options
available are:
.sp2
.in +5
.ti -5
Quit
.sp1
You ought to know by now that this
option returns you to the main menu.
.sp2
.ti -5
Blocks Free
.sp1
Blocks Free shows you how many blocks
are available for storing files on the
currently inserted data disk.  It is
a good idea to use this command prior
to downloading files from a system.
.sp2
.ti -5
Directory
.sp1
You will be prompted with:
.sp1
.nf
Screen (s) or Printer (p):
.sp1
.fi
If you respond with an 's' or RETURN,
the disk directory will be displayed,
a screenful at a time.  Once the screen is
full, you are prompted with:
.sp1
.ti +5
STOP to abort, RETURN to continue...
.sp1
Pressing the STOP key will abort the
directory listing, returning you to the
Disk and File Utilities menu.  Pressing
the RETURN key will allow you to see the
next screenful of the directory.  You
may also enter C=P to copy the current
screen to the printer.
.sp1
If you select the Printer option, the
entire directory will be listed to the
printer.
.sp2
.ti -5
Format Disk (new ID)
.sp1
This command allows you to prepare a
new (or old) floppy disk for the storage
of files.  IF THERE IS DATA ON THE 
DISKETTE, IT WILL BE LOST!  A warning
similar to the one you just read will
be displayed.  You will also be prompted
for a disk name (1-16 characters) and
a disk ID (2 characters).  Consult your
disk drive owner's manual for details
about disk name and ID.
Should you decide that
this is not what you want to do, you
may abort by typing 'n' (no) to the
initial prompt or by responding to the
disk name or ID prompts with RETURN only.
.sp1
The Format command will take approximately
80 seconds on an unmodified 1541 disk
drive.  When formatting is complete, a
status message will be displayed.  If
the status is not "0, OK,0,0" then
you must determine the source of the
error (no disk inserted, write protect
tab on, etc.).  Upon completion, the
Format Disk command will repeat until
you terminate it, allowing you to 
format several disks in one operation.
.sp2
.ti -5
Initialize Disk (same ID)
.sp1
The Initialize Disk option can only
be used with disks that were previously
formatted.  It allows you to rename the
disk, but not change the ID number.  As
with Format Disk, the maximum number of
blocks will be made available and old
data will be destroyed.  Initialize
Disk is much quicker than Format Disk,
being almost instantaneous.
.sp2
.ti -5
Rename File
.sp1
You will first be prompted for the
'New file name' which is the new name
you wish to give a file.  Next, you are
prompted for the 'Old file name' which
must be the name of a file currently
stored on the diskette.  The old file
will be renamed.  Typical errors include
attempting to rename a file to the name
of an existing file and attempting to
rename a file with an incorrect 'Old file name'
(file doesn't exist).
.sp2
.ti -5
Scratch File(s)
.sp1
This option allows you to remove one
or more files from the currently
inserted diskette.  You will be prompted
for the name(s) of the files to be
scratched.  Separate multiple file names
with commas.  A null response terminates
the Scratch File(s) command.  After the
scratch operation is completed, a status
message will be displayed, reporting the
number of files that were scratched.
.sp2
.ti -5
Send Commands to Disk
.sp1
The screen will clear and MRTERM will
prompt you with:
.sp1
.in +5
.nf
Enter disk command or RETURN to quit:
>
.fi
.in -10
.sp1
At this point, you can send DOS commands
directly to your disk drive.  After each
command is processed, the disk status
message is displayed on the screen.
This option is terminated by just pressing
RETURN.  Refer to your disk drive owner's
manual for DOS command syntax.
.br
.in -5
.nx /s8/
SHAR_EOF
fi # end of overwriting check
if test -f 's8'
then
	echo shar: will not over-write existing file "'s8'"
else
cat << \SHAR_EOF > 's8'
.lm 10
.rm 70
.fi
.ju 1
.he /MRTERM/User's Guide/Buffer Utilities/
.bp 1
.fo //Page 8-#//
Buffer Utilities
.sp1
.ti +5
The Buffer Utilities segment of MRTERM
provides functions which manage the
text capture buffer.  The capture buffer
is enabled/disabled by typing logo-b
when in terminal mode.
.sp1
.in +5
.ti -5
Quit
.sp1
.ti +5
Exit the Buffer Utilities segment of
MRTERM.
.sp2
.ti -5
Edit/View Capture Buffer
.sp1
.ti +5
The capture buffer editor is primarily
intended for composing messages for
later transmission to the host computer.
It can also be used to edit the contents
of the capture buffer prior to saving
it to a file.  You won't find all the
features of a full screen editor here,
but you'll probably find more than you're
used to in a terminal program.  The
editor is always in 'insert mode'.  That
is, any text that you type will be
inserted before the text at which the
cursor is positioned.  At all times, a
status line is displayed at the bottom
of the screen which indicates the current
line, column, line length and buffer
space remaining.
.sp1
.ti +5
The editor will handle lines up to 255
characters in length.  It achieves this
by maintaining a 'window' which holds 40
columns by 24 rows of text.  As the cursor is
moved right or left through the borders
of the window, the screen is scrolled, 
in increments of 10 characters, to
make the next region of text visible.
.sp1
.ti +5
Certain special
keys which perform editing functions
are:
.sp1
.in +5
CLR - erases the contents of the buffer.
You will be prompted for confirmation
prior to the actual clearing.
.sp1
DEL - deletes the character to the
left of the cursor.
.sp1
INST - deletes all characters to the
right of the cursor in the current line,
including the carriage return. The next
line on the screen is 'joined' to
the current line at the point of deletion
and the screen is rewritten.
.sp1
HOME - This is a context-sensitive key.
If you are somewhere in the middle of
the buffer, the first press of the
HOME key places you at the top of the
screen.  If you are already at the top
of the screen, but not at the beginning
of the buffer, pressing the HOME key
will place you at the beginning of the
buffer.  Finally, if you are at the
beginning of the buffer, pressing the
HOME key will place you at the end of
the document.
.sp1
RETURN - Move the cursor to the
beginning of the next line, scrolling
the screen window if necessary.
.sp1
SHIFT+RETURN - Move the cursor to the
currently visible portion of the next
line.
.sp1
C=P - Output the screen to the printer.
.sp1
F1 - Scroll forward 20 lines.
.sp1
F2 - Scroll backward 20 lines.
.sp1
F7 - Move the cursor, scrolling the
screen window if necessary, to the
end of the current line.
.sp1
F8 - Move the cursor, scrolling the
screen window, if necessary, to the
beginning of the current line.
.sp1
SHIFT + RUN/STOP - exit the editor.
.sp2
.br
.in -5
.ti -5
Load Buffer from File
.sp1
.ti +5
MRTERM will prompt you for the name
of a SEQ type file.  If successfully
opened, MRTERM will then load the 
file (or as much of it as possible)
into the capture buffer.  If the whole
file will not fit, an error message
will be displayed.
.sp2
.ti -5
Save Buffer to File
.sp1
.ti +5
MRTERM will prompt for the name of a
SEQ type file.  If successfully opened,
the contents of the capture buffer will
be output to the file.
.sp2
.ti -5
Print Buffer
.sp1
.ti +5
This option prints the contents of the
capture buffer to the printer.  The 
current printer defaults are:
.nf
     device 4
     secondary address 7
     no initialization string
.fi
.sp1
In later releases, the user will have
control over these parameters.  You will
be prompted with:
.sp1
Continuous (c) or Paginated (p)?
.sp1
Continuous print will print the data
exactly as it appears in the buffer.
No attempt is made to skip over page
perforations.  Paginated print will
leave a 3 line margin at the top and
bottom of every page.  Be sure to
position the paper at top of form before
issuing this command if you intend to
save the listing.
.sp2
.ti -5
Transfer Buffer to Host
.sp1
.ti +5
This command, used in conjunction with
the buffer editor, provides you with a
very flexible message composing function.
Upon invocation, you will first be
prompted for a character to substitute
for carriage return (CR).  Since many
BBS programs provide automatic word-wrap
features, this feature provides you with
a way to take advantage of them.  By
using some special character (e.g. up-arrow)
to signal a 'hard' return, you can
control the format of messages transferred
to the host system.  If you respond to
this prompt with anything but the RETURN
key, that key code will be watched for.
Whenever it appears in your buffer, a
RETURN will be sent instead.  Whenever
a RETURN appears, a space will be sent.
The next prompt asks you for a delay
value.  A RETURN at this prompt sets a
delay value of zero (none).  If you enter
a number from 1 to 30, that many sixtieths
of a second will elapse between the
transmission of characters.  This provides
a 'safety', giving the host system a
chance to keep up.  I would recommend a
value of 5, though experimentation
is encouraged.  A value of 30 will surely
put you and the other system to sleep!
.br
.in -5
.nx /s9/
SHAR_EOF
fi # end of overwriting check
if test -f 's9'
then
	echo shar: will not over-write existing file "'s9'"
else
cat << \SHAR_EOF > 's9'
.lm 10
.rm 70
.fi
.ju 1
.he /MRTERM/User's Guide/Phone Book/
.bp 1
.fo //Page 9-#//
.in +5
.ti -5
Phone Book Utilities
.sp1
.ti +5
The phone book, used in conjunction
with the auto-dialer, provides a very
convenient approach to connecting with
a remote system.  The phone book stores
the names and phone numbers of up to
20 systems.  The Phone Book Utilities
provide the tools necessary for
maintaining the phone book, allowing
you to add new entries, delete old
ones and save your changes to a special
file (mrterm.phone) on the disk.
.sp2
.ti -5
Quit
.sp1
.ti +5
This command returns you to the main
menu.
.sp2
.ti -5
Auto-Dial
.sp1
.ti +5
This command allows you to test your
new phone book entries without having
to return to the main menu.  It works
the same as the Auto-Dial command
described in section 5.
.sp2
.ti -5
View/Edit Phone Book
.sp1
.ti +5
Upon selecting this command, the
contents of the phone book are displayed
on the screen.  You may simply view this
information, or change it if you wish.
You will notice that the first entry is
titled "Unrecorded".  This is a special
entry for the dialing of numbers other
than those stored in the phone book and
cannot be edited.
.sp1
.ti +5
To exit this command, press the 
SHIFT and RUN/STOP keys simultaneously.
To select an entry for modification,
simply position the highlight bar
to the correct entry and press the 
RETURN key.  A prompt for the system
name will appear at the bottom of the
screen.  The maximum number of characters
allowed will be displayed in parentheses.
Enter the name, terminating it with the
RETURN key.  If you press the RETURN
key as the first character in the Name
field, no change will be made.  Once you
have entered the name, you will be
prompted for the phone number.  Again,
the maximum number of characters allowed
is displayed in the prompt.  Enter the
phone number and press RETURN.  You may
print the current phone book by typing
C=P.
.sp1 
IMPORTANT: your changes are not
permanently recorded UNTIL you use the
Save Phone Book command.
.sp1
If you have not done so already, see section
5 (Terminal Mode) for information on
the significance of special characters
in a phone number.  
.sp2
.ti -5
Load Phone Book
.sp1
.ti +5
This command will reload the phone book
from disk and is useful if you've made
a mistake while editing.
.sp2
.ti -5
Save Phone Book
.sp1
.ti +5
This command saves the phone book to
disk, permanently recording any changes
you have made with the Edit/View Phone
Book command.
.br
.in -5
.nx /s10/
SHAR_EOF
fi # end of overwriting check
#	End of shell archive
exit 0
-- 
| Mark R. Rinfret, SofTech, Inc.		mark@unisec.usi.com |
| Guest of UniSecure Systems, Inc., Newport, RI                     |
| UUCP:  {gatech|mirror|cbosgd|uiucdcs|ihnp4}!rayssd!unisec!mark    |
| work: (401)-849-4174	home: (401)-846-7639                        |