ProQWK.txt ---------- (See end of this file for revision history.) LEGAL STUFF: ------------ This is the text file that accompanies ProQWK, (c) 1994 by Carl Mellesmoen. "ProComm Plus for Windows", "Windows ASPECT" and "Action Bar" are trademarks (c) 1992-1994 Datastorm Technologies, Inc. "Windows" is a trademark of Microsoft Corporation. The script "PQ2.WAX" was compiled using the Windows ASPECT compiler, but was NOT written by Datastorm Technologies or any of its employees. The author is not affiliated with Datastorm Technologies in any way. DISCLAIMER: ----------- The author does not make any guarantees, implicit or explicit, regarding the script "PQ2.wax", and is not responsible for anything that may occur as a result of using it. Users of this script are expected to exercise discretion and accept responsibility for such use, and any effects arising thereof. So there. ABOUT ProQWK: ------------- What does this script do? ------------------------- ProQWK is a little utility meant for ProComm Plus for Windows users. We think it satisfies a need that many PC+/Win users have -- that is, to rename QWK packets in such a manner that the user can keep many QWK packets from the same source in their download directory at one time. The utility renames QWK packets so that when a download of a new QWK packet takes place, the file transfer doesn't crash. As well, ProQWK checks for the existence of a file with the extension "QWK", and if it doesn't find it, it won't rename. Thus, users don't have to try and remember whether they renamed their QWK files previously. When a user chooses to rename a series of QWK files, ProQWK will delete the highest-numbered file that it is configured to keep for the BBS in question. For example, a user may have ProQWK configured to keep seven extra QWK packets for a BBS called, oh, let's say "redeye" for example. If the QWK file name for the BBS is "redeye", ProQWK will look for a file named "redeye.qw6" (because the user chose seven extra packets for that series, and ProQWK starts numbering QWK files at zero, eg., "redeye.qwO"), and upon finding it, will delete it. Next, it will change the name of the file "redeye.qw5" (if found) to "redeye.qw6"; "redeye.qw4" to "redeye.qw5"; "redeye.qw3" to "redeye.qw4", and so on, until it does the last renaming, "redeye.qwk" to "redeye.qw0". If there was no "redeye.qwk" in the down- load subdirectory, ProQWK will not go through this renaming procedure, because it would be unnecessary. Please note that each time ProQWK renames & cycles "QWK" files (actually "QW?" files) in this manner, one file will be deleted and each remaining "QW?" file will be bumped up one rung on the "ladder". ProQWK also is designed to help out with another problem sometimes encountered when using QWK offline readers -- when uploading a reply packet, a user will sometimes forget whether they have already uploaded it -- ProQWK alleviates this problem by allowing users to upload, and then delete the "REP" packet in one "motion". They can also choose to upload only, or to delete only, REP packets that they wish to upload or delete. Why bother? ----------- The main reason to use these utilities is to protect your QWK packets from premature deletion. Some users may only keep one copy of a QWK packet for a particular BBS, read it, delete it, and then download a new one. ProQWK is not going to be of much use to them. But if you want to keep a packet from yesterday, and from a couple of days before that (etc.), for example, you may find ProQWK useful. You can always go a packet or two (or up to ten) back & find those messages that you read a few days ago. If you don't keep multiple copies of QWK packets, once you delete that QWK packet, it's gone, unless you have some kind of deleted file recovery utility. We like to think that ProQWK is a more elegant alternative. But doesn't Zmodem automatically rename files? ---------------------------------------------- In many communications software programs, zmodem downloads are automatically renamed when a file with the same name is already present in the download subdirectory. The standard zmodem protocol, used by ProComm Plus for Windows, version 1.0, did not perform that function. ProQWK 1.x was meant to at least enable users to work around this, if they desired to keep multiple copies of QWK files on their disk. Due to popular demand, ProQWK 2 has been developed for users of Procomm Plus/Windows 2, since 1.x versions will not run under this version of Procomm Plus/Win (with the exception of ProQWK 1.3, which was written in Visual Basic ((c) Microsoft Corporation)). While PCP/Win 2.0 will rename Zmodem downloads, a lot of users have gotten used to using ProQWK, and version 2.0 ensures that they can continue to use it. How do I use it? ---------------- Before downloading a fresh "qwk" packet for a BBS, simply choose the "QWK" option from the main menu and select the name of the BBS whose "qwk" packet you are about to download (ProQWK must be first set up to rename the files for that BBS. See section below regarding setup.). ProQWK will then rename the "QW?" files associated with that BBS, provided the setup was run properly. As well, you can delete individual QW? files using ProQWK, rather than switching to a file management utility. Also, as a new feature in version 2.0, you may run ProQWK as a "command-line" program -- if you use a script that sets the predefined WASP variable, S0 to the string value "allqwk" (case insensitive), and then launches PQ2.WAX. Such a script is included in this archive, both in source code ("Allqwk.was") and in wax form ("Allqwk.wax"). When ProQWK 2.0 is invoked in this manner, it will automatically run through the renaming routine for ALL BBSes named in the ProQWK.INI file that are properly configured, without the need for any intervention from the user (NOTE: Unregistered users will have to click a button on a "nag screen" that appears after ProQWK runs -- so if you have not registered, don't use ProQWK in this way, unless you can afford to have it keep running until such a time as you can make the final click.). You should not need to alter the source code at all in order to use this script, but it has been provided for those who want to incorporate it into larger scripts (such as late-night mail runs). DO NOT ATTEMPT TO RENAME "QWK" PACKETS DURING A DOWNLOAD, OR WHEN A DOWNLOAD IS IMMINENT! THIS MAY/WILL RUIN YOUR DOWNLOAD! (You may rename "QWK" files for BBS "A" while downloading a "QWK" file for BBS "B", but not for "A" while downloading "A") We suggest assigning a Meta Key or Action Bar Icon to the "PQ2.wax" script, in order to have ProQWK available at the touch of a button. See your ProComm Plus for Windows user manual, or online help for more information on setting up Meta Keys or Action Bar icons to run scripts. FILES NEEDED: ------------- In order to use ProQWK Utilities, you need to have the archive, "PROQWK20.ZIP", which includes: ProQWK.txt this file PQ2.wax the Windows ASPECT executable file Allqwk.wax launches "command line" ProQWK session Allqwk.was source code for allqwk.wax socsof2.nil the icon library for ProQWK 2.0 Installation & Setup: --------------------- Uncompress the file "PROQWK20.ZIP" using PKZIP or other program that can uncompress "ZIP" files. The only files that need to be in any specific subdirectory are "PQ2.wax", which should be copied to the subdirectory in which ProComm Plus for Windows 2 expects to find your Windows ASPECT scripts; and "socsof2.nil", which should be copied to the subdirectory in which the executable "PW2.EXE" (for ProComm Plus for Windows 2) is located (for example "c:\prowin2"). If you wish to use the "command line" option, you will need to copy "Allqwk.wax" to your ASPECT subdirectory, and if you wish to make changes to "allqwk.wax", or to incorporate its source code into other scripts, you will need to copy "allqwk.was" to your PCP/W 2 ASPECT subdirectory. Once the files have been placed in the proper subdirectories, the script can be run by selecting "Scripts...Run..." from the ProComm Plus for Windows pull-down menus, and choosing "PQ2.wax" from the list that appears, or by launching from an Action Bar icon or a Metakey (see your Procomm Plus/Win 2 User Manual for details). If you have not used ProQWK before (or if you have and your "ProQWK.ini" file has been moved, erased, or renamed), it will ask you if you wish to go through the setup routine. If you wish to do so, select "Setup", and you will be taken directly to the setup routine. If you choose "Cancel," the script will stop running and you will either have to find your "ProQWK.ini" file (if you have a copy in another location) and place it in your Windows subdirectory, or run ProQWK again and choose to go through the setup routine. ProQWK will create a new file on your hard drive called "ProQWK.ini" (I know what you're thinking: "Ugh! Not ANOTHER 'ini' file!" But, it's not that bad! :) See "De-installing ProQWK" below.), which will be placed in your Windows subdirectory (if it is not already there). This file is necessary for ProQWK to read various setup information in order to be able to execute. Whenever you save changes to your configuration, ProQWK will update the "ProQWK.ini" file. Setup Options: -------------- When you are faced with the ProQWK setup dialog box, you will need to enter the path to your "download" subdirectory, which is where you keep your downloaded QWK files, for example "c:\prowin2\dnload". If you don't enter the proper path, ProQWK will not be able to rename/delete any of your QWK type files, and will be at least 50% useless. The same follows for your "upload" subdirectory (eg. "c:\prowin2\upload") - if it is incorrectly entered, ProQWK will be at least 50% useless, and if both are mispelled, ProQWK will be at least 100% useless (grin)! Please ensure that both directory paths have the proper drive name, eg. C:, D:, etc., followed by a backslash ("\"), followed by the remainder of the path name, but without the final backslash (examples in description above). If you should happen to include a terminating backslash in your upload or download path, ProQWK will inform you that you shouldn't have done that and will remove the final backslash from your path name(s). You will notice a check box underneath the path names, marked "Express Option". This will be explained further under "Using ProQWK" below. Underneath the "Express Option" checkbox is another checkbox labelled "Delete warning". This option, when enabled, will ask you to confirm file deletions before performing them. If the checkbox is not enabled, ProQWK will delete files without asking for confirmation. On the right will be a message saying "You have the following BBS's set up for ProQWK use:". There may or may not be a list of BBS's underneath this message, depending on whether or not you have previously set up ProQWK to work with any particular BBS's. If you have not, the area below the message will be blank. To add a bulletin board name for use by ProQWK, select the "BBS List..." button. This will lead you to a new dialog box called "BBS Names". You can then enter the names of up to twelve computer bulletin boards (giving them whatever name you wish to give them, since these names are meant for your information) in the spaces provided. Once you have selected "Ok", you will then be taken to another dialog box, where you will be prompted to enter the name of the QWK file for the BBS in question. Please be sure to enter the EXACT name of the QWK files for that BBS -- that is, whatever that BBS calls its own QWK files. This name should not include any paths, nor should it include the extension ".qwk", since this will be taken care of by ProQWK when it runs. If the file name is not correctly entered, ProQWK will not be able to rename the "QWK" packets in question. This dialog will also ask you for the number of EXTRA "QWK" packets you wish to keep on hand for the BBS in question. Note that this means that if you enter "1", you will have as many as 2, and as few as 1 (or zero, if you manually delete them) QWK files for that BBS in your download subdirectory at any one time. Similarly, if you enter 2, you will have up to 3 files, and if you enter 3, you will have up to 4 files, and so on. You may choose to keep as many as 11 "QWK" files for a BBS BY CHOOSING "10" for this entry. When you are finished, select "Done", and ProQWK will cycle to the next BBS for which you need to enter information, or it will return you to the "ProQWK Setup" dialog when you have configured the last BBS that you wish to modify. Once you are satisfied with the setup information you have entered, choose "Save-Exit" in the "ProQWK Setup" dialog. ProQWK will then save your settings/changes and you will be returned to the ProQWK main menu (or taken there for the first time, if you have not used ProQWK before). If you do not want to save any changes you have made, or if you do not want to make any changes, select "Exit" in the Setup menu, and you will be taken to the main menu. From the Setup menu, you may also choose to enter your registration name and number, allowing you to run ProQWK without the delay and "nag screen" displayed upon exiting ProQWK. De-installing ProQWK (with apologies to grammarians) ---------------------------------------------------- To remove ProQWK, you need only erase the files: "PQ2.wax" in your PCP/Windows 2 ASPECT subdirectory; "allqwk.wax" and "allqwk.was" in your PCP/Windows 2 ASPECT subdirectory (if present); "ProQWK.ini" in your Windows subdirectory; "ProQWK.txt" (this file) wherever you put it; and "socsof2.nil" in your ProComm Plus for Windows subdirectory. That's it! No changes to your Autoexec.bat, config.sys, Win.ini or System.ini files whatsoever! Now, doesn't that sound simple? (rhetorical question!) RUNNING ProQWK: --------------- From the main menu (entitled "ProQWK Utilities"), you may choose from 5 different options: QWK files... REP files... Setup... Quit About ProQWK Utilities QWK files: Choosing this option and checking the name of a BBS (or the "All of the above option") enables the user of ProQWK to rename their QWK packets in such a way that the oldest file(s) will be deleted, and all newer ones will be renamed in such a manner that the extension of each "QWK" file will be changed to ".qw0", ".qw1", ".qw2", ".qw3", and so on, the highest number depending on the number of QWK packets to be kept as determined during the BBS setup procedure (see "installation" above). The lower the number in a file extension for files renamed by this utility, the newer the file. The newest file will have an extension of ".qw0", unless the file(s) for the BBS in question have not been renamed since the last QWK packet was downloaded, in which case the newest file will bear the extention ".QWK". When the "Ok" button is selected in the "Rename QWK packets..." dialog, the script will execute the renaming for the BBS(s) in question if and only if there is a mail packet for the BBS with the extension ".qwk" present in the download subdirectory. Otherwise, it will not perform the rename for that BBS. When multiple BBS's are chosen, or when "All of the above" is chosen, the script will check for the ".qwk" extension for each BBS separately. In this way, you do not have to worry about whether or not you are deleting a file each time whether it is necessary or not, since if it is not necessary (i.e. there is no ".qwk" file), nothing will be renamed (or deleted) for that BBS. Once the QWK files are renamed, you will be either returned to the main menu (if "Express" is not checked), or the script will turn itself off (if "Express" is checked). See the information regarding the "Express" option further on. If you select "Cancel", ProQWK will return to the main menu without performing any renaming or deleting. If you select "Delete files...", you will be presented with a new dialog box asking you to select a QWK file to delete. The default download directory's "QW?" files will be listed. You may select one or more files to delete (holding down the "CTRL" key while selecting a file will add it to the selections, while holding down the "Shift" key will select a file along with all files between it and a previous selection). If you press "Cancel" you will be returned to the main menu (if the "Express" option is disabled), or ProQWK will exit (if "Express" is enabled). If a file(s) is/are selected, "delete warning" is enabled, and the "Delete" key is pressed, you will be asked to confirm each deletion, and given one last chance to change your mind (if "Delete warning" is disabled, the files will be deleted without your being prompted to confirm the deletions). NOTE: The default under the "QWK files" menu is "OK", which means that if you make a selection and press [ENTER], ProQWK will behave as if you clicked on "OK" with your mouse. REP files: Choosing "REP files..." from the main menu will lead you to the dialog box, "REP Management", which will allow you to do one of three things with your "REP" files: 1) Upload 2) Upload & delete 3) Delete In order to do any of these three things, you must first select a REP file from the list box on the left, and select the "Ok" button, or simply double-click on the REP file you want to process. If no REP files appear in the "REP files..." menu, you have either not entered the proper "upload" subdirectory in ProQWK setup, or have changed the subdirectory in the list box, or you currently have no "REP" files in that subdirectory. Note that an icon will be displayed which represents which of the three options are selected -- an "up arrow" & envelope for "upload", an "up arrow"/envelope with a small "bomb" superimposed for "upload & delete," and a somewhat larger "bomb" for "delete." As the selection is changed, so is the icon. If you do not see the icon(s), you probably have not put the icon file, "socsof2.nil" in the proper subdirectory. If you don't want to use the icons, you will have to either move the icon file to a different directory or rename or delete it, but note that in the process you will lose ALL of the icons that ProQWK uses. The options that perform a file upload (the first two) are meant to be used only while you are online to a bulletin board. You may change the transfer protocol before sending the file. The default transfer protocol will be the one designated in your dialing directory for the BBS you are connected with. You may change the transfer protocol to any protocol recognized by ProComm Plus for Windows by selecting the "Change protocol" combobox, which will present a drop-down list of available protocols (note that this will not change the default protocol for the BBS in your dialing directory -- it only enables the selected file to be sent via the selected protocol). To select a new protocol, simply point and click. The plain "upload" option simply sends the file to the remote host BBS, and warns you if the upload fails. The "upload & delete" option will do the same as the "upload" option,and then ask you whether you wish to delete the file, if "delete warn" is enabled. It will NOT ask to delete the file if the upload is not successful. It's a good idea to wait for the bulletin board you are online to to inform you of whether your REP packet messsages have been sent to the proper message areas successfully BEFORE you confirm that you want to delete the REP packet (provided, of course, that "Delete warn" is enabled). Once you have been satisfied that your messages are on their way, you can then erase them with relative peace of mind. We recommend using the "upload & delete" option to make it easier to keep track of which REP packets you have already uploaded - you can upload & delete all at once so you don't have to ask yourself a day or two later, "Now, did I send that mail packet yet or not?" Of course, if you select the "upload" only option, you will still have to somehow remember when you uploaded your packets (darn!). The third option, "Delete", when selected will delete the selected REP packet. If you enabled "Delete warning" under the setup, you will be prompted before ProQWK deletes the file. ProQWK will default to the option of the three above that was selected the last time you used the "REP Management" option. For instance, if you select a REP file, and choose "Upload & delete", the next time you use ProQWK, "Upload & delete" will be the default selection. If you delete a REP packet by mistake, you can probably still recover it, if you have some kind of deleted file recovery utility on your computer. If you choose "Ok" without highlighting a REP packet, ProQWK will tell you so. After the actions described above have taken place, the script will return to the main menu, if the "Express" option is not selected, or shut itself off, if the "Express" option has been selected (see the section about the "Express" option further along). NOTE: The default for the "REP Management" window is "OK", which means that if you double-click on a REP filename, ProQWK will automatically perform the action by the designated radiobutton on the right (using the specified transfer protocol, if either of the first two radiobuttons are chosen). Setup: Described above. Quit: Exits script (who would've guessed?) About ProQWK Utilities: Choosing this button will invoke a dialog containing some information about ProQWK and how to register (see Registering ProQWK below)! "Express" Option: We figured that this script should run as unobtrusively as possible, so we included a feature called "Express". When the "Express" checkbox is selected, the script will quickly (QWKly?) exit after performing QWK or REP file functions. In this way, you have a nice little utility that does its thing with QWK's or REP's and then gets the heck out of the way when finished, enabling you to get on with your online business. The status of "Express" will remain the same the next time the program is run, i.e. once selected, it is always selected, until the status is changed to "off", when it will remain unselected. If you want to return to the main menu after performing a QWK or REP function, remember to uncheck the "Express" feature if it is checked (if there is an "X" inside the checkbox). Corollary to the above, if you have "Delete warning" disabled, you will be able to exit even more quickly if you are performing any kind of file deletion. This is meant to enhance the flow of ProQWK. Command Line ------------ As a "command-line" utility, you may run ProQWK by launching it from another PCP/W 2 WAX file, if you use a script that sets the predefined WASP variable, S0 to the string value "allqwk" (case insensitive), and then launches PQ2.WAX. "Allqwk.wax" does just this, and is included in the archive, as is the source code, "Allqwk.was". When ProQWK 2.0 is invoked in this manner,it will automatically run through the renaming routine for ALL BBSes named in the ProQWK.INI file that are properly configured, without the need for any intervention from the user (NOTE: Unregistered users will have to click a button on a "nag screen" that appears after ProQWK runs -- so if you have not registered, don't use ProQWK in this way, unless you can afford to have it keep running until such a time as you can make the final click.). You should not need to alter the source code at all in order to use this script, but it has been provided for those who want to incorporate it into larger scripts (such as late-night mail runs). It is suggested that you run ProQWK normally and make sure things are set up the way you want them before using the "command line" option. Further Info: ------------- For further information on "QWK" mail packets, and "REP" files, please consult your offline mail reader documentation. If you have any comments, questions, or concerns about the ProQWK Utilities, please contact Carl Mellesmoen via the Fidonet Windows echo, or send "snail" mail to: Carl Mellesmoen 238 - 4th St. East Saskatoon, SK S7H 1J1 Canada OR, if you so choose, you may report any bugs/problems/questions/comments to Carl Mellesmoen on Ming Men BBS, Saskatoon, SK. ((306)-374-5544), in the "general" or "Windows" message areas. Registering ProQWK ------------------ Send $10 to the "snail mail" address above, along with your name and address, so that a registration code can be sent to you. This code is not to be shared with anyone (see licensing agreement below). Licensing Agreement: -------------------- ProQWK 2 is supplied on an "as is" basis and the author is not liable for any problems encountered while using it, either by direct or indirect cause. Users of this software, registered or not, assume all risk associated with its use. Anyone may use this software for free without registering it for 30 days, and 30 days only. After this period, they must either send the $10 registration fee to the author, along with their name and mailing address, or discontinue their use of the ProQWK 2.0 software. Registration entitles the user to use the ProQWK 2.0 software on one or more computers (one at a time), or for multiple users to use the software on a single workstation. Any additional use requires additional registration(s). The ProQWK software may be freely distributed in its original, archived form, and may not be in any way altered or reverse-engineered. No user may divulge their user registration code to others, nor may they distribute it with copies of the software. If any user is to post portions their "ProQWK.INI" file, in public message areas, they are forewarned to remove their registration code from such postings, as they are not permitted to do so, and they risk others using their registration code. The licencing agreement is to be governed by the laws of the province of Saskatchewan, Canada. *** REVISION HISTORY *** ------------------------ 15/08/94 VERSION 2.0 - PCPW/2-compatible version released - ability to run in a "command-line" manner - multiple file-deletion from the "point-and-click" QWK deletion dialog box - some enhancements of source code (taking advantage of new WASP features) 01/08/94 VERSION 1.3 - (version 1.3 - VB application to bridge gap between ProQWK 1.xx and 2.0) - this version only - does not require a particular version of PCP/W in order to run (can be used by anyone who has Windows 3.1 and VBRUN300.DLL) 20/01/94 VERSION 1.2 - corrected bug in which setup did not change options 09/01/94 VERSION 1.1 - corrected problem with auto-selection of default upload protocol - added "Cancel" button to setup routine - enables user to not save changes - changed default pushbuttons so that double-clicking will process a selection automatically - also allowed for bypassing file deletion warning via setup, enabling smoother operation of ProQWK, especially when uploading files - changed exit message to a usermsg instead of a statmsg, since proqwk changed to allow deletions without prompting - corrected problem with "express" option and QWK delete (single file) procedure - program will now exit quickly if express is enabled, and will update INI file properly 04/10/93 - VERSION 1.0 - changed upload protocol combobox to follow PC+/Win conventions (i.e., not sorted, on right-hand side of dialog rather than left) - fixed problems with "Express" option not updating correctly - added "Express" option to QWK delete - changed usermsg's to errormsg's where appropriate - fixed bug: formerly, when a file was not selected in "QWK delete" mode, did not check to make sure there is a file selected. Now user is told that he has to have a file selected before one can be deleted 24/09/93 - REP option now defaults to last action - icon added to show default REP action 01/09/93 - added selective QWK deleting - only one file at a time - added groupboxes to setup dialog 31/08/93 - changed setup routine - protocol selection no longer a part of setup - protocol selection now takes place under "REP" management module. Default protocol (for each BBS according to the dialing directory)is used, but user may change when selecting file for download, as with PC+/Win regular d/l's. - Fixed bug for restarting the protocol selection process when a file transfer fails - prettied up the setup dialog - centered BBS names - before they were left-aligned - users can now get rid of the "protocol" section entirely from "proqwk.ini" - removed forced delay between uploading & deleting rep files