home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / apollo / apollohlp.txt < prev    next >
Text File  |  2020-01-01  |  9KB  |  176 lines
  1.                 Kermit Version 2.9 to run on the Apollo System
  2.                 ==============================================
  3.  
  4.      The following commands are implemented in the current version of Kermit
  5.      running on the Apollo :
  6.  
  7.         Command                        Description
  8.      ------------- --------------------------------------------------------
  9.      CONNECT (C)   Establish a terminal connection to the system at the
  10.                    other end of the communication line.
  11.  
  12.      EXIT    (E)   Exits the Kermit program.  Reset the I/O lines to their
  13.                    original settings before Kermit was executed.
  14.  
  15.      FINISH  (F)   When running as a local Kermit talking to a remote
  16.                    Kermit server use the FINISH command to shut down the
  17.                    server without logging out the remote job, so that you
  18.                    can CONNECT back to it.
  19.  
  20.      GET     (G)   Requests a remote Kermit server to send the file or
  21.                    file group specified.
  22.  
  23.      HELP    (H)   Gives a brief list of commands and their function
  24.                    (typing command-name ? gives further details).
  25.  
  26.      LOCAL   (LOC) Executes the specified command on the Apollo.  This
  27.                    command is intended to provide local file management
  28.                    capabilities without having to leave the Kermit
  29.                    program.  Extreme caution must be used if attempting
  30.                    to execute programs, especially those outside of the
  31.                    current working directory.  When executing commands, if
  32.                    the command is not a system command, then a relative
  33.                    pathname must be given.  The command search rules will
  34.                    not be followed.
  35.  
  36.      LOG           Log the specified entity to the specified log file.
  37.  
  38.      QUIT    (Q)   Same as Exit.
  39.  
  40.      RECEIVE (R)   Wait for the arrival of a file or file group sent by a
  41.                    Send command from the connected Kermit.
  42.  
  43.      SEND    (SEN) Sends the specified file to the connected Kermit.
  44.  
  45.      SERVER  (SER) Places Kermit into server mode.  In server mode, Kermit
  46.                    does not interact directly with the user, but only with
  47.                    the connected Kermit program.
  48.  
  49.      SET     (SET) Establishes or modifies various parameters for file
  50.                    transfer.
  51.  
  52.      SHOW    (SH)  Displays the values of the parameters settable by the
  53.                    SET command.
  54.  
  55.      STATISTICS    Give statistics about the most recent file transfer.
  56.  
  57.      TAKE    (T)   Executes Kermit commands from the specified file.  The
  58.                    file may contain any valid Kermit commands, including
  59.                    other Take commands.
  60.  
  61.      TRANSMIT      Send the contents of the specified file to the other
  62.                    system "bare", without protocol, packets, error
  63.                    checking, or retransmission.
  64.  
  65.      After each command is listed, in parentheses, an abbreviation for the
  66.      command.  For example, to place Kermit into server mode one can enter
  67.      'Server' as the specified command, or they may abbreviate the command
  68.      to 'Ser'.
  69.  
  70.      The set command recognizes the following parameters :
  71.  
  72.          BAUD-RATE : Sets the baud-rate to 110, 300, 1200, 4800, 9600, or
  73.                      19200.
  74.  
  75.          DEBUG     : Turns the debug mode on or off.  In debug mode a file
  76.                      is created in the current working directory.  In that
  77.                      file is maintained a log of all packets which are
  78.                      sent and received along with any state changes that
  79.                      might take place.  Default is off.
  80.  
  81.          DELAY     : Sets the number of seconds to wait before sending the
  82.                      specified file with a SEND command.  The unit of time
  83.                      is in seconds and must be non-negative.
  84.                      Default is 15.
  85.  
  86.          ESCAPE    : Sets the character used to escape from CONNECT mode. If
  87.                      GRAPHICS is on, can be any ASCII character (except
  88.                      space). IF GRAPHICS off, must be printable. 
  89.                      Default is ctrl] if graphics on or ! if off.
  90.  
  91.          ECHO      : Turns the local echo (when in CONNECT mode) on or off.
  92.                      Default is off.
  93.  
  94.          FILE_TYPE : Sets the type of transmission to handle text or binary
  95.                      files.  If the file type is ascii then only seven
  96.                      bits of each 8-bit data character is used.  If the
  97.                      file type is binary then the full eight bits are used.
  98.                      Default is ascii.
  99.  
  100.          LINE      : Specifies which line to use when running Kermit as a
  101.                      local Kermit.  Can be 1,2 or 3.
  102.  
  103.          NAKS      : Turns on or off the sending of periodic NAK's while in
  104.                      server mode.  If this mode is on then approximately
  105.                      every fifteen seconds a NAK is sent to the connected
  106.                      Kermit if no input is received within that time
  107.                      period.  If this mode is off, then there are no NAK's
  108.                      sent on such timeouts.  If the connected Kermit is not
  109.                      capable of clearing its input buffer before beginning
  110.                      the receive file sequence, then this mode should be
  111.                      turned off.  Default is off.
  112.  
  113.          NORMAL    : If on, names of files sent are converted into a
  114.                      "normal" form before being sent to the connected Kermit
  115.                      and received names are converted into legal Apollo
  116.                      names. If off,no conversion is done. Default is on.
  117.  
  118.          PARITY    : Sets the parity to ODD, EVEN, or NONE.
  119.  
  120.          RETRY     : Specifies the number of times a packet should be
  121.                      resent before a transaction should be aborted.
  122.                      Default is 5.
  123.  
  124.          TIME      : The number of seconds that the connected Kermit is to
  125.                      wait before timing this one out. Must be non-negative.
  126.                      Default is 15.
  127.  
  128.          TIMEOUT   : The number of seconds that this Kermit is to wait
  129.                      before timing the connected one out. Must be
  130.                      non-negative. This value may be altered when the two
  131.                      Kermits exchange parameters.
  132.                      Default is 60.
  133.  
  134.          GRAPHICS  : Turns graphics mode on or off. Normally, if you are
  135.                      running KERMIT locally on a normal Apollo display node,
  136.                      KERMIT uses Graphics Primitives to drive the whole screen
  137.                      when CONNECTed or transferring files. These do not work on
  138.                      an attached dumb terminal or on a remote node. If
  139.                      GRAPHICS is switched off, a cruder driver is used. 
  140.                      Not relevant if running as a host.
  141.                      Default is on if you are on a display node, off otherwise.
  142.  
  143.          RAW       : When CONNECTed, runs screen/line in "raw" mode, i.e. 
  144.                      keystrokes are sent unaltered. If off, works in "cooked"
  145.                      mode, i.e translates Apollo's line terminator (line feed)
  146.                      to the more usual carriage-return. Also filters out most
  147.                      control characters and allows use of backspace, again etc
  148.                      buttons.  Needs to be OFF if you are driving KERMIT on
  149.                      one node from a dumb terminal on another node, or if you
  150.                      switch graphics off.  Not relevant if running as a host.
  151.                      Default on.
  152.  
  153.          8BIT      : "8 bit quoting" is the method KERMIT uses to send data 
  154.                      which uses all 8 bits on a line where the 8th bit is used
  155.                      for parity.  If 8BIT is on, this KERMIT insists on using
  156.                      quoting. This may cause the other end to abort the
  157.                      transfer. If you are only transferring ASCII text, there
  158.                      is no harm in switching it off.  Default is on.
  159.  
  160.          Examples  :
  161.                      SET BAUD-RATE 1200       {Sets baud-rate to 1200}
  162.                      SET DEBUG OFF            {Turn debug mode off}
  163.                      SET DEBUG ON             {Turn debug mode on}
  164.                      SET NAKS OFF             {Do not send periodic NAK's}
  165.                      SET NAKS ON              {Send periodic NAK's}
  166.                      SET PARITY EVEN          {Sets parity to even}
  167.  
  168.      An Apollo process can only drive RS232 ports on its own node. To access
  169.      a port on another node it must be running a Server_Process_Manager. You 
  170.      can then create a remote process on that node by typing:
  171.        CRP -ON nnnn -ME
  172.      Then you can run Kermit on that node. A system manager can make this
  173.      transparent to users by setting /COM/KERMIT on the remote nodes to:
  174.  
  175.      crp '/com/sh -c //node_nnnn/com/kermit' -on nnnn -me
  176.