CD Shareware Magazine 1997 January

home *** CD-ROM | disk | FTP | other *** search

/ CD Shareware Magazine 1997 January / CD_shareware_1-97.iso / DOS / COMUNICA / PCBFX24.ZIP / PCBFX.DOC < prev next >

Wrap

Text File | 1996-10-09 | 86.9 KB | 2,031 lines

------------------------------------------------------------------ | | | | | | | PCBFX Version 2.4 | | | | PCBoard File Transfer Profile Information Door | | | | | | | | | | Quickly scans 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... | | | | | | Callers may scan for THEIR OWN transfers (in certain modes). | | | | Callers may retrieve a "Top 50" Download Profile. | | | | All options are Sysop configurable (on/off). | | | | Conference blocking list for "Who Uploaded" info. | | | | Special Sysop level for Zippy text scans. | | | | Seamless Appearance when used as a "shelled-to" door. | | | | | | PCBFX Version 2.4 | | | | (C) Copyright 1992-1996 Yandell Custom Software | | | | 9438 U.S. Hwy 19 N. - Suite 212 | | Port Richey, FL 34668 | | | | DATA - (813) 842-8099 | | | | | | October 9, 1996 | | | | | | | ------------------------------------------------------------------ -------------------------------------------------------------------- PCBFX -------------------------------------------------------------------- TABLE OF CONTENTS Page ----------------- ---- INTRODUCTION ------------ 1.0 What Is PCBFX 3 INSTALLING PCBFX ---------------- 2.0 Upgrading from Earlier Versions 4 2.1 Preliminaries (first time installation) 4 2.2 Configuring PCBoard Door Files 4 2.3 Setting Up Door Batch Files 5 2.4 Selecting a PCBFX DATABASE Mode 6-7 2.5 Running FXSETUP and Editing PCBFX Parameters 8-13 2.6 Setting Up .CNF files for Multi-Language Use 14 2.7 Setting Up BLOCK.DAT 14 2.8 Setting Up the Profile INFO Display File 15-16 FXDBM DATABASE OPERATIONS ------------------------- 3.0 FXDBM Database (PCBFX.DAT) Overview 17 3.1 Running FXSETUP and Editing FXDBM Parameters 17-18 3.2 Initial Database Creation 19 3.3 Updating the Database 20 3.4 Managing DOWNLOAD.TXT (Database Mode #2) 21 3.5 Sample Automated Update Event Batch Snippets 22 3.6 Creating the (T)op 50 Download Report 23 3.7 Modifying PCBFX.DAT First Transfer Date 24 3.8 Purging PCBFX.DAT of Non-existent Files 24 RUN-TIME CONSIDERATIONS ----------------------- 4.0 Notes Regarding File Profiles 25 4.1 Notes Regarding Local Command Line Use 25 4.2 Notes Regarding (U)ploader Profiles 26 4.3 Notes Regarding Sysop Zippy Scans 27 4.4 Using PCBFX.DAT With FVMM 27 MISCELLANEOUS ------------- 5.0 Sysop Function Keys 28 5.1 Technical Notes 28 5.2 Where To Receive Assistance 28 5.3 Caller Log Entries 29 5.4 Revision History 29 5.5 Multi-Nodes, Networks, Multi-taskers 30 5.6 Disclaimer and Warranty 30 5.7 License to Use PCBFX 30 REGISTRATION ------------ 6.0 Registering PCBFX 31 6.1 Register With CONFIDENCE - Author Information 31 -------------------------------------------------------------------- Page 3 PCBFX Page 3 -------------------------------------------------------------------- 1.0 What is PCBFX ------------------ 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 enclosed 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. PCBFX has the ability to allow the caller to scan DOWNLOAD.TXT for their transfers (only). Callers may scan for their uploads, their downloads, or both. Use of this mode is contingent upon how the Sysop has installed PCBFX. If using the FXDBM database, PCBFX can optionally make a "Top 50" download profile. This profile can be retrieved by a caller in the door. The profile information is also suited to be used as a PCBoard bulletin. The Sysop has complete control of the appearance of the profile, as it is created from a template file the Sysop may modify. If using the FXDBM database, PCBFX can optionally allow callers to view the transfer profile on each of their own uploads (only) with one simple command (U). This is ideal for file uploaders and authors who can use this to measure how popular their uploads are. PCBFX also provides the ability for those at or above a certain security level (Sysops or co-Sysops) to perform "Zippy" text scans on DOWNLOAD.TXT. Typical scans may be for user names, file names, and possible dates of activity. The report is formatted in an easy to read display and non-essential info from DOWNLOAD.TXT is removed. A conference list can be created to block the "who uploaded" field. This is useful where there are conference files and this information should not be available to anyone. PCBFX is DESQview, OS/2 and Windows aware. PCBFX works with PCBoard /M and OS/2 software using a FOSSIL. PCBFX works with non-standard com ports. -------------------------------------------------------------------- Page 4 PCBFX Page 4 -------------------------------------------------------------------- 2.0 Upgrading from Earlier Versions ------------------------------------ Extract PCBFX24.ZIP into your PCBFX directory. Overwrite existing files except TOPTMP (the Top-50 template) unless the default is used (PCBFX.CNF is not enclosed in PCBFX24.ZIP). All of the files have significantly changed from previous versions. If you have customized the INFO files, you may do so again (with the new ones) to suit your needs. Set the new FXSETUP parameters as outlined in FEATURES.NEW and in this documentation. 2.1 Preliminaries (first time installation) -------------------------------------------- Create a directory or subdirectory where you normally place doors. Extract the entire contents of PCBFX24.ZIP into this location. All files enclosed in PCBFX24.ZIP must be located in the same location with PCBFX.EXE in order for the program to function properly. 2.2 Configuring PCBoard Door Files ----------------------------------- The intent in PCBFX is to install it as an "add-on" command on the PCBoard main menu, rather than in a door menu. First decide what you would like this new "command" (DOOR name) to be. Some examples: FX - Files Xfers FI - File Information >These are the most common examples, but FP - File Profile >you may name the command as you desire. Install a DOOR called FX (or whatever you decide to call it) into your DOORS.LST file using PCBSETUP. Answer the following questions: USER DOOR Filename Password Sec Login SYS SYS Shell (other parameters) -------- -------- --- ----- --- --- ----- ------------------ #) FX 10 N Y N S (set as needed) A password would usually not be required for your FX DOOR. A USERS.SYS file MUST be created. PCBFX will not operate without it. A DOOR.SYS file is NOT needed and should not be created. Answer "S" to the SHELL question. This will make PCBoard "shell" to the FX door (providing a seamless appearance) and at the same time PCBoard will "swap" itself from memory to insure PCBFX has enough memory to execute. NOTE: NEVER answer "F" or "Y" to this parameter! If you have different DOORS.LST files in your conferences, you will need to configure the FX door in them also. It is up to the individual Sysop as to whether or not to place the FX command on the doors menu, or as a command on the main menu, or both. The recommended usage is to place FX (or whatever the command will be called) on the main menu and not in the doors menu. -------------------------------------------------------------------- Page 5 PCBFX Page 5 -------------------------------------------------------------------- 2.3 Setting up Door Batch Files -------------------------------- The purpose of this section is to explain the command line calling syntax for PCBFX. Please refer to the PCBoard manual for a more complete discussion on door batch file installation. If you have named the door FX (recommended) the following examples would be the contents of your door file named FX (NOTE: do NOT place an extension such as .BAT on the FX file). A sample FX file is included in PCBFX24.ZIP. If you name the command "FP" or "FI" in DOORS.LST for example, then rename the FX file to FP or FI also. @echo off C:\PCBFX\PCBFX.EXE PCBFX.CNF %PCBDRIVE%%PCBDIR% ------------------ --------- ------------------ | | |-> This node's home directory. | | These environment variables | | will be filled automatically. | | | ----> The name of the configuration | file. Enter a file NAME only. | NEVER place a location here. | -------> The complete executable path and file name. The first parameter in the second line above is the only modification you will most likely need to make for your system. Substitute C:\PCBFX\ with the complete drive and path location where you have placed PCBFX.EXE and all associated files. The two lines in the sample FX door file above are all that is required to execute PCBFX when running as a shell door with PCBoard 14.5a thru 15.x. If you are not running PCBFX as a shelled door, add the call to BOARD.BAT as the third command in the door file. Do NOT end your door file with BOARD.BAT if running PCBFX as a shell door. -------------------------------------------------------------------- Page 6 PCBFX Page 6 -------------------------------------------------------------------- 2.4 Selecting a PCBFX DATABASE Mode ------------------------------------ IMPORTANT: Do not attempt to edit PCBFX.CNF files before reading this section. You MUST select a database mode when configuring PCBFX files. The valid selections are 1, 2 and 3. Each are described below. Please consider each database mode, and decide which is best for you and your system. Make a note of the number of the mode you choose. You will need to enter that number into the PCBFX config files. This number will also be referred to later in this manual when different sets of instructions are given for PCBFX operations depending on which mode PCBFX is using. Please keep in mind that any mention of the "event use" of the FXDBM utility requires PCBFX to be registered. * MODE #1 * ----------- In this mode, the FXDBM database is not used. PCBFX will use the PCBoard DOWNLOAD.TXT file only for all operations. The length of time it takes to process a "File Profile" scan will be dependent on the size of your DOWNLOAD.TXT file and the speed of the node PCBFX is running on. * (Y)our Profile scans *WILL* be available to the caller. * (T)op 50 Downloads scans are *NOT* available, since the FXDBM database is needed. * (U)ploader Profiles are *NOT* available, since the FXDBM database is needed. * (Z)ippy Sysop Text scans *WILL* be available to the Sysop. This mode is best for smaller systems which have a relatively small DOWNLOAD.TXT file. Mode #1 "Up-side" : There is no need to create and maintain the FXDBM database (PCBFX.DAT). The "(Y)our Profile" and "(Z)ippy Sysop Text commands are available. Mode #1 "Down-side" : The "File Profile" scans could be take time to complete, depending on DOWNLOAD.TXT size and BBS computer speed. The (T)op 50 Downloads & (U)ploader Profile commands are not available. NOTE: Mode #1 will cause PCBFX to behave the same as previous PCBFX versions with regard to scanning DOWNLOAD.TXT to retrieve a file profile. >>>>> MORE MODES are described on the NEXT PAGE <<<<< >>>>> MORE MODES ARE DESCRIBED ON THE NEXT PAGE <<<<< -------------------------------------------------------------------- Page 7 PCBFX Page 7 -------------------------------------------------------------------- 2.4 Selecting a PCBFX DATABASE Mode (continued) ------------------------------------------------ * MODE #2 * ----------- If "Mode #2" is used, the FXDBM database (PCBFX.DAT) *ONLY* is used for file profiles. DOWNLOAD.TXT must be REMOVED each time it is processed by FXDBM (such as in a system event). * File Profiles are INSTANT. * (Y)our Profile scans are *NOT* available to the caller, since the DOWNLOAD.TXT file is removed each time the database is updated. * (T)op 50 Download scans *WILL* be available. * (U)ploader Profiles *WILL* be available. * (Z)ippy Sysop Text scans are *NOT* available since DOWNLOAD.TXT is removed each time the database is updated. This mode is best where very large DOWNLOAD.TXT files are created each day due to heavy downloading. It is up to the Sysop to remove (rename, copy etc.) the DOWNLOAD.TXT file each time the database is updated. Examples for this are located on page 21 section 3.4. Mode #2 "Up-side": File Profiles are instant. (T)op 50 Downloads and (U)ploader Profiles are available. Huge DOWNLOAD.TXT files need not be kept on-line. Mode #2 "Down-side": (Y)our Profile, (U)ploader Profile, and (Z)ippy Sysop Text commands are not available. * MODE #3 * ----------- If "Mode #3" is used, both the FXDBM database (PCBFX.DAT) *AND* DOWNLOAD.TXT are used for file profiles. DOWNLOAD.TXT is KEPT after updating the database. PCBFX retrieves profile data from PCBFX.DAT and appends new data from DOWNLOAD.TXT. The size of DOWNLOAD.TXT is stored in PCBFX.DAT when it is updated. After PCBFX retrieves data from PCBFX.DAT it moves to that spot in DOWNLOAD.TXT and appends any new information. * File Profiles are INSTANT. * The "(Y)our Profile" command *WILL* be available to the caller. * (T)op 50 Download scans *WILL* be available. * (U)ploader Profiles *WILL* be available. * The (Z)ippy Sysop Text command *WILL* be available to the Sysop. Mode #3 "Up-side": File Profiles are instant. The (Y)our, (T)op, (U)ploader and (Z)ippy commands are ALL available. Mode #3 "Down-side" : On extremely large systems, the DOWNLOAD.TXT file could become very large. The FXDBM database must be updated often (though this can be done in the system event when registered). -------------------------------------------------------------------- Page 8 PCBFX Page 8 -------------------------------------------------------------------- 2.5 Running FXSETUP and Editing PCBFX Parameters ------------------------------------------------- Enclosed with PCBFX 2.4 is a file called FXSETUP.EXE. This file allows you to easily configure PCBFX configuration files. Only one PCBFX.CNF file is required for all nodes. Please refer to section 2.6 page 14 for information on creating PCBFX.CNF files for multi- language use. To start FXSETUP.EXE, enter FXSETUP at the DOS prompt. Select option number (1), EDIT PCBFX CONFIGURATION PARAMETERS. This will edit the parameters for the PCBFX door. Use PCBFX.CNF as the configuration file name for all nodes, unless your experience in setting up doors on your system indicates otherwise. Each parameter on the screen you see is described on the following pages. Press F1 at each parameter to display a help screen. * Your PCBFX Registration Number --------------------------------- This is the number received when PCBFX is registered. Registration causes the PCBFX [ UNREGISTERED COPY ] message and the brief delay at program termination to disappear. This message is not replaced with your board name or anything else. The entire line completely disappears for a true, seamless, "looks like PCBoard" process when running as a shell-door in PCBoard 14.5a thru 15.x. Registration also enables the event mode in the FXDBM database utility (if used). Registration stops FXDBM from placing the Unregistered Copy message into the "Top 50 Download" report. * Loc/Name of DOWNLOAD.TXT File -------------------------------- This is the LOCATION AND NAME of the DOWNLOAD.TXT file used in the PCBSetup parameter "Name/Loc of Transfer Summary File" located under a heading of "File Locations" in PCBSetup. Use the same location and file name that is used for DOWNLOAD.TXT in PCBSetup. Setting this parameter in a PCBFX configuration file also allows PCBFX to run in a command line local mode without having to read PCBoard files to determine the location and name of DOWNLOAD.TXT. The file in this parameter will be used in database modes #1 and #3 in the "Database Mode for PCBFX to Use" parameter described later. If using FXDBM to create a database from DOWNLOAD.TXT, this is NOT the parameter FXDBM uses for the DOWNLOAD.TXT name and location. That is another parameter on the "Edit FXDBM parameters" screen. ----- Section 2.5 continues on the next page -------------------------------------------------------------------- Page 9 PCBFX Page 9 -------------------------------------------------------------------- 2.5 Running FXSETUP and Editing PCBFX Parameters (continued) ------------------------------------------------------------- * Security to Show Who Uploaded File ------------------------------------- The caller must have this security or greater to display the name of the person who uploaded the file being profiled. This setting covers the @UPLOADNAME@ macro in the INFO file(s), and the corresponding parameter in the (U)ploader Profile scan. If the caller is below this level, the above information field will display "unavailable" or "not available" when shown to the caller. * Security to Show File Upload Date ------------------------------------ The caller must have this security or greater to display the date of the upload for the file being profiled. This setting covers the @UPLOADDATE@ macro in the INFO file(s), and the corresponding parameter in the (U)ploader Profile scan. If the caller is below this level, the above information field will display "unavailable" or "not available" when shown to the caller. * Security to Show Number of Downloads --------------------------------------- The caller must have this security or greater to display the number of downloads that have occurred for the file being profiled. This setting covers the @NUMBERDOWN@ macro in the INFO file(s), and the corresponding parameter in the (U)ploader Profile scan. If the caller is below this level, the above information field will display "unavailable" or "not available" when shown to the caller. * Security to Show Last Download Date -------------------------------------- The caller must have this security or greater to display the date of the last download for the file being profiled. This setting covers the @LASTDLDATE@ macro in the INFO file(s), and the corresponding parameter in the (U)ploader Profile scan. If the caller is below this level, the above information field will display "unavailable" or "not available" when shown to the caller. Section 2.5 continues on the next page -------------------------------------------------------------------- Page 10 PCBFX Page 10 -------------------------------------------------------------------- 2.5 Running FXSETUP and Editing PCBFX Parameters (continued) ------------------------------------------------------------- * Security for Special Sysop Functions --------------------------------------- This is the security level needed for PCBFX to allow the caller to use these two special Sysop functions: (1) The (Z)ippy scan for text in the DOWNLOAD.TXT file. (2) Entering a different user name in the (U)ploader Profile scan. * This should be a security level used by Sysops and Co-Sysops only. If using "Database Mode" #2 (see the parameter below), Zippy scans are not available since DOWNLOAD.TXT is not used in that mode. * Default Uploader Name ------------------------ If upload information is not found, a default name may be displayed. This is useful for instance when a Sysop manually adds many files to their system. If a default uploader name is present, PCBFX will use it in the @UPLOADNAME@ macro in INFO files if uploader information is not available about a file being profiled. Do not enter the @UPLOADNAME@ macro in this parameter. To disable this default feature and have "Unavailable" display when no upload information is found, enter NONE in this parameter. * 'Who Uploaded' Conference Block List --------------------------------------- If a caller performs an 'FX' request in one of the conferences in this list, the "Name of person who sent file' (who uploaded) will not be displayed. This is to accommodate Sysops who have conferences that have special conference files where the uploader should not be known. Simply enter conference numbers separated by a comma (,) such as: 13,14,15,16,17,54,200,201,202 You may group a block of conferences together with a dash: 13-17,54,200-202 Both of the above examples would block the same conferences. IMPORTANT: If you have areas important enough that you feel you need to protect with this feature, then ALWAYS TEST ALL CONFERENCES that are included in the list. Section 2.5 continues on the next page -------------------------------------------------------------------- Page 11 PCBFX Page 11 -------------------------------------------------------------------- 2.5 Running FXSETUP and Editing PCBFX Parameters (continued) ------------------------------------------------------------- * Compressed Filename Extension -------------------------------- The DEFAULT compressed filename extension is configured in the PCBFX configuration files. Setting this default in PCBFX files rather than reading this information from PCBoard system files allows this feature to be used in PCBFX's special Sysop local mode. When entering a filename for a 'File profile' this extension will be appended to the entry if an extension is omitted by the caller. The entry entered here should be the same entry for PCBFX as it is for PCBoard. If ZIP is the default extension for PCBoard, then ZIP be entered in this PCBFX parameter also. * Activity to Track in CALLER Logs ----------------------------------- You may select the activity to track in PCBoard CALLER files. * Profile executed on file (FILENAME.EXT) Enter (F) to have the above written to CALLER log files each time a caller performs a (F)ile Profile scan. * Zippy Scan for (text) Enter (A) (All) to have both File Profile scans and the above Zippy scan activity written to CALLER log files. Enter N for none if this tracking is not desired. This setting does not affect certain caller log entries such as caller input errors, security violations, etc. * Database Mode for PCBFX to Use --------------------------------- You MUST read pages 6 and 7 for an explanation of this parameter. >> IF YOU DO NOT READ PAGES 6 & 7, YOU WILL HAVE DIFFICULTY. << (1) Scan DOWNLOAD.TXT *ONLY* for file profiles. (2) Use the PCBFX.DAT database *ONLY* for file profiles. (3) Use PCBFX.DAT *AND* DOWNLOAD.TXT for file profiles. >> IF YOU DO NOT READ PAGES 6 & 7, YOU WILL HAVE DIFFICULTY. << Section 2.5 continues on the next page -------------------------------------------------------------------- Page 12 PCBFX Page 12 -------------------------------------------------------------------- 2.5 Running FXSETUP and Editing PCBFX Parameters (continued) ------------------------------------------------------------- * Disable (Y)our Profile Scans ------------------------------- You may turn off (Y)our-profile scans with database modes 1 & 3 (it is automatically turned off in database mode 2). Remove the command from FXMNU and FXHLP file if it is disabled. * Disable Compression Information ---------------------------------- When profiling compressed files, PCBFX can display the number of files inside it, the oldest file date and the newest file date. This process will cause PCBFX to take an extra second or two to read through the file to gather this information. This may disabled if this is not desired. (N)o, do not disable. Allow PCBFX to retrieve compressed file info. (S)low, disable "Slow drives" (CD Roms) only. PCBFX will use the slow drive list from PCBoard as configured with PCBSetup. If a file is on a drive in the PCBSetup "slow drive" list, PCBFX will not retrieve the compression information. (Y)es, completely disable retrieval of compression information. The macros for compression information should be removed from all the INFO files. * Security to use (U)ploader Profile ------------------------------------- If the FXDBM database is in use, (U)ploader Profile will display the following information to the user about their own uploads: File Name Times Downloaded Last Download Date Date Uploaded Callers must have this security or greater to use the (U) command. The FXSETUP.EXE "Security to show number of downloads, last download date, and upload date" are honored when displaying this information to the caller. (U)ploader Profile displays information about files the caller uploaded, even a file no longer actually exists. If the information about deleted files has not been purged from PCBFX.DAT, it will be displayed to the caller. Section 2.5 continues on the next page -------------------------------------------------------------------- Page 13 PCBFX Page 13 -------------------------------------------------------------------- 2.5 Running FXSETUP and Editing PCBFX Parameters (continued) ------------------------------------------------------------- * Main Prompt -------------- You may change PCBFX's main command prompt. The default is: (H)elp, File Profile Command? You may include the command letters or command abbreviations: (H)elp, (S), (L), (F), (T), (U), (Y), (X), (P), View Command? Note the example above does not contain "Z" for the Zippy function, as this function should only be made available to the Sysop. You should not include the "Y" or "U" if using database mode #2. What is entered here is exactly what is displayed. See section 2.6 on page 14 for information on multi-language use for this prompt. * File Prompt -------------- You may change PCBFX's file name input prompt. The default is: Filename for Transfer Profile (Enter)=none? What is entered here is exactly what is displayed. See section 2.6 on page 14 for information on multi-language use for this prompt. * Your Prompt -------------- You may change PCBFX's "(Y)our profile" input prompt. The default is (D)ownloads, (U)ploads, (A)ll, (Enter)=none? What is entered here is exactly what is displayed. See section 2.6 on page 14 for information on multi-language use for this prompt. * Zippy Prompt --------------- You may change PCBFX's "(Z)ippy scan" input prompt. The default is: Text for Zippy text search (Enter)=none? What is entered here is exactly what is displayed. See section 2.6 on page 14 for information on multi-language use for this prompt. -------------------------------------------------------------------- Page 14 PCBFX Page 14 -------------------------------------------------------------------- 2.6 Setting Up .CNF Files For Multi-language Use ------------------------------------------------- To make the configurable prompts in the PCBFX.CNF files language compatible, simply create a duplicate PCBFX.CNF file, except give it the appropriate EXTension. For instance with French, use French for the prompts in PCBFX.FRE and PCBFX will automatically use PCBFX.FRE instead of PCBFX.CNF as the configuration file. You do not need to worry about what PCBFX is passed in the door file. If passed PCBFX.CNF and the language is .FRE, PCBFX will look for PCBFX.FRE before using PCBFX.CNF. 2.7 Setting Up BLOCK.DAT ------------------------- If there are files which you wish callers to be able to download, but would prefer the profile remain private, you may "block" those file names by placing them in a text file called BLOCK.DAT. With a text editor, edit BLOCK.DAT in the location with PCBFX.EXE. Simply enter the COMPLETE or WILDCARD file names of those files which may exist on your system yet you do not wish callers to see a profile for. Press enter (RETURN) after each name is entered in BLOCK.DAT so that each entry is on a new line. If you not not wish to use this feature then delete BLOCK.DAT. See figure 2.7 below for examples of names in BLOCK.DAT. ------------------------------------------------------------------ | Good examples Bad examples | | ------------- ------------ | | *.CAP PCBFX uses regular DOS .CAP | | READ*.* wildcard specs to see if READ* | | ALLFILES.ZIP a file is a match. If so, ALLFILES. | | it cannot be profiled. | ------------------------------------------------------------------ ---- Figure 2.7 ---- BLOCK.DAT must reside in the same location with PCBFX.EXE There is a limitation of 100 entries in BLOCK.DAT. This should be sufficient for any needs regarding this parameter. The entries in BLOCK.DAT will not be used when the following occurs: (A) PCBFX is running in its /L local command line mode. (B) The caller's security level meets the security level defined for the Sysop Zippy scan in FXSETUP. -------------------------------------------------------------------- Page 15 PCBFX Page 15 -------------------------------------------------------------------- 2.8 Setting Up the Profile INFO Display File --------------------------------------------- The text file called INFO is what is displayed to the caller when a file profile request is made. All information displayed is done with @macros@ as described below, making the appearance and functionality of PCBFX file profiles 100% Sysop configurable. Two example files are included in PCBFX24.ZIP. They are INFO and INFO2. To see INFO2 used copy INFO to INFO1 then copy INFO2 to INFO. @FILENAMEFX@ This will be replaced with the file name that the current profile request is for. Padded to 12 characters. @FILENAME@ Same as above, no padding. @UPLOADNAME@ This is the name of the person who uploaded the file or the "default uploader" name as supplied if uploader information is not found. Padded to 25 characters. @UPLOADDATE@ This is the upload date. Padded to 12 characters. @NUMBERDOWN@ This is the number of times the file was downloaded. Padded to 12 characters. @LASTDLDATE@ This is the last date the file was downloaded on. Padded to 12 characters. The above 4 macros will replaced with "Unavailable" if the caller does not have security to view the parameter (as set in FXSETUP). @FIRSTDAT@ - @LASTDATE@ The first and last dates (respectively) of transfers in DOWNLOAD.TXT or PCBFX.DAT. NOTE THE SPELLING! @DLTIME@ The amount of time needed to download the file currently being profiled, in XX.X format. Padded to 8 characters. @DLSIZE@ Size of the currently selected profiled file. Padded to 8 characters. @TIMEDL@ A "Yes" or "No" response indicating whether or not the caller will be charged time to download the file being profiled. Padded to 8 characters. @BYTEDL@ A "Yes" or "No" response indicating whether or not the caller will be charged the bytes required to download the file being profiled. Padded to 8 characters. @CONFNO@ This is the conference number the caller is currently in while performing the File Profile. Padded to 8 characters. Section 2.8 continues on the next page -------------------------------------------------------------------- Page 16 PCBFX Page 16 -------------------------------------------------------------------- 2.8 Setting Up the Profile INFO Display File (continued) --------------------------------------------------------- @TIMEOK@ A "Yes" or "No" response indicating whether or not the caller has enough time left to download the file being profiled. Padded to 8 characters. @BYTEOK@ A "Yes" or "No" response indicating whether or not the caller has enough bytes left to download the file being profiled. Padded to 8 characters. @DLPASS@ A "Yes" or "No" response indicating whether or not the caller will be required to enter a password to download the file being profiled. Padded to 8 characters. @FLAGDL@ A "Yes" or "No" response indicating whether or not the file being profiled is flagged for download. Padded to 8 characters. @OLDATE@ If the file being profiled is a compressed file in ZIP, ARJ, RAR, LZH or ARC format, this will indicate the OLDEST file date found for a member file inside the compressed file. Padded to 8 characters. @NWDATE@ If the file being profiled is a compressed file in ZIP, ARJ, RAR, LZH or ARC format, this will indicate the NEWEST file date found for a member file inside the compressed file. Padded to 8 characters. @NUMBER@ If the file being profiled is a compressed file in ZIP, ARJ, RAR, LZH or ARC format, this will indicate the number of member files found inside the compressed file. Padded to 8 characters. The INFO file supports security naming conventions. If a caller is a level 30, and a file called INFO30 exists, it will be shown to the caller instead of the INFO file. Using this feature, you may create INFO files which do not even display the macros which a level cannot view (macros replaced with "Unavailable" as described above). @CLS@ will clear the screen each time INFO is displayed. INFO supports PCBoard @X## color codes for utilizing color. Because PCBFX has been designed to be as small as possible for a "shell to" door, ANSI capabilities in this file were intentionally omitted. If multi-languages are in use, the appropriate extension will be added to the INFO file. If the language file exists, it will be used to display to the caller. -------------------------------------------------------------------- Page 17 PCBFX Page 17 -------------------------------------------------------------------- 3.0 FXDBM Database (PCBFX.DAT) Overview ---------------------------------------- FXDBM is a utility that creates a database from the DOWNLOAD.TXT file. PCBFX will use this database for INSTANT file profiling if database modes 2 or 3 are selected in FXSETUP. The steps to create and maintain the database are fairly simple, however the following instructions should be carefully followed. Skipping steps could cause PCBFX or FXDBM to not perform as expected. 3.1 Running FXSETUP and Editing FXDBM Parameters ------------------------------------------------- To start FXSETUP.EXE, enter FXSETUP at the DOS prompt. Select option number (2), EDIT FXDBM CONFIGURATION PARAMETERS. This will edit the parameters for FXDBM. PCBFX.CNF will be the configuration file these parameters are saved in. Unlike the PCBFX door which can use other configuration file names, FXDBM.EXE will use PCBFX.CNF only. It is perfectly ok to use PCBFX.CNF for the PCBFX door, as the information for PCBFX and FXDBM are stored in different areas in PCBFX.CNF. Each parameter on the screen you see is described on the following pages. Press F1 at each parameter to display a help screen. * Loc/Name of a PCBOARD.DAT File --------------------------------- A PCBOARD.DAT (PCBoard's main configuration file) is needed for FXDBM to operate. These files are found in each node's directory, sometimes referred to as the node's "home directory". FXDBM will first check the environment variable PCBDAT to see where the PCBOARD.DAT file is for the node FXDBM is currently running on. If a PCBOARD.DAT is not found as outlined above, then the location and filename entered here is used. Therefore the location and name entered here should be for the PCBOARD.DAT file on the node where FXDBM is used in an "event" (registration needed for /EVENT use). The location and name of a PCBoard CALLER log and the PCBoard CNAMES file are among the information needed from PCBOARD.DAT. * Write Event Messages to CALLERx LOG -------------------------------------- FXDBM will write activity to the node's CALLER log file when used in the /EVENT mode (registration required for /EVENT use). /UPDATE, /PURGE, and /TOP activity will be written to the CALLER log, as well as any error messages generated during processing. If you are a multi-node system, the CALLER log that is used is the one for the node in the PCBOARD.DAT file used by FXDBM. Section 3.1 continues on the next page -------------------------------------------------------------------- Page 18 PCBFX Page 18 -------------------------------------------------------------------- 3.1 Running FXSETUP and Editing FXDBM Parameters (continued) ------------------------------------------------------------- * Location\Name of DOWNLOAD.TXT File ------------------------------------- This is the LOCATION AND NAME of the DOWNLOAD.TXT file for FXDBM. Enter the location and filename of the DOWNLOAD.TXT file that FXDBM will use for creating and updating the PCBFX.DAT database. The location and name entered here will also be the DOWNLOAD.TXT file used in the FXDBM /UPDATE /EVENT mode (registration is required for "/EVENT" use). * Conferences To Always Purge ------------------------------ In the /PURGE mode of FXDBM, files specific to certain conferences may be automatically purged from PCBFX.DAT (along with files not found). NONE of the PCBFX methods for displaying file information will contain data for files specific to conferences listed in this parameter. Simply enter conference numbers separated by a comma (,) such as: 13,14,15,16,17,54,200,201,202 You may group a block of conferences together with a dash: 13-17,54,200-202 Both of the above examples would block the same conferences. NOTE: Files must be SPECIFIC to the conferences listed in order for them to be purged. If files exist in other conferences not listed in this parameter they will NOT be purged. NOTE: Use this parameter with caution and only with a complete understanding of how it functions. * Minimum Downloads to Qualify ------------------------------- When generating Top 50 Download Profiles (TOPDL) you may set the minimum number of downloads a file must have to be in the report. If you have just started accumulating history with your PCBFX.DAT file, it might be a good idea to set this to a level that will not show a lot of information about files that have only been downloaded 1 or 2 (or even just a few) times. Files specific to the conferences in the "Conferences to always purge" parameter will not be included in the Top 50 Download Profile since they will not be listed in the PCBFX database. -------------------------------------------------------------------- Page 19 PCBFX Page 19 -------------------------------------------------------------------- 3.2 Initial Database Creation ------------------------------ Use of the FXDBM database (PCBFX.DAT) requires the selection of database modes 2 or 3 using the appropriate parameter on the PCBFX parameter screen in FXSETUP. FXDBM scans DOWNLOAD.TXT and makes a database of the contents. This database, called PCBFX.DAT, must reside in the PCBFX directory with PCBFX.EXE once created. NOTE: The following creation times are a small sampling taken from other systems. Your actual creation time will vary: System Size CPU Creation Time Make-up ------------------------------------------------------------- BBS "A" 200K 486 3 seconds Many repeat downloads BBS "A" 200K 286 24 seconds " " " BBS "B" 400K 486 4 minutes General downloading BBS "B" 400K 286 14 minutes " " BBS "C" 10Meg 486 24 minutes Many repeat downloads BBS "D" 10Meg 486 40 minutes General downloading SPECIAL NOTE: FXDBM & PCBFX expect to find an UNALTERED DOWNLOAD.TXT file to use for processing. DOWNLOAD.TXT utilities designed to cut down the size of these files may cause FXDBM and PCBFX to not work properly. If the utility decreases size by removing "parts" of each DOWNLOAD.TXT entry, FXDBM and PCBFX will not function properly. If the utility removes an ENTIRE line from DOWNLOAD.TXT to decrease its size, FXDBM and PCBFX may or may not function properly. Follow these step-by-step instructions for initial database creation ADVANCED SPEED TIP: Placing FXDBM.EXE and PCBFX.CNF on a RAM drive will cause PCBFX.DAT to be created there, which GREATLY decreases its creation time. When completed, just copy PCBFX.DAT from the RAM drive back to the regular PCBFX directory. Placing DOWNLOAD.TXT on a RAM drive is probably not possible for most, and since FXDBM reads such large blocks at one time, it does not significantly lessen the creation time. ONLY DO THIS WITH A LARGE (SEVERAL MEG) RAM DRIVE. ___1) Run FXDBM /UPDATE. You will be told PCBFX.DAT was not found and asked if you wish to create it now. Answer Y for yes. Since this is the initial database creation, you will be advised this could take time to complete. Answer Yes again to proceed. You will be shown the location and name of the DOWNLOAD.TXT file to use for processing. If you wish to use a different file than the one indicated, enter it here. Processing will begin immediately after pressing return at this prompt. ___2) DATABASE MODE #2 *ONLY* Since you have selected database mode #2, you must now remove DOWNLOAD.TXT. This is not an optional step with database mode #2. FXDBM will expect to find a new DOWNLOAD.TXT the next time it runs. It is highly recommended that you back up these DOWNLOAD.TXT files for awhile, until you are confident that PCBFX and FXDBM are installed properly and working as expected. -------------------------------------------------------------------- Page 20 PCBFX Page 20 -------------------------------------------------------------------- 3.3 Updating the Database -------------------------- Once the PCBFX.DAT database has been created, it will need to be updated periodically. The best place for these updates to occur are in an automated system "event" using the FXDBM utility in its special /EVENT mode (registration required). If you do not run regular "events" on your system or if you do not wish to update the database in them, it may be done manually. Updates, when performed regularly only take a few seconds to a couple of minutes to perform, depending on your system. Manual Updates (Registered and unregistered copies) --------------------------------------------------- Run FXDBM /UPDATE. You will be asked if you wish to update the existing PCBFX.DAT. If you answer Yes, FXDBM will then ask you if you wish to backup the existing database (it will be in a file named PCBFX.BAK). PCBFX will then display the DOWNLOAD.TXT entry from the FXDBM settings in FXSETUP. If this is not correct, change as needed (remember to correct the FXDBM setup parameters in FXSETUP also). When you are sure the DOWNLOAD.TXT location and name are correct, pressing [ENTER] at this prompt will begin the update. If you are using DATABASE NODE #2, you will need to remove (rename, etc.) the DOWNLOAD.TXT file each time PCBFX.DAT is updated. This task must be performed by you now, as FXDBM will not perform this task. See the next page for suggestions for using database mode #2. THIS DOES NOT APPLY TO DATABASE MODE #3. Automated Updates (Registered copies only) ------------------------------------------ In your event batch file, move (cd\) to the PCBFX directory and run: FXDBM.EXE /UPDATE /EVENT Registration is required for the /EVENT mode, so make sure your registration number is installed in PCBFX.CNF. If you do not wish for FXDBM to make a backup of PCBFX.DAT before updating it, add /NOBACK to the FXDBM.EXE command line: FXDBM.EXE /UPDATE /EVENT /NOBACK If you are using DATABASE NODE #2, you will need to remove (rename, etc.) the DOWNLOAD.TXT file each time PCBFX.DAT is updated. This task must be performed with DOS commands in your "event" batch file (after the update is finished) as FXDBM will not perform this task. See the next page for suggestions for using database mode #2. THIS DOES NOT APPLY TO DATABASE MODE #3. -------------------------------------------------------------------- Page 21 PCBFX Page 21 -------------------------------------------------------------------- 3.4 Managing DOWNLOAD.TXT (Database Mode #2) --------------------------------------------- If you chose database mode #2, you chose to delete DOWNLOAD.TXT each time the database is updated. When using database mode #2 (ONLY!) you must remove the DOWNLOAD.TXT file each time FXDBM updates the database. Below is a suggested method for managing DOWNLOAD.TXT when using database mode #2. First Time Database Creation ---------------------------- When creating the database for the first time, follow these steps: 1) Rename DOWNLOAD.TXT to DOWNLOAD.FX. By renaming the file at the start, you can be assured you will not miss any new DOWNLOAD.TXT entries if other nodes are up, because they will be written to a new DOWNLOAD.TXT, not to the current DOWNLOAD.FX while FXDBM is running. You must RENAME the file in this step, *not* COPY it. 2) If you wish to keep a master copy of DOWNLOAD.TXT, then copy DOWNLOAD.FX to DOWNLOAD.HIS. 3) Run FXDBM.EXE /UPDATE giving it the DOWNLOAD.FX file to use when prompted for a DOWNLOAD.TXT filename. 4) Delete DOWNLOAD.FX. Manual or Automated Updating ---------------------------- 1) Use FXSETUP.EXE to edit the *FXDBM* DOWNLOAD.TXT parameter. Enter DOWNLOAD.FX as the filename in DOWNLOAD.TXT parameter. * IF STEP #1 WAS ALREADY PERFORMED START AT STEP #2 * 2) Rename DOWNLOAD.TXT to DOWNLOAD.FX. 3) Run FXDBM.EXE /UPDATE [/EVENT] (will use DOWNLOAD.FX). 4) If you wish to continue keeping a master copy of DOWNLOAD.TXT, append DOWNLOAD.FX to DOWNLOAD.HIS using the COPY command, such as COPY DOWNLOAD.HIS + DOWNLOAD.FX which will cause DOWNLOAD.FX to be appended to DOWNLOAD.HIS. 5) Delete DOWNLOAD.FX and you are ready to go again for the next update. Go to step 2. See the sample event batch file snippets on the next page for examples of automated database updates (registration required). -------------------------------------------------------------------- Page 22 PCBFX Page 22 -------------------------------------------------------------------- 3.5 Sample Automated Update Event Batch Snippets ------------------------------------------------- Below are some examples from "event" batch files for updating the FXDBM database during the system event. Registration is required to use FXDBM in the /EVENT mode. * Database Mode #2 ------------------ The following assumes you are following the suggestion on page #21 and have named the file FXDBM processes as DOWNLOAD.FX. .......(other event items) ....... " " " RENAME C:\PCB\MAIN\DOWNLOAD.TXT DOWNLOAD.FX. C: CD\PCBFX FXDBM.EXE /UPDATE /EVENT [/NOBACK] FXDBM.EXE /TOP /EVENT DELETE C:\PCB\MAIN\DOWNLOAD.FX %PCBDRIVE% CD%PCBDIR% .......(other event items) ....... " " " In the first line of the snippet above, edit to include the actual location of YOUR DOWNLOAD.TXT file. In the second and third lines of the snippet, change to the drive and directory where YOUR PCBFX and FXDBM files are located. In the sixth line of the snippet above, edit to include the actual location of YOUR DOWNLOAD.FX file. * Database Mode #3 ------------------ .......(other event items) ....... " " " C: CD\PCBFX FXDBM.EXE /UPDATE /EVENT [/NOBAK] FXDBM.EXE /TOP /EVENT %PCBDRIVE% CD%PCBDIR% .......(other event items) ....... " " " In the first and second lines of the snippet, change to the drive and directory where YOUR PCBFX and FXDBM files are located. -------------------------------------------------------------------- Page 23 PCBFX Page 23 -------------------------------------------------------------------- 3.6 Creating the (T)op 50 Download Report ------------------------------------------ A "Top Download" profile can be generated from the information in the FXDBM database (PCBFX.DAT). Enter FXDBM /TOP after creating or updating the database. If your copy of PCBFX is registered you may enter FXDBM /TOP /EVENT after updating the database during an event. FXDBM will read in a template file called TOPTMP. This may contain up to 50 top downloads. This process is "macro-driven" meaning you may COMPLETELY control what and how the results are displayed. The macros are: @FILENAME01@, @FILENAME02@, etc. The file name. @DL01@, @DL02, etc. Number of times downloaded. @DNDT01@, @DNDT02@, etc. Last download date. @UPDT01@, @UPDT02@, etc. Date file was uploaded. @WHOUP01@, @WHOUP02@ etc. Who uploaded files. Each file macro contains two characters at the end which must be 01, 02, 03 etc. up to 50. This represents the information for the file matching the corresponding ranking, to be displayed in that macro position. See the enclosed TOPTMP for an example. The file created is called TOPDL, and is displayed with PCBFX by the "T" command, for (T)op download profile. PCBFX's BLOCK.DAT is read for this process and any files matching entries in it will not be added to the TOPDL profile list. You may set the number of downloads files must have to qualify for inclusion in the Top Download Profile (use FXSETUP for this). The TOPDL file may also be used as a bulletin in PCBoard by copying it to a filename and location set up as a bulletin for this purpose. NOTE: If you have a conference block list configured for "who uploaded" in the PCBFX door, you should remove @WHOUPxx@ headings and macros in TOPTMP, as FXDBM does not know which conference a file in PCBFX.DAT is in, when creating TOPDL. FXDBM uses the default uploader name (from the PCBFX door settings) for the @WHOUPxx@ macro if uploader information is not found in PCBFX.DAT. Like all other PCBFX files, TOPTMP and TOPDL only support PCBoard color macros for color. A suitable PCBoard color macro file editor should be used for editing TOPTMP to suit your needs. If you wish the "Top 50" command to only be a "Top 10" command, simply edit the last 40 entries out of TOPTMP, leaving only those that will result in the "Top 10" being filled. If the (T)op 50 Download function is not desired in the PCBFX door, simply make certain that the TOPDL file does not exist in the PCBFX directory. FXDBM places an "Unregistered Copy" message at the top of TOPDL until PCBFX is registered. -------------------------------------------------------------------- Page 24 PCBFX Page 24 -------------------------------------------------------------------- 3.7 Modifying PCBFX.DAT First Transfer Date -------------------------------------------- When FXDBM first creates PCBFX.DAT, it stores the first transfer date found in DOWNLOAD.TXT. This information is used in the old @DWNTXTDATE@ macro (padded) in INFO and the new @FIRSTDAT@ (no pad). This may be manually changed if desired AFTER a database is created. Run FXDBM.EXE /NEWDATE and you will be prompted for the new date. 3.8 Purging PCBFX.DAT of Non-existent Files -------------------------------------------- FXDBM can purge PCBFX.DAT of files that no longer physically exist. The command line to purge is FXDBM.EXE /PURGE. * ALWAYS BACK UP PCBFX.DAT BEFORE PURGING! * ALWAYS UPDATE *ALL* PCBOARD .IDX INDEX FILES BEFORE PURGING! * PURGING CAN TAKE A VERY LONG TIME depending on the system size. * FXDBM reads CNAMES.@@@ and loads in conference DLPATH.LST files (up to 1000 *DIFFERENT* DLPATH.LST files). 1000 is an arbitrary limit, and it is felt this a realistic number. Certainly there are systems with thousands of conferences, but it is doubtful anyone has over 1000 DIFFERENT DLPATH.LST files on their systems. If you do, FXDBM will not purge the database. * FXDBM reads each *DIFFERENT* DLPATH.LST and loads in all of the the DIFFERENT physical locations OR .IDX files, up to 3000. Again this is an arbitrary limit as it is doubtful anyone has over 3000 different download locations AND .IDX files combined. * FXDBM reads in file names located in download paths NOT listed in the PCBoard .IDX index files (up to 10000). It is assumed large systems have the bulk of their files indexed in PCBoard .IDX files. Therefore, FXDBM will only read in up to 10000 file names located in NON-IDX locations. Anything over 10000 will be physically searched. * FXDBM then checks each file in PCBFX.DAT to see if it exists. All .IDX files are searched, then files in physical locations (placed in memory in the above step) are searched, then if there are more files in quantity than 10000 from the above step, the paths that exceeded the 10000 mark will be physically searched (SLOW!). * The command line for purging in an event is /PURGE /EVENT. Add /NOBAK if a backup copy (PCBFX.BAK) of PCBFX.DAT is not desired. Registration is required for FXDBM /EVENT mode use. /EVENT NOTES: You should determine how long a purge takes on your system before deciding to include /PURGE in your /EVENT. While purging non-existent files from PCBFX.DAT saves some disk space and no measurable time while looking up a file, the only real functional benefit to purging is that non-existent files won't be included in the TOPDL profile report (if used). Naturally, if you purge after an initial PCBFX.DAT creation with a large DOWNLOAD.TXT the FIRST purge will take longer than subsequent routine purges. -------------------------------------------------------------------- Page 25 PCBFX Page 25 -------------------------------------------------------------------- 4.0 Notes Regarding File Profiles ---------------------------------- One file name may be passed to PCBFX from the PCBoard command line. For example, if you have named the command (door) FX, then typing: FX FILENAME.ZIP at the PCBoard main prompt will run PCBFX and it will immediately start a profile scan for FILENAME.ZIP. This is handled automatically by PCBFX and PCBoard and requires no additional installation. If the extension is omitted from the file name, whether passing the name from PCBoard or entered at the PCBFX (S)elect prompt, 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 requested the profile in. If the file does not (still) physically exist, the caller will be informed. 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 input the password before allowing the profile to proceed. 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". After each profile displays (the PCBFX INFO file), the PCBFX main menu will appear. The caller may enter any functions available to them or press (Enter) alone at this to return them to PCBoard. 4.1 Notes Regarding Local Command Line Use ------------------------------------------- Create a batch file called FX.BAT (or whatever name you choose): C:\PCB\PCBFX PCBFX.CNF %1 /L Place FX.BAT (or whatever you name it) in your DOS path, and you will have a DOWNLOAD.TXT profiler and searcher at your fingertips at all times. Simply type FX FILENAME.ZIP to start PCBFX and immediately begin a profile scan of FILENAME.ZIP. The special /L local command line mode performs slightly differently than when running with PCBoard. When a profile is performed in the /L local mode, the files existence, password security, and like features are not performed. In this manner, the Sysop may retrieve a profile for a file which is no longer physically on the system. -------------------------------------------------------------------- Page 26 PCBFX Page 26 -------------------------------------------------------------------- 4.2 Notes Regarding (U)ploader Profiles ---------------------------------------- The (U) command uses the PCBFX.DAT database created with FXDBM to display to the caller the history profile of the files they (ONLY) have uploaded. This will display the file name, date uploaded, last download date and times downloaded. The security level attached (in FXSETUP) to each of the above fields is used to determine whether a particular field will be displayed to the caller. The Sysop may also determine who can use this command by setting the FXSETUP "Security for (U)ploader Profile" parameter to meet their needs. After pressing (U), the caller will be asked how they want to sort the report. Valid options are (F)ile Name and (D)ate Uploaded. If (F)ile Name is chosen, the sort will be in alphabetically ascending order. If (D)ate Uploaded is chosen, the sort will be in descending order, which allows the caller to view the activity on their recent uploads. The is limited to up to 1000 uploads from the caller (less (depending on available memory). The Sysop may use the following table and the amount of memory showing on the PCBFX local status line to determine how many caller uploads would be sorted on their system: Memory PCBFX will sort ------ --------------- 58K 1000 uploads from the caller 48K 800 " " " " 39K 600 " " " " 29K 400 " " " " 20K 200 " " " " If there is less than 20K available the caller will not be asked how to sort the report, their uploads will simply be listed as they are found in PCBFX.DAT. If there is not enough memory displaying on the PCBFX status line to meet the "sort" needs of your system, you should consider running PCBFX as a "swapped shell" door by answering the "swap" question in the PCBSetup DOORS.LST question with a "S" instead of with "Y". See section 2.2 on page for for a sample DOORS.LST entry for a PCBFX door installation. If more than 1000 uploads by the caller are found in PCBFX.DAT, the files will be listed as they appear in the PCBFX.DAT database. If the caller's security is set at or above the Security for Sysop Special Functions, they will be asked to enter an "Uploader Name". This allows Sysops to use the (U)ploader Profile command to view the popularity or activity of a particular caller's uploads. The (U)ploader Profile will display to the caller their uploads if found in the PCBFX.DAT database, even if the file is no longer on the system. Whenever the database is purged with FXDBM, files that do not exist on the system are removed from the database. -------------------------------------------------------------------- Page 27 PCBFX Page 27 -------------------------------------------------------------------- 4.3 Notes Regarding Sysop Zippy Scans -------------------------------------- Sysop (Z)ippy text scans are only available in PCBFX database modes #1 and #3. It should be stressed that it is important to only allow Sysops and possibly the co-Sysops access to the Sysop Zippy Text scan feature. Anyone who is at or above the security level set for this feature in FXSETUP will have the ability to view any and all of the entries in the DOWNLOAD.TXT file. Sysops may use the Zippy scan to scan for a particular file name, a particular user name, or possibly any activity on a particular date. Do not use wildcards in the Zippy search. They are not required. If scanning for activity on a particular date, the following format must be used: MM-DD-YYYY. This is required to match the date format which is used in the DOWNLOAD.TXT file. If using PCBFX in color mode or in local /L mode on a color monitor, the results of the Zippy scan will be colorized. 4.4 Using PCBFX.DAT With FVMM ------------------------------ INSTANT profiles are now possible with FVMM (File View Maintenance Manager) for PCBFiler! FVMM is available with the YCS PCBFV (PCBoard FileView) utility, distributed separately. FVMM has always contained a profile generator similar to previous PCBFX 1.x versions which scans the DOWNLOAD.TXT file each time. All that is needed for FVMM to use the PCBFX database is to replace the location and name of DOWNLOAD.TXT in FVMM.CNF with the location AND name of the new PCBFX database (the database name is always PCBFX.DAT). NOTE: This requires FVMM.EXE from PCBFV versions 3.4 and later. Do not attempt to substitute DOWNLOAD.TXT in FVMM.CNF with the database if using FVMM.EXE from PCBFV versions 2.5 through 3.3. The PCBFV version as of this writing is 3.85 and is dated 08-04-95. -------------------------------------------------------------------- Page 28 PCBFX Page 28 -------------------------------------------------------------------- 5.0 Sysop Function Keys ------------------------ PCBFX follows F3 (printer on/off), and F9 (display on/off) toggles from PCBoard. If F3 is on, PCBFX will print any information sent to the caller log to the printer also. If F9 is off, PCBFX will not write to the local screen. PCBFX will act on ALT-X and ALT-N requests from the Sysop. PCBFX will set the appropriate flag so that PCBoard will use it after the caller logs off (as if ALT-X or ALT-N had been set in PCBoard). 5.1 Technical Notes -------------------- PCBFX has been designed to run specifically with PCBoard versions 14.5a thru 15.x. PCBFX will not run with earlier versions of PCBoard or with other brands of BBS software. Carrier is monitored by PCBFX. Should a caller drop carrier while in PCBFX they will be returned to PCBoard, which will detect the "no carrier" status and cycle appropriately. PCBFX works with non-standard com ports ,addresses, and IRQs. COM1 is address 3F8/IRQ 4. COM2 is address 2F8/IRQ 3. If a COM port other than 1 or 2 is used, PCBFX will use the address and IRQ information as indicated in PCBOARD.DAT for the node. All of the enclosed executable files have been compressed with a commercial compression utility. Uncompressed versions of these files are not available. 5.2 Where To Receive Assistance -------------------------------- Yandell Custom Software (YCS) provides the following technical assistance for PCBFX: 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. -------------------------------------------------------------------- Page 29 PCBFX Page 29 -------------------------------------------------------------------- 5.3 Caller Log Entries ----------------------- PCBFX makes pertinent entries into the caller log as follows: * Profile executed on file (FILENAME.EXT) - Caller performed a profile on FILENAME.EXT (See NOTE #1 below). * Zippy Scan for (text) - A Zippy scan was performed for (text) (See NOTE #1 below). * (FILENAME.EXT) not found! - FILENAME.EXT was not physically found during a profile request. * (FILENAME.EXT) is an invalid filename! - File is not a valid DOS file name or is an illegal file name. * Transfer Profile is not permitted on (FILENAME.EXT) - FILENAME.EXT exists in BLOCK.DAT. * Insufficient security for Profiling (FILENAME.EXT) - Caller lacks access to download file as found in PCBoard FSEC. * Incorrect Profile Password for File (FILENAME.EXT) - FILENAME.EXT has password in FSEC and caller could not provide. * Self explanatory error messages will also be written. Note #1 from above: This entry will be written only if the Sysop desires (as defined in the FXSETUP 'Activity to track' parameter). If your are using FXDBM in /EVENT mode (registration required) and have it installed to write /EVENT messages to the CALLER log, the following messages will appear: * PCBFX Database (PCBFX.DAT) updated at: 00:00 (time) - This will be written when FXDBM.EXE /UPDATE /EVENT is used. * PCBFX Top D/L file (TOPDL) updated at: 00:00 (time) - This will be written when FXDBM.EXE /TOP /EVENT is used. * PCBFX Database (PCBFX.DAT) purged at : 00:00 (time) - This will be written when FXDBM.EXE /PURGE /EVENT is used. * Self explanatory error messages will also be written. 5.4 Revision History --------------------- Date Version Details -------- ------- ------- 03-29-92 1.0 PCBFX initial release. 04-03-92 1.1 See the enclosed file FEATURES.NEW. 05-01-92 1.2 See the enclosed file FEATURES.NEW. 07-10-93 2.0 See the enclosed file FEATURES.NEW. 03-18-94 2.1 See the enclosed file FEATURES.NEW. 11-11-94 2.2 See the enclosed file FEATURES.NEW. 08-11-95 2.3 See the enclosed file FEATURES.NEW. -------------------------------------------------------------------- Page 30 PCBFX Page 30 -------------------------------------------------------------------- 5.5 Multi-nodes, Networks, Multi-taskers ----------------------------------------- PCBFX has been developed in a multi-node environment. All multi- node features are tested on several multi-node PCBoard systems. PCBFX detects if DESQview, OS/2 or Windows are present. If detected, PCBFX will give back time to the multi-tasker while PCBFX is idling at an input prompt. 5.6 Disclaimer and Warranty ---------------------------- PCBFX is a shareware product. PCBFX may be uploaded to BBS systems as long as copyright notices are not removed and no changes are made to the program. There are no warranties, expressed or implied, for unregistered copies of PCBFX. Sysops who install PCBFX on their systems assume any and all liabilities for anything which may result as a consequence of running PCBFX. For registered copies of PCBFX, Yandell Custom Software warrants PCBFX will perform as specified in this documentation. In the event that PCBFX does not perform as specified, Yandell Custom Software may elect to fix PCBFX or refund the amount paid, if YCS is notified within 90 days of the initial registration. This notification must contain a description that enables YCS to reproduce the situation. Under no circumstances shall Yandell Custom Software or the author of PCBFX 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 PCBFX. 5.7 License To Use PCBFX ------------------------- PCBFX is not "public domain" or "free" software. A limited license is granted to use and evaluate PCBFX for thirty days after initial installation. PCBFX must be registered if it is used after the initial thirty day evaluation period. A PCBFX registration may be used only on the original licensee's BBS system and only on nodes the original licensee owns and operates for their own purposes. If the original licensee provides some or all of their nodes to another entity, those nodes will require their own PCBFX registration. PCBFX registrations are not transferable. A PCBFX registration is a license to use the PCBFX software on one (1) BBS System at a single location with as many nodes as the original licensee owns and operates at THAT location. When the licensee owns and operates other BBS' in other locations, each location will require a separate PCBFX registration. If PCBFX has not been registered after 30 days, a Sysop reminder will begin appearing at program termination and will also be written to the current node's caller log file. -------------------------------------------------------------------- Page 31 PCBFX Page 31 -------------------------------------------------------------------- 6.0 Registering PCBFX ---------------------- PCBFX is not free software. PCBFX must be registered no later than 30 days after installation. Registration removes the [UNREGISTERED COPY] message at program termination along with the corresponding brief delay which provides a seamless interface with PCBoard BBS software. Registration enables the /EVENT mode in the FXDBM database utility. Registration also stops FXDBM from placing the Unregistered Copy message into the "Top 50 Download" report. Registration is $15.00 and may be paid by check, money order, VISA, Mastercard, and American Express. Receive a registration number INSTANTLY by registering with a major credit card! Refer to the ORDER.FRM file for complete registration instructions. 6.1 Register with CONFIDENCE - Author Information -------------------------------------------------- Brent Yandell has been programming for over fourteen years including more than nine 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). Yandell Custom Software is an *AUTHORIZED* credit card merchant for VISA, Mastercard and American Express charge cards. There are no additional charges to use a credit card to register PCBFX.