home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / f / fnls098b.zip / FNLSCAN.DOC < prev    next >
Text File  |  1993-03-04  |  14KB  |  334 lines

  1.  
  2.                     ╖──── ╖────╖ ╖     ╓───
  3.                     ║     ║    ║ ║     ║
  4.                     ║───  ║    ║ ║     ╙───╖ ╓───  ──╖ ╖──╖
  5.                     ║     ║    ║ ║         ║ ║    ╓──║ ║  ║
  6.                     ╜     ╜    ╜ ╜──── ────╜ ╙─── ╙──╜ ╜  ╜
  7.  
  8.                           FNLScan Documentation File
  9.                                 Version 0.98ß
  10.                        (c) Copyright 1993 - Stacy Smith
  11.  
  12.  
  13.                                 Courtesy of:
  14.  
  15.                         The Bloom Beacon-Picayune BBS
  16.           Node 1: (804) 525-9760 (USRobotics Courier Dual Standard)
  17.              Node 2: (804) 525-5372 (USRobotics Courier V.32bis)
  18.                               FidoNet 1:276/112
  19.                                   Intelec
  20.  
  21.                                 Stacy Smith
  22.                               Route 6 Box 189
  23.                            Forest, Virginia 24551
  24.  
  25.  
  26. ┌────────────────────┐
  27. │  1. Introduction:  │
  28. └────────────────────┘
  29.  
  30. FNLScan was developed because many of my users who use Fidonet Netmail kept
  31. coming to me wanting to know if there was a node in such-and-such a place, or
  32. what address this-or-that person was at. While unzipping the nodelist and using
  33. a text editor to search the nodelist, I groused that I wish they could do this
  34. themselves. Now they can using FNLScan, the Fidonet NodeList Scan door.
  35.  
  36.  
  37. ┌───────────────────────────┐
  38. │  2. Features of FNLScan:  │
  39. └───────────────────────────┘
  40.  
  41.       ∙ Scans the standard NODELIST.nnn text file (uncompiled nodelist). This
  42.         format was chosen since it is available to all Fidonet systems,
  43.         regardless of mailer or BBS software used.
  44.       ∙ Most door text is contained within text files that can be modifed by
  45.         the user. This will allow simple customization by the sysop for foreign
  46.         language support and different tastes.
  47.       ∙ Optionally logs all FNLScan operations.
  48.       ∙ Fully multinode and multiuser compatible.
  49.       ∙ Supports most BBS software through the use of PCBOARD.SYS, DOOR.SYS,
  50.         CALLINFO.BBS and DORINFOx.DEF door drop files.
  51.       ∙ Supports IRQs 2 through 15 and any COM port address.
  52.       ∙ Supports FOSSIL drivers.
  53.       ∙ Supports Digiboard multiport cards.
  54.       ∙ Written completely in C for optimal speed, using Microsoft C/C++ 7.0.
  55.       ∙ Lifetime registration; pay ONCE and your registration number will work
  56.         on all future versions!
  57.  
  58.  
  59. ┌─────────────────────────────────────────────────────────┐
  60. │  3. Files Included in the FNLScan Distribution Archive  │
  61. └─────────────────────────────────────────────────────────┘
  62.  
  63.         FNLSCAN.EXE     Fidonet NodeList Scan door program
  64.         FNLSCAN.DOC     This file
  65.         FNLSCAN.CFG     Sample configuration file
  66.         WELCOME         Text door welcome screen file
  67.         WELCOMEG        Graphics door welcome screen file
  68.         MENU            Text door menu file
  69.         MENUG           Graphics door menu file
  70.         HELP            Text help file
  71.         HELPG           Graphics help file
  72.         CLOSE           Text closing file
  73.         CLOSEG          Graphics closing file
  74.         HISTORY.TXT     FNLScan revision history in reverse order
  75.         REGISTER.FRM    Registration form for FNLScan
  76.         FILE_ID.DIZ     Internal description file
  77.  
  78. When you unzip the distribution archive, you should see my PKZIP authenticity
  79. verification stamp, and a '-AV' after every file in the archive:
  80.  
  81.         # SSU301    The Bloom Beacon-Picayune BBS
  82.  
  83. If there are any files missing or added, or the -AV stamp is missing, the
  84. archive has been tampered with. It would be advisable to call my BBS (listed at
  85. the top of this document) for the latest version of FNLScan.
  86.  
  87.  
  88. ┌───────────────────────────┐
  89. │  4. Program Requirements  │
  90. └───────────────────────────┘
  91.  
  92. To the best of my knowledge, this door will run on most any machine capable of
  93. running a BBS package. My BBS setup is PCBoard 14.5a/10 running under DESQview
  94. on a LANtastic network, but other sysops that I have been in contact with have
  95. successfully implemented FNLScan on a wide variety of hardware.
  96.  
  97. FNLScan requires DOS 3.x or later, as it uses DOS SHARE-compatible file reads
  98. and writes.  FNLScan's memory requirements are very small (about 80K or so), so
  99. it can be run as a shelled door versus a dropped-to-DOS door, if your software
  100. supports such a mode.
  101.  
  102.  
  103. ┌───────────────────┐
  104. │  5. Registration  │
  105. └───────────────────┘
  106.  
  107. FNLScan is not free; nor is FNLScan is crippled to force registration. FNLScan
  108. is fully functional, and will always remain so. The only variation with the
  109. registered copies is no time delay and beg message.
  110.  
  111. Why register? Besides a clean conscience, you will get a registration code that
  112. will work for all future versions of FNLScan, and will remove the delay and
  113. message displayed upon closing the door.
  114.  
  115. The registration fee for your unique code is $15 for non-commercial BBSs (not
  116. too bad, eh?). The registration fee for commercial BBSs, defined if you run
  117. your BBS in the course of a commercial business or for profit, is $30. Other
  118. variations are available; refer to the file REGISTER.FRM for all registration
  119. options. Please print the file REGISTER.FRM and fill it out. You can print out
  120. the form by issuing the following command from the DOS prompt:
  121.  
  122.         TYPE REGISTER.FRM > PRN
  123.  
  124.  
  125. ┌───────────────────────────────────────┐
  126. │  6. License, Warranty and Disclaimer  │
  127. └───────────────────────────────────────┘
  128.  
  129. I'll keep this part short and sweet, and dispense with the legal-ese:
  130.  
  131.         License: You are allowed to use FNLScan for 30 days, after which you
  132.            must either register FNLScan or stop using it completely. FNLScan
  133.            registration is a license for your use of FNLScan; I retain
  134.            ownership of the software. A single registration applies to a single
  135.            BBS system, regardless of the number of computers used in the
  136.            system. If you run two or more distinct BBS systems on the same
  137.            computer(s) (with different names), you require two or more FNLScan
  138.            registrations. Refer to the registration form for the currect
  139.            pricing structure.
  140.  
  141.         Warranty: There isn't one. The only thing I'll guarantee is that
  142.            FNLScan will take up disk space, and will disappear when deleted.
  143.  
  144.         Disclaimer: I'm not responsible for anything bad that happens. FNLScan
  145.            works here, but I cannot be held responsible for it not working on
  146.            your computer or doing any damage to hardware or software.
  147.  
  148. If these aren't agreeable with you, then the best thing to do is delete FNLScan
  149. right now. I'll do my best to help any user (registered or not) that wants to
  150. use FNLScan, and I'll act on bug reports quickly, but I simply cannot and will
  151. not be responsible for anything bad, like lost data, disk crashes, or whatever
  152. else you can think of.
  153.  
  154.  
  155. ┌───────────────────┐
  156. │  7. Installation  │
  157. └───────────────────┘
  158.  
  159. GENERAL INSTALLATION:
  160. ─────────────────────
  161. Make a subdirectory on your hard drive. For the purposes of this document,
  162. we'll call it "C:\FNLSCAN". Unarchive the FNLScan distribution archive into
  163. this subdirectory. You've more than likely already made it this far, if you're
  164. reading this file. <grin>
  165.  
  166. The FNLScan system opens a few files simultaneously for various reasons. I
  167. would recommend that you have a minimum of FILES=30 per node in your system
  168. CONFIG.SYS file for a single-node system, since FNLScan is run in conjunction
  169. with your BBS software.
  170.  
  171. If you are running under a network or a multitasking operating system, you
  172. should already have DOS's SHARE.EXE loaded. You must have SHARE loaded in order
  173. to take advantage of the file sharing and locking methods used by the FNLScan
  174. program to prevent data loss. (If you are running a single-node system without
  175. a multitasker, SHARE is not needed).
  176.  
  177. Edit the configuration file to suit your needs. Proper configuration will
  178. require you to refer to this section, the previous section and the section
  179. titled "Configuration", which has an in-depth explanation of each configuration
  180. parameter and its function.
  181.  
  182. Note that for the FNLScan program, you can obtain a limited program syntax
  183. screen simply by executing the program name "FNLSCAN".
  184.  
  185. INSTALLATION INTO YOUR BBS SOFTWARE:
  186. ────────────────────────────────────
  187. FNLScan must be run from its own subdirectory; this is required so it can find
  188. the text files required for display. Only two command-line parameters are
  189. required for FNLScan:
  190.  
  191.         FNLSCAN -Cfnlscan.cfg -Dc:\bbs\door.sys
  192.  
  193. where -C defines the configuration file for FNLScan, and -D is the complete
  194. path and filename of the door drop file. This should be sufficient for most BBS
  195. systems. In general, your BBS batch file will look like the following:
  196.  
  197.         CD \FNLSCAN
  198.         FNLSCAN -Cfnlscan.cfg -Dc:\bbs\door.sys
  199.         CD \BBS
  200.         BOARD
  201.  
  202. * NOTE: If you choose to run FNLScan as a shelled door, calling the BOARD batch
  203.         file is unnecessary, and will hose up the node.
  204.  
  205. If you are running a multinode system, you can use environment variables such
  206. as PCBDRIVE and/or PCBDIR created by PCBoard to define the locations of the
  207. door drop files. This type of door batch file would use the same batch file for
  208. all nodes, and would like something like:
  209.  
  210.         CD \FNLSCAN
  211.         FNLSCAN -Cfnlscan.cfg -D%PCBDIR%\pcboard.sys
  212.         CD %PCBDIR%
  213.         BOARD
  214.  
  215. If required, you can provide the COM port information directly to FNLScan by
  216. using the -I and -A command switches:
  217.  
  218.         FNLSCAN -Cfnlscan.cfg -Dc:\bbs\door.sys -I4 -A3F8
  219.  
  220. where -I is the COM port IRQ line and -A is the port base address (in hex).
  221.  
  222. FNLScan is capable of using a FOSSIL driver, and automatically detects if you
  223. are running PCBoard /M and uses the appropriate FOSSIL port. However, if you
  224. need to force FNLScan to use a FOSSIL driver, use the -F command switch with
  225. the FOSSIL port number as the argument:
  226.  
  227.         FNLSCAN -Cfnlscan.cfg -Dc:\bbs\door.sys -F0
  228.  
  229. FNLScan is also capable of directly accessing a Digiboard multiport I/O card.
  230. This can be defined using the -M command switch with the Digiboard channel
  231. number as the argument:
  232.  
  233.         FNLSCAN -Cfnlscan.cfg -Dc:\bbs\door.sys -M1
  234.  
  235. Note that these parameters can also be passed to the batch file using
  236. environment variables as previously discussed.
  237.  
  238. CUSTOMIZATION OF FNLSCAN TEXT FILES:
  239. ────────────────────────────────────
  240. The WELCOME/WELCOMEG, MENU/MENUG, HELP/HELPG and CLOSE/CLOSEG files may be
  241. modified by the sysop if desired. However, some caveats before you start:
  242.  
  243.     - The files should not be deleted or renamed. FNLScan expects to find these
  244.       files as currently named in the currently logged subdirectory.
  245.     - FNLScan does not recognize PCBoard @ variables.
  246.     - FNLScan does not recognize PCBoard @Xnn color macros; use standard ANSI
  247.       codes.
  248.  
  249.  
  250. ┌────────────────────┐
  251. │  8. Configuration  │
  252. └────────────────────┘
  253.  
  254. The sample configuration file included in the distribution archive is heavily
  255. commented, but some additional information is provided below:
  256.  
  257. REG_CODE
  258.     The registration code EXACTLY as provided to you on your registration
  259.     letter. If this is an unregistered version, comment out this line. Note
  260.     that this is case-sensitive, as the serial number, BBS name and sysop name
  261.     are all encrypted into this code.
  262.  
  263. BBS_NAME
  264.     The BBS name EXACTLY as provided to you on your registration letter. If
  265.     this is an unregistered version, comment out this lines. Note that this is
  266.     case-sensitive!
  267.  
  268. SYSOP_NAME
  269.     The sysop name EXACTLY as provided to you on your registration letter. If
  270.     this is an unregistered version, comment out this line. You get the picture
  271.     by now...
  272.  
  273. NL_PATH
  274.     The full pathname (including the trailing backslash) to where the
  275.     uncompiled nodelist is kept. FNLScan will always grab the latest nodelist
  276.     if more than one is available. For optimal scanning speed, this file could
  277.     be copied to a RAM disk in AUTOEXEC.BAT.
  278.  
  279. LOG_FILE
  280.     FNLScan can write scanning and error information to a log file, if desired.
  281.     This is the path/filename of the log file for FNLScan to record its
  282.     activities; comment it out if you don't want any disk logging.
  283.  
  284.  
  285. ┌──────────────┐
  286. │  9. Support  │
  287. └──────────────┘
  288.  
  289. If you require support for FNLScan, I can be contacted by any of the following
  290. means:
  291.  
  292.     ∙ Fidonet Netmail addressed to Stacy Smith, node 1:276/112
  293.     ∙ Intelec BBS Doors conferences
  294.     ∙ The ULP Support conference (#42) on Salt Air (PCBoard support BBS)
  295.     ∙ The Support conference (#2) on my BBS (listed at the top of this
  296.       document).
  297.  
  298.  
  299. ┌─────────────────────────────┐
  300. │  10. The Future of FNLScan  │
  301. └─────────────────────────────┘
  302.  
  303. FNLScan will be supported as long as I'm in the BBSing business (which will be
  304. quite a while...once it's in your blood, you can never shake it <g>). The
  305. FNLScan system will be continually expanding it's features, so get your
  306. comments in now! Some current plans:
  307.  
  308.       ∙ Develop code to read compiled nodelist formats (e.g. Version6,
  309.         Version7, Front Door, etc.).
  310.       ∙ Speed enhancements.
  311.       ∙ Any ideas from you guys? Thanks! <g>
  312.  
  313. If you have any other suggestions, contact me by U.S. snail-mail or on my BBS
  314. at the number at the top of this document.
  315.  
  316. Thanks for giving FNLScan a try!
  317.  
  318.  
  319. ┌────────────────────────────────┐
  320. │  Appendix A:  DOS Errorlevels  │
  321. └────────────────────────────────┘
  322.  
  323. The following is a list of the errorlevels than can be returned by FNLScan:
  324.  
  325.         0           Successful execution
  326.         99          Help screen (executing a program with no or an
  327.                         insufficient number of arguments)
  328.         100         Could not close all open files
  329.         101         Unknown command line parameter
  330.         102         Configuration file not found
  331.         110         Unable to allocate heap memory
  332.         111         Unable to open or lock disk logging file
  333.         200         Undefined error (internal to FNLScan program)
  334.