home *** CD-ROM | disk | FTP | other *** search
/ RBBS in a Box Volume 1 #2 / RBBS_vol1_no2.iso / add2 / sk_j0506.zip / SUPERK.DOC < prev   
Text File  |  1989-05-04  |  42KB  |  881 lines
  1. SuperK v4.12  MiniNet's External Protocol Driver including
  2. JBatch        MiniNet's Driver for Richard B. Johnson's Jmodem Protocol
  3.  
  4. Protocols Supported: Xmodem Checksum, Xmodem CRC, Ymodem (1k Xmodem)
  5.                      Jmodem, WXmodem, K9Xmodem and Super8K  in  full
  6.                      Batch  or  Single File Mode.
  7.  
  8. SuperK is Copyright 12/4/1986, 1989 and JBatch is Copyright 11/01/1988, 1989
  9. by Crater Rim Software. All Rights Reserved.
  10.  
  11. = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
  12.  
  13. SuperK Licensing Agreement
  14. --------------------------
  15.    For the sake of clarity,  all references and restrictions to the use  of 
  16.    the  SuperK  also apply to all of the associated support files INCLUDING 
  17.    the K9Xmodem, Super8K and Jbatch protocols. 
  18.  
  19.    SuperK,  its overlays and all of its associated support  files  are  not 
  20.    public domain software, nor are they free software.  SuperK is copyright 
  21.    (C) 1985,  1989 - the K9Xmodem, Super8K, SuperK and JBatch protocols are 
  22.    copyright 1987, 1989 by Crater Rim. 
  23.  
  24.    Non-registered users are granted a limited license to use SuperK version 
  25.    4.xx on a trial basis for  the  purpose  of  determining  whether  these 
  26.    programs are suitable for their needs.  The term of this limited license 
  27.    is  30 days.  Use of SuperK,  except for this limited purpose,  requires 
  28.    registration.  Use of non-registered copies of  SuperK  by  any  person, 
  29.    business,  corporation,  governmental agency or other entity institution 
  30.    is strictly forbidden.  
  31.  
  32.    Registration permits you to use SuperK on a regular basis  on  a  single 
  33.    computer.  A  registered  user  may  use  the  program  on  a  different 
  34.    computer,  but may not use the program on more than one computer at  the 
  35.    same  time.  Registration  also  includes priority support on Underdog's 
  36.    MiniNet  BBS.   Users  need  register  only  one  version   of   SuperK.  
  37.    Registration includes licensed use of all upgrades.  
  38.  
  39.    All corporate,  business,  government or other commercial uses of SuperK 
  40.    must be registered.  We offer quantity discounts and Corporate  or  site 
  41.    licensing is also available.  
  42.  
  43.    No  user  may  modify  SuperK  in any way,  including but not limited to 
  44.    decompiling, disassembling or otherwise reverse engineering the program.  
  45.  
  46.    All users are granted a limited license to copy SuperK version 4.xx only 
  47.    for  the trial use of others subject to the above limitations,  and also 
  48.    the following: 
  49.  
  50.          SuperK  version  4.xx  must  be  copied  in unmodified form, 
  51.          complete with the file containing this license information.  
  52.  
  53.          Any and all SuperK documentation must be included  with  the 
  54.          copy.  No fee,  charge or other compensation may be accepted 
  55.          or requested by any licensee.  
  56.  
  57.          SuperK may not be distributed in conjunction with any  other 
  58.          product without prior arrangements with Crater Rim Software. 
  59.  
  60.    Operators  of electronic bulletin board systems (Sysops) may post SuperK 
  61.    version 4.xx for downloading by their users only as long  as  the  above 
  62.    conditions are met.  
  63.  
  64.    Distributors  of public domain or user supported software may distribute 
  65.    copies of SuperK version 4.xx subject to the above conditions only after 
  66.    obtaining written permission from Crater Rim Software.  Such  permission 
  67.    usually is granted.  Please write or call for details.  
  68.  
  69.  
  70.                   ShareWare Software Discalaimer and Warranty
  71.  
  72.    Crater  Rim Software makes no warranty of any kind,  express or implied, 
  73.    including without limitation,  any warranties of merchantability  and/or 
  74.    fitness  for  a  particular  purpose.  Crater  Rim Software shall not be 
  75.    liable  for  any  damages,   whether  direct,   indirect,   special   or 
  76.    consequential  arising  from a failure of this program to operate in the 
  77.    manner desired by the user.  Crater Rim Software shall not be liable for 
  78.    any damage  to  data  or  property  which  may  be  caused  directly  or 
  79.    indirectly by use of the program.  
  80.  
  81.    IN  NO  EVENT WILL Crater Rim Software BE LIABLE TO YOU FOR ANY DAMAGES, 
  82.    INCLUDING  ANY  LOST  PROFITS,  LOST  SAVINGS  OR  OTHER  INCIDENTAL  OR 
  83.    CONSEQUENTIAL  DAMAGES  ARISING  OUT OF YOUR USE OR INABILITY TO USE THE 
  84.    PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY.  
  85.  
  86.    See the Ordering section for more information on registration, corporate 
  87.    licensing and similar topics.  
  88.  
  89.    WARNING:  YOU MAY NOT USE EITHER VERSION OF SuperK ON A REGULAR BASIS 
  90.              WITHOUT REGISTERING THE PACKAGE. 
  91.  
  92. = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
  93. SuperK External Protocol Driver - Revision Log
  94.  
  95. V2.50  - Dated 08/22/88  Initial Release
  96. V2.52  - Dated 09/01/88
  97. V3.10  - Dated 11/05/88
  98. V3.12  - Dated 12/04/88
  99. V3.13  - Dated 12/06/88
  100. V3.14  - Dated 12/27/88
  101. V3.15  - Dated 01/07/89
  102. V3.16  - Dated 01/26/89
  103. V4.00  - Dated 02/20/89
  104. V4.10  - Dated 03/29/89  Changes
  105.  
  106.    Modem Buffer size has been increased from 4K to 8K
  107.  
  108.    Sending  files  using  Super8K will now recognize the receipt of an XOFF 
  109.    from the modem.  Upon receipt,  SuperK will cycle for  about  5  seconds 
  110.    waiting for an XON from the modem or a user abort via the Esc or ^X key. 
  111.    Please  Note  that the XOFF/XON support is ONLY for use with MNP modems.  
  112.    The Super8K receiver software does not send the XOFF/XON. 
  113.  
  114.    It has been brought to my attention that the latest MS  Basic  compilers 
  115.    drop the RTS line when performing a DOS shell. SuperK now checks the RTS 
  116.    line upon startup and will raise it if it has been dropped. 
  117.  
  118.    There have also been some reports of memory errors when using SuperK  in 
  119.    EEMS memory...  I suspect that this may have been caused by a Stack/Heap 
  120.    collision  within SuperK.  To this end,  I have increased both the Stack 
  121.    and Heap.  Please check the new memory requirements to be sure that  you 
  122.    have  ample  memory available for SuperK to do its thing!  Please let me 
  123.    know if this problem still exists. 
  124.  
  125.    The  addition  of a Work Path so that SuperK can easily access Read Only 
  126.    files in a networking envirnment (see W - Work Path below). 
  127.  
  128.    Corrected a bug in the Overwrite check.  Under certain circumstances, an 
  129.    I/O error would occur if too many files were rejected by the receiver.
  130.  
  131. V4.11  - Dated 04/05/89  Corrected a minor bug in the ReadOnly copy routine
  132.  
  133. V4.12  - Dated 05/04/89  Changes
  134.  
  135.    In an effort to make Super8K a little more "bullet  proof",  I  reworked
  136.    then Super8K Error Recovery routines.
  137.  
  138.    There have been a number of users having problems with SuperK  reporting
  139.    a run time error of F0=xxxx.  This is due to the fact that SuperK cannot
  140.    find its overlay file, SUPERK.000. Seems there are some (antiquated) BBS
  141.    packages  that change directories before transferring a file!  When this
  142.    happens,  SuperK is unable to find its overalay (or the  SKA.COM  jmodem
  143.    module for that matter).  If this is happening to you,  be sure to start
  144.    up SuperK as   SUPERK @   and define  OVL Path  parameter  to  the  FULL
  145.    drive:\path\  where SUPERK resides.
  146.  
  147.    There are also reports that some BBS software is unable  to  "read"  the 
  148.    SuperK errorlevel returned upon exit. This is a problem with the calling 
  149.    program  NOT  with SuperK as the errorlevel returned is fully recognized 
  150.    by DOS via a batch file. 
  151.  
  152.  
  153. Memory requirements:
  154. ~~~~~~~~~~~~~~~~~~~   
  155.    Jmodem  transfers require a minimum of 125K (128,000 bytes).  All of the 
  156.    other protocols only require about 70K (71,680 bytes). If you don't know 
  157.    how much memory you have available, it can be checked easily as follows: 
  158.  
  159.    1)  Copy  DOS' CHKDSK.COM  to your comm directory.
  160.  
  161.    2)  Start up your comm program and execute the comm program's DOS  shell 
  162.        option. 
  163.  
  164.    3)  Type  CHKDSK  at the DOS prompt
  165.  
  166.    4)  CHKDSK  will display its results along with the "bytes free" figure. 
  167.        In order to perform Jmodem transfers,  the "bytes free" must  be  at 
  168.        least 128,000 (if you intend on using SuperK's Jmodem).
  169.  
  170.    5)  Enter "EXIT" at the DOS prompt.
  171.  
  172.    6)  Exit your comm program...
  173.  
  174.  
  175. Command Line Syntax:
  176. ~~~~~~~~~~~~~~~~~~~
  177.   SuperK Px Sbaud [Nx] [M] [R] [E] Dprotocol{by} F filespec filespec filespec
  178.  
  179. Command line parameters :
  180. ~~~~~~~~~~~~~~~~~~~~~~~
  181.    Px  - Comm Port to use.
  182.  
  183.        Where x = 1 or 2
  184.  
  185.    Sbaud - Modem Speed.
  186.  
  187.        Where baud = 300, 1200, 2400, 4800, 9600, 19200
  188.  
  189.    DirectionProtocol[b][y]
  190.    
  191.        Direction of transfer. Where D = R (receive) or S (send)
  192.           and Protocol X = Xmodem
  193.                        C = CRC Xmodem
  194.                        Y = Ymodem (1k Xmodem)
  195.                        W = WXmodem
  196.                        J = Jmodem
  197.                        K = K9Xmodem
  198.                        S = Super8K
  199.  
  200.               b = Perform  the  transfer  in  Batch  mode.  Note  that both 
  201.                   computers MUST be using SuperK or K9X in  order  for  the 
  202.                   Batch mode to be operational. 
  203.  
  204.               y = SuperK  allows  you to specify if you want overwriting of 
  205.                   existing files to be performed. By including a Y with the 
  206.                   Direction/Protocol  parameter,   the  default   overwrite 
  207.                   setting will be reversed during the current transfer. 
  208.  
  209.           In single file mode,  the J,  X,  C,  W and Y protocols are fully 
  210.           compatible with their counterparts  used  on  all/most  BBS  Both 
  211.           systems  must  be  using SuperK to invoke the K9Xmodem or Super8K 
  212.           Protocols. 
  213.  
  214.           Both y and b are optional.  The y overwrite reversal  only  works 
  215.           in Batch mode (when the b is also present).  If the b is omitted, 
  216.           SuperK defaults to single file mode 
  217.  
  218.           A brand new protocol!!!  As is the case  with  the  other  SuperK 
  219.           protocols,  the Super8K protocol itself may be executed in either 
  220.           Batch (SB parameter) or Single File  (S  parameter)  mode.  Along 
  221.           with a much improved throughput, the Super8K protocol also rounds 
  222.           file sizes up to the next higher 128 byte sector,  ala X/WXmodem, 
  223.           rather than the next higher 1K byte sector, ala Y/K9Xmodem. 
  224.  
  225.           Super8K uses an 8K block with a  1K  error  fallback/restart  and 
  226.           since it IS NOT a windowing protocol (like WXmodem and K9Xmodem), 
  227.           the  error/abort  response  time  is improved 1000 fold!  Super8K 
  228.           also passes the number of file sectors to the receiving system so 
  229.           a file size and transfer time (approxomate) is displayed on  both 
  230.           the sending and receiving systems. 
  231.  
  232.           Of course,  the Super8K protocol has its own colors so be sure to 
  233.           setup SuperK before you use it. 
  234.  
  235.           Since Super8K only does a byte count update each 8K,  the tranfer 
  236.           may  seem  to  be  taking a long time...  but in reality....  the 
  237.           following  SUPERK.LOG  extract  displays  the  preliminary   test 
  238.           results for each of the SuperK protocols and a test comparison to 
  239.           Zmodem  and  Jmodem.  These  tests  were run between two AT's via 
  240.           Null Modem cable.  Results via modem will probably  be  a  little 
  241.           lower accross the board. 
  242.  
  243.             Size    Speed      Cps       Errors   BlkSize    Protocol
  244.           --------------------------------------------------------------
  245.            60800   9600 bps   533 cps  0 errors   0  128   Xmodem   Batch
  246.            60800   9600 bps   769 cps  0 errors   0  128   WXmodem  Batch
  247.            61440   9600 bps   787 cps  0 errors   0 1024   Ymodem   Batch
  248.            61440   9600 bps   869 cps  0 errors   0 1024   K9Xmodem Batch
  249.            60707   9600 bps   861 cps  0 errors   0 1024   Zmodem
  250.            60800   9600 bps   965 cps  0 errors   0 8192   Super8K  Batch
  251.  
  252.            60707   2400 bps   223 cps  0 errors   0 1024   Jmodem
  253.            60707   2400 bps   222 cps  0 errors   0 1024   Zmodem
  254.            60800   2400 bps   262 cps  0 errors   0 8192   Super8K  Batch
  255.           ---------------------------------------------------------------
  256.  
  257.    M   - Monitor  Carrier,  abort  if  not  present.
  258.  
  259.        Including  this parameter allows you to use SuperK to transfer files 
  260.        between systems  via  null  modem  cable.  Default  is  ON  (Monitor 
  261.        Carrier). 
  262.  
  263.    Nx  - Node Letter or Number. Where x = A to Z  or  0 to 9
  264.  
  265.    E   - The  E parameter toggles the status of the "erase" flag.
  266.  
  267.        If specified on the command line, SuperK will not erase the BATCHLST 
  268.        file it creates when multiple filenames are specified on the command 
  269.        line (until the next time you specify multiple filenames, that is!) 
  270.  
  271.    R   - This Command Line Parameter is for use with RBBS-PC.
  272.  
  273.        RBBS-PC  utilizes  a  true  Batch  download  with a single file mode 
  274.        upload.  During uploads, RBBS-PC includes the full path and filename 
  275.        for the f paramter.  Since SuperK Batch modes are TRUE Batch in both 
  276.        downloads and uploads,  I have added the R command  line  switch  to 
  277.        tell  SuperK  that  the  F  parameter  may  (or  may  not) include a 
  278.        filename.  When SuperK sees the R parameter,  it will look  for  the 
  279.        last  \  or :  characters and parse all characters after that,  thus 
  280.        leaving just the path...  which it then appends to any uploads.  The 
  281.        default is True (non RBBS-PC) batch uploads. 
  282.  
  283.           RBBS command line for Batch Receive using K9Xmodem Batch
  284.  
  285.              SUPERK.COM p[PORT#] s[BAUD] r n[NODE] rkb f [FILE]
  286.  
  287.           RBBS command line for Batch Receive using K9Xmodem Batch
  288.  
  289.              SUPERK.COM p[PORT#] s[BAUD] r n[NODE] skb f [FILE]
  290.  
  291.           example:  RBBS-PC passes [FILE] as  C:\RBBS\99\filename.ext
  292.                     (or your defined upload path) during uploads
  293.  
  294.           exclusion  of the  R  command  line parameter  results in an 
  295.           invalid file specification of 
  296.  
  297.                    C:\RBBS\99\filename.ext\
  298.  
  299.           inclusion of the R command line parameter results in a valid file 
  300.           specification of 
  301.  
  302.                    C:\RBBS\99\
  303.  
  304.           for obvious reasons, if you use the R command line parameter, you 
  305.           must include the last \ or at least one superflous (non  \  or  : 
  306.           character) at the end of the F specification. 
  307.  
  308.           when using the R parameter...
  309.  
  310.             valid     C:\RBBS\99\*.*       results in   C:\RBBS\99\
  311.             valid     C:\RBBS\99\ABC.PAK   results in   C:\RBBS\99\
  312.             valid     C:\RBBS\99\          results in   C:\RBBS\99\
  313.             invalid   C:\RBBS\99           results in   C:\RBBS\
  314.             no f parameter                 results in   *.*  (all files saved
  315.                                                          in logged drive\dir)
  316.  
  317.           when using the default (non RBBS-PC)
  318.  
  319.             invalid   C:\RBBS\99\*.*       results in   C:\RBBS\99\*.*\
  320.             invalid   C:\RBBS\99\ABC.PAK   results in   C:\RBBS\99\ABC.PAK\
  321.             valid     C:\RBBS\99\          results in   C:\RBBS\99\
  322.             valid     C:\RBBS\99           results in   C:\RBBS\99\
  323.             no f parameter                 results in   *.*  (all files saved
  324.                                                          in logged drive\dir)
  325.  
  326.    F   - Filespecs Next
  327.  
  328.        This  parameter  acts  as  a  flag  for  SuperK and denotes that ALL 
  329.        parameters after the F are  to  be  interpreted  as  filenames.  For 
  330.        obvious  reasons,  this  parameter  should be the last one specified 
  331.        (before the filenames)! Each filename may contain a full path in the 
  332.        form: 
  333.  
  334.                  [d:\path\]Filename [d:\path\]Filename   to send/receive.
  335.  
  336.                                   or
  337.  
  338.        You may also specify the use of a text file  containing  a  list  of 
  339.        filenames.  Each filename in the list may contain a full path.  This 
  340.        option is specified as: 
  341.  
  342.                  @drive:\path\Filelist   (of files to Batch send.
  343.  
  344.                                   or
  345.  
  346.        You may want to use the second option for  file  lists...  that  is, 
  347.        include a second path where ALL of the files within the list reside. 
  348.        This option is specified as: 
  349.  
  350.                  @drive:\path\listfilename@drive:\path 
  351.  
  352.  
  353.    @   - Default Configuration Mode
  354.  
  355.        Modify  colors/logfile name/xferfile name/overlay path/options flags 
  356.        Clone SUPERK.COM if changes are made 
  357.  
  358.    The port, speed and direction/protocol parameters MUST be supplied... If 
  359.    operating in single file mode, the F parameter must be supplied.  The B, 
  360.    E, Y, M, N and R parameters are optional...  and the @ parameter is only 
  361.    used to  review/modify  the  default  settings  (see  modification  mode 
  362.    below). 
  363.  
  364.    The  direction R and S parameters are mutually exclusive (only one,  but 
  365.    not both). 
  366.  
  367.    Command Line parameters may be supplied as upper or lower case,  and may 
  368.    be  entered  in  any  order (except for the F paramter which must be the 
  369.    last one... before any filenames). 
  370.  
  371.  
  372. SK4.LOG 
  373. ~~~~~~~
  374.    SuperK will record transfer results to  the  logfile  in  the  following 
  375.    format: 
  376.  
  377. +--- Transfer Direction
  378. |  +------- File Size (0 if transfer fails)
  379. |  |      +---------- Modem Speed
  380. |  |      |         +---------- CPS efficiency (0 if transfer fails)
  381. |  |      |         |         +------------- Number of errors
  382. |  |      |         |         |            +-- Dummy for DSZLOG compatability
  383. |  |      |         |         |            | +----- Packet size in bytes
  384. |  |      |         |         |            | |    +--- Filename
  385. |  |      |         |         |            | |    |    Protocol ----++- Batch
  386. |  |      |         |         |            | |    |                 ||
  387. S  27648  1200 bps  108 cps   0 errors     0 1024 C:\DLS\SUPERK.PAK KB
  388.  
  389.  
  390. XFER.TXT 
  391. ~~~~~~~~
  392.    If  (and  only  if)  a Node character is specified OR a question mark is 
  393.    used within the XferFile name or SuperK Log file name,  SuperK will also 
  394.    create a Xfer Node File to show success/failure status messages. 
  395.  
  396.        This file has the following format :
  397.  
  398.                 Filename
  399.                 Upload   or   Download
  400.                 Protocol      (X/C/Y/W/K/S/XB/CB/YB/WB/KB/SB)
  401.                 Success  or   Fail
  402.                 EOF           (^Z)
  403.  
  404.            Sample:
  405.  
  406.                 SUPERK.PAK
  407.                 Download
  408.                 KB
  409.                 Success
  410.                 ^Z
  411.  
  412.    The  file  will  be created in the default directory if no drive/path is 
  413.    specified during the command line @ parameter modification  mode.  While 
  414.    in  batch  mode,  only the first file transfer results will be logged to 
  415.    this file.  However,  SUPERK.LOG will contain the results of  all  files 
  416.    transferred in the batch. 
  417.  
  418.  
  419. ErrorLevel Exits 
  420. ~~~~~~~~~~~~~~~~
  421.    For ease of use within batch files... in all cases, SupeK will exit with 
  422.    an ErrorLevel determined by the success of the transfer. 
  423.  
  424.    If  ALL transfers are successful,  SuperK will return an ERRORLEVEL 0 If 
  425.    ANY ONE transfer fails, SuperK will return an ERRORLEVEL 1 
  426.  
  427.  
  428. Command Line @ Parameter Modification Mode
  429. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  430.    Starting SuperK with the @ command line parameter will put  SuperK  into 
  431.    its  default  modification  mode.  SuperK will first display its current 
  432.    default settings and then prompt you for any changes  you  may  wish  to 
  433.    make.  Note  that  entering  a  blank line (simply hitting [Enter]) will 
  434.    leave the current setting intact.  SuperK  allows  modification  to  the 
  435.    colors it uses,  the logfile name, the xfer file name (for BBS use), the 
  436.    overlay path and certain operational flags. 
  437.  
  438.    C - Modifying colors:
  439.  
  440.        This one's easy!  After selecting the C option,  SuperK will display 
  441.        the  127 color palette that it supports.  Simply select a number for 
  442.        each of the 5  colors  used...  SuperK  will  cycle  through  all  5 
  443.        colors,  updating  the "current settings" accordingly.  If you don't 
  444.        want to change a current color setting,  simply hit the [Enter]  key 
  445.        and  SuperK  will move on to the next setting.  Note:  Jmodem window 
  446.        colors default to black text on a  white  background.  The  5  color 
  447.        types are: 
  448.  
  449.           Xcolors for Xmodem/Xmodem CRC/WXmodem transfers
  450.           Kcolors for K9Xmodem transfers
  451.           Ycolors for Ymodem transfers
  452.           Scolors for SuperK transfers
  453.           Ucolors for universal display of the SuperK logo and batch
  454.                       filenames
  455.  
  456.    D - Logfile Name:
  457.  
  458.        This  is  the  filename  SuperK  uses  to  record the results of any 
  459.        tranfers it performs.  SuperK will accept upto 40 characters so  you 
  460.        may  include  a  full  drive:\path\  along  with  the  logfile name. 
  461.        Additionally,  you may use a question mark (?) as one (and only one) 
  462.        of  the  logfile  name  characters.  If  a question mark is present, 
  463.        SuperK will substitute the Node character in its place.  If no  node 
  464.        character  is  specified,  SuperK  will  use  the letter A as a Node 
  465.        character.  The letter A is substituted ONLY if the question mark is 
  466.        encountered in the logfile name.  If  you  do  not  want  SuperK  to 
  467.        maintain a logfile, simply enter a backslash (\).. which will inform 
  468.        SuperK  to  blank out the logfile name.  The default logfile name is 
  469.        SK4.LOG 
  470.  
  471.    E - XferFile Name:
  472.  
  473.        This is the filename SuperK uses to record transfer results for  use 
  474.        by  BBS  programs.  Its  format and modification is identical to the 
  475.        Logfile Name. The default Xferfile name is XFER.TXT 
  476.  
  477.    F - OvlPath:
  478.  
  479.        Although in most cases,  you will be storing all of the SuperK files 
  480.        in  the  same  directory  as your comm/BBS program files,  there are 
  481.        cases where you may want to store them in a directory other than the 
  482.        logged directory.  This option allows you to do  this.  When  SuperK 
  483.        starts  up,  it  will  use  the  OvlPath  to locate its overlay file 
  484.        (SUPERK.000) and Jmodem module (SKA.COM).  You must supply the  full 
  485.        drive and path in which the SKA.COM, SUPERK.COM and SUPERK.000 files 
  486.        reside and all SuperK files MUST reside in this area.  If no OvlPath 
  487.        is defined,  SuperK will expect all of its files to  reside  in  the 
  488.        logged directory.  If,  after defining a path, you decide that it is 
  489.        NOT required,  simply enter a backslash \ for  the  new  path.  This 
  490.        will cause SuperK to null out any existing path. 
  491.  
  492.    G - Overwrite:
  493.  
  494.        This  flag  setting  tells  SuperK  whether  or not in can overwrite 
  495.        existing files during Batch mode transfers. The default is NO 
  496.  
  497.    H - Save Aborts:
  498.  
  499.        This flag setting tell SuperK whether or  not  it  should  keep  any 
  500.        partial  files  which were aborted during transfer.  This flag holds 
  501.        for any protocol - batch or single file mode. The default is YES 
  502.  
  503.    I - Write On 0:
  504.  
  505.        This flag setting tells SuperK whether or not it should  create  the 
  506.        XferFile  when  a  transfer  is  not  successfully completed and the 
  507.        uploaded file contains 0 bytes.  The status of this flag is the last 
  508.        check that  SuperK  makes  before  creating  the  XferFile.  A  node 
  509.        character  and XferFile Name must be specified before the Write On 0 
  510.        flag comes into play. The default is YES 
  511.  
  512.    P - Patch SKA.COM
  513.  
  514.        In order to  facilitate  the  use  of  JBatch  in  a  multinode  BBS 
  515.        environment  the  SK.COM  module  has  been  renamed  JBA.COM.  In a 
  516.        multinode BBS environement,  SuperK  requires  the  presence  of  an 
  517.        exclusive  copy  of  SKA.COM for each node.  Each SK module is named 
  518.        according to the BBS node it  supports  (SKA.COM  supports  node  A, 
  519.        SKB.COM supports node B, SK1.COM supports node 1, etc.). 
  520.  
  521.        In previous versions, there was a separate patching utility provided 
  522.        so  that you could patch SKA.COM (JBA.COM before).  SuperK v4.00 now 
  523.        provides an internal method of performing this  modification!  After 
  524.        selecting  this option,  SuperK will prompt you for the current name 
  525.        of the SKx.COM file and then prompt you for a new node character. 
  526.  
  527.        Upon making the patch, SuperK will rename the old SKx.COM file to SK 
  528.        + your new node character. 
  529.  
  530.        SuperK will strip the last character of the filename (the A in  SKA) 
  531.        and  insert  the node character in its place rename the SKA.COM file 
  532.        to SK + node character + .COM. 
  533.  
  534.        If no node character is specified on the SuperK command line (the  n 
  535.        parameter), SuperK will use the A character...  as you have probably 
  536.        surmised,  SuperK appends the node character (or temporary A) to the 
  537.        SK module (JBA, JBB, JB1, etc). 
  538.  
  539.        Caution...
  540.  
  541.        If  you  haven't any use for mutiple copies of SKA.COM,  simply copy 
  542.        SKA.COM down into your comm directory and use  it.  The  default  is 
  543.        SKA.COM 
  544.  
  545.    W - Work Path
  546.  
  547.        This  parameter  was  included  in order to supply a simple means of 
  548.        transferring files which have the Read Only attribute set. Since the 
  549.        Turbo Pascal compiler opens all files in a  Read  and  Write  state, 
  550.        SuperK  would experience an I/O error when attempting to open a Read 
  551.        Only file.  Since this problem is more  prevelant  in  a  networking 
  552.        environemnt...  and I didn't particularly care to have to revamp all 
  553.        of the SuperK file  read/write  I/O  routines...  This  option  will 
  554.        circumvent  the compiler problem for those users who wish to use the 
  555.        SuperK driver to send Read Only files. 
  556.  
  557.        By  specifying  a  work path here,  SuperK will create a copy of the 
  558.        requested download in this directory and then proceed  to  send  the 
  559.        copy.  Upon  completion  (or  abort) SuperK will erase the copy.  Of 
  560.        course,  you may use this feature regardless of the File's Read Only 
  561.        Attribute...  if  you  feel  insecure  at  having  SuperK access the 
  562.        "master" file,  set up a work path and SuperK.  If a  work  path  is 
  563.        specified,  it  MUST  be  a  complete path including a drive letter, 
  564.        colon, backspace, directory etc...  upto a maximum of 40 characters. 
  565.        As is the case with the SuperK support files, you may use a question 
  566.        mark  as  a  valid  character  within  the  path  string.  If SuperK 
  567.        encounters a question mark in the Work Path,  it will substitute the 
  568.        node  character  specified  on  the  command  line  or,  if  none is 
  569.        specified, SuperK will substitute an A for the question mark. 
  570.  
  571.        Valid Paths:
  572.  
  573.              Specifed                    Result
  574.  
  575.              C:\BBSWORK                  C:\BBSWORK\filename
  576.  
  577.              C:\NODE?WRK         if no node specified
  578.                                          C:\NODEAWRK\filename
  579.                                  if node 1 specified
  580.                                          C:\NODE1WRK\filename
  581.  
  582.              C:\BBS\NODE?        if no node specified
  583.                                          C:\BBS\NODEA\filename
  584.                                  if node 1 specified
  585.                                          C:\BBS\NODE1\filename
  586.        InValid:
  587.  
  588.              C:\NODE?WRK?        if no node specified
  589.                                          C:\NODEAWRK?\filename
  590.                                  if node 1 specified
  591.                                          C:\NODE1WRK?\filename
  592.  
  593.    [Enter] Quit:
  594.  
  595.        If  you  only wish to view the current default settings,  simply hit 
  596.        [Enter] to exit back to DOS.  If any changes have been made,  SuperK 
  597.        will go into its cloning mode and ask if you want to clone SuperK to 
  598.        preserve  the  new  changes.  Note  that you MUST press the Y key in 
  599.        order to clone SuperK.  Hitting [Enter] here will simply return  you 
  600.        to DOS without saving your changes within the SuperK program. 
  601.  
  602.  
  603. Program control keys
  604. ~~~~~~~~~~~~~~~~~~~~
  605.    SuperK  will recognize either the [Esc] key or ^X (control X) key during 
  606.    transfers and will abort the current transfer,  returning  you  to  DOS.  
  607.    Note  that  the  streaming  protocols  (Wxmodem,  K9Xmodem)  may require 
  608.    several [Esc] or ^X to abort the transfer and Jmodem/JBatch may  require 
  609.    a ^Break to abort the transfer. 
  610.  
  611.    I  have modified the Jmodem module (SKA.COM) to eliminate as much of the 
  612.    delays as possible... making the batch mode cycling quite "brisk"!  Note 
  613.    however  that there is a delay if the Jmodem transfer is aborted for any 
  614.    reason...  this is due to the fact that the buffers have to be "drained" 
  615.    before recycling. 
  616.  
  617. Batch transfers
  618. ~~~~~~~~~~~~~~~
  619.    SuperK is capable of sending and receiving multiple files in batch mode.  
  620.    Since  this  protocol  driver  was  written  for use with my MiniNet BBS 
  621.    package...  the sending of the file creation date (ala DSZ  and  Telink) 
  622.    tends  to  drive  me  up the wall,  creating quite a bit of confusion in 
  623.    keeeping track of newly acquired files! 
  624.  
  625.    For this reason the major difference between SuperK Batch mode and other 
  626.    Batch modes is that SuperK Batch only sends the File Name and File  size 
  627.    but does not send the file creation date. 
  628.  
  629.    During  Batch  mode  transfers,  SuperK  will  display  the last 3 files 
  630.    requested under the SuperK logo so that you may have a running update of 
  631.    what's happening.  The present transfer progress is displayed in its own 
  632.    window alongside the SuperK logo. 
  633.  
  634.    SuperK is able to handle multiple filenames on  the  command  line.  The 
  635.    command  syntax  remains  the  same  but  if  more  than one filename is 
  636.    specified, SuperK will create its own BATCHLST file. If a Node character 
  637.    is specified on the command line,  that character will be used  for  the 
  638.    extension  of  BATCHLST.  The  default  is  "A"  if no node character is 
  639.    specified. 
  640.  
  641.    The number of filenames that can be specified  will  depend  largely  on 
  642.    your own particular system setup, the string length used by your calling 
  643.    program and the individual filename lengths. 
  644.  
  645.    This   feature  is  only  active  while  in  Batch  Send  Mode  (receive 
  646.    automatically gets filename from sender),  the command  line  paramaters 
  647.    can be in any order,  NO WILDCARDS ARE ALLOWED,  the first filename MUST 
  648.    be preceeded by an F (upper or lower case) and EACH filename may include 
  649.    a full path. 
  650.  
  651.    Your command line should look like this...
  652.  
  653.          SUPERK p1 s9600 SWB f FILE1 FILE2 FILE3
  654.  
  655.    Since the BATCHLST is created internally (by SuperK),  SuperK will erase 
  656.    the  BATCHLST  file once it is done with it...  You may override this by 
  657.    including an E as one of the command line parameters.  The  E  parameter 
  658.    toggles  the  status  of  the "erase" flag.  If specified on the command 
  659.    line,  SuperK will not erase the BATCHLST file (until the next time  you 
  660.    specify multiple filenames, that is!) 
  661.  
  662.  
  663.    Receiving files in Batch mode
  664.    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  665.       You  do  not  have to supply any filename during batch mode receives. 
  666.       You may of  course,  include  a  full  drive:\path\  in  place  of  a 
  667.       filename.  Use  the F command line parameter to designate the path in 
  668.       the form:  f C:\FOO\BAR (with or  without  the  trailing  backslash).  
  669.       And...  DO  NOT  specify  the  f  parameter if no path or filename is 
  670.       specified. 
  671.  
  672.  
  673.    Sending files in batch mode
  674.    ~~~~~~~~~~~~~~~~~~~~~~~~~~~   
  675.       You  may  use  any  valid  DOS  wildcard  configuration  with  the  F 
  676.       parameter. 
  677.  
  678.       Additionally, you may specify a list of filenames for SuperK to send.  
  679.       The list filename is specified as 
  680.        
  681.               @drive\:path\listfilename
  682.  
  683.       You may also specify a full drive:\path\ to where all of the files in 
  684.       the list reside. This is specified as 
  685.  
  686.               @drive:\path\filelist@drive:\path
  687.  
  688.       The  filenames  in the list may contain a full drive:\path\ (the same 
  689.       or different) for each filename. 
  690.  
  691.    SuperK is capable of reading and extracting filenames from a standard  - 
  692.    single  line  - BBS files listing.  If you use a BBS type files listing, 
  693.    and call SuperK from the comm or BBS directory, you will have to add the 
  694.    full drive:\path\ to each filename in the list if the files to  send  do 
  695.    not  reside in the default directory.  There are other ways of accessing 
  696.    files that reside in directories other than the default (default  upload 
  697.    and download directories,  etc.),  but I won't go into this area as most 
  698.    comm and BBS programs do this work for you (K9X does it ALL  for  you... 
  699.    automatically!) 
  700.  
  701.  
  702. Examples
  703. ~~~~~~~~
  704.    1.  Use COM1, 1200 baud, Xmodem, Send files MYFILE.DOC and FILE.COM
  705.  
  706.         SUPERK p1 s1200 SX f MYFILE.DOC FILE.COM
  707.  
  708.    2.  Use  COM2,  19200  baud,  Ymodem Batch,  Receive file *.DOC,  do not 
  709.        monitor carrier, override the default "do not overwrite". 
  710.  
  711.         SUPERK p2 s19200 m RYBY
  712.  
  713.        Note: The  protocol  character  must  follow  the  direction R.  The 
  714.              second Y above is the override for the overwrite flag.  The  B 
  715.              and  second Y may be in any order just as long as they are the 
  716.              third and fourth characters in the Direction parameter. 
  717.  
  718.    3.  Use COM1,  9600 baud,  K9Xmodem Batch Send files in MYLIST.LST which 
  719.        resides  in  my  C:\BBS\  directory.  The files listed in MYLIST.LST 
  720.        reside in various directories on different drives.  Do  not  monitor 
  721.        carrier and record success results to Node A of my BBS. 
  722.  
  723.         SUPERK p1 s9600 SKB m nA f @C:\BBS\MYLIST.LST
  724.  
  725.         C:\BBS\MYLIST.LST looks like this:
  726.  
  727.           ABC.PAK              (this one resides in the default directory)
  728.           D:\FOO\BAR\MYGAME.EXE
  729.           E:\LOTUS\123GRAPH.PAK
  730.  
  731.        XFER.TXT (or XFERA.TXT if ?  specified in the default xferfile name) 
  732.        will reflect the results of the transfer.  Note that only the  first 
  733.        filename  and  its  transfer  results  will  be present in XFER.TXT.  
  734.        SUPERK.LOG will however, contain the results of all three files. 
  735.  
  736.    4.  Use COM2,  19200 baud,  K9Xmodem Batch Send only files containing an 
  737.        PAK extension and residing in my C:\DLS directory, and don't monitor 
  738.        carrier. 
  739.  
  740.         SUPERK p2 s19200 SKB m f C:\DLS\*.PAK
  741.  
  742.    5.  Use COM2,  19200 baud,  K9Xmodem Batch Receive files - store them in 
  743.        my C:\DLS directory. 
  744.  
  745.         SUPERK p2 s19200 RKB f C:\DLS
  746.  
  747. Batch Files
  748. ~~~~~~~~~~~
  749.    There are sample batch files included in SUPERK.PAK 
  750.  
  751.        SEND.BAT  - this batch file is set up for sending file(s) to
  752.                    another system
  753.  
  754.        RECV.BAT  - this batch file is set up to receive file(s) from 
  755.                    another system
  756.  
  757.    Executing any one of the batch files  without  any  parameters  (or  the 
  758.    wrong  parameter)  will  display  a  short  message  showing the correct 
  759.    calling procedure and parameter choices.  Since these batch files handle 
  760.    transfers in either Send or Receive mode and single or batch  mode,  you 
  761.    will have to supply the proper information in order to have them perform 
  762.    correctly. 
  763.  
  764.  
  765. NOTE: If you are operating a MiniNet BBS v18.00 or above... or K9X v8.xx or 
  766.       above...  access to SuperK is handled internally and does not require 
  767.       the use of the batch files. 
  768.  
  769.       If you are not... please read the enclosed PRODUCTS.TXT file...  It's 
  770.       worth a look! 
  771.  
  772.       For pure BBS'ing, K9X can't be beat! 
  773.  
  774.  ------------------------------------------------------------------------------
  775.    I  have  been using this protocol driver on Underdog's MiniNet for quite 
  776.    some time now.  If you need more information  on  the  various  transfer 
  777.    protocols,  please  get  a  copy of K9X (my comm program) and review the 
  778.    K9X.DOC file contained in that package.  All suggestions are  gratefully 
  779.    received and reviewed! Let me know... 
  780.  
  781.  
  782.                    Sal Manaro  dba  Crater Rim Softare
  783.                            4028 41st Ave South
  784.                           Seattle, Wa 98118 USA
  785.                           (206) 723-6728  voice
  786.  
  787.                    Underdog's MiniNet  (206) 725-9233
  788.                 1200/2400/9600  24hrs   600 megs OnLine
  789.                 Supporting 22 files transfer protocols!
  790.  
  791.                            Enjoy,
  792.                                Sal Manaro
  793.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  794.     N O T I C E    N O T I C E    N O T I C E    N O T I C E    N O T I C E
  795.  
  796.     Due to the amount of time and money I have spent setting up SuperK  for 
  797.     use  with  your  Comm/BBS  programs,  I am requesting that this and all 
  798.     subsequent  versions  of  SuperK  be  registered  so  that  I  may   be 
  799.     compensated  for the many hours I have spent developing,  modifying and 
  800.     setting up this protocol driver.
  801.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  802.  
  803.                       LET YOUR PRINTER DO ALL THE WORK!!!
  804.           -------------------  INSTANT MAILER  ----------------------
  805.           Please support quality shareware by registering your copies
  806.                          We thank you for your support!
  807.  
  808.   Remit To:  Sal Manaro  dba  Crater Rim Software           SuperK Order Form
  809.             4028  41st Ave. South
  810.             Seattle, WA  98118 USA
  811.  
  812.   Quantity Discount Schedule (per purchase).  Each:
  813.  
  814.      1-10      $20.00        11-49     $18.00         50-99   $15.00
  815.      100-199   $12.00        200-499   $10.00         500+    $ 8.00 
  816.  
  817.   Please send the ShareWare Evaluation version 4.00 
  818.   -------------------------------------------------
  819.     ____ SuperK Disk(s) without registration ...... @ $  8.00 ea. $ _______
  820.  
  821.   I would like to register the copy I already have:
  822.   ------------------------------------------------
  823.     ____ SuperK Registration(s) Only .............. @ $ 15.00 ea. $ _______
  824.  
  825.   Please register and send the latest version:
  826.   -------------------------------------------
  827.     ____ SuperK Registration(s) and Disk .......... @ $ 20.00  or $ _______
  828.  
  829.  
  830.     PO, Rush and COD orders add $5.00 ........................... $ _______
  831.  
  832.                                                         Subtotal    _______
  833.  
  834.            (Washington residents please add  8%  sales tax)  Tax    _______
  835.  
  836.                                                             Total $ _______
  837.  
  838.   Payment by:  ( ) Check    ( ) Money Order    ( ) PO # ___________________
  839.   Use address on check ( ) or mail to:
  840.  
  841.        Name: ______________________________________________________________
  842.  
  843.     Company: ______________________________________________________________
  844.  
  845.     Address: ______________________________________________________________
  846.  
  847.            : ______________________________________________________________
  848.  
  849.            : ______________________________________________________________
  850.  
  851.   Day Phone: (______)__________________ Eve: (______)______________________
  852.  
  853.   ORDERS OUTSIDE USA: Use Check or Money Order drawn on US bank in US dollars
  854.           -------------------  INSTANT MAILER  ----------------------
  855.                                                                                 
  856.   Fold  at  the  page break below with the printing above facing up and the 
  857.   mailing label below folded underneath.  Staple check to the mailer,  fold 
  858.   letter  style,  exposing the mailing address and hiding your information. 
  859.   Fold sides along dotted line and staple or tape sides and top. 
  860.                                                                                 
  861.                                                                               
  862.    |_________________________________                                Place   |
  863.    |                                                                         |
  864.    |_________________________________                                Stamp   |
  865.    |                                                                         |
  866.    |_________________________________                                Here    |
  867.    |                                                                         |
  868.    |                                                                         |
  869.    |                                                                         |
  870.    |                                                                         |
  871.    |                                                                         |
  872.    |                                                                         |
  873.    |                                     Crater Rim Software                 |
  874.    |                                     4028  41st Ave South                |
  875.    |                                     Seattle WA  98118  USA              |
  876.    |                                                                         |
  877.    |                                                                         |
  878.    |                                                                         |
  879.    |                                                                         |
  880.  
  881.