FPBLT v2.2 ~~~~~~~~~~ A Mail Traffic Bulletin Generator for FidoPCB by George Silberstern U S E R S M A N U A L ~~~~~~~~~~~~~~~~~~~~~~~ In memory of Matjaz Koce (19xx-1994), author of FidoPCB. If not for him, this program would not have been. Page i FPBlt v2.2 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� Distribution Archive The following files should have been included in the archive containing this program: FPBLT EXE - The FPBlt Utility Program FPBLT INI - A sample Configuration file FPBLT DOC - This file: The User's Manual REBUILD BAT - Pointer File management file REVISION INF - List of changes made to FPBlt ORDERING FRM - Generic Order Form SOFTWARE LST - Other programs I have written FILE_ID DIZ - Description file Bulletin Boards If any of these files are missing, then you may not have an original copy of the archive. Distribution FPBlt is being released as Shareware. You may distribute the program freely, as long as you do not alter the program in any way (that includes disassembly, and reverse engineering). It would also be greatly appreciated if you distributed the archive unchanged. That is, containing all of the files listed at the start of this document. License and Registration You are authorized to use FPBlt for a thirty (30) day period for the purpose of evaluation. If you like the program and choose to use it after this period, you are required to register your copy. Registered owners of FPBlt will receive a Key Code that will enable additional features that have been, and will be added in the future. In addition, registered users are entitled to receive a discount when registering any other software I author(ed). Finally, you'll also have the satisfaction of knowing that you're helping to support the availability of inexpensive software. At $25 (US), that isn't asking for too much. Of course, if you believe FPBlt to be worth more than $25, I won't stop you from sending in a higher amount! Please make your check payable to GEORGE SILBERSTERN, and mail it to the following address: George Silberstern 1 Makefield Road #E-184 Morrisville, Pa 19067 FPBlt v2.2 Page ii 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� Finding the Author If you need to get in touch with me directly, you may call my system, NETRef BBS at 215/736-1889. You can connect to the BBS at speeds of 300-28800 Bps (US Robotics V.Fast). Once your account has been validated (done online), you will be able to leave me a message. If you have access to Fidonet, you can send a Netmail message to me at 1:273/214. If you have a problem running FPBlt, please be specific about it in your message and leave a means to contact you. I will get in touch just as soon as I'm able to. If you call my BBS and wish to find the latest release of this, or any other software I have written for public release, they can be found in the File Area #1, "SOFTWARE AUTHORED BY THE SYSOP", off the Main Board. If you have access to a FidoNet site, you can always File Request the program from 1:273/214. A complete list of files available online is always available using the Magic Name, FILES. Page iii FPBlt v2.2 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� Warranty and Copyright Information The author of this program shall not be held responsible or accountable, under any circumstance, for the behavior or performance of the program. Furthermore, neither the author, or any party given permission to distribute this program, shall be held liable or responsible for damages incurred, including the incidental or consequential loss of data, equipment or income, that may result from usage or inability to use this program. This also implies any data rendered inaccurate, and/or loss sustained by third parties. These terms apply in all cases and situations, even if the author has been advised of the possibilities of such damages, or for any claims by any other parties. All the programs, products, and features thereof, that are mentioned in this documentation, are copyrighted and/or trademarked by their respective owners and authors. Please refer to the documentation of each product to determine the actual copyright and/or trademark owner(s). Errors, or omissions are unintentional. Notes of Appreciation A special "Thank You" goes to the following SysOps for being among the first to register FPBlt: John Stewart, The Lunatic Fringe BBS (1:124/2113) 214/235-5288 Bill Athineos, InFiNiTe SoLiTuDe BBS (1:2619/156) 516/829-4804 Frank Gaude (�), High Sierra Online (1:203/888) 916/577-4015 Don Patrick, Shareware Depot BBS (1:157/561) 216/886-2321 FPBlt v2.2 Page iv 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� About the Author George Silberstern was born and raised in Quito, Ecuador (South America). He took a passing interest in Computer Science while in High School. Computers became his hobby (ie. vice) while in College, where he majored in Communications and Foreign Languages, and during his Freshman year, in 1984, discovered Telecomputing and started his first BBS. George has also taught himself several Computer programming languages. In 1987, George began consulting on a freelance basis, primarily developing custom database applications using Clipper. In 1990, he started NETRef BBS, in order to provide product support for his clients, and as a place where users can obtain help with hardware and software problems. In 1991, NETRef BBS became a member of FidoNet, and shortly thereafter became the first United States support site for FidoPCB, a Fido to PCBoard Message format converter originating in Europe. Page v FPBlt v2.2 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� Other Programs I have also written a number of other programs which can be found on Bulletin Boards around the world. They have all been released as either Shareware or Freeware. A list of these is included separately, along with descriptions and other information. These files are File Requestable (FREQ) via Fidonet, and also found in File Area 1 (Software authored by the SysOp) on NETRef BBS FPBlt v2.2 Page 2 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� I] - Introduction to FPBlt FPBlt is a utility designed for use in conjunction with the FidoPCB Mail Tosser written by Matjaz Koce, and PCBoard v14.5 or later. In addition, FPBlt will work with Russell Frey's PowerBBS v3.2 and later. It is meant to provide the user with the means of creating an activity (traffic) summary that can be presented to BBS callers, a function not available from within FidoPCB. The program is very easy to set up and run, as preparation consists of editing the Configuration file, including the Bulletin file declaration in your Bulletin Board's Configuration file, and adding it to your Mailer batch files. In short, reading this Users Manual is a more involved than getting FPBlt up and running. But don't take that as an excuse not to read this thoroughly at least once... FPBlt was originally written with Microsoft QuickBasic v4.5, but due to the limitations of that environment, the code has been ported to CA/Clipper. This version of FPBlt was written with the Summer '87 release of this compiler. Basic runtime information is obtained from the Configuration file, and the rest is gathered from both the BBS and FidoPCB Configuration files. NOTE: FPBlt will definitely not work with releases of PCBoard prior to v14.5 or releases of PowerBBS prior to v3.2. 3 FPBlt v2.2 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� II] - Release Notes FPBlt is being released as Shareware. In its unregistered format, the program has the same functional capabilities as its registered counterpart, but there are a few behavioral differences between them. Quite simply, the unregistered version of FPBlt will sound a brief alert whenever it runs, for as long as you use an unregistered version of FidoPCB and/or FPBlt (it is short, really). In addition, bulletin colors cannot be customized as long as FPBlt remains unregistered. Lastly, while all Message Areas will be processed by FPBlt, only the first twenty (20) areas will be posted for as long as the program remains unregistered. The registered version of FPBlt eliminates the aforementioned alert (as long as FidoPCB is also registered), and will post all configured areas. Registration also entitles you to future upgrades of FPBlt, with all of its features enabled, because any features that may be added down the line will not be accessible to unregistered users. But enough with the hoopla! A registered version of FPBlt can be yours for a mere $25.00 (US). Yes, you read correctly: Twenty five US Dollars, and you're the proud owner of a copy of FPBlt for life! FPBlt v2.2 Page 4 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� III] - Installing FPBlt NOTE: Please be aware that this manual will assume you are using PCBoard v15.0 or later. If you are still using v14.5, the PCBSetup options might be labeled somewhat differently. PowerBBS users, please read these instructions thoroughly and replace references to PCBoard and the PCBoard Setup utilities with their PowerBBS equivalents. a) Requirements: You need to be running either PCBoard v14.5 or later, PowerBBS v3.2 or later, and FidoPCB v1.4 or later. You will also need a Text File Editor such as QEdit, PCWrite, EDLIN (urgle), or similar. Finally, you need to decide where FPBlt will be installed and run from (the directory containing FidoPCB is the best place). b) Preparation (FPBlt): Copy the FPBLT.EXE, FPBLT.INI and REBUILD.BAT files into the directory from which you will run FPBlt. Next, edit the FPBLT.INI file. It contains thirteen lines, as follows: 1] Must be all zeroes (0) -sixteen in all- or contain the validation key provided by the author 2] Your Site Address (same as the ORIGIN line in FIDOPCB.CFG) � 3] The name of your BBS or the name you want FPBlt to display in the Traffic Summary bulletin (30 character limit -additional characters will be truncated) 4] Bulletin Board Software being used. PCBoard users should indicate PCBOARD, PowerBBS users indicate POWERBBS. 5] Location of the FidoPCB files (DO NOT ADD A TRAILING '\'!) 6] The full path and name of PCBOARD.DAT 7] The full path and name of the Traffic bulletin � 8] Column Header text color in the Summary Bulletin. For a list of colors, please refer to the section titled, "Available Colors" later in this manual. � 9] Area Name text color in the Summary Bulletin � 10] Received Message counts color in the Summary Bulletin � 11] Sent Message counts color in the Summary Bulletin � 12] Activity Total counts color in the Summary Bulletin � 13] Grand Total counts color in the Summary Bulletin � Enabled in the Registered version only Information on REBUILD.BAT appears in its own section later in this manual. c) Preparation (Batch Files): The only way to generate a Traffic Summary bulletin, is to invoke FPBlt immediately after the execution of FidoPCB. Since there is more than one occasion or situation where FidoPCB may be executed, you should place a statement invoking FPBLT, immediately following each line which invokes FidoPCB. The The most common place for this is the 'Control' Batch File for your Mailer, but if you run FidoPCB as part of your Events, as part of a BBS Batch file (including Doors), you need to do this there too. Page 5 FPBlt v2.2 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� Given the way FidoPCB runs, if you do not, you may loose vital traffic information. To produce the Traffic Summary bulletin, FPBlt reads the Transaction Statistics file (FIDOPCB.STA), which FidoPCB will create or overwrite every time it runs. The only way to salvage that information then, is to be sure that FPBlt runs immediately after FidoPCB. d) Preparation (PCBoard): In order to make the bulletin generated by FPBlt available to BBS callers, you need to load PCBSetup (PowerBBS users, please refer to your Software documentation for instructions on completing these procedures). Choose option I (Main Board Configuration), or option J (Conferences). Should you opt to make FPBLt available from within a Conference, you will have to select the desired entry. Once you are at the first Conference Setup screen, highlight the "Bulletin Menu Listing" option and press to add the FPBlt Bulletin to the ASCII menu screen. After saving, repeat the process for the Graphical version and again for the RIP version (if you use one or both of these). Next, select the "Bulletin Path/Name List File" option, and press to edit it. Add the path and name of the Traffic bulletin file which you specified on line 11 of the FPBLT.INI file. Press to exit the Path Editor, and save the changes. If you are making the bulletin available in additional Conferences, and each Conference has its own Bulletins list, repeat this process for each Conference from which it can be viewed. Unless you wish to get really fancy, this will complete the installation and Setup procedures for FPBlt. PCBoard v15.0 allows the SysOp to do all sort of nifty tricks, such as Conference Introduction Bulletins, etc. You are always free to merge the bulletin file into one more of these features, but since there are so many possibilities, they will not be discussed in this manual. However, if you can come up with a unique implementation, please contact the author with the specifics. If it is considered worthwhile, they will be included in the manual. FPBlt v2.2 Page 6 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� IV] - Command Line Options When run on its own, FPBlt simply takes the information it needs from the statistical file generated by FidoPCB, and creates a BBS ready bulletin with it. Special functions can be accessed by using command line switches. Currently, FPBlt supports the following switches: /BUILD - This switch makes it possible to add or remove Message areas from the FPBlt Pointer file while retaining all of the accumulated statistics. Switches may be entered in upper or lower case. Invalid switches cause the program to exit with an error message. Page 7 FPBlt v2.2 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� V] - Using the Rebuild program REBUILD.BAT is a ready made program which, in conjunction with the /BUILD switch, will delete areas that are no longer listed in your FidoPCB configuration. It also clears them from the FPBlt Pointer file, while retaining the statistics for the remaining areas. The file does require minor editing, so that it will work with your particular configuration. If you look at the file included with the FPBlt archive, you will notice a section titled SETUP. All you have to do is modify the parameters listed, so that they contain the correct drive and path information, as applicable to your system. These parameters are: toss_drv = c: (Drive where FIDOPCB is located) fpbt_drv = c: (Drive where FPBLT is located ) toss_path = \fp (Path to FIDOPCB files - No trailing "\") fpbt_path = \fpblt (Path to FPBLT files - No trailing "\") These parameters are used by the program to execute drive and directory changes, and are cleared before the program ends. You will need to be sure your environment buffer has enough free space to hold them, or the results may be unpredictable. My Environment Inspector, ENVIRO, will give you that answer real quick. Before using REBUILD, you must be ABSOLUTELY certain that you have no mail waiting to be processed (inbound and outbound), otherwise you will loose traffic statistics. When run, REBUILD will make a backup of the current FIDOPCB.CNF file, so that you can quickly recover if things go wrong. If they do, rename FIDOPCB.CN! to FIDOPCB.CNF and you will be all set. A backup of FPBLT.PTR is also made, and can be restored by renaming FPBLT.BAK to its original name. REBUILD first creates a new FIDOPCB.CNF file, by executing FidoPCB with the SET ALL TOP command line parameters. After this file was created, it runs FPBlt with the /BUILD switch to update the Pointer file. The counts from areas carried over will be retained, and new areas are initialized with a value of zero. FPBlt v2.2 Page 8 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� VI] - How it all works FPBlt is very quick and straightforward. For the technically minded, here's how the program works: The first thing FPBlt does is read the Configuration file, from which it extracts information needed in order for the program to work. It then reads FIDOPCB.CNF in order to extract the Area Names. Next, a database is created for these, if it doesn't exist. If it does, but has less areas than FIDOPCB.CNF, the extras are appended. Once this is done, a check is made to see if there was a rollover on the calendar. If this took place since the last run, then FPBlt will recycle the daily, monthly and/or yearly statistics, based on which has changed. The recycle process adds the daily totals to the monthly counts, resetting the daily counts to zero. The same is done to the monthly and yearly totals, as necessary. In the case of the yearly totals, these are simply reset to zero, so that the year starts out with a clean slate. At this point FPBlt has completed its housekeeping and is ready to merge the results from the last run of FidoPCB. It does this by reading the Statistical file, FIDOPCB.STA, in which FidoPCB stores the most recent activity. If there was no activity or an error, the file is smaller than the 300 byte header, and in this case, FPBlt shuts down. If any activity was recorded, then the message areas and their respective In/Out transactions will be extracted. The areas are then matched against both of the previously loaded tables, and the counts added to the daily statistics. Once the statistics have been updated, they are written back to the database. Once the database has been updated, FPBlt proceeds with the creation of the Traffic Summary bulletin. A portion of the text contained in the bulletin file is matched against FIDOPCB.CFG, and then the bulletin file is constructed in earnest. The daily, monthly, yearly and total counts for each area are read from the database. The grand totals are calculated on the fly. If the program is operating in "Unregistered" mode, FPBlt will only write the first twenty areas to the Bulletin file. After generating the bulletin, FPBlt erases the FidoPCB Statistical file in order to avoid duplicate readings of the same run of FidoPCB, and then shuts down. Page 9 FPBlt v2.2 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� VII] - Error Messages If an error condition arises while running FPBlt, the program will halt with an error message. Nearly all of the error messages observe the following format: FPBlt vx.xx � Mail Traffic Bulletin Generator for FidoPCB Error [ppp(###)] - ttt Program Halted! Where ppp is the portion of the program causing the error, ### is the exact location, and ttt is the type of error. The is an additional definition for the error, but only appears in certain circumstances. If the error condition is caused by a file/path error, the following message may be displayed: FPBlt vx.xx � Mail Traffic Bulletin Generator for FidoPCB Error nn [] - Program Halted! Where nn is a DOS Error number (consult your manual for a description of these error numbers), and is the file that caused it. If the error condition is caused by an error in the Command Line, the following message will be displayed: FPBlt vx.xx � Mail Traffic Bulletin Generator for FidoPCB Invalid Parameter issued on Command Line: [] - Program Halted! Valid switches are: /BUILD Where sw is the Command Line parameter passed to the program. FPBlt v2.2 Page 10 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� VIII] - Color Codes The following charts contain the numeric values which correspond to FPBlt's internal color table. Choose the color combinations you desire to use in the bulletin created by FPBlt and insert them on the apropriate line in the FPBLT.INI configuration file. NOTE: Custom Colors are only available when FPBlt operates in Registered mode, and ignored in unregistered mode. Low Intensity Colors 旼컴컴컴컴컴컴컴컴컴컴컴컴컴켠컴컴컴컴컴컴컴컴컴컴컴컴컴컴� � CODE BACKGRND FOREGROUND � CODE BACKGRND FOREGROUND � 팠袴袴袴袴袴袴袴袴袴袴袴袴袴誥袴袴袴袴袴袴袴袴袴袴袴袴袴袴� � 1 Black Black � 33 Blue Black � � 2 Black Red � 34 Blue Red � � 3 Black Green � 35 Blue Green � � 4 Black Brown � 36 Blue Brown � � 5 Black Blue � 37 Blue Blue � � 6 Black Magenta � 38 Blue Magenta � � 7 Black Cyan � 39 Blue Cyan � � 8 Black Lt. Grey � 40 Blue Lt. Grey � � 9 Red Black � 41 Magenta Black � � 10 Red Red � 42 Magenta Red � � 11 Red Green � 43 Magenta Green � � 12 Red Brown � 44 Magenta Brown � � 13 Red Blue � 45 Magenta Blue � � 14 Red Magenta � 46 Magenta Magenta � � 15 Red Cyan � 47 Magenta Cyan � � 16 Red Lt. Grey � 48 Magenta Lt. Grey � � 17 Green Black � 49 Cyan Black � � 18 Green Red � 50 Cyan Red � � 19 Green Green � 51 Cyan Green � � 20 Green Brown � 52 Cyan Brown � � 21 Green Blue � 53 Cyan Blue � � 22 Green Magenta � 54 Cyan Magenta � � 23 Green Cyan � 55 Cyan Cyan � � 24 Green Lt. Grey � 56 Cyan Lt. Grey � � 25 Brown Black � 57 Lt. Grey Black � � 26 Brown Red � 58 Lt. Grey Red � � 27 Brown Green � 59 Lt. Grey Green � � 28 Brown Brown � 60 Lt. Grey Brown � � 29 Brown Blue � 61 Lt. Grey Blue � � 30 Brown Magenta � 62 Lt. Grey Magenta � � 31 Brown Cyan � 63 Lt. Grey Cyan � � 32 Brown Lt. Grey � 64 Lt. Grey Lt. Grey � 읕컴컴컴컴컴컴컴컴컴컴컴컴컴켕컴컴컴컴컴컴컴컴컴컴컴컴컴컴� Page 11 FPBlt v2.2 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� High Intensity Colors 旼컴컴컴컴컴컴컴컴컴컴컴컴컴켠컴컴컴컴컴컴컴컴컴컴컴컴컴컴� � CODE BACKGRND FOREGROUND � CODE BACKGRND FOREGROUND � 팠袴袴袴袴袴袴袴袴袴袴袴袴袴誥袴袴袴袴袴袴袴袴袴袴袴袴袴袴� � 65 Black Dk. Grey � 97 Blue Dk. Grey � � 66 Black Lt. Red � 98 Blue Lt. Red � � 67 Black Lt. Green � 99 Blue Lt. Green � � 68 Black Yellow � 100 Blue Yellow � � 69 Black Lt. Blue � 101 Blue Lt. Blue � � 70 Black Violet � 102 Blue Violet � � 71 Black Lt. Cyan � 103 Blue Lt. Cyan � � 72 Black White � 104 Blue White � � 73 Red Dk. Grey � 105 Magenta Dk. Grey � � 74 Red Lt. Red � 106 Magenta Lt. Red � � 75 Red Lt. Green � 107 Magenta Lt. Green � � 76 Red Yellow � 108 Magenta Yellow � � 77 Red Lt. Blue � 109 Magenta Lt. Blue � � 78 Red Violet � 110 Magenta Violet � � 79 Red Lt. Cyan � 111 Magenta Lt. Cyan � � 80 Red White � 112 Magenta White � � 81 Green Dk. Grey � 113 Cyan Dk. Grey � � 82 Green Lt. Red � 114 Cyan Lt. Red � � 83 Green Lt. Green � 115 Cyan Lt. Green � � 84 Green Yellow � 116 Cyan Yellow � � 85 Green Lt. Blue � 117 Cyan Lt. Blue � � 86 Green Violet � 118 Cyan Violet � � 87 Green Lt. Cyan � 119 Cyan Lt. Cyan � � 88 Green White � 120 Cyan White � � 89 Brown Dk. Grey � 121 Lt. Grey Dk. Grey � � 90 Brown Lt. Red � 122 Lt. Grey Lt. Red � � 91 Brown Lt. Green � 123 Lt. Grey Lt. Green � � 92 Brown Yellow � 124 Lt. Grey Yellow � � 93 Brown Lt. Blue � 125 Lt. Grey Lt. Blue � � 94 Brown Violet � 126 Lt. Grey Violet � � 95 Brown Lt. Cyan � 127 Lt. Grey Lt. Cyan � � 96 Brown White � 128 Lt. Grey White � 읕컴컴컴컴컴컴컴컴컴컴컴컴컴켕컴컴컴컴컴컴컴컴컴컴컴컴컴컴� FPBlt v2.2 Page 12 컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� USER NOTES: