Columbia Kermit/kermit.zip/intel86b/kermithlp.txt

Text File | 2020-01-01 | 15KB | 312 lines

~ iRMX-86 Kermit help library file (by Albert J. Goodman, revised 22-Aug-85)
This is iRMX-86 Kermit, a file transfer utility.  It can be used to
transfer text files to or from any system which has an implementation
of Kermit, as well as to make this system act as a "virtual terminal"
to a remote system.  Refer to the Kermit Users Guide for general
information about Kermit.

To obtain a list of commands type ? and press [RETURN] at the Kermit
prompt.  Similarly, any keyword in a command may be replaced by a ?
to obtain a list of possible keywords which may go in that position.
The only exceptions are the SEND and GET commands; anything following
these commands (including a single ?) is treated as a filespec (file
specification).  Any command or keyword may be abbreviated as long as
it is unambiguous.  To obtain detailed help on any command type HELP
followed by the name of the command.
~1~EXIT
The EXIT command is used to leave the Kermit program and return
to the local operating system.  It has no effect on the remote
system.
~1~SEND
The SEND command is used to send one or more files to the remote system.
Before giving the SEND command you should have given a RECEIVE or SERVER
command to the remote Kermit.  The word SEND should be followed by the
name(s) of the file(s) to be sent.  Normally one name is given, possibly
with wild-cards to specify more than one file:  a "?" will match any
single character in its position and a "*" will match any number of
characters (including zero).  Thus, for example, the command "SEND ?"
will send all files with one-letter names and the command "SEND *" will
send all files (in the default directory).  You may also specify more
than one file name, but if you do so you must separate the names with
commas and you must NOT include any spaces before or after the commas.
A directory pathname or logical name (enclosed in colons) may preceed
any filename.  The filename (but not the directory if specified) will be
sent to the remote Kermit to allow the file to be stored with the same
name on the remote system.  (You can expect a short delay after giving
the SEND command before seeing the first message telling you what file
is being sent.)
~1~RECEIVE
The RECEIVE command is used to receive files being sent by the
remote Kermit.  Before giving the RECEIVE command you should have
given a SEND command to the remote Kermit.  If you wish to get
files from a Kermit server you should use the GET command.

RECEIVE will display the name of each file as it receives it,
and it will store the files, under the name sent by the remote
Kermit, in your current default directory.
~1~GET
The GET command is used to request a remote Kermit server to send
files to the local system.  To receive files from a remote Kermit
which is not a server you must use the RECEIVE command.
GET must be followed by the filespec for the files on the remote
system.  Whether this filespec may contain wild-cards to get
more than one file with a single command (and in fact the entire
form of the filespec) depends on the remote Kermit.

GET will display the name of each file received and store the
files, under the name sent by the remote Kermit, in your current
default directory.
~1~CONNECT
The CONNECT command is used to make Kermit act as a "virtual terminal"
to the remote system.  After this command is given your terminal will
behave like a terminal directly connected to the remote system, except
for the "escape" character (see HELP CONNECT Escape).  (However, some
control characters have special meaning to the iRMX-86 and thus they
will be intercepted by it and cannot be sent to the remote system;
also the break key, which is not a character, cannot be sent.)
CONNECT is usually used to log on to the remote system and start up
the remote Kermit to allow a file transfer operation to begin.  To
leave connect mode and resume talking to the local Kermit, press the
escape character followed by the letter C.
~2~Escape-character
The escape character is used to talk to the local Kermit while in
connect mode.  By default it is <Ctrl-]> (which means to hold down
the "control" key while pressing the right bracket key "]"), but
it may be changed if necessary by the SET ESCAPE command.  It
should be something not usually used in communication with the
remote system.

When the escape character is pressed, the local Kermit looks at the
next character typed to determine what action to take.
  If the next character is:          Kermit will:
    C (in upper or lower case)    Close the connection, returning you
                                  to the local Kermit's command level.
    the escape character again    Send the escape character itself
                                  to the remote system.
    ? (or in fact anything else)  Display a brief message summarizing
                                  these options and continue the
                                  connection.
If nothing is typed after the escape character for about 5 seconds,
Kermit will act as if a ? was typed.
~1~BYE
The BYE command is only used after exchanging files with a remote
Kermit server.  It tells the remote server to shut down and log
itself out.  After receiving an acknowledgement that this is being
done, iRMX-86 Kermit will exit to the local operating system.  (BYE
is equivalent to LOGOUT followed by EXIT.)  This prevents the need
to connect back to the remote system to log out.
~1~LOGOUT
The LOGOUT command is only used after exchanging files with a remote
Kermit server.  It tells the remote server to shut down and log
itself out.  After receiving an acknowledgement that this is being
done, iRMX-86 Kermit will say "Ok" and prompt for another command.
This prevents the need to connect back to the remote system to log
out.  This command is similar to BYE but leaves you at the local
Kermit command level.
~1~FINISH
The FINISH command is only used after exchanging files with a remote
Kermit server.  It tells the remote server to shut down (stop behaving
as a server) but not to log out.  Thus you may follow this command
with CONNECT and you will be able to give further commands to the
remote system.
~1~SET
The SET command is used to set various flags and parameters which
affect how iRMX-86 Kermit behaves.
~2~BEEP
This determines whether Kermit will beep to alert you that it
has finished a file transfer.  If BEEP is set ON, Kermit will
beep after finishing, either successfully or unsuccessfuly, any
SEND, RECEIVE, or GET command.  If BEEP is set OFF you will
not hear any beeps.  The initial state is BEEP ON.
~2~DEBUG
This determines whether debugging information is displayed on
the screen.  If DEBUG is set ON, each packet sent or received
will be displayed on the screen.  DEBUG is normally OFF.
~2~ESCAPE
This command sets the escape character used in CONNECT to
get the attention of the local Kermit.  SET ESCAPE must
be followed by a decimal number representing the ASCII
value of the new escape character desired.  (The default
escape character, <Ctrl-]>, is ASCII 29.)  See HELP CONNECT
Escape-character for more information about the escape
character.
~2~RETRY
This command sets the maximum number of times iRMX-86 Kermit
will attempt to send or receive a packet before giving up
and aborting the operation.  SET RETRY must be followed by a
decimal number.  Typical values are in the range 5 to 20;
the initial value is 10.
~2~PACKET-LENGTH
This command sets the maximum-length packet for Kermit to
send.  Actually, this value will not necessarily be used;
iRMX-86 Kermit will send packets up to the size requested
by the remote Kermit.  Note that PACKET-LENGTH must NOT be
set greater than 94!  (It usually does not need to be set
at all.)
~2~TIMEOUT
This command sets the number of seconds to wait for a
character from the remote system.  (If no character is
received within this time limit, the packet is assumed
lost but the entire operation is not terminated unless
this occurs a certain number of times--see HELP SET RETRY.)
SET TIMEOUT must be follwed by the number of seconds
desired (in decimal).  Typical values are in the range 5 to
15; the intial value is 10.  This parameter may be modified
during a transaction by the remote Kermit, but may need
to be set to get the first packet across.
~2~PADDING
This command sets the number of padding characters to
send between packets.  It must be follwed by a decimal
number.  The intial (and typical) value is zero.  This
parameter may be modified during a transaction by the
remote Kermit, but may need to be set to get the first
packet across.
~2~PADCHAR
This command sets the padding character to be sent
between packets (if any padding is needed--see HELP
SET PADDING).  It must be followed by a decimal number
representing the ASCII value of the character desired.
The initial (and typical) value is ASCII 0, a null.
This parameter may be modified during a transaction
by the remote Kermit, but may need to be set to get
the first packet across.
~2~END-OF-LINE
This command sets the "end-of-line" character sent
after each packet.  SET END-OF-LINE must be followed
by a decimal number giving the ASCII value of the
character desired.  The typical and initial value
is ASCII 13, a carriage-return.  This parameter may
be modified during a transaction by the remote Kermit,
but may need to be set to get the first packet across.
~2~QUOTE
This command sets the prefix quoting character used
to "quote" control characters in the files being sent.
SET QUOTE must be follwed by a decimal number giving
the ASCII value of the desired character.  Normally
the quote character is "#", ASCII 35.  This can be
changed by the remote Kermit during a transaction, and
should only be set if necessary to get the first packet
across.
~1~SHOW
The SHOW command can display the current value of
any parameter which may be set by the SET command,
as well as the version identification of Kermit.
~2~VERSION
This command is used to display the version of Kermit
which you are running.  It displays the same line which
is displayed upon first entering the Kermit program,
which includes this Kermit's name, version number,
date of last modification, and initials of the author.
~2~BEEP
This displays the current state of the BEEP flag.
See HELP SET BEEP for more information.
~2~DEBUG
This displays the current state of the debug-mode
flag.  See HELP SET DEBUG for more information
about the debug-mode flag.
~2~ESCAPE
This displays the current escape character used in
CONNECT to talk to the local Kermit.  Both a
representation of the charcter and its ASCII value
are given.  The character representation is also
displayed upon executing the CONNECT command.  See
HELP CONNECT Escape-character for more information
about the escape character.
~2~RETRY
This displays the maximum number of retires which will
currently be attempted on any packet.  See HELP SET
RETRY for more information.
~2~PACKET-LENGTH
This displays the current maximum packet length which
Kermit will send.  See HELP SET PACKET-LENGTH for
more information.
~2~TIMEOUT
This displays the current number of seconds after which
to time out (assume the current packet was lost) if no
character is received.  See HELP SET TIMEOUT for more
information.
~2~PADDING
This displays the number of padding characters currently
being sent between packets.  See HELP SET PADDING for
more information.
~2~PADCHAR
This displays the character currently being used for
padding (if any padding is being done), both in character
representation and its ASCII value.  See HELP SET PADCHAR
for more information.
~2~END-OF-LINE
This displays the current "end-of-line" character sent
after each packet, both in character representation and
its ASCII value.  See HELP SET END-OF-LINE for more
information.
~2~QUOTE
This displays the current control-quoting prefix character,
both in character representation and its ASCII value.  See
HELP SET QUOTE for more information.
~2~ALL
This command is used to show all the information
which SHOW can show with a single command.
~1~HELP
The HELP command gives information to help in using Kermit.
Simply typing HELP gives a general message; HELP followed by a
command name gives help on that command.  Whenever you see "Further
help available on:" you may get help on any of the topics listed
by typing the HELP command you used to obtain that message followed
by one of the keywords listed below it.  Any keyword in a HELP
command may be abbreviated; if the abbreviation matches more than
one keyword help will be displayed on the first matching one.
~1~Control-characters
Control characters are typed by holding down the key marked
"Control" or "Ctrl" while pressing another key.  They are usually
written as CTRL/x (where x represents the other key) or <Ctrl-x>.
You may use the normal command line editing characters while
entering commands to Kermit.  However, CTRL/C, which normally
aborts the program, will have no effect while entering commands
to Kermit.  It may be used, though, to abort most Kermit commands
and return to the iRMX-86 Kermit prompt.
~1~Ports
Version 2.41 of iRMX-86 Kermit assumes that the port to which
the remote system is connected has been already attached with
the logical name :KERMITPORT: (for example with the command
ATTACHDEVICE T4 AS :KERMITPORT: PHYSICAL).  The baud rate and
other characteristics of the port must be set prior to running
Kermit (for example in the system configuration).
~1~Summary
Program:            iRMX-86 Kermit
Author:             Albert J. Goodman, Grinnell College
Machine:            Intel System 86/310
Operating system:   iRMX 86
Language:           PL/M-86
Version:            2.41
Date:               August 22, 1985

iRMX-86 Kermit Capabilities At A Glance:

    Local operation:                    Yes
    Remote operation:                   No
    Transfers text files:               Yes
    Transfers binary files:             No
    Wildcard send:                      Yes
    ^X/^Y interruption:                 No, but ^C interruption
    Filename collision avoidance:       Yes
    Can time out:                       Yes
    8th-bit prefixing:                  No
    Repeat count prefixing:             No
    Alternate block checks:             No
    Terminal emulation:                 Yes
    Communication settings:             Only some packet parameters
    Transmit BREAK:                     No
    IBM mainframe communication:        No
    Transaction logging:                No
    Session logging:                    No
    Raw transmit:                       No
    Act as server:                      No
    Talk to server:                     Yes
    Advanced server functions:          No
    Advanced commands for servers:      No
    Local file management:              No
    Handle file attributes:             No
    Command/init files:                 No
    Command macros:                     No
~END~