------------------------------------------------------------------ | | | | | | | | | FXFLAG Version 1.0 | | | | | | PCBoard FLAG.PPE Enhancement for PCBFX (I)nfo | | | | For | | | | PCBoard Versions 15.1 through 15.2x | | | | | | | | FXFLAG is a mod to the popular CDC FLAG.PPE. FXFLAG adds | | quick scans of DOWNLOAD.TXT or a DATABASE and reports: | | | | - Number of times a file has been download | | - Who uploaded Date of upload | | - Last download date Time to download | | - Are time/bytes charged? Enough time/bytes? | | - Compressed file data (oldest, newest, quantity) | | - and much more... | | | | | | | | FXFLAG requires PCBFX from Yandell Custom Software. | | | | | | | | | | PCBFX (C) Copyright 1992-1995 Yandell Custom Software | | | | | | | | FXFLAG Version 1.0 | | | | (C) Copyright 1995 Yandell Custom Software | | | | 9438 U.S. Hwy 19 N. - Suite 212 | | Port Richey, FL 34668 | | | | DATA - (813) 842-8099 | | | | | | August 11, 1995 | | | | | | | ------------------------------------------------------------------ -------------------------------------------------------------------- FXFLAG -------------------------------------------------------------------- TABLE OF CONTENTS Page ----------------- ---- INTRODUCTION ------------ 1.0 What Is FXFLAG 3 1.1 Requirements 3 INSTALLING FXFLAG ----------------- 2.0 Step-By-Step Installation 4 2.1 Fine-Tuning PCBFX 5 2.2 Modifying FXFLAG.PPE 5 2.3 Modifying Text Prompts and Files 6 RUN-TIME CONSIDERATIONS ----------------------- 3.0 Notes Regarding PCBFX Profiles with FXFLAG 7 MISCELLANEOUS ------------- 4.0 How To Receive Assistance 8 4.1 License to Use FXFLAG 8 4.2 Disclaimer and Warranty (none) 9 4.3 Author Information 9 -------------------------------------------------------------------- Page 3 FXFLAG Page 3 -------------------------------------------------------------------- 1.0 What is FXFLAG ------------------- FXFLAG is a modified version of the popular FLAG.PPE from Clark Development Company. FLAG.PPE allows the caller to flag a file for download by highlighting file names with the SPACE bar while listing directories. Callers can also VIEW compressed files by pressing "V" while a file is highlighted. With FXFLAG, callers can now also press the letter "I" while a file is highlighted, or they may press "I" then enter a file name. The addition of the "I" command has been made to look and work like the commands in the original FLAG.PPE as much as possible. FXFLAG adds the ability for the caller to obtain extra (I)nformation that is provided by PCBFX. PCBFX is required to use FXFLAG.PPE. PCBFX (PCBoard File Xfer) provides a file transfer "PROFILE" using PCBoard's DOWNLOAD.TXT file. Information such as the number of downloads, who uploaded, the date of the last download, the date of the upload, and the date at which the profile scan begins can be displayed to the caller. ALL of this information is displayed in a text file, so that both the content and appearance of what the caller sees in the profile report is 100% configurable by the Sysop. PCBFX can be set to either scan DOWNLOAD.TXT or to use a database created with the the PCBFX/FXDBM utility for INSTANT file profiles. All of the file profile categories may have their own security attached to them so only certain callers can see the information in certain categories. A default uploader name may be displayed when there is none found in DOWNLOAD.TXT. This could be useful for Sysops who manually add many files to their systems. The prompt in FXFLAG.PPE will appear as this: (60 min left), (H)elp, (V)iew, (I)nfo, (SPACE)=Mark, More? ^^^^^^^ 1.1 Requirements ----------------- PCBFX from Yandell Custom Software is required. It must be installed and completely functional in order for the new "I" command in FXFLAG to function properly. This documentation for FXFLAG assumes the Sysop is already familiar with PCBFX. To some degree, it also assumes the Sysop is familiar with the original FLAG.PPE, due to its popularity and the fact it is included with PCBoard. PCBoard must be set to "Swap Out During Shell". This setting is in PCBSetup: "G Configuration Options", "D Configuration Switches". The FXFLAG.PPE will shell to PCBFX and this setting will insure that enough memory is available. -------------------------------------------------------------------- Page 4 FXFLAG Page 4 -------------------------------------------------------------------- 2.0 Step-By-Step Installation ------------------------------ (1) Backup PREFILER in the \CMDFILES directory (this is usually in a location such as \PCB\CMDFILES). You may not currently have a PREFILER file and/or a \CMDFILES directory. If not, you may skip this step. NOTE: Since the FXFLAG files are placed in the PCBFX directory, your original installation of FLAG.PPE and its other files will not be affected by FXFLAG installation. (2) Extract the contents of FXFLAG10.ZIP into your PCBFX directory. If you have not installed PCBFX, put FXFLAG away for now and obtain PCBFX and completely install it. PCBFX is required first. (3) Copy the new PREFILER file to the PCBoard \CMDFILES directory if you have one. If not, then skip this step. The use of this new PREFILER is a MUST for RIP callers. If you have no RIP callers, this is not needed. The \CMDFILES directory needs to be defined in PCBSetup, "B-File Locations", "A-System Files & Directories". (4) Run MKPCBTXT.EXE - Enter PCBTEXT or a valid PCBTEXT file name. (5) Press F3 (jump to #). Enter 549 and press ENTER. (6) If FLAG.PPE is already installed, note the information currently in this parameter, in case you decide to resume using FLAG.PPE. (7) Enter ! (exclamation point), followed by the drive and directory location of PCBFX, followed by the file name of FXFLAG.PPE. For example, if PCBFX is installed in "C:\PCBFX" (no quotes), you would enter: !C:\PCBFX\FXFLAG.PPE (8) Press ESC to exit MKPCBTXT.EXE. (9) Run PCBSETUP.EXE. Select "G Configuration Options". Then select "D Configuration Switches". Then find "Swap Out During Shell" on the screen and make sure it is answered with a "Y". If PCBFX is already installed and working properly, and FXFLAG has been installed properly, you should be ready to try it out. See the following sections about fine-tuning PCBFX and modifying FXFLAG.PPE. -------------------------------------------------------------------- Page 5 FXFLAG Page 5 -------------------------------------------------------------------- 2.1 Fine-Tuning PCBFX ---------------------- The PCBFX setup program FXSETUP.EXE contains a switch that controls whether PCBFX writes an entry to the CALLER logs when a caller performs a file profile. You may wish to set this to no, because the the new (I) command will probably cause profiles to be performed more often, which will increase the size of your CALLER logs. 2.2 Modifying FXFLAG.PPE ------------------------- The source code for FXFLAG.PPE is included. Each and every addition, modification and deletion in the original FLAG.PPS is documented with the nomenclature: 'FX - either just above or immediately to the right of the change. The original source code was FLAG.PPS from version 3.2 (FLAG32.ZIP). The original source has been included in accordance with FLAG.DOC from Clark Development Company. All modifications were "additive" for the "PCBFX (I)nfo" process except for one. Lines 267 through 276 in FXFLAG.PPS correct a small anomaly in the original FLAG.PPE. This would occur when a caller pressed "V" to view a file and then simply pressed enter at the file name prompt. FLAG.PPE would send a carriage-return to PCBoard, which would then scroll to the next screen of directory listings instead of staying on the present screen of file listings. Some modifications you may wish to make are in the :PCBFX subroutine at the end of FXFLAG.PPS. You can see where we borrowed the variable called "text" to define the file name input prompt. You may wish to change this to meet your needs, or make it language compatible. A little further down you see the text "Checking File Info...", which you may wish to also change. You may want to modify the PCBFX SHELL command. As you will see, an example was left in a "comment" line showing how to place FXFLAG.PPE and its files somewhere other than in the PCBFX directory (you would place the exact location -AND- PCBFX.EXE file name as shown in the source code. NOTE: Be very careful when modifying the SHELL command. NEVER omit the /PPE parameter or PCBFX will NOT perform properly. If you are using PCBoard 15.22 and running in a multi-tasking setup, you can change all occurrences of INKEY() to TINKEY(0) to make FXFLAG more friendly. If you are using PCBoard 15.1, 15.2 or 15.21 you can add the command DELAY 2 immediately before each INKEY() and that will help also. Other things you may want to add are DELAY 2 before each occurrence of the INKEY() function. This will assist the The enclosed FXFLAG.PPE was compiled with PPLC version 2.0 for compatibility with systems running older versions of PCBoard. -------------------------------------------------------------------- Page 6 FXFLAG Page 6 -------------------------------------------------------------------- 2.3 Modifying Text Prompts and Files ------------------------------------- Included with FXFLAG.PPE are six files that were also enclosed with the original FLAG.PPE. For the most part, the only change in these files is the addition of the new (I)nfo command. For the sake of familiarity, the names are unchanged and the original look-and-feel of the prompts was not altered in most cases. All of these files must reside with FXFLAG.PPE except where noted. FLAGNEW ------- This file contains the following prompt (color codes omitted here): (@MINLEFT@ min left), (H)elp, (V)iew, (I)nfo, (SPACE)=Mark, More? Change: Addition of "(I)nfo" command. FLAGOLD ------- The prompt in this file is used if the caller cannot process ANSI: (@TIMELEFT@ min left), (H)elp, (V)iew, (I)nfo, (F)lag, More Change: Addition of "(I)nfo" command. FLAGBAR ------- This file contains the following prompt (color codes omitted here): Press SPACE to move down, ENTER to flag, V to view, I for info, - - ESC to exit Change: Addition of "(I)nfo" command. FLAGBARR -------- This is used for RIP callers. This file was slightly changed so that it provides a little more instruction to the caller. FLAGHLP ------- This is the help file that is displayed if the caller presses "H" at the above prompts. This file was modified considerably for FXFLAG. Changes include the addition of (I)nfo instructions, the appearance was changed considerably to more closely resemble PCBoard's other help files, and instructions for other sub-commands were added. PREFILER (located in the \CMDFILES directory) --------------------------------------------- The (I)nfo "button" was added and the appearance of this RIP file was changed considerably for FXFLAG. -------------------------------------------------------------------- Page 7 FXFLAG Page 7 -------------------------------------------------------------------- 3.0 Notes Regarding PCBFX Profiles with FXFLAG ----------------------------------------------- PCBFX will run differently when called by FXFLAG.PPE than when it runs as a DOOR. FXFLAG will send PCBFX a file name on the command line and PCBFX will display the file's profile. Then PCBFX will display a "Press Enter to Continue" prompt. PCBFX will return to FXFLAG.PPE instead of displaying the PCBFX menu. The PCBFX menu is never displayed when PCBFX has been called by FXFLAG.PPE. This means that PCBFX quickly runs, displays the file profile, then exits to FXFLAG.PPE for smooth, SEAMLESS integration of the "(I)nfo" function. None of the menu functions are available in this mode. PCBFX takes the file name passed on the FXFLAG SHELL command line and processes it exactly as if it had been entered with the PCBFX (S)elect command, as follows: If the extension is omitted from the filename when a caller manually enters it, the default extension for compressed files as defined with FXSETUP.EXE will be used by PCBFX. After a file name is entered, PCBFX will check to insure that it is a valid file name and could exist. File names which do not conform to DOS name conventions or which could be a DOS device will not be accepted. PCBFX will then scan the download path from PCBoard for the conference the caller is currently in. If the file does not physically exist, the caller will be informed, and PCBFX will prompt the caller to enter the file name again. If the caller does not have enough access to download a file in PCBoard they will also not be able to perform a profile on that file. If a file in PCBoard is password protected, PCBFX will require the caller to enter the password before allowing the profile. If the caller is in a conference that has been included in the "conference block" list in FXSETUP, the 'who uploaded' information will be replaced with "Unavailable". All parameters in the PCBFX portion of the FXSETUP.EXE program will affect PCBFX operation with FXFLAG, unless the option is specific to one of the commands on the PCBFX menu, none of which are available to the caller since the MENU will not display when used with FXFLAG. -------------------------------------------------------------------- Page 8 FXFLAG Page 8 -------------------------------------------------------------------- 4.0 How To Receive Assistance ------------------------------ If all aspects of the FXFLAG.PPE work except the new (I)nfo command, insure that PCBFX is working properly as a DOOR on your system. If it is working properly as a door, insure you have located ALL of the FXFLAG files with PCBFX.EXE in the PCBFX directory. Insure that you have set PCBoard to "Swap out on shells" as outlined in this manual. If you see something in FXFLAG.PPE that is not working the same way it did in FLAG.PPE, then please let us know about it. This would of course pertain to functions not related to the (I)nfo command. If you see something odd in FXFLAG.PPE that also exists in FLAG.PPE, feel free to let us know. Most of the anomalies which exist in CDC's FLAG.PPE are known to FXFLAG's author. Fixing some of the anomalies inherited from the original FLAG.PPE, especially those related to (V)iewing files, would require a large restructuring of the PPE. It is YCS' stated intention "at this time" to make as few changes as possible to CDC's original FLAG.PPE. Yandell Custom Software (YCS) provides the following technical assistance for FXFLAG: 813-842-8099 The YCS Support System. Available to all BBS Sysops. INSTANT on-line credit card registration and support system for YCS Shareware. On-line 7 days per week, 24 hours per day. Support is also available on the Salt Air BBS (the home of PCBoard) in the YCS conference (#36). Limited voice support is available to registered users of PCBFX. 4.1 License To Use FXFLAG -------------------------- FXFLAG in a no-charge enhancement to PCBFX and may be used freely by registered users of PCBFX. PCBFX is not "public domain" or "free" software, however. The license to use PCBFX by unregistered users is governed solely by the PCBFX documentation. 4.2 Restrictions on Distribution --------------------------------- The FXFLAG distribution ZIP may not be included with any other product or service. Feel free to modify and distribute FXFLAG.PPS, however the following restrictions apply: - Use a file name for your program other than FXFLAG??. This applies to all files including source files and the distribution ZIP file. - Do NOT use ANY part of this documentation (FXFLAG.DOC). - Do NOT include FXFLAG.PPS or FXFLAG.PPE. - The restrictions CDC places on FLAG.PPE modifications apply to its derivatives. This means you must include the FLAG.PPS from CDC. -------------------------------------------------------------------- Page 9 FXFLAG Page 9 -------------------------------------------------------------------- 4.3 Disclaimer and Warranty (none) ----------------------------------- FXFLAG is a no-charge enhancement to Yandell Custom Software's PCBFX software. There are no warranties, expressed or implied, for FXFLAG. Sysops installing FXFLAG assume any and all liabilities for anything which results as a consequence of running FXFLAG. No part of any warranty for any other Yandell Custom Software product including but not limited to PCBFX, extends to FXFLAG. Under no circumstances shall Yandell Custom Software or the author of FXFLAG be liable for any loss of profit or any other damages, including but not limited to special, incidental, consequential, or other damages, arising out of the use or inability to use FXFLAG, or the use or inability to use PCBFX with FXFLAG. FXFLAG is a derivative of FLAG.PPE, a copyrighted "freeware" program released by the authors of PCBoard software. FXFLAG has been created and is distributed in accordance with their requirement of including the original FLAG.PPE source code with FXFLAG, and also with their requirement of naming the new work differently (FXFLAG). 4.4 Author Information ----------------------- Brent Yandell has been programming for over thirteen years including more than eight years of developing telecommunications software. Many Sysops will be familiar with PCBFV, the popular on-line PCBoard File Viewer. See the enclosed CATALOG.TXT file for a complete list of Sysop utilities from YCS. Yandell Custom Software (YCS) is a licensed business, operating and existing under the laws of the State of Florida since July, 1990. Writing BBS Shareware doors and utilities, in addition to custom programming, is our business... our ONLY business. First Door Release: 7/6/87 (USBBSDoor). Still updated and supported! YCS Shareware is GUARANTEED (each product's documentation contains each product's specific guarantee). FXFLAG is not Shareware and is not covered by any guarantee, however (see section 4.3 above). A dedicated multi-node BBS for support and on-line registrations, a toll-free voice line for registrations, and a voice support line for registered customers are just a few of the offerings in our effort to provide you with RELIABLE, FAST, FRIENDLY SERVICE.