home *** CD-ROM | disk | FTP | other *** search
/ CBM Funet Archive / cbm-funet-archive-2003.iso / cbm / c128 / archivers / nzp12811.sfx / qpe.bas.docs < prev    next >
Text File  |  1990-02-12  |  13KB  |  331 lines
  1.                 QPE v1.1 (C)1994 by David Schmoll: 04-25-94
  2.  
  3.  
  4.       =====================================================================
  5.       =                               QPE                                 =
  6.       =====================================================================
  7.       
  8.     COPYRIGHT:
  9.       
  10.       I   have  decided  to  distribute  QPE  as  FREEWARE  with  the  only
  11.       requirement  that  the  distribution of this software be left in it's
  12.       original distibution form.
  13.       
  14.       David Schmoll
  15.       1703 Pagosa Way
  16.       Aurora, Colorado 80011
  17.       USA
  18.       
  19.       I  am  currently also available on the CBM and CBM-128 FIDO Echo's to
  20.       answer  any  questions or suggestions you may have. I am able to send
  21.       and receive Internet mail at the below address as well.
  22.       
  23.       david.schmoll@f518.n104.z1.fidonet.org
  24.       
  25.       Netmail can be received at 1:104/518
  26.       
  27.       Please do not distribute this program except in the original archive!
  28.       
  29.       ---------------------------------------------------------------------
  30.       
  31.     PROGRAM DESCRIPTION V1.1:
  32.       
  33.       QPE  IS A BASIC program written to interface with the offline Readers
  34.       QWKRR128  and  QWKie 64 to create a more automated process of dealing
  35.       with  your  QWK mail packets. You have the choice to un-ZIP (see note
  36.       1)  or un-ARC (see note 2) your QWK packets - the archive type is now
  37.       auto-detected. When QPE is run and the unpacking process is complete,
  38.       either  QWKRR128  is executed if you are in 128 mode, or  QWKie 64 is
  39.       executed if you are in 64 mode.
  40.       
  41.       * NOTE 1: Permission has been requested from Bill Lucier to allow the
  42.       release  of  a  special  64  unZIP  module  that  runs under QPE, but
  43.       permission  has  not  been  given  as  of yet, so for now the only 64
  44.       option  is to use the CSX64.ml to un-ARC the QWK packets. If and when
  45.       permission  is  granted,  the 64 module can then be interfaced to QPE
  46.       will  no  further  modifications.  I have offered this module to Bill
  47.       Lucier  so  he  can release it himself if that is more acceptable. As
  48.       QPE is written it expects the 64 module to be called unzip4.ml.
  49.       
  50.       *  NOTE  2:  To  un-ARC  packets  you  need a separate program called
  51.       CSX01.SDA  (written  by  Chris  Smeets  -  see note 3). Included with
  52.       CSX01.SDA  are  two  machine  language  modules  called  CSX64.ML and
  53.       CSX128.ML  You  need to copy these over to the same disk or partition
  54.       as QPE is on - nothing else is required.
  55.       
  56.       *  NOTE 3: No part of CSX01.SDA may be distributed in any form except
  57.       the  original  .SDA  without  the  expressed  consent  of the current
  58.       copyright  holder  (Parsec). CSX01, CSX64.ML, CSX128ML, CSX01.SDA are
  59.       not part of the UNZIP128 distribution package, and must be downloaded
  60.       separately.
  61.  
  62.  
  63.  
  64.                                                                      Page 1
  65.  
  66.  
  67.                 QPE v1.1 (C)1994 by David Schmoll: 04-25-94
  68.  
  69.  
  70.       ---------------------------------------------------------------------
  71.       
  72.     FIRST TIME:
  73.       
  74.       The  first  time  QPE  is  run, you will see a listing of the current
  75.       configuration along with the prompt "Accept Defaults". The very first
  76.       time  you run QPE, answer no to this default, since QPE does not know
  77.       your  needs. This will bring up individual prompts so you can set you
  78.       own  defaults. If you do not give any response, QPE will autostart in
  79.       10  seconds  (see autostarting), accepting whatever defaults that are
  80.       set  -  whether they are correct or not! It is your responsibility to
  81.       answer  the  prompts  correctly, as QPE has no way of knowing when an
  82.       error has been made. The archive type is now auto-detected by reading
  83.       the  first two bytes of the QWK packet and comparing it to "pk". If a
  84.       match  is  made then the packet is assumed to be ZIP, otherwise it is
  85.       assumed  to  be  an  ARC.  Another  change is that input file type no
  86.       longer matters.
  87.       
  88.     AUTOSTARTING:
  89.       
  90.       There  is a 10 second countdown timer displayed on the screen showing
  91.       you  how  much  time  is  left  before  QPE  will  accept the current
  92.       defaults,  and  then  proceed  to  unpack  the QWK packet and run the
  93.       appropriate  OLR.  To  stop  this  timer  just  answer  no to "Accept
  94.       Defaults"  before  it  reaches  0  - you can also start the unpacking
  95.       sooner by answering yes to the prompt instead.
  96.       
  97.     PROMPTS:
  98.       
  99.       The  prompts  you  will see when you are setting your defaults are as
  100.       follows:
  101.       
  102.     CRC CHECKING:
  103.       
  104.       This  prompt  now shows up regardless of whether the input file is an
  105.       ARC  or  ZIP file, because the archive type isn't known at this time,
  106.       but  it  is  only  valid  on Zipped packets. This is a file integrity
  107.       checksum  (after  the  file is unzipped) and can be turned on or off.
  108.       Even  if  a  CRC errors happen, the offline readers seem to work just
  109.       fine,   so  the  importance  of this information and choice is yours.
  110.       Answer "y/n".
  111.       
  112.       One  reason  to  turn  off CRC checking is if you want to run the OLR
  113.       regardless of the result of the CRC check.
  114.       
  115.       *  Note:  Any  error during the unpacking will cause QPE to stop when
  116.       control  is returned to BASIC and before control is given to the OLR.
  117.       Should  an  error occur during the unpacking and you wish to continue
  118.       (only recommended with a CRC error), you can type in "cont" and press
  119.       return, and the appropriate OLR will then load and run - this applies
  120.       to  both  the  un-ARC  and un-ZIP option. Make sure you see the BASIC
  121.       "ready"  prompt  before  typing in "cont" and pressing return! If any
  122.       other  error  occurs, besides a CRC, try running QPE again, and if an
  123.       error occurs again, something is wrong with the QWK packet.
  124.       
  125.     FILE TO UNPACK:
  126.       
  127.  
  128.  
  129.  
  130.                                                                      Page 2
  131.  
  132.  
  133.                 QPE v1.1 (C)1994 by David Schmoll: 04-25-94
  134.  
  135.  
  136.       This  is  the name of the QWK packet that you downloaded. The .ARC or
  137.       .ZIP  extension  is  no  longer  needed  unlike  the  full version of
  138.       UNZIP128 ie: "qwk mail" works fine
  139.       
  140.     MAXIMUS KLUDGE:
  141.       
  142.       Sometimes  when  you  have  downloaded  from  a  Maximus BBS, a extra
  143.       chr$(0)  needs  to  be  appended  to  the QWK packet before it can be
  144.       successfully  unpacked.  So  if  you  have  unpacking  problems,  try
  145.       answering yes to this prompt. Answer "y/n".
  146.       
  147.     ACCEPT QWKRR DRIVES:
  148.       
  149.       You will only see this when QPE is run in 128 mode, and it allows you
  150.       to  bypass  the usual drive prompts that QWKRR128 asks for and accept
  151.       whatever is defined in the QWKRR128 default file. Answer "y/n".
  152.       
  153.     AUTO-INDEX:
  154.       
  155.       You will only see this when QPE is run in 128 mode, and it allows you
  156.       to automatically trigger the indexing function when starting QWKRR128
  157.       Answer "y/n".
  158.       
  159.     INPUT DEVICE:
  160.       
  161.       This  is  the  drive unit where the QWK packet that you downloaded is
  162.       located.
  163.       
  164.     INPUT PATH:
  165.       
  166.       This  is  the  drive path where the QWK packet that you downloaded is
  167.       located.  Non  CMD  users will use drive 0, while CMD users will give
  168.       the  path  location,  such  as  "3//wherever/". Do not add the ending
  169.       colon  as that will be appended for you to overcome the error message
  170.       that BASIC will give you should you include one.
  171.       
  172.     OUTPUT DEVICE:
  173.       
  174.       This  is  the  drive  unit  to where the extracted files from the QWK
  175.       packet are to be extracted.
  176.       
  177.     OUTPUT PATH:
  178.       
  179.       This  is  the  drive  path  to where the extracted files from the QWK
  180.       packet are to be extracted. Non CMD users will use drive 0, while CMD
  181.       users will give the path location, such as "3//wherever/". Do not add
  182.       the  ending  colon  as  that will be appended for you to overcome the
  183.       error message that BASIC will give you should you include one.
  184.       
  185.     OLR DEVICE:
  186.       
  187.       This  is  the  drive  unit  number where, depending on computer mode,
  188.       either QWKRR128 or QWKIE 64 is located.
  189.       
  190.     OLR PATH:
  191.       
  192.       This  is  the  drive  path  where, depending on computer mode, either
  193.  
  194.  
  195.  
  196.                                                                      Page 3
  197.  
  198.  
  199.                 QPE v1.1 (C)1994 by David Schmoll: 04-25-94
  200.  
  201.  
  202.       QWKRR128  or  QWKie  64  is  located. Non CMD users will use drive 0,
  203.       while  CMD users will give the path location, such as "3//wherever/".
  204.       Do  not  add  the  ending  colon  as that will be appended for you to
  205.       overcome  the  error  message  that  BASIC  will  give you should you
  206.       include one.
  207.       
  208.       
  209.       
  210.     SET CONTROL.DAT TIME:
  211.       
  212.       This  is  only seen when QPE is run in 128 mode, and it gives you the
  213.       option  when  using QWKRR128 to set the date from the control.dat, in
  214.       case you do not have a Real Time Clock (RTC) available. Answer "y/n".
  215.       
  216.     SAVING CONFIGURATION:
  217.       
  218.       After  the  options  are set, you can save the changes to disk if you
  219.       desire  to,  otherwise  the changes are for the current session only.
  220.       When  the  changes  are  saved, the entire program QPE is saved using
  221.       dynamic  keyboard  methods; so beware of renumbering QPE, as this can
  222.       cause  problems during the save, otherwise minor changes are possible
  223.       to QPE to meet your needs! The program saved is called QPE, while the
  224.       master  version  is called QPE.BAS. This prevents you from destroying
  225.       the original should something go wrong!
  226.       
  227.     FILES INSIDE THE PACKET:
  228.       
  229.       The  files  inside  of  the QWK packet can vary by BBS, and the files
  230.       needed  depend  on  whether you are using QWKRR128 or QWKie. QWKRR128
  231.       only  needs  the  files "CONTROL.DAT" and "MESSAGES.DAT", while QWKie
  232.       needs  the  files "CONTROL.DAT", "MESSAGES.DAT", and the files ending
  233.       in  ".NDX". To save BASIC memory space and simplify programming logic
  234.       all  files  inside  the QWK packet are extracted, regardless of their
  235.       importance.  The  best  way to avoid this situation, is to see if you
  236.       can  exclude  the files that you do not need from the QWK packet when
  237.       you  define your offline reader settings on the BBS. In my experience
  238.       the  added  files are usually very small, so their extraction doesn't
  239.       really consume much time anyway.
  240.       
  241.     PATH WARNINGS:
  242.       
  243.       QPE, CONTROL.DAT, AND  MESSAGE.DAT do not need to be on the same disk
  244.       or  partition  as  either QWKRR128 or QWKie 64, but be aware that the
  245.       current  version  of  QWKie  doesn't  recognize  CMD paths, so if you
  246.       unpack  to a sub-partition that is not the current partition as well,
  247.       QWKie  64  will  not automatically see it until you make that path or
  248.       partition the current one. Fortunately, this can be accomplished with
  249.       the QWKie Dos command (wedge) very easily.
  250.       
  251.       The  path  information  is  for CMD drives only (Ramlink, Hard drive,
  252.       Ramdrive,  and FDx000) and does *NOT* support 1581 partitions. If CMD
  253.       path  information  is entered, the it must follow the general form of
  254.       "x//wherever/"   -  where  x is the actual partition number, the "//"
  255.       means  start  from the root partition, "wherever" is the subdirectory
  256.       name,  and  it  must end with a "/".  The ending "/" is a change from
  257.       the earlier verion of QPX by Russell Prater!
  258.       
  259.  
  260.  
  261.  
  262.                                                                      Page 4
  263.  
  264.  
  265.                 QPE v1.1 (C)1994 by David Schmoll: 04-25-94
  266.  
  267.  
  268.       Alternately,  the  0  in  the  path becomes the drive number that the
  269.       other  Commodore  drives understand, and no error checking is done if
  270.       things are wrong.
  271.       
  272.       A ":" is appended to either path style to complete the path name!
  273.       
  274.     MEMORY USAGE:
  275.       
  276.       Memory  usage for the special 128 UNZIP modules is currently: $1300 -
  277.       $1bff, $3400 - $3fff and $0400 - $0801. QPE memory usage will use any
  278.       normal  basic  area  not  used  by  the ML or buffers. Memory for the
  279.       buffer storage needed by the all of the UNZIP modules is from $4000 -
  280.       $ffff.  When  running  in 64 mode, QPE will set the top of free basic
  281.       memory  to  $28ff  so  variable  memory  is  not corrupted during the
  282.       unzipping   -  otherwise  the ability to call QWKie would not then be
  283.       possible - note this is also due to the potential memory usage of the
  284.       unreleased 64 unzip module which is currently from $2900 - $3fff.
  285.       
  286.       *  NOTE:  Zero  page  is  saved  to  $3f00 when the unZIP modules are
  287.       called,  to  avoid  corruption,  and  then  restored  when control is
  288.       returned to QPE.
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.                                                                      Page 5
  329.  
  330.  
  331.