SHAREWARE from WALU SOFTWARE WALU Software presents HoloQWk ÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿÿ What A Lovely Utility Software. Copyright & Distribution ~~~~~~~~~~~~~~~~~~~~~~~~ Copyright of this document and the program and files to which it relates remains with WALU Software. The product is Shareware and may be distributed via Public Domain Libraries, and non-commercial Bulletin Board Systems, but not be included in any bundled or packaged software including cover discs or other value added packages without the written consent of the copyright holders. The source code, executable program and all associated files remain the property of the author. Reverse engineering or modifying executable program files is strictly prohibited without the prior written consent of the copyright holders. Licence for Use ~~~~~~~~~~~~~~~ HoloQwk is distributed as SHAREWARE and as such if you wish to use it you should register with WALU Software within a period of 30 days. Registration costs 10 UK pounds in return for which you will receive notification of updates and other WALU Software products along with a the latest version of HoloQwk. The use of this product for commercial purposes at any time is prohibited without the prior written consent of the copyright holders. For further details write to WALU Software at the address given at the end of this document. Disclaimer ~~~~~~~~~~ The author specifically disclaims all warranties, expressed or implied, including but not limited to implied warranties of merchantability and fitness for any particular purpose with respect to defects in the software and documentation. In no event shall the author be liable for any loss of profit, or other damage, commercial or otherwise, whether caused directly or indirectly by use of this product. What is it? ~~~~~~~~~~~ HoloQwk is a QWK compatible mail packer for use with QBBS ST to allow users to either pack and download online or to have it batch packed overnight for download next day. The format of the HoloQwk mail packets is compatible with QWK mailers including IMHO and Mountain Quick on a range of different computer platforms. No longer is it necessary for users to spend hours online reading the message bases, they can now download packets read them offline, generate thier replies and call back to upload thier reply packets,spending alot less time and money actually online. Its many features include : o Select conferences to read. o Pack online or batch mode. o Limit download packet size. o Limit number of messages to pack. o Rescan conferences. o Set last read pointers. o Supports the use of control messages within reply packets. Brief & Basic Instructions for HoloQWK Installation & Operation. ---------------------------------------------------------------- Installation ------------------------------------------------------------------------------- When unarchived, certain folders are created, these folders are an example of one way of setting up Hqwk, the only major point to note is that the TEMP folder must be exclusive to Holoqwk, during normal operation this folder has it's contents erased, including any write protected files. In this archive you will find a program 'CONFIG.PRG' - Use this to install HoloQWK, filling in ALL the required details, any non-vital information missing will cause your users problems, any information that is vital for HoloQWK to operate that is not present will prevent HoloQWK from operating at all. The CONFIG.PRG has a built in HELP feature, simply click on the help button for a particular function, clicking on the Fsel button where available will bring up a fileselector to aid you in the selection of files and paths. HoloQWK ALWAYS expects a copy of your AREAS.BBS file to be present within the QBBS folder - if it is not then HoloQWK will fail to run up correctly in both local and online modes. A program called 'NEWFILES.PRG' is used to generate a text file of new files for a user to peruse offline - this program was written by Robert Darling - Frequestable from his BBS system 'Folkestone QBBS' telephone +44-303-249306. Both example TOMSHELL.BAT files and also .DOR files can be found within this archive in order to help you install the program with as little effort as possible - Should you have installation problems then please either contact Dave on The Holodeck (+44-454- 317047), or Martin on The Chameleon (+44-454-881095), please make sure that you have executed the CONFIG.PRG and filled in all the necessary details before thinking you have a problem - and always examine the LOG file produced ! Once installed you should run the program twice to initiate all the control files used by HoloQWK, once this is done HoloQWK is mainly self maintaining. Disc Space Requirements ------------------------------------------------------------------------------- The TEMP folder is where .QWK packets are initially created, the .QWK packets contain numerous ASCII and binary files which can take up a lot of storage space, especially if you have a lot of mail areas and your users pack plenty of mail. Likewise, the HOLD folder can also take huge amounts of space depending on the number of users who have packets being held for them, and also how long you are willing to allow the system to pack messages for users without them having to pick it up. So how much ? - Well, if you have a quiet system, not many users using the HoloQWK then lets start with a guesstimate of approx. 1M, and then build up from there - If there are any memory or disc limitations found during the use of HoloQWK it will be reported in the log file so if you are worried about disc space then consult your log file often ! Operating Systems ------------------------------------------------------------------------------- HoloQWK has been tested on both STE's and STFM's, with TOS 2.06 and also TOS 1.4 with no adverse effects, it also has been tested in conjunction with PDOS and so no problems are expected with any other 'Multitasking' systems. Memory Requirements ------------------------------------------------------------------------------- HoloQWK has been tested on 1M machines upwards, although it is expected operate on 0.5M machines as well, memory is used as and when needed and it is not hogged, no limiting is required for 'Multitasking' systems. System Protection ------------------------------------------------------------------------------- BBS System ---------- Full carrier detection is employed, carrier is expected at all times unless run in local mode which is detected by use of the DORINFO1.DEF file that is expected to be in the QBBS folder. A sleep timer ensures that a user does not tie up your system due to inactivity - it prompts the user for some input before exiting so that they get a last chance to do something before being returned to the BBS Mail System ----------- Uploaded reply packets are checked to ensure that they are correctly destined for the system they have been sent to - if they were generated for another system then they are not processed. Operation ------------------------------------------------------------------------------- HoloQWK is designed to operated via the 'Exit with Errorlevel' command of QBBS. This is because not only does it update the users 'Lastread' pointers, but it also credits them with entered messages - using Hqwk via an 'Exec' command from a .DOR file can be done, but it is not recommended. Exiting QBBS with an error level writes a DORINFO1.DEF file within the QBBS folder, this file is required for normal operation. Mail Areas ------------------------------------------------------------------------------- Mail areas 2-200 can be accessed from HoloQWK, area names are read from BOARDS.BBS within QBBS\CONF\, the path to each mail area is read from the AREAS.BBS file. All three security levels are utilised, allowing users access only to those areas for which they have security access - the flags are NOT used when accessing mail areas. Messages destined for private only areas are marked as private and any messages destined for non-private areas are marked as public. Niceties ------------------------------------------------------------------------------- Messages are formatted before being saved into thier destination area to a line length of 72 characters, this includes any messages sent to the monitor area. The 'from' field of the message is capitalised using the normal QBBS standard, no more names in CAPITOL LETTERS ONLY ! Should some fool upload a reply packet with a write protected file within it it still gets deleted from the temporary area. A DOOR.ID file is written into the QWK packets that inform the user of what control messages are available within HoloQWK - these control messages are expected to be the next major upgrade to HoloQWK, perhaps even allowing the requesting and uploading of files ! Memory permitting, in local mode when the fileselector is used a tidy screen is kept when the fileselector is removed. Should a user drop carrier when packing online, the packing is halted although the users lastread pointers will have been adjusted by then. Should a user drop carrier when packing online, the twirly is disabled when archiving - this prevents garbage being sent to the modem when the archiver is busy and there is no user. Within the CONFIG.PRG you are given the option to monitor any mail uploaded this copies any messages sent via HoloQWK into a mail area of your choice, this must of course be a non-echomail area, usually private to the SysOp. Control Messages ------------------------------------------------------------------------------- ALL control messages should be addressed to HOLOQWK and are sent as normally uploaded messages within the users .REP packet. CONTROLTYPE = ADD ----------------- When a control message has this on it's subject line then the area in which this message was written is added to the users profile and is included in any future packing. Issuing this command in an already connected area will have no effect. CONTROLTYPE = DROP ------------------ When a control message has this on it's subject line then the area in which this message was written is removed from the users profile and no further packing of this area will occur. Issuing this command in a disconnected area will have no effect. CONTROLTYPE = SETMAX -------------------- When a control message has this on it's subject line the lastread pointer for this area will be adjusted so that any mail currently available in this area will be regarded as already read. Issuing this command in a disconnected area will cause the area to be added to the users profile as well as adjusting the lastread pointer for the area. CONTROLTYPE = RESCAN -------------------- When a control message has this on it's subject line the lastread pointer for this area will be adjusted so that any mail currently available for this area will be regarded as unread - that is, during the next packing operation all messages will be included Issuing this command in a disconnected area will cause the area to be added to the users profile as well as adjusting the lastread pointer for the area. CONTROLTYPE = MAXPACK --------------------- When a control message has this on it's subject line followed by a decimal number from 10 to 32767 then the MAXPACK value will be set for the user accordingly. Setting a value of less than 10 or greater than 32767 will disable the feature. The area in which this message is issued is not important and is ignored. CONTROLTYPE = MAXMSGS --------------------- When a control message has this on it's subject line followed by a decimal number from 1 to 32767 then the LOCKMESSAGES value will be set for the user accordingly. Setting a value of less than 1 or greater than 32767 will disable the feature. The area in which this message is issued is not important and is ignored. Defaults -------- Should a control message be detected that does not follow the rules for the particular function, or is not a recognised function, then the message is simply ignored - should this occur then the user is informed and also it is logged. Continual logging of this nature should prompt you to have a word with the user as to the error of his/her ways ! Online Menu Options ------------------------------------------------------------------------------- [ H ] Help ---------- This displays a text file 'HOLOQWK.HLP' if present within the same folder as HoloQWK - if the text file is not present then this option is not shown to the user. [ P ] Preferences ----------------- This sub-menu allows a user to select the archiver. protocol as well as which files to be included in the QWK packets. Each selection 'rotates' when the corresponding key is pressed, this is also where 'batch' packing is enabled/disabled [ C ] Conferences ----------------- This displays pages of areas that are available to the user, of which there is three methods of (de)selecting active areas. 1 - Simply enter the number of the area to (de)select 2 - Enter more than one area, separated by commas i.e. 2,3,6,10,23 etc 3 - Enter a range of areas, separated by a minus i.e. 123-134 etc [ O ] Online Pack ----------------- This starts the packing process and then archives and sends the QWK packet according to the preferences for the user. Packing can be aborted between areas by pressing ESC [ D ] Download Packet --------------------- Should an attempt to download a packet fail then further attempts can be made by use of this menu option. [ U ] Upload reply packet -------------------------- Packed replies are uploaded with this option, the protocol and archiver used is as set up by the user in the preferences menu Messages are dearchived and processed online [ S ] Set Lastread ------------------ This sub-menu allows a user to (re)set the mail pointers for any areas available to HoloQWK. There are four methods available : 1 - Reset pointers - all messages are considered unread 2 - Set pointers - all messages are considered read 3 - Set the number of unread messages (minimum of 6 per area) 4 - Set the last date of read messages - effectively rescan an area [ L ] Lock Messages ------------------- This allows a user to set the maximum number of messages that will be packed from each area, by knowing how many areas the user has selected along with this value, a maximum message count per packet can be calculated. [ M ] Maximum packet size ------------------------- This function only operates on batch packed packets. When a user has batch mode enabled and the system starts to pack mail it first checks the existing size of any packets already on hold for the user - if the size of the packet is greater than this value then batch mode is disabled for this user, the user will have re-enable batch mode whilst online. Batch Pack Mode ------------------------------------------------------------------------------- To operate HoloQWK in Batch Pack Mode it is simply a matter of passing a command line of BATCH to the program, any users with batch mode enabled will have mail packed for them, unless the packet size exceeds thier preset limit or the age of the packet exceeds your preset limit - in either case batch mode is disabled for the user - although any existing mail packets will remain on hold until collected or manually deleted. Local Operation ------------------------------------------------------------------------------- Local operation is performed when the connect rate of the user as told in the DORINFO1.DEF file is '0' - The only differences between this mode of operation and the normal 'online' mode is that uploads and also downloads are performed using a fileselector - this enables you to test both packing and depacking. Newfiles Setup ------------------------------------------------------------------------------- When setting up the NEWFILES.PRG, dont forget to ensure that the data file NEWFILES.DAT is written to where you have told HoloQWK it will be written to. Future Support ------------------------------------------------------------------------------- HoloQWK is an ongoing project with updates expected to include many new features, many of which will be breaking new ground as far as QWK packers are concerned for the QBBS system. This version is released as Shareware and although support will be given to anyone wishing to operate this system, no updates will be supplied unless the registration fee has been paid. Registration ------------------------------------------------------------------------------- This version of HoloQWK has not been crippled or otherwise limited, this is a complete QWK packer system designed for QBBS BBS's, if you wish to be able to attain any new releases then you must register. Registration costs 10 U.K. Pounds, for which you will receive a copy of HoloQWK with your own ID, and also make you eligible for upgrades, and of course your voice will count for more should you want extra features or changes made in later versions. Editor ----------------------------------------------------------------------------- Users who register will receive the Editor program which will allow you to edit users settings without having to log on as them. Payment ----------------------------------------------------------------------------- Registration payments should be made to : HoloQWK Registrations c/o Martin Stacey 37, Sandy Lodge Yate, Avon. BS17 4HE England, U.K. Fax +44 (0)454 881095 Please include your full address, name of your BBS, hours etc. Other WALU Software Programs -------------------------------------------------------------------------- Filesyst An alternative file system for use with QBBS Getspeed for use with Semper and Tomshell CheckJek For use with Jekyll and QBBS RunJek For use with Jekyll and QBBS Netmail For use with networked BBS's Support BBS's -------------------------------------------------------------------------- Holodeck Sbbs Chameleon BBS NeST 90:106/151.0 90:106/153.0 Atarinet 50:501/151.0 50:501/153.0 Fido 2:444/43.0 2:444/102.0 Fishnet 777:777/0.0 777:200/0.0 +44 (0)454 317047 +44 (0)454 881095 V32 bis 24 Hours ------------------------------------------------------------------------