home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / hqwk52dm / hqwk52 / docs / holoqtec.asc < prev    next >
Text File  |  1994-05-21  |  7KB  |  200 lines
  1.  
  2.  
  3.    A few explanations on working practices and other anomalies
  4.    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  5.  
  6.  
  7.  
  8.  
  9.                            Sleep timer
  10.                            ~~~~~~~~~~~
  11.  
  12.      The sleep timer is accurate to within 2 seconds for each
  13.      of the three phases :
  14.  
  15.           Phase One : Two minutes of inactivity after which the
  16.                       user is prompted for some action.
  17.           Phase Two : Thirty seconds of further inactivity prompts
  18.                       the user again.
  19.         Phase Three : Following another thirty seconds of
  20.                       inactivity the system saves the users
  21.                       current profile and also lastread pointers
  22.                       and then returns them to the BBS, exiting
  23.                       with an error level of '3'.
  24.  
  25. When the user is exited from the system in this manner the modem
  26. is not instructed to drop carrier - this is left to either the
  27. BBS or perhaps a third party program by utilising the error
  28. levels from HoloQWK.
  29.  
  30.  
  31.  
  32. -------------------------------------------------------------------------
  33.  
  34.  
  35.  
  36.                            MaxPktSize
  37.                            ~~~~~~~~~~
  38.  
  39.      The setting that the user wishes to set this pointer to is
  40.      used when HoloQwk performs Batch mode, if an existing packet
  41.      for the user is detected then it's size is compared with
  42.      this value, and then only if this existing packet exceeds
  43.      the defined limit is Batch mode disabled.
  44.  
  45.      Packet sizes are not compared during or after Batch mode and
  46.      so it is quite possible for a user to select (for instance)
  47.      a 5k limit and for the system to create a packet of 300k.
  48.  
  49.      By judicious use of not only this pointer, but also Lock
  50.      Messages it is possible for a user to efficiently maintain a
  51.      reasonable level of packet size, however, by not
  52.      understanding completely what happens during Batch mode a
  53.      user can quite soon be put off by extremely large packets -
  54.      it is in your interest to help your users as much as
  55.      possible during thier first dealings with QWK packers.
  56.  
  57.  
  58.  
  59.                            Local Mode
  60.                            ~~~~~~~~~~
  61.  
  62.  
  63.  
  64.  
  65.                             HQWKDOOR
  66.                             ~~~~~~~~
  67.  
  68.           In order to keep this program as small and as quick as
  69.           possible there are no fileselectors used in local mode
  70.           - in order to test HoloQwk it is necessary to use the
  71.           main system.
  72.  
  73.  
  74.  
  75.  
  76.                              HOLOQWK
  77.                              ~~~~~~~
  78.  
  79.           When performing both uploads and downloads in local
  80.           mode you are presented with a fileselector so that you
  81.           may locate the source/destination of your packets.
  82.  
  83.           If you have enough free memory then the screen is
  84.           redrawn to its previous contents after the
  85.           fileselector, this is purely cosmetic.
  86.  
  87.  
  88.  
  89. -------------------------------------------------------------------------
  90.  
  91.  
  92.  
  93.                              Timings
  94.                              ~~~~~~~
  95.  
  96.      Timing estimates calculated from previous archiving times
  97.      are shown to the user prior to archiving online, the actual
  98.      time taken is displayed after archiving.
  99.  
  100.      Estimates are only calculated when archiving in excess of
  101.      150 messages takes place and so it may be some while before
  102.      estimates are displayed, although time taken is displayed in
  103.      each case no matter how many messages were archived.
  104.  
  105.      Three separate estimates are kept, one for each archiver.
  106.  
  107.  
  108.                           System Files
  109.                           ~~~~~~~~~~~~
  110.  
  111.      During normal operation a number of files are created by
  112.      HoloQwk within its own folder :
  113.  
  114.      HOLOQWKC.BAK - This is a copy of the HOLOQWK.CTL file that
  115.                     has been backed up prior to rewriting with
  116.                     new timing estimates - it is not normally
  117.                     used for anything but is a security measure.
  118.  
  119.      HOLOQWK.DAX  - This is a copy of the HOLOQWK.DAT file that
  120.                     has been backed up prior to rewriting after
  121.                     you have changed user details with EDITOR.PRG
  122.  
  123.      There are three optional files that you may or may not have
  124.      present in the HoloQwk folder :
  125.  
  126.      HOLOQWK.TAG  - This is an ASCII file containing tag lines
  127.                     used in the generation of AutoTags if that
  128.                     option is selected by the user.
  129.  
  130.                     If this file is not present then although the
  131.                     AutoTags option is still shown to the user it
  132.                     cannot be selected.
  133.  
  134.                     The .TAG file is held in memory during all
  135.                     normal HoloQwk operations and so if you are
  136.                     experiencing low memory problems try cutting
  137.                     this file down from 600k !
  138.  
  139.      HOLOQWK.HLP  - This is an ASCII file that can be displayed
  140.                     to the user from the main HoloQwk menu, if it
  141.                     is not present at startup then the option is
  142.                     not shown to the user.
  143.  
  144.                     The file can be as long as you wish and is
  145.                     displayed to the user with prompts at the end
  146.                     of each page.
  147.  
  148.      HOLOQWK.GRP  - This is the binary file written by the
  149.                     GROUPED program, if it is not present then
  150.                     conferences will be displayed in numerical
  151.                     order instead of groups.
  152.  
  153.      HOLOQWK.SYN  - This is a binary file used internally.
  154.                  It must NOT be deleted.
  155.  
  156.                           NEWFILES.PRG
  157.                           ~~~~~~~~~~~~
  158.  
  159.      This program is used to generate a NEWFILES.DAT file that is
  160.      written into the users QWK packets should they have it
  161.      enabled. A new version is currently available that MUST be
  162.      used - it uses the new QWKUSER.INF format file that is
  163.      written into the QBBS folder from where you must obviously
  164.      set NEWFILES.PRG to read it from.
  165.  
  166.      NEWFILES.PRG was written by Robert Darling and is available
  167.      from his BBS 24Hours a day - Folkestone Qbbs +44-303-249306.
  168.      Not using the new format NEWFILES.PRG will result in
  169.      erroneous NEWFILES.DAT files.
  170.  
  171. -------------------------------------------------------------------------
  172.  
  173.  
  174.                              Colour
  175.                              ~~~~~~
  176.  
  177.      Colour is used to highlight certain lines during the
  178.      operation of HoloQwk. ANSI, VTM and also VTC are used
  179.      depending on the users profile within QBBS.
  180.  
  181.      For display to the console both the graphic mode selected on
  182.      the BBS and also the resolution is used to decide wether to
  183.      send colour or inverse blocks to the screen.
  184.  
  185.      The users name displayed at the top of the main HoloQwk menu
  186.      is shown only to console, the users should know who they are !
  187.  
  188.  
  189.  
  190.                         Console override
  191.                         ~~~~~~~~~~~~~~~~
  192.  
  193.      All key presses from the console take preference over the
  194.      users activity, this means you can 'walk' a user through the
  195.      system should the need arise.
  196.  
  197.      This does not mean the user gets locked out, just that you
  198.      have the ability to press the keys for them.
  199.  
  200.