home *** CD-ROM | disk | FTP | other *** search
/ kermit.columbia.edu / kermit.columbia.edu.tar / kermit.columbia.edu / victor9000 / vickermithlp.txt < prev   
Text File  |  1991-04-17  |  8KB  |  217 lines
  1.  
  2. ;    KERMIT HELP FILE
  3. ;
  4. ;    A few conventions:
  5. ;    [1] Line Starting with ";" in column 1 (i.e. the character sequence
  6. ;        '\n';) is considered a comment line.
  7. ;    [2] This file may be "segmented" into the following groups:
  8. ;        '^\'  is a "File" separator.  This is not currently support, but
  9. ;          in  the future,  multiple message files will be maintained
  10. ;          on a single file.
  11. ;        '^]'  is a "Group" separator.  This  is  used  to  separate help 
  12. ;          levels.  For instance,  ROOT level help is separated  from
  13. ;          SET level help by this code.
  14. ;        '^C'  is a "Sub-section" separator.  This  code is  used to sub-
  15. ;          divide a group.  A sub-section is  selected  interactively
  16. ;          via the Enquire feature, where the operator enters a digit
  17. ;          between 1 and n.
  18. ;        '^_'  is a "Unit" separator. This code is used to page the help.
  19. ;          When this symbol is encountered, the help will pause until
  20. ;          the RETURN key is struct.
  21. ;        '^E'  requests (numeric) input  from the keyboard.  This code is
  22. ;          used to  request a subsection,  where each  sub-section is
  23. ;          separated by a '^C'.
  24. ;
  25. ;
  26. ;    This  help  file was constructed using  PMATE.  This text editor has
  27. ;    certain useful features, such as the ability to insert special char-
  28. ;    acters, which facilitated the process.  It is recommended that  this
  29. ;    editor be used for any future modifications.  PMATE  is available as
  30. ;    part of the MS-DOS Programmer's Tool Kit, vol. 1. 
  31. ;
  32. 
  33. KERMIT                                    HELP
  34.  
  35. Select one of the following topics by entering the associated index:
  36.  
  37.     1    Kermit Overview
  38.     2    File Transfer
  39.     3    Soft keys
  40.  
  41. Select topic: 
  42. 
  43. KERMIT            Overview                        HELP
  44.  
  45. Kermit provides three modes of operation:
  46.  
  47. [1] Terminal Emulation:  This mode enables one to  communicate with the host
  48.     as if we were a terminal. We are currently in this mode
  49. [2] File Transfer: This mode enables one  to transfer files to,  or from the
  50.     host.
  51. [3] Setup:  This mode enables one to reset  parameters of operation, such as
  52.     baud rate.
  53.  
  54. This  version  of  Kermit differs  in  two ways from  the  standard version.
  55. Firstly it 'Comes up' in terminal mode, rather than having to be  explicitly 
  56. 'Connected' and disconnected. Secondly,  it uses softkeys.
  57. 
  58. KERMIT            File Transfer                    HELP
  59.  
  60. In the file transfer mode of operation, KERMIT  transfers source files to or
  61. from the host system.  Prior to  sending or  receiving files the user should
  62. adjust any of the required communications parameters, such as baud rate.
  63.  
  64. During transmision  if we are  unable to transmit  or  receive from the host
  65. KERMIT will continue looping waiting for a response. Every (about) 10 seconds
  66. KERMIT will scan the keyboard and beep.  All keys are ignored except for the
  67. RETURN key, and the DEL key.
  68.  
  69. If the RETURN key was struck, KERMIT will retry the transmision. If the  DEL
  70. key was struck, the file transfer will be aborted.
  71.  
  72. KERMIT            File Transfer                    HELP
  73.  
  74. During transmision the following screen will be displayed:
  75.  
  76.               Transmision Statistics
  77.            Send   Receive            Accumulated Data          
  78. Message Type:                          Transmision State:
  79. Message Number:                   Number of Messages:
  80. Data Length:                   Number of Characters:
  81.  
  82. The information on the left is associated with each message transfered with
  83. the information displayed under the  Send  or  Receive colum, which ever is
  84. appropriate.  Information  displayed  under the   Accumulated  Data  column
  85. applied to the entire file transfer.
  86.  
  87. Message Type: Describes the type of message (see KERMIT manual)
  88. Message Number: Modulo 64 message identifier
  89. Data Length: Number of character of data in the package
  90. Transmision State: R-receiving data; S-sending data; W-waiting for data
  91. Number of Message: Number of messages processed
  92. Number of Characters: Number of characters pf data processed
  93.                 
  94. KERMIT            Soft Keys                        HELP
  95.  
  96. The function keys have the following meanings:
  97.  
  98. pEXIT   q   Used to return control back to the local operating system
  99.  
  100. pSEND   q   Used to initiate a file transfer to the host. 
  101.  
  102. pRECEIVEq   Used to initiate a file transfer from the host
  103.  
  104. pSET    q   Used to reset parameters of operation
  105.  
  106. pSHOW   q   Used to display current settings of parameters
  107.  
  108. pTRACE  q   Used to display the last 256 message transactions
  109.  
  110. pHELP   q   This message
  111.  
  112. pEXEC   q   Used to execute a MS-DOS command - Not implemented
  113.  
  114. 
  115. SET                                    HELP
  116.  
  117. Set  enables  one  to  reset  the  parameters  of operation of  Kermit.  The
  118. procedure is to select the parameter to be reset via the appropriate softkey.
  119. You will be prompted  for more information  as it  is required. When all the
  120. desired parameters have been reset,  hit the  p RETURN q softkey to return the
  121. the main menu. The softkeys are:
  122.  
  123. pBAUD   q   This key is used to modify the baud rate.
  124.  
  125. pECHO   q   This key is used to turn on/off local echoing of keys
  126.  
  127. pWARNINGq   This  key is used to enable/disable file warnings. A file warning
  128.           is issued if the host sends a file with the same name as one locally.
  129.  
  130. pPARAMS.q   This key enables one to modify certain parameters
  131.  
  132. pRETURN q   This key returns control to the main menu
  133.  
  134. pHELP   q   This message
  135. 
  136. YES/NO                                HELP
  137.  
  138. This menu enables the operator to set an option/parameter ON (yes) or OFF (no).
  139.  
  140. pYES q      This key is used to turn on or activate an option
  141.  
  142. pNO  q      This key is used to turn off or deactivate an option
  143.  
  144. 
  145. ECHO                                    HELP
  146.  
  147. If ECHO is turned on (i.e. YES) then all characters typed in at the keyboard
  148. are  echoed to  the screen.  If echo is off,  then characters  typed are not
  149. echoed.
  150.  
  151. Generally,  echo  should be off,  since  the host  computer will  return the
  152. characters sent to it (i.e. Full duplex).
  153.  
  154. pYES   q    This key is used to turn on or activate the echo option
  155.  
  156. pNO    q    This key is used to turn off or deactivate echoing
  157.  
  158. pRETURNq    This key is used to return without changing the state
  159.  
  160.  
  161. 
  162. WARN                                    HELP
  163.  
  164. If WARN is turned on (i.e.YES), then when a file is RECEIVED from the host a
  165. check  is made to ensure  that no files exist locally with the same name. If
  166. such a name is used locally,  the operator is  warned of this situation, and
  167. thus has  the option of renaming the incomming file, or overwritting the old
  168. file.
  169.  
  170. pYES   q    This key is used to turn on or activate the warn option
  171.  
  172. pNO    q    This key is used to turn off or deactivate warnings
  173.  
  174. pRETURNq    This key is used to return without changing the state
  175.  
  176. BAUD                                    HELP
  177.  
  178. This allows one to select the baud rate ( the transmision speed of data ).
  179. The baud rate is selected by stricking the appropriate softkey.
  180. 
  181. TRACE                                    HELP
  182.  
  183. The trace buffer maintains a list of the last  255  transactions between the
  184. local and the host systems. Two columns of data are  displayed, titled local
  185. and host. The column labled local list messages eminating  from your  Victor
  186. while the column labeled  host  lists those messages sent from the connected
  187. computer. 
  188.  
  189. Transactions are listed starting with that one most resently dispatched end-
  190. ing with that most historical one (upto 255 transactions ago).
  191.  
  192. The following softkeys are available:
  193.  
  194. pPAGE  q    This key is used to print the next 10 transactions
  195.  
  196. pNEXT  q    This key is used to print the next transaction
  197.  
  198. pPREV  q    This key is used to print the previous transaction
  199.  
  200. pRETURNq    This key is used to return to the main menu
  201. 
  202. GET CHARACTER                                HELP
  203.  
  204. Enter the character to be subsistuted as the parameters. Some characters can
  205. not be entered in there character form.  In these cases striking the pNUMERICq
  206. key allows one to enter the decimal representation of the character.
  207.  
  208. pENTER  q    This key is used to confirm/entre the character entered
  209.  
  210. pNUMERICq    This  key is used  to enter the  decimal representation of a char-
  211.        acter. This is especially useful for entering characters suchas ^C
  212.        or ^@.
  213.  
  214. pHELP   q    This key is used to display help (what you are currently reading)
  215. 
  216. 
  217.