home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / honeywellcp6a / hc6ker.her < prev    next >
Text File  |  2020-01-01  |  37KB  |  823 lines

  1. .*M*
  2. HELP file for: KERMIT
  3. .*T*
  4.  
  5. .*A*
  6. The invocation syntax for CP-6 KERMIT is as follows:
  7.   !KERMIT [cmd-file] [,default-file] [{ON|TO|OVER|INTO} ,dest] [( options [)]]
  8. .*B*
  9. The invocation parameters have the following meaning:
  10.  
  11.   cmd-file -
  12.     is a CP-6 file containing KERMIT commands.
  13.   default-file -
  14.     is a file containing KERMIT commands that will be read automatically
  15.     before most other commands are executed.  This file is read through the
  16.     F$DEFAULTS DCB and if the file name is not specified, it defaults to
  17.     :KERMIT_INI.
  18.   dest -
  19.     is where KERMIT will output messages that would go to the screen by
  20.     default.  These messages are written through the M$LO DCB.
  21.   options -
  22.     one or more of the options/commands, separated by semicolons, listed in
  23.     this help file.  Note that if any commands (other than DONT GREET, DONT
  24.     PROMPT, NO DEFAULTS and SILENT MODE) are specified on the invocation line,
  25.     when the last such command is completed, KERMIT will exit rather than
  26.     prompt for more commands.
  27. .*B*
  28. KERMIT uses the KERMIT protocol (developed at Columbia University) to provide
  29. reliable file transfers between two computers (at least one of which is CP-6)
  30. over an asynchronous communications line.  Checksums and other control
  31. information are used to ensure (with high probability) error free transfers.
  32.  
  33. This version of Kermit is written in PL-6; a PL/1-like implementation language
  34. available on the Honeywell CP-6 operating system.  This Kermit contains all of
  35. the "basic" Kermit features and several optional/advanced features.  Some of
  36. the optional features are suggested in the Kermit User's Guide and/or Kermit
  37. Protocol Manual, while others where implemented to provide added flexibility
  38. on CP-6.  The following table briefly summarizes the capabilities of this
  39. version of Kermit.
  40. .*B*
  41. Features this Kermit has or can do:
  42.   Transfers text files
  43.   Transfers binary files
  44.   Send file groups (wildcarding)
  45.   File overwrite protection
  46.   Timeouts
  47.   8th-bit prefixing
  48.   Repeat count prefixing
  49.   Transaction logging
  50.   Debugging facility
  51.   Acts as a server
  52.   Talks to a server (limited)
  53.   Automatically reads default commands from a file
  54.   Reads commands from a file
  55.   Help for each of the commands
  56.   Graceful handling of interrupted group transfers
  57.  
  58. Features not included in this version:
  59.   Advanced server commands
  60.   Extended block checks (2 and 3 byte checks)
  61.   Handling file attributes
  62. .*K* '!' IBEX
  63. !command
  64. .*B*
  65.     Any command which may be entered from IBEX may be entered while in KERMIT
  66.     by preceding the IBEX command with a !  (the IBEX prompt character).  For
  67.     all of these commands, with the exception of !XEQ, the user is returned to
  68.     KERMIT after the command is executed.
  69.  
  70.     Note: This feature will NOT work on pre-C00 versions of CP-6.
  71. .*K* '?'
  72. ?
  73.     Requests that the next level of HELP be displayed.  This should only be
  74.     issued after a HELP or ?  command.  See the HELP command for more
  75.     information.
  76. .*K* '??'
  77. ??
  78.     Requests all remaining HELP on the most recently specified topic.  This
  79.     should only be issued after a HELP or ? command.  See the HELP command
  80.     for more information.
  81. .*K* BYE
  82. BYE
  83.     Tells "the other" KERMIT (which should be running in SERVER mode) to exit
  84.     and terminate the session.
  85. .*K* CG
  86. CG = comgroup_name
  87. .*B*
  88.     Specifies the name of the ComGroup to be used for file transfers.
  89.     This option is only meaningful when specified in conjunction with the
  90.     STATION option.  If either the CG or STATION options are specified
  91.     without the other option then the option that was specified will
  92.     be IGNORED.
  93. .*K* COPY TYPE
  94. C[OPY] sourcelist [{ON|TO|OVER|INTO} destination] [FROM fid]
  95. .*B*
  96.     Causes CP-6 KERMIT to M$LINK to PCL, passing the entire COPY command to
  97.     PCL.  Since PCL, not KERMIT, is really doing the COPY, the command
  98.     specified may have any of the options that the PCL COPY command accepts.
  99. .*K* DATE TIME
  100. { DATE | TIME }
  101.     Displays the current date and time in the format:
  102.      mmm dd 'yy hh:mm    (month) (day) (year) (hour) (minute)
  103. .*K* DEBUG
  104. DEB[UG] [[{ON|TO|OVER|INTO}] debug-file] [( option [,option...] )]
  105. .*B*
  106.     Specifies what information will be written to the debug file.
  107.  
  108.     The debug parameters have the following meaning:
  109.  
  110.     debug-file
  111.         is a CP-6 file where the requested (via options) debug information
  112.         will be written.  If 'debug-file' is not specified on a command, any
  113.         previously specified 'debug-file' name will be used.  If this is the
  114.         first DEBUG command issued, the file name '*DEBUG' will be used by
  115.         default.
  116.     option
  117.         is one of the following:
  118.  
  119.     A[LL] -
  120.         writes ALL available debug information
  121.     C[OMMAND] -
  122.         writes a copy of the command issued by the user.  This is handy when
  123.         you are DEBUGging INTO the same file (as might be done when the DEBUG
  124.         command is in the :KERMIT_INI file) and you want/need to know at what
  125.         point in the DEBUG file each CP-6 KERMIT session began.
  126.     E[RROR] -
  127.         writes unexpected monitor errors
  128.     I[NFORMATION] -
  129.         writes "miscellaneous" information.  Currently, this just means
  130.         include a copy of the CP-6 KERMIT invocation line (B$JIT.CCBUF) in the
  131.         debug file.
  132.     M[ICRO] -
  133.         writes a debug record for each packet sent and received, timeout value
  134.         change and unexpected monitor errors.  This is a shorthand method of
  135.         specifying the ERROR, RECEIVE, SEND and TIMEOUT options.
  136.     OF[F] -
  137.         Causes CP-6 KERMIT to CLOSE the debug file and cease writing debug
  138.         information to it.  A subsequent DEBUG command without a 'debug-file'
  139.         specified will cause the previous debug file to be extended.
  140.     ON -
  141.         Causes CP-6 KERMIT to start/continue writing debug information to the
  142.         debug file.
  143.     REA[D] -
  144.         writes a debug record for each record READ from a CP-6 file being
  145.         transferred to "the other" computer.
  146.     REC[EIVE] -
  147.         writes a debug record for each packet received from "the other"
  148.         computer.
  149.     S[END] -
  150.         writes a debug record containing packets that CP-6 KERMIT sends to
  151.         "the other" computer.
  152.     T[IMEOUT] -
  153.         writes a debug record indicating that either a read timeout value was
  154.         changed or that a timeout occurred; the text of the record indicates
  155.         which occurred.
  156.     W[RITE] -
  157.         writes records as they were written to a CP-6 file; as a result of a
  158.         RECEIVE command on CP-6 or a SEND command on "the other" computer when
  159.         CP-6 KERMIT was running as a SERVER.
  160.  
  161.     The default is to NOT DEBUG.  However, if a DEBUG command is specified
  162.     with no parameters, the default is DEBUG INTO *DEBUG(MICRO).
  163.  
  164.     Each record written to the debug file is preceded by a 15 byte header.
  165.     The first four bytes indicate what type of record it is and have the
  166.     following meanings:
  167.  
  168.     'Cmnd' - the record contains a KERMIT command as issued by the user.
  169.     'Info' - the record contains miscellaneous information.  With this
  170.              version of CP-6 KERMIT, the record will contain a copy of the
  171.              KERMIT invocation line.
  172.     'Read' - the record was one READ from a CP-6 file and was eventually
  173.              SENT (hopefully) to the "other" computer.
  174.     'Rcvd' - the record was RECEIVEd from the "other" computer.
  175.     'Sent' - the record was SENT to the "other" computer.
  176.     'Timo' - either a read timed out or a timeout value was changed.  The
  177.              remaining portion of the record (past the header) contains a
  178.              message indicating what happened.
  179.     'Writ' - the record was written as a logical record to the file that
  180.              was RECEIVEd from the "other" computer.
  181.  
  182.     The remaining 11 bytes of header is a time stamp which is provided to aid
  183.     the user in finding "timing holes" which may exist between the personal
  184.     computer and CP-6 versions of KERMIT.
  185. .*K* DELETE DEL
  186. [LOCAL] DEL[ETE] sourcelist [FROM fid]
  187. .*B*
  188.     Causes CP-6 KERMIT to M$LINK to PCL, passing the entire DELETE command
  189.     (minus the LOCAL if it was specified) to PCL.  Since PCL, not CP-6 KERMIT,
  190.     is really doing the DELETE, the command specified may have any of the
  191.     options that the PCL DELETE command accepts.
  192. .*K* DIRECTORY DIR
  193. { DIRECTORY | DIR } [[DP#packset].account | R[ESET]]
  194. .*B*
  195.     Changes the default account and optionally, the default packset.  The
  196.     default account and packset are the account and associated packset that
  197.     are selected if an account is not supplied as part of a disk fid.
  198.     Initially, the default account is the logon or running account and the
  199.     packset name is nil.  When used without parameters, the DIRECTORY command
  200.     displays the current directory.
  201. .*K* DO
  202. DO command-to-be-passed-to-IBEX
  203. .*B*
  204.     Any command which may be entered from IBEX may be entered while in KERMIT
  205.     by preceding the IBEX command with 'DO '.  For all of these commands, with
  206.     the exception of DO XEQ, the user is returned to KERMIT after the command
  207.     is executed.
  208.  
  209.     Note: This feature will NOT work on pre-C00 versions of CP-6.
  210. .*K* END EXIT QUIT
  211. { E[ND] | EX[IT] | X[IT] | Q[UIT] }
  212.     Exits KERMIT after closing and saving any currently OPEN files.
  213. .*K* ERASE
  214. ERASE [ALL | ldevlist]
  215. .*B*
  216.     ERASE deletes the accumulated output for ALL or for the specified logical
  217.     devices defined for the session or job.  If no parameters are specified,
  218.     ALL is assumed.
  219. .*K* FINISH
  220. FIN[ISH]
  221.     Tells the "other" KERMIT (which is assumed to be running in SERVER mode)
  222.     to exit.  Unlike the BYE command, the "other" session remains active.
  223. .*K* HELP
  224. H[ELP] [(processor)][ TOPICS ][ keyword1 ][ - ][ keyword2]
  225. .*B*
  226.     HELP prints information.
  227.  
  228.     HELP messages have levels.  Once the initial level has been printed,
  229.     typing a question mark prints the next level, usually containing greater
  230.     detail.  Typing two question marks prints the entire message.
  231.  
  232.     Any processor with a standard HELP file can be read from KERMIT.
  233.  
  234.     The HELP can be issued at the double-bang (!!) without losing the
  235.     suspended activity.  Thus, one may exit a processor (such as FORTRAN) with
  236.     a <CNTL><Y>, query for HELP information, and then issue GO to return to
  237.     FORTRAN.
  238. .*B*
  239.     Parameters have the following meanings:
  240.  
  241.     processor -
  242.         specifies a program or processor that has an associated HELP file.
  243.         The default is the processor currently under control (in this
  244.         case, KERMIT).
  245.  
  246.     TOPICS -
  247.         specifies that only a list of available topics (message names) is
  248.         required.  The range of topics is determined by keyword1 or
  249.         keyword2.
  250.  
  251.     keyword1  -
  252.         specifies the name of the message to be printed.
  253.  
  254.     keyword2  -
  255.         if a range is specified (by including a dash " - " or greater than
  256.         ">"), keyword2 is the upper limit of the range.  If a range is not
  257.         specified, keyword2 is a submessage, or category within a message.
  258. .*K* LIST L
  259. L[IST] [(listopt)] [sourcelist [{ON|TO|OVER|INTO} destination]] [FROM fid]
  260. .*B*
  261.     Causes KERMIT to M$LINK to PCL, passing your entire LIST command to PCL.
  262.     Since PCL is really doing the LIST, the command specified may have any of
  263.     the options that the PCL LIST command accepts.
  264. .*K* LOCAL
  265. LOC[AL] { CWD [[.] account] | DIR[ECTORY] [listopt] }
  266. .*B*
  267.     The LOCAL commands are miscellaneous commands to be performed on the local
  268.     machine; in this case CP-6.  The LOCAL CWD (Change Working Directory)
  269.     performs the same function as the CP-6 DIRECTORY command.  The LOCAL
  270.     DIRECTORY command performs the same function as the CP-6 PCL LIST command.
  271. .*K* LOG
  272. LOG [T[RANSACTIONS]] [{ON|TO|OVER|INTO}] fid
  273. .*B*
  274.     LOGs information about the files transferred into the specified file.
  275.     This is especially useful when CP-6 KERMIT is running as a SERVER.  In
  276.     SERVER mode it is difficult (at best) to get "informational" messages
  277.     displayed to the user because the "other" computer is in transfer mode all
  278.     the time.
  279. .*B*
  280.     LOG information is written to the indicated EDIT KEYED file with the
  281.     fractional portion of the EDIT key being the same for like types.  The
  282.     following is a summary of the various types currently generated:
  283.  
  284.     xxxxx.000 - Date, time and users logon account and name
  285.     xxxxx.100 - A message indicating the direction (SEND or RECEIVE) of the
  286.                 transfer, file name, number of records and the mode (TEXT or
  287.                 BINARY).  This record is actually written twice; once when the
  288.                 transfer starts (the text indicates this) and again when the
  289.                 transfer completes.  This is the reason why this file is KEYED
  290.                 and makes it possible to tell if a started transfer actually
  291.                 finished normally.
  292.     xxxxx.200 - Packet sizes used (by each side) for the transfer
  293.     xxxxx.300 - Number of Data packets used and how many bytes were
  294.                 transferred
  295.     xxxxx.600 - Elapsed time of the transfer
  296.     xxxxx.700 - Error message from any error that may have prematurely stopped
  297.                 the transfer
  298. .*K* NO_DEFAULTS
  299. N[O] D[EFAULTS]
  300. .*B*
  301.     By default, when KERMIT is invoked it looks for a file called :KERMIT_INI
  302.     in the current directory.  If it is NOT found, then the logon account is
  303.     searched (if it is not the current account).  If the file is found in
  304.     either account, it is read and any KERMIT commands in it are executed.
  305.     This NO DEFAULTS option suppresses this behavior if it is specified on the
  306.     command line.  Furthermore, if it is the only option on the command line,
  307.     KERMIT will prompt the user for additional commands.  Otherwise, all the
  308.     commands/options on the command line are executed and then KERMIT exits.
  309.  
  310.     If specified, this option should appear on the invocation line.
  311. .*K* NO_GREETING
  312. { D[ONT] | N[O] } G[REETING]
  313.     Causes the greeting (KERMIT 1.00 Here (01/25/87)) to be suppressed.
  314.  
  315.     If specified, this option should appear on the invocation line.
  316. .*K* NO_PROMPT
  317. { D[ONT] | N[O] } P[ROMPT]
  318.     Causes the prompt string to be suppressed.
  319.  
  320.     If specified, this option should appear on the invocation line.
  321. .*K* OUTPUT
  322. OUT[PUT] [{ON|TO|OVER|INTO}] destination
  323. .*B*
  324.     Directs KERMIT's primary output to the specified destination.
  325.  
  326.     The default is OUTPUT ON ME.
  327. .*K* PRINT
  328. PRINT [ALL | ldevlist]
  329. .*B*
  330.     Causes accumulated output for the specified logical device to be released
  331.     to the symbiont.  If no parameters are specified, ALL is assumed.
  332. .*K* PROMPT
  333. PROM[PT] 'prompt-string'
  334. .*B*
  335.     Specifies the prompt string that KERMIT will subsequently prompt with.
  336.  
  337.     The default is PROMPT 'CP-6 Kermit> '.
  338. .*K* READ TAKE
  339. { READ | TAKE } fid
  340. .*B*
  341.     Causes subsequent KERMIT commands to be read from 'fid'.  When the end of
  342.     'fid' is reached, input reverts back to the source in use prior to the
  343.     READ command.  READ commands may NOT be nested; that is, a file being READ
  344.     cannot contain a READ command.
  345. .*K* RECEIVE
  346. REC[EIVE] [{ destfid | otherfid {ON|TO|OVER|INTO} destfid }]
  347. .*B*
  348.     Instructs KERMIT to RECEIVE file(s).  If no parameters are specified, the
  349.     file name is taken from the file packet sent to CP-6 from "the other"
  350.     computer.  If destfid is specified, it overrides the name sent in the file
  351.     packet.  If otherfid is specified, it is ignored!
  352. .*K* SEND
  353. SEN[D] sourcefid [[AS] destfid]
  354. .*B*
  355.     Causes KERMIT to SEND sourcefid to "the other" computer.  If destfid is
  356.     specified and sourcefid is NOT wildcarded, destfid will be sent as the
  357.     file name in the File packet to "the other" computer.  'sourcefid' may be
  358.     wildcarded using the question mark (?) as the wildcard character.
  359. .*K* SERVER
  360. SER[VER]
  361. .*B*
  362.     Puts CP-6 KERMIT into file SERVER mode.  In this mode, CP-6 KERMIT accepts
  363.     its commands through packets from "the other" computer.  Once this command
  364.     is issued on CP-6, it can be stopped in any one of three ways:
  365.  
  366.       1) If "the other" computer goes back to emulator mode on CP-6 and a
  367.          carriage return(s) are entered, CP-6 KERMIT will again prompt the
  368.          user for commands.
  369.       2) Issue the FINISH command on "the other" computer.  This will cause
  370.          CP-6 KERMIT to exit to IBEX.
  371.       3) Issue the BYE command on "the other" computer which causes CP-6
  372.          KERMIT to be exited and an !OFF command to be issued thus terminating
  373.          the CP-6 session.
  374. .*K* SET
  375. The SET command allows the user to SET various options.
  376. .*B* BLOCK_CHECK CHECKSUM
  377. SET B[LOCK] [-] [C[HECK]] [=] { 1 | 2 | 3 } [CHARACTER] [CHECKSUM]
  378.  
  379. Note: Only 1 is supported at the present time.
  380. .*B*
  381.     KERMIT checks the validity of data in each packet via a block check.  The
  382.     sender of the packet computes the block check based on the other
  383.     characters in the packet and the receiver recomputes it the same way.  If
  384.     these quantities agree, the packet is accepted and the transmission
  385.     proceeds.  If they disagree, the packet is rejected and transmitted again.
  386. .*B*
  387.     There are three different block checks (sometimes know as checksums) that
  388.     are supported in the KERMIT protocol.  The first one ("1" in the option
  389.     list above) is the simplest block check and is required to be supported in
  390.     all versions of KERMIT.  At the present time, this is the ONLY one
  391.     supported by CP-6 KERMIT.  This block check is only a 6-bit quantity (the
  392.     low order 8 bits of the arithmetic sum folded upon itself).  With only six
  393.     bits of accuracy, the chances are one in 64 that an error can occur which
  394.     will not be detected in the checksum, assuming that all errors are equally
  395.     likely.
  396.  
  397.     The second block check ("2" in the option list above) is much like the
  398.     first except that it is a 12-bit checksum instead of 6-bit.  This reduces
  399.     the chance of an undetected error to be one in 4096 but also takes another
  400.     byte in the packet that otherwise could have been used for data.
  401.  
  402.     The third and last block check ("3" in the option list above) is a
  403.     3-character, 16-bit Cyclic Redundancy Check, CCITT format.  In addition to
  404.     errors in any odd number of bits, this method detects double bit errors,
  405.     all error bursts of length 16 or less and more than 99.99% of all possible
  406.     longer bursts.  This method also uses two more bytes in the packet that
  407.     could have otherwise been used for data.
  408. .*B* DELAY
  409. D[ELAY] [=] value
  410. .*B*
  411.     "value" specifies the number of seconds to wait before sending the first
  412.     packet to "the other" computer after a SEND command is issued to CP-6
  413.     KERMIT.  The reason for this is to give you enough time to "escape" back
  414.     to "the other" computer and issue a RECEIVE command.  This "delay" does
  415.     NOT occur when CP-6 KERMIT is in SERVER mode.
  416.  
  417.     The default is SET DELAY = 10.
  418. .*B* FILE
  419. SET FILE { B[INARY] EX[TENSIONS] [=] 'suffix' [,'suffix'...]               |
  420.            C[P] [-] [6] [F[IDS]] [P[ERMITTED]] [=] { Y[ES] | N[O] }        |
  421.            E[DIT] [K[EY]] [=] { Y[ES] | N[O] }                             |
  422.            E[ND] O[F] R[ECORD] [=] dec [,dec]                              |
  423.            I[NCOMPLETE] [=] { D[ISCARD] | K[EEP] }                         |
  424.            M[ODE] [=] { A[UTOMATIC] | B[INARY] | T[EXT] }                  |
  425.            N[AMES] [=] { A[S] [IS] | L[OWER] [C[ASE]] | U[PPER] [C[ASE]] } |
  426.            [PC] EX[TENSIONS] [=] ( Y[ES] | N[O] }                          |
  427.            PR[EFIX] [=] '19characters'                                     |
  428.            R[EPLACEMENT] [C[HARACTER]] [=] '1character'                    |
  429.            SUB [DIRECTORY] C[HARACTER] [=] '1character'                    |
  430.            SUB [DIRECTORY] [=] { ON | OFF }                                |
  431.            W[ARNING] [=] { OFF | ON | OVER | INTO | TO }                    }
  432. .*B* FILE_BINARY_EXTENSIONS
  433. SET F[ILE] B[INARY] EX[TENSIONS] [=] 'suffix' [,'suffix'...]
  434. .*B*
  435.     This option, when used in conjunction with SET FILE MODE=AUTOMATIC and SET
  436.     FILE PC EXTENSION=YES, allows the user to specify a list of (possibly
  437.     wildcarded) binary file extensions (i.e., suffixes).  If the name of a
  438.     file being transferred matches any of the extensions specified in this
  439.     option, the file will be transferred in BINARY mode.  Otherwise, the
  440.     transfer will be done in TEXT mode.  Each of the extensions you specify is
  441.     implicitly preceded with a '?'.
  442.  
  443.     The default is SET FILE BINARY EXTENSIONS = '-ARC','_ARC','-COM', '_COM',
  444.     '-EXE','_EXE','-LIB','_LIB'.
  445. .*B* FILE_CP6_FIDS_PERMITTED
  446. SET F[ILE] C[P] [-] [6] [F[IDS]] [P[ERMITTED]] [=] { Y[ES] | N[O] }
  447. .*B*
  448.     If YES is specified, CP-6 KERMIT will expect the file names passed, in
  449.     type 'F' packets, to be legal CP-6 fids.  This being the case, any periods
  450.     in names will be treated as CP-6 file name, account and/or password
  451.     delimiters as opposed to PC name and extension separators.  If NO is
  452.     specified, then CP-6 KERMIT looks for illegal fid characters in the passed
  453.     file names.  If any are found, they are replaced with the SET FILE
  454.     REPLACEMENT character, which is an underscore (_) by default.
  455.  
  456.     The default is SET FILE CP6 FIDS PERMITTED = NO.
  457. .*B* FILE_EDIT_KEY
  458. SET F[ILE] E[DIT] [K[EY]] [=] { Y[ES] | N[O] }
  459. .*B*
  460.     If YES is specified, then RECEIVEd file will be EDIT KEYED.  Otherwise,
  461.     the file will be created as a CONSECutive file.
  462.  
  463.     The default is SET FILE EDIT KEYED = NO.
  464. .*B* FILE_END_OF_RECORD
  465. SET F[ILE] E[ND] O[F] R[ECORD] [=] dec3 [,dec3]
  466. .*B*
  467.     This option allows the user to specify the "end of record" sequence that
  468.     will be sent in packets to delimit logical records.  The values are
  469.     specified in decimal and separated with commas.
  470.  
  471.     The default is SET FILE END OF RECORD = 13, 10 which is CR, LF.
  472. .*B* FILE_INCOMPLETE
  473. SET F[ILE] I[NCOMPLETE] [=] { D[ISCARD] | K[EEP] }
  474. .*B*
  475.     If KEEP is specified, any portion of a file transfer (to CP-6) prior to an
  476.     interruption will be kept.  If DISCARD is specified, only successfully
  477.     transferred files will be retained.
  478.  
  479.     The default is SET FILE INCOMPLETE = DISCARD.
  480. .*B* FILE_MODE
  481. SET F[ILE] M[ODE] [=] { A[UTOMATIC] | B[INARY] | T[EXT] }
  482. .*B*
  483.     This option controls the file transfer mode.
  484.  
  485.     If BINARY is specified, all records being read or written from/to a CP-6
  486.     file should be 128 bytes.  All bytes are transmitted such that they will
  487.     end up on "the other" machine as they were on the source machine (e.g.,
  488.     TAB characters will end up as TAB characters rather than an appropriate
  489.     number of blanks).
  490.  
  491.     If TEXT is specified, each record being sent from a CP-6 file will have
  492.     the END OF RECORD (see SET FILE END OF RECORD) character(s) appended to it
  493.     in the packet.  Similarly, packets being received will have the END OF
  494.     RECORD character(s) removed from each record before the record is written
  495.     to the CP-6 file.
  496.  
  497.     If AUTOMATIC is specified, a RECEIVE transfer will be done in BINARY mode
  498.     if:
  499.       1) the SET FILE PC EXTENSIONS = YES and
  500.       2) if the name of the file being transferred matches one of those
  501.          extensions in the extension list (see SET FILE BINARY EXTENSIONS).
  502.     If AUTOMATIC is specified and a SEND is being done, the transfer will be
  503.     done in BINARY if:
  504.       1) the CP-6 files 'TY' field equals 'BI' (as in BInary) or
  505.       2) if SET FILE PC EXTENSIONS = YES and the name of the file being
  506.          transferred matches at least one of the extensions in the binary
  507.          extension list (see SET FILE BINARY EXTENSIONS option).
  508.  
  509.     The default is SET FILE MODE AUTOMATIC.
  510. .*B* FILE_NAMES
  511. SET F[ILE] N[AMES] [=] { A[S] [IS] | L[OWER] [C[ASE]] | U[PPER] [C[ASE]] }
  512. .*B*
  513.     This option controls if and how file names will be changed prior to being
  514.     used on CP-6.
  515.  
  516.     If AS IS is specified, then the file names will be used "as is" on CP-6.
  517.  
  518.     If LOWERCASE is specified, then the file name will be changed to all
  519.     lowercase prior to being used on CP-6.
  520.  
  521.     If UPPERCASE is specified, then the file name will be changed to all
  522.     uppercase prior to being used on CP-6.
  523.  
  524.     The default is SET FILE NAMES = AS IS.
  525. .*B* FILE_PC_EXTENSIONS
  526. SET F[ILE] [PC] EX[TENSIONS] [=] { YES | NO }
  527. .*B*
  528.     This option controls whether the BINARY EXTENSION list will be used to
  529.     determine the MODE of file transfers.  See SET FILE MODE and SET FILE
  530.     BINARY EXTENSIONS options for more information.
  531.  
  532.     The default is SET FILE PC EXTENSIONS ON.
  533. .*B* FILE_PREFIX
  534. SET F[ILE] PR[EFIX] [=] '19characters'
  535. .*B*
  536.     This option allows a CP-6 file prefix (up to 19 characters) to be
  537.     specified.  When a file is RECEIVEd on CP-6, this prefix will precede the
  538.     file name passed from "the other" computer.  When a file is SENDed from
  539.     CP-6, this prefix (if present) will be removed from the file name sent to
  540.     "the other" computer.  This feature was added to aid, for example, those
  541.     users who are using CP-6 to "backup" the files on their "other" machine
  542.     (usually a micro).
  543.  
  544.     For instance, suppose you have a hard disk on your "other" computer that
  545.     has multiple subdirectories.  In several of those subdirectories is a file
  546.     called 'READ.ME'.  If you were to "backup" all those subdirectories into a
  547.     single account on CP-6, you would end up with one READ.ME file.  The file
  548.     would be either from the first (if SET FILE WARNING ON) or the last (if
  549.     SET FILE WARNING OFF) subdirectory you "backed-up".  With this option, you
  550.     could specify a different PREFIX (I.e., the subdirectory name) for each
  551.     subdirectory you "backup".  This would result in all of the READ.ME files
  552.     ending up with unique names on CP-6.
  553.  
  554.     For another way to get files "restored" back to "the other" computer, see
  555.     the SET FILE SUBDIRECTORY CHAR command.
  556. .*B*
  557.     The default is SET FILE PREFIX = '' which effectively disables this
  558.     feature.
  559. .*B* FILE_REPLACEMENT_CHARACTER
  560. SET F[ILE] R[EPLACEMENT] [C[HARACTER]] [=] '1character'
  561. .*B*
  562.     If SET FILE CP-6 FIDS PERMITTED = NO is in effect, CP-6 KERMIT will check
  563.     all specified CP-6 file names for illegal characters (including periods).
  564.     If any are found, they are replaced with the '1character' specified on
  565.     this option.
  566.  
  567.     The default is SET FILE REPLACEMENT CHARACTER = '_'.
  568. .*B* FILE_SUB_CHAR FILE_SUBDIRECTORY_CHAR
  569. SET F[ILE] SUB [DIRECTORY] C[HARACTER] [=] '1character'
  570. .*B*
  571.     This command permits the user to simulate subdirectories (to a limited
  572.     extent) on CP-6.  This is done by choosing a character to represent the
  573.     subdirectory separator character.  This character and all characters
  574.     preceding it will be removed from file names sent to the local Kermit.
  575.  
  576.     For example, if you type:
  577.       SET FILE SUBDIRECTORY CHARACTER = ':'
  578.       SEND TEST:FILE_EXT
  579.     the file would be sent under the name 'FILE.EXT'.
  580.  
  581.     If you want to turn this feature off, simply type:
  582.       SET FILE SUBDIRECTORY OFF
  583.     This will disable the feature until a subsequent SET FILE SUBDIRECTORY ON
  584.     command is issued.  Event when this feature is disabled, the SET FILE
  585.     SUBDIRECTORY CHARACTER is still retained so once specified it doesn't need
  586.     to be SET again.
  587. .*B*
  588.     Initially, this feature is OFF, but the character is set to ':'.  This
  589.     character was chosen because it can't occur in a PC filename, but it can
  590.     in a CP-6 filename.  This feature is mainly intended to help organize CP-6
  591.     directories which are being used as central repositories for micro
  592.     software.
  593.  
  594.     The default is SET FILE SUBDIRECTORY CHARACTER = ':' and
  595.                    SET FILE SUBDIRECTORY OFF.
  596. .*B* FILE_SUB_ON_OFF FILE_SUBDIRECTORY_ON_OFF
  597. SET F[ILE] SUB[DIRECTORY] [=] { ON | OFF }
  598. .*B*
  599.     When ON is specified, the feature described under the SET FILE
  600.     SUBDIRECTORY CHAR command will be used.  When OFF is specified said
  601.     feature is disabled but the character specified in SET SUB DIRECTORY CHAR
  602.     will be retained.
  603. .*B* FILE_WARNING
  604. SET F[ILE] W[ARNING] [=] { OFF | OVER | ON | TO | INTO }
  605. .*B*
  606.     This option controls what happens if the file being sent to CP-6 already
  607.     exists.
  608.  
  609.     If OFF or OVER is specified, any existing file of the same name is
  610.     overwritten.  If no file currently exists, a new one is created.
  611.  
  612.     If ON or TO is specified and a file of the same name already exists, an
  613.     error is returned and the existing file remains unchanged.
  614.  
  615.     If INTO is specified and the file already exists, the file will be
  616.     extended.  If no file currently exists then one is created.
  617.  
  618.     The default is SET FILE WARNING ON.
  619. .*B* RETRY
  620. SET R[ETRY] [C[OUNT]] [F[OR]] { I[NITIAL] [P[ACKETS]] | P[ACKETS] } value
  621. .*B*
  622.     This option sets the error retry threshold for either the Initial packet
  623.     or Data packets.
  624.  
  625.     The defaults are SET RETRY COUNT FOR INITIAL PACKET = 10 and
  626.                      SET RETRY COUNT FOR PACKETS = 10.
  627. .*B* SEND
  628. SEN[D]    { EI[GHT] [B[IT]] [Q[UOTING]] [C[HARACTER]] [=] '1character' |
  629.             E[ND] [-] [O[F]] [-] [L[INE]] = dec3                       |
  630.             PACK[ET] [L[ENGTH]] [=] dec2                               |
  631.             PAU[SE] [=] dec                                            |
  632.             PADD[ING] [=] dec                                          |
  633.             PADC[HAR] [=] dec3                                         |
  634.             Q[UOTE] [CTL] [=] '1character'                             |
  635.             R[EPEAT] [C[HARACTER]] [=] '1character'                    |
  636.             S[TART] [-] [O[F]] [-] [P[ACKET]] [=] dec3                 |
  637.             T[IMEOUT] [=] dec                                            }
  638. .*B* SEND_EIGHT_BIT_QUOTING_CHAR
  639. SET SEN[D] EI[GHT] [B[IT]] [Q[UOTING]] [C[HARACTER]] [=] '1character'
  640. .*B*
  641.     This option will only be used when the parity of the communications line
  642.     is something other than NONE or ZERO (i.e., when the eighth bit is not
  643.     available for data).  When specified, this character must be "Y" or "N" or
  644.     a character in the range ASCII 33-62 ("!" through ">") or 96-126 ("'"
  645.     through "~"), but MUST be different from the SEND QUOTE and SEND REPT
  646.     values.  The value is interpreted as follows:
  647.  
  648.       Y CP-6 KERMIT will do 8-bit quoting if "the other" KERMIT requests it.
  649.       N 8-bit quoting will NOT be done.
  650.       & (or any other character in the range 33-62 or 96-126) means CP-6
  651.         KERMIT will use this character for 8-bit quoting (if "the other"
  652.         KERMIT responds with a "Y" or the same character).  The "&" is the
  653.         recommended 8-bit quote character.
  654. .*B* SEND_END_OF_LINE
  655. SET SEN[D] E[ND] [O[F]] [L[INE]] [=] dec3
  656. .*B*
  657.     The ASCII character that will be used as the line terminator for
  658.     all outgoing packets.  The default value is a 13 (Carriage Return).
  659. .*B* SEND_PACKET_LENGTH
  660. SET SEN[D] PACK[ET] [L[ENGTH]] [=] dec
  661. .*B*
  662.     The maximum length packet that CP-6 KERMIT wants to receive, a number in
  663.     the range 7 to 94, inclusive.  It is recommended that this value be 94
  664.     (the maximum) unless alot of retries are occurring in which case the value
  665.     should be gradually decreased until retries only occur occasionally, if at
  666.     all.
  667.  
  668.     The default is SET SEND PACKET LENGTH = 94.
  669. .*B* SEND_PAUSE
  670. SET SEN[D] PAU[SE] [=] dec
  671. .*B*
  672.     Specifies how many seconds to pause before ACKnowledging a packet.
  673.     Setting this to a nonzero value will slow down the rate at which data
  674.     packets arrive, which may be necessary for systems that have "sensitive"
  675.     front ends and cannot accept input at a high rate.
  676.  
  677.     The default is SET SEND PAUSE = 0.
  678. .*B* SEND_PADCHAR
  679. SET SEN[D] PADC[HAR] [=] dec3
  680. .*B*
  681.     This is a padding character that the "other computer" will send before
  682.     each packet.  The number of padding characters required is determined by
  683.     the value of the SEND PADDING parameter.  It is doubtful that you will
  684.     ever need to set this or the SEND PADDING values.
  685.  
  686.     The default is SET SEND PADCHAR = 0.
  687. .*B* SEND_PADDING
  688. SET SEN[D] PADD[ING] [=] dec
  689. .*B*
  690.     This indicates the number of padding characters (see SET SEND PADCHAR)
  691.     that the "other computer" should send before each packet.  It is doubtful
  692.     that you will ever need to set this value.  A value of 0 (zero) means
  693.     that no padding characters are needed.
  694.  
  695.     The default is SET SEND PADDING = 0.
  696. .*B*  SEND_QUOTE
  697. SET SEN[D] Q[UOTE] [CTL] [=] '1character'
  698. .*B*
  699.     This is the printable ASCII character CP-6 KERMIT will use to quote
  700.     control characters.  This must be a printable character and the MUST be
  701.     different from both the EIGHT BIT QUOTING CHARACTER and the REPEAT
  702.     CHARACTER.
  703.  
  704.     The default is SET SEND QUOTE CTL = '#'.
  705. .*B* SEND_REPEAT_CHARACTER
  706. SET SEN[D] R[EP] [E[A]] [T] [C[HARACTER]] [=] '1character'
  707. .*B*
  708.     This is the character that will indicate a repeated character.  This can
  709.     be any printable character in the range ASCII 33-62 ("!" through ">") or
  710.     96-126 ("'" through "~") but MUST be different than both the SEND QUOTE
  711.     and SEND EIGHT BIT QUOTING CHARACTER.  Any character outside this range
  712.     indicates repeating will NOT be done.  The tilde (ASCII 126, "~") is the
  713.     recommended and normal repeat prefix.  If "the other" KERMIT does not
  714.     respond with the same character, no repeating will be done.  If repeating
  715.     is possible by both KERMITs, it will be used to represent 4 or more
  716.     consecutive occurrences of the same character.
  717. .*B* SEND_START_OF_PACKET
  718. SET SEN[D] S[TART] [O[F]] [P[ACKET]] [=] '1character'
  719. .*B*
  720.     The synchronization character that marks the beginning of the packet.
  721.     This is a SOH (CTRL-A) by default but may be changed if needed.
  722.  
  723.     The default is SET SEND START OF PACKET = 1.
  724. .*B* SEND_TIMEOUT
  725. SET SEN[D] T[IMEOUT] [=] dec
  726. .*B*
  727.     The number of seconds after which KERMIT wants "the other" KERMIT to time
  728.     out while waiting for a packet from CP-6.
  729.  
  730.     The default is SET SEND TIMEOUT = 8.
  731. .*B* TAB_EXPANSION
  732. SET TAB EX[PANSION] [=] { OFF | ON }
  733. .*B*
  734.     Indicates if received TAB characters are to be replaced with an
  735.     appropriate number of spaces to move to the next "tab stop".  If ON is
  736.     specified, it is only honored during TEXT mode transfers (i.e., in a
  737.     BINARY transfer, TABs will be sent as TAB characters).
  738.  
  739.     The default is SET TAB EXPANSION ON.
  740. .*B* TABS
  741. SET TABS [ dec [,dec...] ]
  742. .*B*
  743.     Accepts the desired "tab stop" settings.  Up to 40 values may be specified
  744.     but they must be in ascending order.  A value of 0 (zero) means revert
  745.     back to the default.
  746.  
  747.     These values are only used on TEXT mode transfers and only if SET TAB
  748.     EXPANSION = ON, which IS the default.
  749.  
  750.     The default is SET TABS 9,17,25,33,41,49,57, ... ,305,313,321.
  751. .*K* SHOW
  752. SHOW
  753. Shows the current settings for SETable items.
  754. .*K* SILENT_MODE
  755. SILE[NT] [M[ODE]]
  756.     Causes KERMIT to NOT write anything through the M$LO DCB (DCB4).  This may
  757.     not be completely successful in some situations.
  758.  
  759.     If specified, this option should appear on the invocation line.
  760. .*K* STATION
  761. STATION = station_name
  762. .*B*
  763.     The name of the Comgroup station to be used for file transfers.  This
  764.     option is only meaningful when specified in conjunction with the CG option.
  765.     If either the CG or STATION is specified without the other, the option
  766.     specified is IGNORED.
  767. .*K* TRANSMIT
  768. TR[ANSMIT] fid
  769. .*B*
  770.     Sends 'fid' to the "other computer" raw; that is, with no protocol
  771.     involved.  CP-6 KERMIT will DELAY the sending of 'fid' by the number of
  772.     seconds currently set for the SET DELAY option.
  773. .*K* CHANGES
  774. January, 1988  (CP-6 Kermit, version 1.00)
  775.  
  776.     The following are changes/additions made to CP-6 KERMIT since the
  777.     original version (0.95) was sent to Columbia University in
  778.     December, 1985.  Many thanks to John Stewart of Carleton University,
  779.     Tom Erskine of CRC, Mike Iglesias of UC Irvine and Mike Schmidt of
  780.     Honeywell Bull, Canada, for their help and supplied code.
  781.  
  782.     Recognize ARC and LIB as default binary file extensions.
  783.  
  784.     Optimize code that strips parity off incoming characters.
  785.  
  786.     Block move of packet data to eliminate looping.
  787.  
  788.     Eliminate redundant checksum calculation.
  789.  
  790.     Handle repeat counts in file name packet.
  791.  
  792.     Use FSFA on file that is being received or sent.
  793. .*B*
  794.     Added the ability to specify up to two EOR characters instead of
  795.     assuming CR/LF.  This is useful, for instance, when communicating with
  796.     some software on Apples.
  797.  
  798.     Fixed bug that caused KERMIT to Memory Fault if a 'LIST' command
  799.     was issued with no fid specified.
  800.  
  801.     Enhanced the SHOW command to show some of the SETable things that
  802.     it didn't before (EG, Binary EXtensions) as well as values for
  803.     all the new commands.
  804.  
  805.     The PARITY used for a transfer is now logged in the LOG file.
  806.  
  807.     The activation character for received packets is now included in
  808.     KERMIT "debug" files.
  809.  
  810.     Fixed bug that prevented records with embedded CR's from being
  811.     received correctly.
  812.  
  813.     Relaxed syntactical constraints on some commands so optional blanks
  814.     are permitted.
  815. .*B*
  816.     Added the SET FILE PREFIX, SET FILE SUBDIRECTORY CHAR and
  817.     SET FILE SUBDIRECTORY { ON | OFF } commands.
  818.  
  819.     Made it possible to interrupt multiple file transfers so you can
  820.     quit the current file or the entire group of files.
  821.  
  822.     Added the CG and STATION options to allow transfers through ComGroups.
  823.