home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / bbs_ra / ggen210.arj / GGEN.DOC < prev    next >
Text File  |  1991-08-04  |  12KB  |  262 lines
  1.  
  2. Program    : GoodByeGen V2.00
  3. Copyright  : July 11 1991, LogiComp Inc.
  4. Written by : Joey P. Lindstrom
  5. Compiler   : QuickBASIC V4.5 (Copyright 1990 Microsoft)
  6.  
  7. This is a SHAREWARE program, if you use this program regularly I ask
  8. that you register it.  To do so, simply send me a postcard at the
  9. address listed at the end of this document.
  10.  
  11. Many sysops like to put the names and phone numbers of other bulletin
  12. boards to call on their logoff screen.  QuickBBS, SuperBBS, and
  13. RemoteAccess systems use the GOODBYE.ANS and GOODBYE.ASC files for
  14. logoff messages, and that's where GoodByeGen comes in: its job is to
  15. create neatly formatted and colorful GOODBYE.A?? files for you.  You
  16. can give it your own custom datafile to use for output, and/or you can
  17. use a FidoNet-style nodelist.  You have full control over all the
  18. colors on the screen and many other commands to customize which nodes
  19. from the FidoNet nodelist get included.  Up to 100 nets may be used.
  20.  
  21. This program was written with myself in mind.  This is the type of
  22. logoff screen I like.  The program works and works well and I'm quite
  23. happy with it, and if you're happy with it, great.  If you'd like to
  24. send some suggestions for improvements my way, please do so (addresses
  25. are listed at the end of this document).  Please don't ask for a
  26. tremendous overhaul of the program to radically change the format of
  27. the output: that's not what I want so I'm not going to code it.  :-)
  28.  
  29.  
  30. How to use it:
  31.  
  32. GGEN [filename.txt]
  33.  
  34. GGEN will look for a file in the current directory called GGEN.CTL.
  35. This is its operational control file (described shortly).  If you wish
  36. to rename it or store it in another directory, you may specify
  37. explicitly which filename it should load to get control data.
  38.  
  39.  
  40. The GGEN.CTL File:
  41.  
  42. Comments: These lines begin with a ";" and are IGNORED by GoodByeGen
  43.  
  44. Colour Commands: These lines allow you to customize the color scheme
  45. for the output files.  The format for these is:
  46.  
  47. Command Colour
  48.  
  49. Available Colour Commands:
  50.  
  51. BackgroundColour     - BackGround Colour (only the first 8 are allowed)
  52. OurnameColour        - Colour of our own system's name
  53. HeaderColour         - Header Text Colour
  54. BorderColour         - Border Colour (remember BOXTYPE?)
  55. NameColour           - BBS Name Colour
  56. NumDigitColour       - Colour of telephone number DIGITS
  57. NumDashColour        - Colour of other telephone number characters, such as:
  58.                        ) ( and -
  59. NodeDigitColour      - Colour of node number DIGITS
  60. NodeDashColour       - Colour of other node number characters, such as:
  61.                        : / and .
  62. NoColour             - Colour of NO entries in the CheckList
  63. YesColour            - Colour of YES entries in the Checklist
  64. BaudColour           - Colour of Baud Rate
  65. LastLineColour       - Colour of Last Line (Copyright Notice)
  66.  
  67. Please note: the string "COLOUR" may be replaced with "COLOR".  In
  68. other words, you may use HEADERCOLOR instead of HEADERCOLOUR.
  69.  
  70. Available Colours:
  71.  
  72. Black           - all commands
  73. Red             - all commands
  74. Green           - all commands
  75. Brown           - all commands
  76. Blue            - all commands
  77. Magenta         - all commands
  78. Cyan            - all commands
  79. White           - all commands
  80. Grey (or Gray)  - not available for BACKGROUNDCOLOUR
  81. LightRed        - not available for BACKGROUNDCOLOUR
  82. LightGreen      - not available for BACKGROUNDCOLOUR
  83. Yellow          - not available for BACKGROUNDCOLOUR
  84. LightBlue       - not available for BACKGROUNDCOLOUR
  85. LightMagenta    - not available for BACKGROUNDCOLOUR
  86. LightCyan       - not available for BACKGROUNDCOLOUR
  87. LightWhite      - not available for BACKGROUNDCOLOUR
  88.  
  89.  
  90. Other Commands:
  91.  
  92. BBSNAME         - Your System Name
  93. BoxType         - As with BinkleyTerm, determine border pattern.
  94. Continuous      - Turn on/off MORE prompting
  95. Formfeed        - Turn on/off screen-clearing prior to display
  96. Pause           - Turn on/off "Press key to disconnect".  Note: sysops
  97.                   using HST or other modems that accept data faster
  98.                   than they transmit it *SHOULD* use this command, or
  99.                   else the user will not get the last portion of the
  100.                   output file.
  101. ANSIoutput      - The filename to send ANSI output to.
  102. ASCIIoutput     - The filename to send ASCII output to.
  103.  
  104. Some OPTIONAL Commands (if you wish to override the defaults):
  105.  
  106. Intro1          - Line displayed just before BBSNAME
  107. Intro2          - Line displayed just after BBSNAME
  108. Intro3          - Line displayed just after Intro2
  109.  
  110. Nodelist Commands:
  111.  
  112. Nodelist        - Specify a nodelist file, in one of three ways:
  113.  
  114.    NODELIST GGEN GGENLIST.TXT
  115.    NODELIST FTSC NODELIST.186 1:134 1:342 1:163
  116.    NODELIST FTSC NODELIST.### 1:134 1:342
  117.  
  118.                 - With method #1, you are telling GGEN to use a
  119.                   GGEN-format nodelist (described later).
  120.                 - With method #2, you are telling GGEN to use an
  121.                   FTSC-format nodelist, the same type used in FidoNet
  122.                   and other networks.  Additionally, you are telling
  123.                   GGEN to scan for nets 134, 342, and 163 in Zone 1.
  124.                   The Zone will default to Zone 1 if not specified.  A
  125.                   Region is considered to be a net, as is a Zone...
  126.                   so, for example, if you wanted to include all of the
  127.                   Zone 1 administrative nodes, you could do this:
  128.                      NODELIST FTSC NODELIST.186 1:1 1:134 (etc)
  129.                 - Method #3 is identical to #2 but is somewhat more
  130.                   useful: GGEN will scan the newest version of the
  131.                   specified nodelist, replacing "###" with the Julian
  132.                   date of the newest available nodelist.
  133.  
  134. Exclude         - Specify a node number to exclude from output.  Handy
  135.                   for those "hub" type nodes that don't have a HUB
  136.                   statement on them, and aren't very useful showing up
  137.                   in a BBS list.
  138. NoDupe          - Similar in concept to EXCLUDE.  This command, when
  139.                   enabled, causes GGEN to accept only the first
  140.                   occurence of any phone number.  Subsequent identical
  141.                   phone numbers that appear in its compiled database
  142.                   will be THROWN AWAY.  It is important to realize
  143.                   that NODUPE processing is done *AFTER* the EXCLUDE
  144.                   commands are processed, so any nodes you've already
  145.                   thrown away with EXCLUDE will *NOT* be a factor in
  146.                   NoDupe checking.  You can therefore, if you like,
  147.                   force GGEN to keep the SECOND (only) occurence of a
  148.                   phone number simply by EXCLUDEing the first one,
  149.                   thus making the actual second occurence the first
  150.                   one to appear in the compiled database (which later
  151.                   gets processed into output files).
  152. NoHost          - Tells GGEN not to list any HOST, REGION, or ZONE
  153.                   entries, ie: your Net Coordinator.
  154. NoHub           - Tells GGEN not to list any nodes flagged with the
  155.                   HUB keyword.
  156. NoPvt           - Tells GGEN not to list any nodes flagged with the
  157.                   PVT (private node) keyword.
  158. NoMO            - Tells GGEN not to list any nodes flagged with the MO
  159.                 - (Mail Only) keyword.
  160. HSTmeansMNP     - Many nodelists will *NOT* flag a node with the MNP
  161.                   flag if it already has the HST flag, as a
  162.                   space-saving measure.  This will tell GGEN to assume
  163.                   that the HST flag implies the MNP flag as well.
  164. V32meansMNP     - Same as above but this one turns MNP on if V32 is
  165.                   found in the node's flags.
  166.  
  167.  
  168. The GGEN-format nodelist:
  169.  
  170. This is really nothing special but it's easy to use and doesn't carry
  171. the "crud" that we don't really need.  The format is fairly
  172. straightforward, and an example should be enclosed with the
  173. distribution archive (GGENLIST.TXT).  There is one node entry per
  174. line, with several elements per entry seperated by commas.  Example:
  175.  
  176. BBS NAME,000-000-0000,1:134/55,14400,HST,V32,MNP,V42
  177.  
  178. The first four parameters are REQUIRED. Note that spaces are *OK* but
  179. you may also use the underscore character, which will be replaced by
  180. spaces during compilation.  The first parameter is the name of the
  181. BBS, the second is its phone number, the third its node number (you
  182. can enter "n/a" or "none" if this BBS is not a member of any FTSC-type
  183. network), and finally the maximum baud rate supported.
  184.  
  185. Following this, you may have up to four flags, each specifying various
  186. "special" things about the modem that the BBS uses.  Every one that
  187. applies must be explicitly stated: the HSTmeansMNP and V32meansMNP
  188. flags will *NOT* function with a GGEN-format nodelist.  If a node is
  189. HST, list it as both HST and MNP.  Etc.
  190.  
  191.  
  192. GGEN can handle as many individual BBS entries as you have disk space
  193. to handle, although you are limited to scanning 100 nets and you have
  194. a maximum of 100 EXCLUDEs (let me know if this is restricting, I can
  195. probably expand these limits at the cost of a bit of speed).
  196.  
  197. And that's about it!  Hope you like it.
  198.  
  199. The Vulcan Science Academy BBS
  200. Line 1 Phone 1-403-226-0867
  201. Line 2 Phone 1-403-226-0868
  202. Node 1:134/55 in FidoNet
  203. Node 99:9305/55 in GoodEggNet
  204. Node 201:5500/55 in MetroNet
  205.  
  206. SnailMail:
  207.  
  208. Joe Lindstrom
  209. 34 Harvest Wood Link N.E.
  210. Calgary, AB, Canada
  211. T3K 3X8
  212.  
  213. Trek on!
  214.  
  215. [~] Sarek Of Vulcan [~]
  216.  
  217.  
  218. Revision History
  219. ================
  220.  
  221. V0.07   - Initial Beta Release
  222.  
  223. V0.08   - Made a couple of minor cosmetic changes (prettier now)
  224.  
  225. V1.00   - Extensive beta-bashing produced no bugs (!), therefore I
  226.           simply changed the version number, recompiled, and released
  227.           it.
  228.  
  229. V1.99   - A complete revamping, added FTSC nodelist support.
  230.  
  231. V1.99c  - Hopefully the last beta, added NODUPE command and completely
  232.           reworked the EXCLUDE command.  Theoretically, I can now
  233.           easily reverse the order of processing, so if somebody
  234.           thinks NODUPE should be processed before EXCLUDE, that can
  235.           be arranged.  Feedback?
  236.  
  237. V2.00   - Yep, that was the last beta.  Fixed the formatting, it
  238.           finally works right... specifically, the node numbers are
  239.           now centred in their column based on the length of the
  240.           longest node number to be included with the output files.
  241.         - Sped things up.  In a series of tests with my 386SX running
  242.           at 16MHz with HyperDisk disk caching, V1.99C took 196
  243.           seconds to extract Net 134 from NODELIST.193.  This version,
  244.           after extensive streamlining, now takes 116 seconds.  Your
  245.           mileage may vary.
  246.  
  247. V2.10   - Increased nodelist read speed dramatically, thanks to a
  248.           programming tip I picked up out of the QB-News.
  249.         - Added INTRO1, INTRO2, and INTRO3 so that sysops could use
  250.           GGEN's output lists within their BBS systems instead of only
  251.           for logoff screens.  Specifically, Nathan Moschkin in Net
  252.           109 asked for this so that he could set up several GGEN.CTL
  253.           files, each of which would be programmed to read certain
  254.           portions of his nodelist and output different files, which
  255.           the users could then read from a sort of "BBS list" submenu
  256.           within his board.  As it was, GGEN's lists make it look like
  257.           the user is about to logoff and this was undesirable in this
  258.           situation (although this *IS* GGEN's purpose).  Sysops now
  259.           have the option to override the "Thank you for calling" and
  260.           stuff, though it's far from as flexible as it could be.
  261.  
  262.