home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / ACNFN24.ZIP / ACNFN.DOC < prev    next >
Encoding:
Text File  |  1994-08-07  |  14.2 KB  |  370 lines
  1.              Automated Network/Conference Listing Generator
  2.  
  3.                                   v2.4
  4.  
  5.                           PCBoard 14.5a/15.0
  6.  
  7.                                    by
  8.  
  9.                               Al Lawrence
  10.  
  11.                             Sunrise-80  BBS
  12.                          (404) 256-9525 (Data)
  13.                          (404) 705-9104 (Data)
  14.                   (404) 256-9518 (Voice, 9am-9:30pm EST)
  15.                             Fido 1:133/410
  16.  
  17.  
  18.  
  19.  
  20.                               DESCRIPTION
  21.                               ___________
  22.  
  23.  
  24. The Automated Network/Conference Listing Generator (ACNFN) is a utility that
  25. creates the conference display file. Most Sysops use an editor to create the
  26. conference listing, more commonly called CNFN. As you add/change/delete
  27. conferences you end up spending hours trying to realign and colorize the
  28. display. If you happen to add a whole network, you could very well spend
  29. more time fixing the conference listing, than creating the conferences
  30. themselves. This utility does not create any extraneous files on disk and
  31. uses the CNAMES file as input. There is no need to create a second file for
  32. the colorized listing, as the program uses the @X variables made available
  33. in PCBoard v14.5/15.0  Just about everything is configurable, from verbage
  34. to colors.
  35.  
  36.  
  37.  
  38.                               INSTALLATION
  39.                               ____________
  40.  
  41.  
  42.    Installation is fairly easy and straight-forward. The following steps and
  43.    examples should have you up and running in a very short period of time.
  44.  
  45.      (1) Create a Configuration file with a name of your choice.
  46.  
  47.      (2) Run the program using the following command line:
  48.  
  49.                ACNFN   xxxx.CFG
  50.  
  51.          Where xxxx = the name used in (1) above.
  52.  
  53.  
  54.  
  55.  
  56.                              CONFIGURATION FILE
  57.                              __________________
  58.  
  59.      Line 1.   Sunrise-80 BBS
  60.      Line 2.   Al Lawrence
  61.      Line 3.   00000000
  62.      Line 4.   INPUT=C:\PCB\MAIN\CNAMES.@@@
  63.      Line 5.   OUTPUT=C:\PCB\GEN\CNFN
  64.      Line 6.   SORT=N
  65.      Line 7.   NUMCOL=LEFT
  66.      LINE 8.   NDESC=RIM:RIME
  67.      Line 9.   NETCONF=RIM:2:100:P
  68.      Line 10.  CONF=LOC:Sunrise Doors:1:1:p
  69.      Line 11.  XCNF=@X06
  70.      Line 12.  XTYP=@X0C
  71.      Line 13.  XCFN=@X0A
  72.      Line 14.  XHDB=@X1A
  73.      Line 15.  XBBS=@X1F
  74.      Line 16.  XNET=@X57
  75.      Line 17.  XBBG=@X1F
  76.      Line 18.  XMRE=@X8C
  77.      Line 19.  BLINE=R = Restricted
  78.      Line 20.  COLUMNS=4
  79.      Line 21.  SEPCNFN=N
  80.  
  81.  
  82. __________________________________________________________________________
  83.  
  84. Line 1.  Your BBS Name. Will Display on Heading and is mandatory
  85.  
  86. Line 2.  Sysop's First and Last Name. Does not display, but is mandatory.
  87.  
  88. Line 3.  Registration Number
  89.  
  90. Line 4.  Full Pathname\Filename of the CNAMES.@@@ file. This entry is
  91.          mandatory.
  92.  
  93. Line 5.  Full Pathname\Filename of the output file that will contain
  94.          the conference listing. This entry is mandatory.
  95.  
  96. Line 6.  This entry indicates the SORT sequence for the conference displays.
  97.          N = Display conference's in conference NUMBER sequence.
  98.          A = Display conference's in conference NAME sequence.
  99.          This entry is mandatory.
  100.  
  101. Line 7.  This entry indicates where you would like to have the conference
  102.          number displayed.
  103.          LEFT  = Display it to the LEFT  of the conference name
  104.          RIGHT = Display it to the RIGHT of the conference name.
  105.          This entry is mandatory.
  106.  
  107. Line 8.  This entry assigns a UNIQUE 3 character ID and description to each
  108.          Network on your system. The format is|  NETWORK ID:NETWORK NAME
  109.          The Network name will appear in the header, displayed at the top of
  110.          each column of the listing for that network. One NDESC entry is
  111.          required for EACH Network you carry. The maximum size of the Network
  112.          Name is 17 characters. The program will support a maximum of 99
  113.          Networks. At least one is mandatory
  114.  
  115. Line 9.  This entry describes the conference numbers to be associated with
  116.          each of the conference descriptions you have defined above. At
  117.          least one is mandatory.
  118.  
  119.          Format|  NETWORK ID:STARTING CONF. #:ENDING CONF. #:CONF. TYPE
  120.          NETWORK ID = Must match one of the IDs in line 8.
  121.          STARTING # = First conference # in a range comprising the network
  122.          ENDING   # = Last  conference # in a range comprising the network
  123.          CONF. TYPE = P for Public Conferences, R for Restricted/Reserved or
  124.                       F for conferences that contain files
  125.                       Note: This applies to ALL the conference numbers in the
  126.                             range indicated.
  127.  
  128.          Use multiple NETCONF entries if you have a mixture of Public and
  129.          Reserved. For example: if your RIME conferences covered numbers
  130.          1-100 and #35-37 were Reserved and all others were Public you would
  131.          use 3 NETCONF entries. 1-34 would have a CONF TYPE of P, 35-37 would
  132.          have a CONF TYPE of R and 38-100 would have a CONF TYPE of P. You can
  133.          use any number of NETCONF entries to fully describe your conference
  134.          to a maximum of 500 !
  135.  
  136. Line 10. This entry is used to assign a conference to more than one NETWORK.
  137.          This is mostly cosmetic and is NOT a required entry. In future
  138.          versions this entry will be used by non-PCBoard systems. Optional.
  139.          Format| NETWORK ID:CON. NAME:CONF. #:CONF. TYPE
  140.          NETWORK ID = Must match one of the IDs in line 8.
  141.          CON. NAME  = Conference name up to a maximum of 12 characters
  142.          CONF. #    = Conference number up 3 digits
  143.          CONF. TYPE = Same as Line 9 above
  144.  
  145. -------------------------------------------------------------------------
  146. --- Next 8 Entries Control the Colors For Each Section of the Listing ---
  147. ---------------------- Uses @X Color Codes ------------------------------
  148. -------------------- Registered Version Only ----------------------------
  149. -------------------------------------------------------------------------
  150.  
  151. Line 11. Conference Name Color
  152. Line 12. Conference Type Color
  153. Line 13. Conference Number Color
  154. Line 14. Heading Color (box)
  155. Line 15. Heading BBS Name Color
  156. Line 16. Network Name Color
  157. Line 17. Bottom Line Color
  158. Line 18. "More" Color, on Bottom line (both ends)
  159.  
  160. Line 19. With this entry you can define what appears on the bottom line.
  161.          By default it will show "R = Restricted", in registered version.
  162.          Maximum length is 70 characters. Optional. Requires Registration!
  163.  
  164. Line 20. This entry will allow you to define the number of columns to be
  165.          used to display the conferences. Your choices are 3 or 4. If you
  166.          define 4 columns and the program determines that you have more than
  167.          9,999 conferences, the the number of columns will be reduced to 3.
  168.  
  169. Line 21. This entry will allow you create separate CNFN files for each
  170.          network you have defined. The file name for each of the CNFN files
  171.          will be the same as the 3 character network ID you assigned in the
  172.          NETCONF lines above. In addition to the individual CNFN files an all
  173.          encompassing  CNFN will also be created.
  174.  
  175.  
  176. __________________________ E X A M P L E ____________________________________
  177. To help make all this a little clearer (it is really very simple), I will
  178. describe the conferences/Networks of my BBS and what the Configuration file
  179. would look like. Sunrise-80 BBS has 4 Networks and Local conferences. The
  180. Networks are RIME, City2City, SmartNet and L&Lnet. Conference numbers are
  181. assigned as follows:
  182.  
  183.            Rime     : 2-23, 25-70, 94 (all are Public except 29,30,35)
  184.            City2City: 73-93 (all are Public except 75,84,86)
  185.            FidoNet  : 1, 71-72, 95-97 (all are Public)
  186.            SmartNet : 98-112 (all are Public)
  187.            Local    : 0, 24 (all are Public)
  188.  
  189. In addition I display my Sunrise Doors conference (conf # 1) in Local area
  190. as well as the FidoNet Network.
  191.  
  192. I also use all the default colors and a special bottom line. All has been
  193. included in the example CFG.
  194.  
  195. The CNFN.CFG file would look like this:
  196. _______________________________________
  197.  
  198. Sunrise-80 BBS
  199. Al Lawrence
  200. 00000000
  201. INPUT=C:\PCB\MAIN\CNAMES.@@@
  202. OUTPUT=C:\PCB\GEN\CNFN
  203. SORT=N
  204. NUMCOL=LEFT
  205. NDESC=100:R I M E
  206. NDESC=200:City2City
  207. NDESC=400:FidoNet
  208. NDESC=300:SmartNet
  209. NDESC=500:L O C A L
  210. NETCONF=200:73:74:P
  211. NETCONF=200:75:75:r
  212. NETCONF=200:76:83:p
  213. NETCONF=200:84:84:r
  214. NETCONF=200:85:85:p
  215. NETCONF=200:86:86:r
  216. NETCONF=200:87:93:p
  217. NETCONF=100:2:23:p
  218. NETCONF=100:25:28:p
  219. NETCONF=100:29:30:r
  220. NETCONF=100:31:34:p
  221. NETCONF=100:35:35:r
  222. NETCONF=100:36:70:p
  223. NETCONF=100:94:94:p
  224. NETCONF=400:1:1:p
  225. NETCONF=400:71:72:p
  226. NETCONF=400:95:97:p
  227. NETCONF=500:0:0:p
  228. NETCONF=500:24:24:p
  229. NETCONF=300:98:112:P
  230. CONF=500:Sunrise Doors:1:p
  231. XCNF=@X06
  232. XTYP=@X07
  233. XCFN=@X0A
  234. XHDB=@X1A
  235. XBBS=@X1F
  236. XNET=@X57
  237. XBBG=@X1F
  238. XMRE=@X8C
  239. BLINE=R = Restricted    [AVAILABLE FROM: Sunrise Doors/Utility Software]
  240. COLUMNS=4
  241.  
  242.  
  243.                         Hints/Tips/Other Ramblings
  244.                         __________________________
  245.  
  246.      (1) The sequence in which the networks appear, is controlled by the
  247.          NETWORK ID field. The program will sort on this field, therefore
  248.          it is important to assign values to each network that will place
  249.          them in the proper sequence. As you can see from the Example
  250.          Sunrise CFG file, above, I use 3 digit numbers.
  251.  
  252.      (2) The first three(3) entries in the CFG file are required to be in
  253.          that sequence. All others may be in any sequence.
  254.  
  255.      (3) This version will handle up to 99,999 conferences (NON-Registered
  256.          only handle 50).
  257.  
  258.      (4) Be sure to use the ':' to separate fields within each Entry.
  259.  
  260.      (5) I really do not like to do documentation and therefore there may be
  261.          some errors or omissions in this document. I would appreciate any
  262.          feedback you wish to give relative to the program itself or the Docs.
  263.  
  264.  
  265.  
  266.  
  267.                           TROUBLESHOOTING
  268.                           ---------------
  269.  
  270. (1) If you are running this Door on a 486 system and encounter errors such as
  271.  
  272.     ERROR 6.... OVERFLOW Error
  273.     ERROR 5.... ILLEGAL Function Call (may be associated with other problems)
  274.     KEYBOARD Timeout after 5 minutes
  275.  
  276.     You may have to put the following line in your AUTOEXEC.BAT file:
  277.  
  278.          SET NO87=ON
  279.  
  280. (2) If you encounter an Error 62 (Input Past End of File), BEFORE you see the
  281.     opening screen of the Door, your problem will more than likely be associated
  282.     with the CFG file. The error 62 means that you do not have enough entries
  283.     in the CFG. Compare your CFG file with the CFG definition in the DOC file.
  284.  
  285.  
  286. (3) If you encounter an ERROR 70... Permission Denied, this will more than
  287.     likely mean that you DO NOT have SHARE loaded. SHARE is a DOS file that
  288.     comes with your version of DOS. To load it type the word SHARE at the DOS
  289.     prompt. To load it permanently type the word SHARE on a line by itself in
  290.     your AUTOEXEC.BAT file, any place prior to the loading of your BBS
  291.     software. There have been numerous reports that loading SHARE high causes
  292.     some problems, so to be on the safe side, do not load it high.
  293.  
  294.  
  295. Should you have any questions or problem, please do not hesitate to call
  296.    voice for immediate help... 404-256-9518 (9am-9:30pm EST) any day!
  297.  
  298.  
  299.  
  300.  
  301.                               LEGALITIES
  302.                               __________
  303.  
  304.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  305.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  306.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  307.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  308.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  309.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  310.       OR BREACH OF ANY WARRANTY.
  311.  
  312.  
  313.  
  314.  
  315.  
  316.                              DISTRIBUTION
  317.                              ____________
  318.  
  319.    You may make this file available for downloading from your BBS or you may
  320.    upload it to any BBS of your choice, provided that you do not make any
  321.    changes to the contents of the archive (ZIP file). The archive and its
  322.    individual contents may not be used by any service that charges any money
  323.    whatsoever, without the written permission of the author.
  324.  
  325.  
  326.  
  327.  
  328.  
  329.                              REGISTRATION
  330.                              ____________
  331.  
  332.    Registration and the subsequent insertion of the registration number into
  333.    your configuation file, allows for the display of your BBS name on the
  334.    opening screenand its display in the heading of the listing, reduction of
  335.    delays, and the ability to change certain values in the configuration file.
  336.  
  337.    To register your copy of ACNFN, please fill out the registration form
  338.    (REGISTER.FRM) and mail it along with the registration fee to the name and
  339.    address on the form.
  340.  
  341.    Once a door is registered, any changes to registration information (Sysop
  342.    name or BBS Name) will require the doors to be re-registered. Download or
  343.    File Request a file named CHANGE.FRM from our BBS, complete the form and
  344.    follow ALL instructions in the document!
  345.  
  346.    Registration fees are subject to change at any time. The most current
  347.    registration form is always available on our BBS. You may download or
  348.    File Request REGISTER.FRM at any time.
  349.  
  350.    Be sure to use the proper upper/lower case when filling in your name and
  351.    BBS name, as they MUST match the way you entered them in the configuration
  352.    file.             ^^^^
  353.  
  354.    Based upon information supplied on the registration form, I will pre-
  355.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  356.    up your registration number.
  357.  
  358.  
  359.  
  360.                                  MISC
  361.                                  ____
  362.  
  363.    The latest version of ACNFN and other fine SUNRISE DOOR programs are
  364.    always available for download from SUNRISE-80 BBS.
  365.  
  366.    Remember, should you have any problems, questions or suggestions, be sure
  367.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors,
  368.    PCBHints, SYSops), SmartNet (SN_Sysops), City2City, FIDO (Sysops,
  369.    PCBnet, Sysop18), DoorNet or GeniusNet
  370.