home *** CD-ROM | disk | FTP | other *** search
/ synchro.net / synchro.net.tar / synchro.net / modem.madness / SMMTRBBS / TRIUI100.ZIP / TRIUINFO.DOC < prev    next >
Encoding:
Text File  |  1993-05-27  |  18.1 KB  |  588 lines
  1. TriUInfo                                                       
  2. Copyright (c) 1993 Chihli Lu.  All Rights Reserved.
  3. ---------------------------------------------------
  4. TriBBS Usage Information Statistic Bulletin Maker
  5.  
  6.  
  7. DISCLAIMER
  8. ----------
  9. I Chihli Lu will not be responsible for any  damages or lost
  10. profits, or any other losses resulting from the use of or the
  11. inability to use this program.  This program is distributed without
  12. warranty.  You should register this program if you plan to continue
  13. the usage of this program after the 10 days trial period.  This
  14. program is distributed under the shareware concept, any
  15. modifications with out the written permission is an direct
  16. violation of International copyright laws.
  17.  
  18. TriBBS is a registered trademark of Mark Goodman.  All other brand
  19. and product names  mentions in this manual are trademarks or
  20. registered trademarks of respective companies
  21.  
  22.  
  23. TABLE OF CONTENTS
  24. -----------------
  25. INTRODUCTION  ...............................................    1
  26. INSTALLATION  ...............................................    1
  27. CONFIGURATION  ..............................................    2 
  28.    TRIUINFO.CFG  ............................................    2 
  29.    BULLETIN.MNU  ............................................    4 
  30.    DOORS.MNU  ...............................................    5 
  31.    EXCLUSION FILES  .........................................    6 
  32. PARAMETERs   ................................................    8
  33. LIMITATIONs   ...............................................    8
  34. ERRORs  .....................................................    9 
  35. SUPPORT  ....................................................   10
  36. REGISTRATION  ...............................................   10
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56. TriBBS Usage Information Statistic Bulletin Maker          Page  1
  57.  
  58. INTRODUCTION
  59. ------------
  60. TriUinfo is one of the newest usage statistic bulletin maker for
  61. TriBBS. TriUInfo was designed as a weekly statistic generator to
  62. provide monthly report of the bbs.  Although TriUInfo is relatively
  63. new to the 3rd party programs that will also make statistic
  64. bulletins, TriUInfo surpasses many if not all for it's functions
  65. and features in a single package.  Remote Calls, New Users Added,
  66. Uploads Completed, Downloads Completed, Doors Used, Questionnaires
  67. Used, Bulletins Read, Messages Entered, Users Paged SysOp Entered
  68. CHATs, Total User Online(m), Aver. User Online(m), Total Door
  69. Usage(m), Aver. Door Usage(m),  Locked or Deleted User, Incorrect 
  70. Passwords, Bad Uploads, Keyboard Time Outs, Lost of Carriers,
  71. Duplicated Messages, Sysop Sessions, Edits User Base,  Edits File
  72. Base, Edits Message Base, Edits Events Base, Viewed Caller Logs,
  73. Sorted File Lists, Packed Users Base, Moved Files, Removed Files.
  74. Logon Baud Rates                  Users Logon Hours
  75. Logon Baud Rates Chart            User Logon Time Chart
  76. New Users                         Top Uploader(s)
  77. Top Downloader(s)                 Top Door User(s)
  78. Top Message User(s)               Top Pager(s)
  79. Top Bulletin User(s)              Top Questionnaire User(s) Top
  80. Callers by Times On               Top Callers by Online Duration
  81. Top Callers by Hangups            Top Downloads!
  82. Top Doors Opened                  Top Doors by Usage Time
  83. Top Conferences                   Top Bulletins
  84.  
  85.  
  86. INSTALLATION
  87. ------------
  88. TriUInfo can work in a separate directory other than that of
  89. TriBBS.  You can either create a new directory and move all files
  90. in the to the new directory or you can simply move all files to the
  91. TriBBS directory.  You then need to edit various configuration
  92. files according to your needs.  It's not recommended to run
  93. TriUinfo in Between.bat due to the extensive searching that may
  94. require a lot of down time between callers.  TriUInfo serves better
  95. as a Event run daily.  Note: TriUinfo will back the log to by
  96. appending to another Callers.LOG located in the system directory. 
  97. So each and every time you run the stats, you should deleted the
  98. log after the run or after all utilities are done with the
  99. Mwork\Callers.LOG  If you uses programs that requires you to have
  100. the COMPLETE HUGE log in order to run... (Maybe you should bug the
  101. author so you can run it with an appending function)  you should
  102. redirect the utilities to use the log in the system dir cause it
  103. would be the continuous log combined from the first usage of
  104. TriUInfo unless you delete the backup log.   
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111. TriBBS Usage Information Statistic Bulletin Maker          Page  2
  112.  
  113. CONFIGURATION
  114. -------------
  115. * TriUInfo.CFG *
  116. Line 1 - 20 are NEEDED for proper running of the program
  117. Line 21 - X are used for identifying extended menu programs
  118. ************************************************************
  119. Line 1  -->>   BBS NAME
  120. Line 2  -->>   Sysop Name
  121.      3  -->>   ANSI  File PATH and NAME     (Bullet3.ANS)
  122.      4  -->>   ASCII File PATH and NAME     (Bullet3.BBS)
  123.      5  -->>   TriBBS System Files Directory
  124.      6  -->>   (PATH&NAME *No Extention*)Top Uploader(s) =-
  125.      7  -->>   (PATH&NAME *No Extention*)Top Downloader(s) =-
  126.      8  -->>   (PATH&NAME *No Extention*)Top Door User(s) =-
  127.      9  -->>   (PATH&NAME *No Extention*)Top Message User(s) =-
  128.      10 -->>   (PATH&NAME *No Extention*)Top Pager(s) =-
  129.      11 -->>   (PATH&NAME *No Extention*)Top Bulletin User(s)=-
  130.      12 -->>   (PATH&NAME *No Extention*)Top Questionnaire User(s)
  131.      13 -->>   (PATH&NAME *No Extention*)Top Callers by Times On =-
  132.      14 -->>   (PATH&NAME *No Extention*)Top Callers by Duration =-
  133.      15 -->>   (PATH&NAME *No Extention*)Top Callers by Hangups =-
  134.      16 -->>   (PATH&NAME *No Extention*)Top Downloads! =-
  135.      17 -->>   (PATH&NAME *No Extention*)Top Doors Opened =-
  136.      18 -->>   (PATH&NAME *No Extention*)Time Spent in Top Doors =-
  137.      19 -->>   (PATH&NAME *No Extention*)Top Conferences =-
  138.      20 -->>   (PATH&NAME *No Extention*)Top Bulletins =-
  139.      21 -->>   Extended Menu Batch File's FULL PATH&NAME (ALL CAPS)
  140.      22 -->>   Description of Extended Menu (lower case allowed)
  141.      23 -->>   Extended Menu Batch File's FULL PATH&NAME (ALL CAPS)
  142.      24 -->>   Description of Extended Menu (lower case allowed)
  143.      and so on
  144. ************************************************************   
  145. Line  1 -  5 are vital for the program to execute correctly
  146. Line  6 - 20 are optional single statistic bulletins that will
  147.              include only the specific topic of the bulletins.
  148.              For example.  Line 6 is for Top Uploaders.  Therefore
  149.              if you enter C:\TriBBS\DISPLAY\Bullet12 in line 6
  150.              TriUInfo will created bulletin # 12 for ANSI and ASCII
  151.              in the DISPLAY dir of TriBBS system with content of  
  152.              Top Uploaders during the log period.  There is no    
  153.              extension for the path and name  
  154. Line 21 -  X are lines for identifying Extended Menus you have set 
  155.              in various menus.  Main/Message/File Odd lines are for 
  156.              FULL PATH and name, Even lines are for the description 
  157.              of the preceding line. 
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166. TriBBS Usage Information Statistic Bulletin Maker          Page  3 
  167.  
  168. Example TriUinfo.CFG
  169. ************************************************************
  170. Nirvana                       
  171. Eric Lu                       
  172. D:\tb\display\Bullet3.ans     
  173. D:\tb\display\Bullet3.bbs    
  174. D:\TB                         
  175. D:\tb\display\Bullet11 
  176. D:\tb\dummy
  177. D:\tb\dummy
  178. D:\tb\display\bullet14                         
  179. D:\tb\display\Bullet15
  180. D:\tb\display\Bullet16
  181. D:\tb\display\Bullet17
  182. D:\tb\display\Bullet18
  183. D:\tb\display\Bullet19
  184. D:\tb\display\Bullet20
  185. D:\tb\display\Bullet21
  186. D:\tb\display\Bullet22
  187. D:\tb\display\Bullet23  
  188. D:\tb\display\Bullet24
  189. D:\tb\display\Bullet25
  190. D:\TB\MESST.BAT
  191. Nirvana Offline Mail
  192. D:\TB\MAIN1.BAT
  193. TriBBS Sysop Upgrade Door
  194. ************************************************************
  195. Line 3 & 4 have the FULL path and name with .ANS/.BBS extensions
  196. trailing. Line 6-20 have no extensions trailing.  TriUInfo will
  197. generate the ANSI & ASCII file accordingly by the file name with no
  198. extensions.  this is used for saving extra config lines.  :)
  199. You should note that line 7 is setup as a dummy file.  In doing
  200. this I have disabled the optional single bulletin for Top
  201. Downloaders & Door users.  You must have a dummy file name if you
  202. don't want TriUInfo to generate the optional bulletin.
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221. TriBBS Usage Information Statistic Bulletin Maker          Page  4
  222.  
  223. * Doors/Bulletin.MNU*
  224. You must have a valid Doors.MNU in order to run the program it
  225. should be the way that you have the bullet.mnu if you do not uses
  226. bulletin.ANS/.BBS  This is vital for TriUInfo to read data about
  227. the top bulletins read.  And if you reserved some bullet number for
  228. future uses like I do. Here's the MNUs from my board:  Bulletin.MNU 
  229. ************************************************************
  230. 4,15,1,15
  231. General Rules of Nirvana
  232. Securities of Nirvana
  233. How to make you Sysop Proud
  234. What is SHAREWARE?
  235. Nirvana Donation Information
  236. About Real Sysops
  237. BBS Acronyms
  238. 30 BBS commandments
  239. Want to be a Sysop?
  240. Today in history
  241. TriUInfo-BBS Usage Info.,10
  242. TriLUser-Last 50 Users,10
  243. TriUStat-User Statistic,10
  244. TriBList-BBS List   
  245. 15,9999
  246. 16,9999
  247. 17,9999
  248. 18,9999
  249. 19,9999
  250. Denizens of Nirvana
  251. Declaration of Independence
  252. Gettysburg's Addrress
  253. Bill of Rights
  254. Universal Human Rights
  255. Magna Carta
  256. The Constitution of USA
  257. The Emancipation Proclaimation
  258. The Mayflower Compact
  259. The Star Spangled Banner
  260. 40,9999
  261. ************************************************************
  262. Bulletin.MNU should have the description length down to 41
  263. characters.  As you can see that I have reserved several bulletins
  264. for future usage.  If you wishes to reserve certain number of
  265. bulletins for the future expansion  of the board.  You need to
  266. insert a dummy line with security level that is not accessible by
  267. all users.  This will prevent crossed linked bulletins or bulletins
  268. with no description on the bulletins.
  269.    
  270.  
  271.  
  272.  
  273.  
  274.  
  275. TriBBS Usage Information Statistic Bulletin Maker          Page  5
  276.  
  277. Doors.MNU
  278. ************************************************************
  279. 1,15,3,15
  280. D,Verify Registration,10,1000
  281. D,SCRABBLE,01,10
  282. D,Land of Devastation,02,1000
  283. D,Solar Realms Elite,03,10
  284. D,Global War,04,10
  285. D,Word-Z,05,10
  286. D,The PIT,06,1000
  287. D,Cripple Smash,07,10
  288. D,BBS Hockey,08,10
  289. D,King of the Board,09,1000
  290. ************************************************************
  291. Doors.MNU  should have the description length down to 41
  292. characters.
  293.  
  294.    
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330. TriBBS Usage Information Statistic Bulletin Maker          Page  6
  331.  
  332. * Exclusion Files *
  333. These files are NOT RELATED to the /E# parameter switches. These
  334. files will simply stop any of the specific names from showing up in
  335. the bulletins. This is used for excluding maybe some adult oriented
  336. materials from showing in the bulletins of which you don't want
  337. young people to have know about or your name if you don't want you
  338. to be on the top of the caller's stats.
  339.  
  340.    Secondary DATA File:   TriUInfo.D1        (User Name)
  341.    Secondary DATA File:   TriUInfo.D2        (File Name)
  342.    Secondary DATA File:   TriUInfo.D3        (Door Name)
  343.    Secondary DATA File:   TriUInfo.D4        (Conference Name)
  344.    Secondary DATA File:   TriUInfo.D5        (Bulletin #)
  345.  
  346. These are the data files where you put in the name of the certain
  347. User(s), file(s), door(s), conference(s), or bulletin(s) from
  348. showing on the output bulletins.   Here are some examples:
  349.  
  350. TriUInfo.D1:
  351. ************************************************************
  352. Eric Lu
  353. Mail BBS
  354. User1
  355. User2
  356. ************************************************************
  357. First line is the sysop name if you want yourself out of the
  358. bulletins.  Second line is an example mail node that's calling your
  359. board for messages.  You may wish to exclude it from showing up in
  360. the bulletin since they logon as bbs name and only calling for
  361. messages and nothing else.  The user names MUST be exactly as it is
  362. in the Users.Dat which  the first character of the first or last
  363. name will be capital letter. 
  364.  
  365. TriUInfo.D2:
  366. ************************************************************
  367. MASTER.ZIP
  368. SUPPORT.ZIP
  369. ************************************************************
  370. Here's the frequently downloaded files from my board.  Which 
  371. usually will end up on top of the stats.  So if you want certain 
  372. files to be excluded from the bulletins.  ie:  adult files and
  373. such.  
  374.  
  375. TriUInfo.D3:
  376. ************************************************************
  377. Private Door1
  378. Private Door2
  379. ************************************************************
  380. The Door does. names MUST be exactly as it is in the Doors.MNU 
  381. one way to modify it easier is to run the TriUInfo first then 
  382. uses a text editor to edit the ASCII bullet and save the names 
  383. to TriUInfo.D3                                                 
  384.  
  385. TriBBS Usage Information Statistic Bulletin Maker          Page  7
  386.  
  387. TriUInfo.D4:
  388. ************************************************************
  389. Private Messages1
  390. Private Messages2
  391. ************************************************************
  392. The Conference names MUST be exactly as it is in the Mconf.dat  
  393. one way to modify it easier is to run the TriUInfo first then  
  394. uses a text editor to edit the ASCII bullet and save the confs 
  395. to TriUInfo.D4                                                 
  396.  
  397. TriUInfo.D5:
  398. ************************************************************
  399. 1
  400. 2
  401. ************************************************************
  402. The above numbers represent the bulletin numbers
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440. TriBBS Usage Information Statistic Bulletin Maker          Page  8
  441.    
  442. PARAMETERs
  443. ----------
  444.   /A      Append to existing DATA.
  445.           If  you wishes to use this parameter so you don't have to 
  446.           keep a huge log.  You must remember to delete the log   
  447.           after the run.  Otherwise you will be doubling the data. 
  448.           This switch will append to the statistics that you have 
  449.           compiled last time the program was ran.  
  450.   /E1     No User Related Stats
  451.   /E2     No Download Related Stats
  452.   /E3     No Door Related Stats
  453.   /E4     No Conference Related Stats
  454.   /E5     No Bulletin Related Stats
  455.           The Exclude switches will totally disable the specific  
  456.           function in the program.  /E1 will stop the program from 
  457.           making any user related bulletins.
  458.  
  459.     
  460. LIMITATIONs
  461. -----------
  462. TriUInfo is currently limited to the following.
  463. Up to  5000 in User Names
  464.       15000 in File Names
  465.        5000 in Door Names
  466.        5000 in Conf Names
  467.         99 in Bulletin Names       
  468.         99 in Extended Menu Names  
  469. once the the limit is exceeded, the program will abort
  470. automatically.  When you have compiled over 1000 of certain stats. 
  471. You must restart the stats from scratch again.   TriUInfo is
  472. designed to be a monthly stat maker, so the limits should suffice
  473. most bulletin boards.
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495. TriBBS Usage Information Statistic Bulletin Maker          Page  9
  496.  
  497. ERRORs
  498. ------
  499.   2  File not found-check TriUInfo.CFG
  500.   3  Path not found-check TriUInfo.CFG 
  501. 100  Disk read error
  502. 101  Disk write error
  503. 106  Invalid numeric format- most likely caused by the invalid    
  504.      length of description of doors or bulletins in               
  505.      Doors.MNU/Bulletin.MNU
  506. 150  Disk is write-protected
  507. 152  Drive not ready
  508. 154  CRC error in data
  509. 156  Disk seek error
  510. 157  Unknown media type
  511. 158  Sector Not Found
  512. 160  Device write fault
  513. 161  Device read fault
  514. 162  Hardware failure
  515. 200  Division by zero
  516. 201  Range check error
  517. 202  Stack overflow error
  518. 203  Heap overflow error
  519. 204  Invalid pointer operation
  520. 205  Floating point overflow
  521. 206  Floating point underflow
  522. 207  Invalid floating point operation
  523. 208  Overlay manager not installed
  524. 209  Overlay file read error
  525. 210  Object not initialized
  526. 211  Call to abstract method
  527. 212  Stream registration error
  528. 213  Collection index out of range
  529. 214  Collection overflow error
  530. 215  Arithmetic Overflow-Incompatible log.  You should delete the 
  531.      current log and start a new one.
  532. 216  General Protection fault
  533.     
  534.      
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550. TriBBS Usage Information Statistic Bulletin Maker          Page  10
  551.  
  552. SUPPORT
  553. -------
  554. You may obtain assistance with TriUInfo related problems by
  555. accessing TriBBS support conferences on various mail networks such
  556. as Intelec, TTN, & FIDO.  I check for messages on the supporting
  557. conferences for ideas and updates on TriBBS or getting feedbacks on
  558. my programs.   I'll get the message with 2-3 days delay due to the
  559. cross link of the message networks.  So you should expect a reply
  560. within a week.   I'll try to help you get the program running 
  561. correctly.  There will also be many acknowledgeble sysops who may
  562. be able to answer your questions before I get the message.   In any
  563. case, I'll do my best to support my programs.
  564.  
  565.  
  566.  
  567. REGISTRATION
  568. ------------
  569. Registration fee for TriUInfo is only $17.00  Please use the
  570. registration form included in the archive: TriUInfo.REG to register
  571. for your board.  Upon the reception of the fee.   I'll upload all
  572. necessary files to you board.  The uploaded archive will include
  573. the latest public release of TriUInfo available at that time, a
  574. encrypted registration key:  TriUInfo.Key.  All future updated 
  575. will automatically be registered with the key that you receive upon
  576. the registration.  Archive will also include few free programs
  577. that's offered to you as a bundle.   These files require the
  578. registration key: TriUInfo in order to run.  These handy utilities
  579. are free for you as my appreciation of you registering TriUInfo. 
  580. Many of the bundled programs are just as good and in some cases
  581. better than that of the sharewares out there.   So you are 
  582. basically getting a bunch of programs with a single registration. 
  583. if you find that TriUInfo suits you needs.  Please consider to
  584. register it.  TriUInfo represent hours of programming and beta
  585. testing.   And by registering this program, you are supporting the
  586. past/present/future of the developments and will also encourages
  587. for more good utilities to be made in the future. 
  588.