home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / holoqwk3 / holoqwk / holoqwk.asc < prev    next >
Text File  |  1994-01-25  |  23KB  |  513 lines
  1.  
  2.  
  3.                             SHAREWARE
  4.  
  5.                               from
  6.  
  7.                           WALU SOFTWARE
  8.  
  9.  
  10.  
  11.                  WALU Software presents HoloQWk 
  12.                  ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯                  
  13. What A Lovely Utility Software.
  14.  
  15.  
  16. Copyright & Distribution
  17. ~~~~~~~~~~~~~~~~~~~~~~~~
  18.  
  19.      Copyright of this document and the program and files to 
  20.      which it relates remains with WALU Software. 
  21.      The product is Shareware and may be distributed via Public 
  22.      Domain Libraries, and non-commercial Bulletin Board Systems, 
  23.      but  not  be included  in  any bundled or packaged software 
  24.      including cover discs or other value added packages without 
  25.      the written consent of the copyright holders.  
  26.      The source code, executable program and all associated files 
  27.      remain the property of the author.  Reverse  engineering or 
  28.      modifying  executable  program files is strictly prohibited 
  29.      without the prior written consent of the copyright holders.
  30.  
  31. Licence for Use
  32. ~~~~~~~~~~~~~~~
  33.  
  34.      HoloQwk is distributed as SHAREWARE and as such if you wish 
  35.      to  use it  you should  register with WALU Software  within 
  36.      a  period  of  30  days. Registration costs 10 UK pounds in 
  37.      return  for which  you will receive notification of updates 
  38.      and  other  WALU Software  products along with a the latest 
  39.      version of HoloQwk.
  40.   
  41.      The use of this product for commercial purposes at any time 
  42.      is  prohibited  without  the  prior  written consent of the 
  43.      copyright holders.
  44.  
  45.      For  further details write to  WALU Software at the address 
  46.      given at the end of this document.
  47.  
  48. Disclaimer
  49. ~~~~~~~~~~
  50.  
  51.      The author specifically disclaims all warranties, expressed 
  52.      or implied, including but not limited to implied warranties 
  53.      of  merchantability  and fitness for any particular purpose 
  54.      with respect to  defects in  the software and documentation. 
  55.      In  no  event  shall  the author  be liable for any loss of 
  56.      profit,  or other damage, commercial or otherwise,  whether 
  57.      caused directly or indirectly by use of this product. 
  58.  
  59. What is it?
  60. ~~~~~~~~~~~
  61.  
  62.      HoloQwk is a QWK compatible mail packer for use with QBBS ST 
  63.      to allow users to either pack and download online or to have 
  64.      it batch packed overnight for download next day.
  65.  
  66.      The  format of  the HoloQwk mail  packets is compatible with 
  67.      QWK mailers including IMHO and Mountain Quick on a  range of 
  68.      different computer platforms.
  69.  
  70.      No  longer is it necessary   for users to spend hours online 
  71.      reading  the message  bases, they  can now  download packets 
  72.      read  them offline, generate thier  replies and call back to 
  73.      upload thier reply packets,spending alot less time and money 
  74.      actually online.
  75.  
  76.      Its many features include :
  77.  
  78.      o   Select conferences to read.
  79.      o   Pack online or batch mode.
  80.      o   Limit download packet size.
  81.      o   Limit number of messages to pack.
  82.      o   Rescan conferences.
  83.      o   Set last read pointers.
  84.      o   Supports the use of control messages within reply 
  85.          packets.    
  86.  
  87.  
  88.  
  89.         Brief & Basic Instructions for HoloQWK Installation & Operation.
  90.         ----------------------------------------------------------------
  91.  
  92.  
  93.                                Installation
  94. -------------------------------------------------------------------------------
  95.  
  96.         When unarchived, certain folders are created, these folders are an
  97.         example of one way of setting up Hqwk, the only major point to note
  98.         is that the TEMP folder must be exclusive to Holoqwk, during normal
  99.         operation this folder has it's contents erased, including any write
  100.         protected files.
  101.  
  102.         In this archive you will find a program 'CONFIG.PRG' - Use this to
  103.         install HoloQWK, filling in ALL the required details, any non-vital
  104.         information missing will cause your users problems, any information
  105.         that is vital for HoloQWK to operate that is not present will
  106.         prevent HoloQWK from operating at all.
  107.  
  108.         The CONFIG.PRG has a built in HELP feature, simply click on the help
  109.         button for a particular function, clicking on the Fsel button where
  110.         available will bring up a fileselector to aid you in the selection
  111.         of files and paths.
  112.  
  113.         HoloQWK ALWAYS expects a copy of your AREAS.BBS file to be present
  114.         within the QBBS folder - if it is not then HoloQWK will fail to run
  115.         up correctly in both local and online modes.
  116.  
  117.         A program called 'NEWFILES.PRG' is used to generate a text file of
  118.         new files for a user to peruse offline - this program was written by
  119.         Robert Darling - Frequestable from his BBS system 'Folkestone QBBS'
  120.         telephone +44-303-249306.
  121.  
  122.         Both example TOMSHELL.BAT files and also .DOR files can be found 
  123.         within this archive in order to help you install the program with 
  124.         as little effort as possible - Should you have installation 
  125.         problems then please either contact Dave on The Holodeck (+44-454-
  126.         317047), or Martin on The Chameleon (+44-454-881095), please make 
  127.         sure that you have executed the CONFIG.PRG and filled in all the 
  128.         necessary details before thinking you have a problem - and always 
  129.         examine the LOG file produced !
  130.  
  131.         Once installed you should run the program twice to initiate all the
  132.         control files used by HoloQWK, once this is done HoloQWK is mainly
  133.         self maintaining.
  134.  
  135.                           Disc Space Requirements
  136. -------------------------------------------------------------------------------
  137.  
  138.         The TEMP folder is where .QWK packets are initially created, the .QWK
  139.         packets contain numerous ASCII and binary files which can take up a
  140.         lot of storage space, especially if you have a lot of mail areas and
  141.         your users pack plenty of mail.
  142.  
  143.         Likewise, the HOLD folder can also take huge amounts of space
  144.         depending on the number of users who have packets being held for them,
  145.         and also how long you are willing to allow the system to pack messages
  146.         for users without them having to pick it up.
  147.  
  148.         So how much ? - Well, if you have a quiet system, not many users using
  149.         the HoloQWK then lets start with a guesstimate of approx. 1M, and then
  150.         build up from there - If there are any memory or disc limitations found
  151.         during the use of HoloQWK it will be reported in the log file so if you
  152.         are worried about disc space then consult your log file often !
  153.  
  154.                              Operating Systems
  155. -------------------------------------------------------------------------------
  156.  
  157.         HoloQWK has been tested on both STE's and STFM's, with TOS 2.06 and
  158.         also TOS 1.4 with no adverse effects, it also has been tested in
  159.         conjunction with PDOS and so no problems are expected with any other
  160.         'Multitasking' systems.
  161.  
  162.                             Memory Requirements
  163. -------------------------------------------------------------------------------
  164.  
  165.         HoloQWK has been tested on 1M machines upwards, although it is expected
  166.         operate on 0.5M machines as well, memory is used as and when needed and
  167.         it is not hogged, no limiting is required for 'Multitasking' systems.
  168.  
  169.                              System Protection
  170. -------------------------------------------------------------------------------
  171.  
  172.                                  BBS System
  173.                                  ----------
  174.  
  175.         Full carrier detection is employed, carrier is expected at all times
  176.         unless run in local mode which is detected by use of the DORINFO1.DEF
  177.         file that is expected to be in the QBBS folder.
  178.  
  179.         A sleep timer ensures that a user does not tie up your system due to
  180.         inactivity - it prompts the user for some input before exiting so that
  181.         they get a last chance to do something before being returned to the BBS
  182.  
  183.                                 Mail System
  184.                                 -----------
  185.  
  186.         Uploaded reply packets are checked to ensure that they are correctly
  187.         destined for the system they have been sent to - if they were generated
  188.         for another system then they are not processed.
  189.  
  190.                                  Operation
  191. -------------------------------------------------------------------------------
  192.  
  193.         HoloQWK is designed to operated via the 'Exit with Errorlevel' command
  194.         of QBBS. This is because not only does it update the users 'Lastread'
  195.         pointers, but it also credits them with entered messages - using Hqwk
  196.         via an 'Exec' command from a .DOR file can be done, but it is not
  197.         recommended.
  198.  
  199.         Exiting QBBS with an error level writes a DORINFO1.DEF file within the
  200.         QBBS folder, this file is required for normal operation.
  201.  
  202.                                 Mail Areas
  203. -------------------------------------------------------------------------------
  204.  
  205.         Mail areas 2-200 can be accessed from HoloQWK, area names are read from
  206.         BOARDS.BBS within QBBS\CONF\, the path to each mail area is read from
  207.         the AREAS.BBS file.
  208.  
  209.         All three security levels are utilised, allowing users access only to
  210.         those areas for which they have security access - the flags are NOT
  211.         used when accessing mail areas.
  212.  
  213.         Messages destined for private only areas are marked as private and any
  214.         messages destined for non-private areas are marked as public.
  215.  
  216.                                  Niceties
  217. -------------------------------------------------------------------------------
  218.  
  219.         Messages are formatted before being saved into thier destination area
  220.         to a line length of 72 characters, this includes any messages sent to
  221.         the monitor area.
  222.  
  223.         The 'from' field of the message is capitalised using the normal QBBS
  224.         standard, no more names in CAPITOL LETTERS ONLY !
  225.  
  226.         Should some fool upload a reply packet with a write protected file
  227.         within it it still gets deleted from the temporary area.
  228.  
  229.         A DOOR.ID file is written into the QWK packets that inform the user of
  230.         what control messages are available within HoloQWK - these control
  231.         messages are expected to be the next major upgrade to HoloQWK, perhaps
  232.         even allowing the requesting and uploading of files !
  233.  
  234.         Memory permitting, in local mode when the fileselector is used a tidy
  235.         screen is kept when the fileselector is removed.
  236.  
  237.         Should a user drop carrier when packing online, the packing is halted
  238.         although the users lastread pointers will have been adjusted by then.
  239.  
  240.         Should a user drop carrier when packing online, the twirly is disabled
  241.         when archiving - this prevents garbage being sent to the modem when the
  242.         archiver is busy and there is no user.
  243.  
  244.         Within the CONFIG.PRG you are given the option to monitor any mail
  245.         uploaded this copies any messages sent via HoloQWK into a mail area of
  246.         your choice, this must of course be a non-echomail area, usually private
  247.         to the SysOp.
  248.  
  249.                              Control Messages
  250. -------------------------------------------------------------------------------
  251.  
  252.         ALL control messages should be addressed to HOLOQWK and are sent as
  253.         normally uploaded messages within the users .REP packet.
  254.  
  255.         CONTROLTYPE = ADD
  256.         -----------------
  257.  
  258.         When a control message has this on it's subject line then the area in
  259.         which this message was written is added to the users profile and is
  260.         included in any future packing.
  261.  
  262.         Issuing this command in an already connected area will have no effect.
  263.  
  264.         CONTROLTYPE = DROP
  265.         ------------------
  266.  
  267.         When a control message has this on it's subject line then the area in
  268.         which this message was written is removed from the users profile and
  269.         no further packing of this area will occur.
  270.  
  271.         Issuing this command in a disconnected area will have no effect.
  272.  
  273.         CONTROLTYPE = SETMAX
  274.         --------------------
  275.  
  276.         When a control message has this on it's subject line the lastread
  277.         pointer for this area will be adjusted so that any mail currently
  278.         available in this area will be regarded as already read.
  279.  
  280.         Issuing this command in a disconnected area will cause the area to
  281.         be added to the users profile as well as adjusting the lastread
  282.         pointer for the area.
  283.  
  284.         CONTROLTYPE = RESCAN
  285.         --------------------
  286.  
  287.         When a control message has this on it's subject line the lastread
  288.         pointer for this area will be adjusted so that any mail currently
  289.         available for this area will be regarded as unread - that is, during
  290.         the next packing operation all messages will be included
  291.  
  292.         Issuing this command in a disconnected area will cause the area to
  293.         be added to the users profile as well as adjusting the lastread
  294.         pointer for the area.
  295.  
  296.         CONTROLTYPE = MAXPACK
  297.         ---------------------
  298.  
  299.         When a control message has this on it's subject line followed by a
  300.         decimal number from 10 to 32767 then the MAXPACK value will be set for
  301.         the user accordingly.
  302.  
  303.         Setting a value of less than 10 or greater than 32767 will disable the
  304.         feature.
  305.  
  306.         The area in which this message is issued is not important and is
  307.         ignored.
  308.  
  309.         CONTROLTYPE = MAXMSGS
  310.         ---------------------
  311.  
  312.         When a control message has this on it's subject line followed by a
  313.         decimal number from 1 to 32767 then the LOCKMESSAGES value will be set
  314.         for the user accordingly.
  315.  
  316.         Setting a value of less than 1 or greater than 32767 will disable the
  317.         feature.
  318.  
  319.         The area in which this message is issued is not important and is
  320.         ignored.
  321.  
  322.         Defaults
  323.         --------
  324.  
  325.         Should a control message be detected that does not follow the rules for
  326.         the particular function, or is not a recognised function, then the
  327.         message is simply ignored - should this occur then the user is informed
  328.         and also it is logged. Continual logging of this nature should prompt
  329.         you to have a word with the user as to the error of his/her ways !
  330.  
  331.                             Online Menu Options
  332. -------------------------------------------------------------------------------
  333.  
  334.         [ H ] Help
  335.         ----------
  336.  
  337.                 This displays a text file 'HOLOQWK.HLP' if present within the
  338.                 same folder as HoloQWK - if the text file is not present then
  339.                 this option is not shown to the user.
  340.  
  341.         [ P ] Preferences
  342.         -----------------
  343.  
  344.                 This sub-menu allows a user to select the archiver. protocol
  345.                 as well as which files to be included in the QWK packets.
  346.  
  347.                 Each selection 'rotates' when the corresponding key is pressed,
  348.                 this is also where 'batch' packing is enabled/disabled
  349.  
  350.         [ C ] Conferences
  351.         -----------------
  352.  
  353.                 This displays pages of areas that are available to the user, of
  354.                 which there is three methods of (de)selecting active areas.
  355.  
  356.                 1 - Simply enter the number of the area to (de)select
  357.                 2 - Enter more than one area, separated by commas
  358.                         i.e. 2,3,6,10,23 etc
  359.                 3 - Enter a range of areas, separated by a minus
  360.                         i.e. 123-134 etc
  361.  
  362.         [ O ] Online Pack
  363.         -----------------
  364.  
  365.                 This starts the packing process and then archives and sends the
  366.                 QWK packet according to the preferences for the user.
  367.  
  368.                 Packing can be aborted between areas by pressing ESC
  369.  
  370.         [ D ] Download Packet
  371.         ---------------------
  372.  
  373.                 Should an attempt to download a packet fail then further
  374.                 attempts can be made by use of this menu option.
  375.  
  376.         [ U ] Upload reply packet
  377.         --------------------------
  378.  
  379.                 Packed replies are uploaded with this option, the protocol and
  380.                 archiver used is as set up by the user in the preferences menu
  381.  
  382.                 Messages are dearchived and processed online
  383.  
  384.         [ S ] Set Lastread
  385.         ------------------
  386.  
  387.                 This sub-menu allows a user to (re)set the mail pointers for
  388.                 any areas available to HoloQWK.
  389.  
  390.                 There are four methods available :
  391.  
  392.                 1 - Reset pointers - all messages are considered unread
  393.                 2 -  Set  pointers - all messages are considered read
  394.                 3 - Set the number of unread messages (minimum of 6 per area)
  395.                 4 - Set the last date of read messages - effectively rescan an
  396.                     area
  397.  
  398.         [ L ] Lock Messages 
  399.         -------------------
  400.  
  401.                 This allows a user to set the maximum number of messages that
  402.                 will be packed from each area, by knowing how many areas the
  403.                 user has selected along with this value, a maximum message
  404.                 count per packet can be calculated.
  405.  
  406.         [ M ] Maximum packet size
  407.         -------------------------
  408.  
  409.                 This function only operates on batch packed packets.
  410.  
  411.                 When a user has batch mode enabled and the system starts to
  412.                 pack mail it first checks the existing size of any packets
  413.                 already on hold for the user - if the size of the packet is
  414.                 greater than this value then batch mode is disabled for this
  415.                 user, the user will have re-enable batch mode whilst online.
  416.  
  417.                               Batch Pack Mode
  418. -------------------------------------------------------------------------------
  419.  
  420.         To operate HoloQWK in Batch Pack Mode it is simply a matter of passing
  421.         a command line of BATCH to the program, any users with batch mode
  422.         enabled will have mail packed for them, unless the packet size exceeds
  423.         thier preset limit or the age of the packet exceeds your preset limit
  424.         - in either case batch mode is disabled for the user - although any
  425.         existing mail packets will remain on hold until collected or manually
  426.         deleted.
  427.  
  428.                               Local Operation
  429. -------------------------------------------------------------------------------
  430.  
  431.         Local operation is performed when the connect rate of the user as told
  432.         in the DORINFO1.DEF file is '0' - The only differences between this
  433.         mode of operation and the normal 'online' mode is that uploads and also
  434.         downloads are performed using a fileselector - this enables you to test
  435.         both packing and depacking.
  436.  
  437.                               Newfiles Setup
  438. -------------------------------------------------------------------------------
  439.  
  440.         When setting up the NEWFILES.PRG, dont forget to ensure that the data
  441.         file NEWFILES.DAT is written to where you have told HoloQWK it will be
  442.         written to.
  443.  
  444.                               Future Support
  445. -------------------------------------------------------------------------------
  446.  
  447.         HoloQWK is an ongoing project with updates expected to include many new
  448.         features, many of which will be breaking new ground as far as QWK
  449.         packers are concerned for the QBBS system.
  450.  
  451.         This version is released as Shareware and although support will be
  452.         given to anyone wishing to operate this system, no updates will be
  453.         supplied unless the registration fee has been paid.
  454.  
  455.                                Registration
  456. -------------------------------------------------------------------------------
  457.  
  458.         This version of HoloQWK has not been crippled or otherwise limited,
  459.         this is a complete QWK packer system designed for QBBS BBS's, if you
  460.         wish to be able to attain any new releases then you must register.
  461.  
  462.         Registration costs 10 U.K. Pounds, for which you will receive a copy of
  463.         HoloQWK with your own ID, and also make you eligible for upgrades, and
  464.         of course your voice will count for more should you want extra features
  465.         or changes made in later versions.
  466.  
  467.                              Editor
  468. -----------------------------------------------------------------------------
  469.  
  470.      Users who register will receive the Editor program which 
  471.      will allow you to edit users settings without having to log 
  472.      on as them.
  473.  
  474.                              Payment
  475. -----------------------------------------------------------------------------
  476.  
  477.         Registration payments should be made to :
  478.  
  479.                         
  480.  
  481.                         HoloQWK Registrations
  482.                     c/o Martin Stacey
  483.                         37, Sandy Lodge
  484.                         Yate, Avon.
  485.                         BS17 4HE
  486.                         England, U.K.
  487.  
  488.                         Fax +44 (0)454 881095
  489.  
  490.         Please include your full address, name of your BBS, hours etc.
  491.  
  492.                   Other WALU Software Programs
  493. --------------------------------------------------------------------------
  494.  
  495.      Filesyst       An alternative file system for use with QBBS
  496.      Getspeed       for use with Semper and Tomshell
  497.      CheckJek       For use with Jekyll and QBBS
  498.      RunJek         For use with Jekyll and QBBS
  499.      Netmail        For use with networked BBS's
  500.  
  501.                          Support BBS's
  502. --------------------------------------------------------------------------
  503.           Holodeck Sbbs                           Chameleon BBS
  504. NeST      90:106/151.0                            90:106/153.0
  505. Atarinet  50:501/151.0                            50:501/153.0
  506. Fido      2:444/43.0                              2:444/102.0
  507. Fishnet   777:777/0.0                             777:200/0.0
  508.  
  509.       +44 (0)454 317047                        +44 (0)454 881095
  510.  
  511.                        V32 bis   24 Hours
  512. ------------------------------------------------------------------------
  513.