home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 15 / CD_ASCQ_15_070894.iso / vrac / stats200.zip / SBBSTATS.DOC < prev    next >
Text File  |  1994-04-30  |  15KB  |  410 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                              SBBStats v2.0
  15.  
  16.  
  17.  
  18.                     The complete Statistics Management!
  19.  
  20.  
  21.  
  22.                          Use with Synchronet BBS
  23.  
  24.  
  25.  
  26.                             April 30th, 1994
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.         (C) Copyright 1994 Michel Pelletier, All rights reserved.
  56.  
  57.   SBBStats v2.0 - (C)Copyright 1994, Michel Pelletier. All rights reserved. 
  58.  
  59.  
  60. FIRST OF ALL
  61. ------------
  62.     I try to make this doc as good as possible, *but* i'am a french Canadian 
  63. and I can make some english mistake. If you find some errors or you have any
  64. suggestion and/or comment, just send me a message via DOVE-Net SysOp 
  65. Discussion.
  66.  
  67.  
  68.  
  69. WARRANTY/DISCLAIMER
  70. -------------------
  71.     Michel Pelletier, makes *NO* warranty, express or implied, with respect
  72. to disks, manuals, or any related item, their quality, performance, or fitness
  73. for any purpose.  It is the sole responsibility of the user and/or purchaser of
  74. this product to determine the suitability of the product for any purpose. In no
  75. event will Michel Pelletier be held liable for direct, indirect, consequential
  76. or incidental damages resulting from any defect or omission in the manual, 
  77. programs, or other related items and processes.
  78.  
  79.  
  80.  
  81. COPYRIGHT NOTICE
  82. ----------------
  83. Copyright 1994 Michel Pelletier. All rights reserved.
  84.  
  85.     The user and/or purchaser of this product is entitled to use this product
  86. for their personal use, on a single electronic Bulletin Board System (BBS) 
  87. basis.  A single BBS may consist of one or more computers, so long as all 
  88. computers are elements of the same BBS, existing at a single location.  The
  89. user and/or purchaser is not entitled to sell or transfer reproductions of the 
  90. software, manual or related items to other parties whether electronically or
  91. otherwise, nor to rent or lease this product without prior written permission of
  92. Michel Pelletier.  Any violation of this copyright is a violation of Federal law
  93. and may carry a fine of up to $50,000, or imprisonment, or both.
  94.  
  95.  
  96.  
  97. REGISTRATION
  98. ------------
  99.  
  100. Registration is only $25 us. or $35 cnd. (see the enclosed REGISTER.FRM).
  101. It entitles you to unlimited use of this program.  Registration also elimina-
  102. tes the 10 second delays and (UNREGISTERED) notices.  You are entitled to a
  103. thirty day trial period during which you can use this program on your system.
  104. After that, either pay for it or remove it.  Your support is vital to the pro-
  105. duction of high quality, low cost programs.
  106.  
  107. This program is exclusive property of Michel Pelletier, and I reserve the right
  108. to deny registration at any time for any reason.
  109.  
  110.   SBBStats v2.0 - (C)Copyright 1994, Michel Pelletier. All rights reserved. 
  111.  
  112.  
  113. DISTRIBUTION POLICY
  114. -------------------
  115.  
  116. You may not distribute this program for commercial purposes, include it
  117. with another package, or charge a fee for its distribution without written
  118. consent and license from the author.  Exception:  Companies which make a
  119. specific business of distributing shareware (like Public Brand Software or
  120. The Software Labs) may distribute this program as long as my archive is kept
  121. intact and the per disk distribution fee does not exceed $10.  BBS System
  122. Operators (SysOps) may distribute this program freely as long as the archive
  123. is kept intact.  Individual persons are encouraged to distribute this program
  124. freely, but may only accept payment to cover the cost of a disk and may not
  125. modify the archive.
  126.  
  127. *** What constitutes an intact archive? ***
  128.  
  129. The archive must contain the following 16 files:
  130.  
  131. SBBSTATS.EXE     - The main executable
  132. SSETUP.EXE       - The Configuration utility
  133. SUPDATE.EXE      - The Update utility
  134. SEDIT.EXE        - The Edit utility 
  135. VIEWASC.EXE      - ViewASC v1.0
  136. VIEWASC.DOC      - ViewASC Documentation
  137. SBBSTATS.CFG     - The program configuration file
  138. SBBSTATS.DOC     - This documentation
  139. SBBSTATS.HST     - The History of SBBStats
  140. SAMPLE.ASC       - A Bulletin's sample
  141. DEMO.BAT         - To Display the bulletin's sample
  142. README.1ST       - Important information
  143. REGISTER.FRM     - The registration form
  144. FILE_ID.DIZ      - Description of SBBStats v2.0
  145. DESC.SDI         - Description of SBBStats v2.0
  146. WAVERIDE.R       - Origin of SBBStats
  147. --------------
  148.  
  149. BBS SysOps may add an additional "comment file" or advertisement to the
  150. archive in the form of a file.  You may change the format from the original
  151. .ZIP as long as the filename remained STATS200.??? and you may add a comment
  152. or advertisement to the archive as provided for by the archiver software, as 
  153. long as the above files are intact.  You may not decompile or reverse-engineer 
  154. this program, nor may you distribute it in modified form.  Any such act imme-
  155. diately revokes the right of that user to use SBBStats on his/her system.
  156.  
  157.  
  158. CONTACT THE AUTHOR
  159. ------------------
  160. If you have any questions, leave e-mail for PiToNe #1 on WaveRider BBS 
  161. (418) 871-8079 (28.8 VFC), or e-mail for Michel Pelletier on Vertrauen. 
  162. You can also contact me on DOVE-Net or Fidonet. I'd like to hear any com-
  163. ments you may have.  
  164.     
  165.       WaveRider BBS (418) 871-8079 V.FC
  166.       FidoNet: 1:240/507 (via Bab-O-Manie)
  167.       DOVE-Net
  168.  
  169.   SBBStats v2.0 - (C)Copyright 1994, Michel Pelletier. All rights reserved. 
  170.  
  171.  
  172. DESCRIPTION
  173. -----------
  174.  
  175.     I have always liked TopTen bulletins that showoff your top users. I have 
  176. always seen them for other BBS software, but never for Synchronet BBS, there-
  177. fore, SBBStats was born. With this new release, it is the most complete stats
  178. management ever make for any bbs package! What it basically does it generate 
  179. over 50 differents TopTen files and over 50 differents messages to notify your
  180. top users! All this is full sysop configurable! The output files have Synchro-
  181. net Ctrl-A color code that are ready to display to your caller. All this with 
  182. CRC-32 dup checking function.
  183.  
  184. Each TopTen/ output can be: This Week      TopTen/ are: Uploaded bytes.
  185.      Message                Last Week      Message      Uploaded files.
  186.                             This Month                  Downloaded bytes.
  187.                             Last Month                  Downloaded files.
  188.                             All Times                   Messages posted.
  189.                                                         Messages read.
  190.                                                         E-Mails sended.
  191.                                                         Feedback sended.
  192.                                                         Times called.
  193.                                                         Time online.
  194.  
  195.  
  196.  
  197. *** Some features ***
  198.  
  199.  * Update utility to get you ready to run.
  200.  * Support full network/share operation.
  201.  * Each Bulletin are SysOp configurable.
  202.      - Output filename.
  203.      - Bulletin Title.
  204.      - Active or Inactive. 
  205.  * Each Notify message are SysOp configurable.
  206.      - Message to send.
  207.      - Active or Inactive. 
  208.  * CRC-32 Dup checking.
  209.      - Log files. 
  210.      - Notify Messages.
  211.      - Bulletins.
  212.      - Date.
  213.  * Output file have Synchronet Ctrl-A color code.
  214.  * Don't process deleted users in database.
  215.  * Support up to 20 exclude user from the statistics files. 
  216.  * Require Synchronet v1c and up. 
  217.  
  218.  
  219.   SBBStats v2.0 - (C)Copyright 1994, Michel Pelletier. All rights reserved. 
  220.  
  221.  
  222. HOW DOES IT WORK
  223. ----------------
  224.  
  225. SBBSTATS read your "yesterday log file" to keep track of everything. You must
  226. call SBBSTATS.EXE in your daily event (every single day after midnight) to
  227. keep your database in sync with your log file. When it run, it will update 
  228. the database file (SBBSTATS.DAB) with the log file and after that, it will 
  229. generate any bulletin and notify message that are active in the configuration
  230. file (SBBSTATS.CFG). It will generate CRC-32 code in order to not make any 
  231. output that as not changed since the last day. If for any raison, your data-
  232. base become out of sync, there is an update utility provided (SUPDATE.EXE) that
  233. will scan your log file in order to create a new database and it will read your 
  234. USER.DAT file to compile the AllTimes statistics. The only field that is not
  235. going to be correct is the AllTimes Message Reader. That because the user data-
  236. base (USER.DAT) doesn't keep any record about this field. All the Messages
  237. Reader values are taken from the log file so I can't scan your log since the
  238. begining of your bbs.
  239.  
  240.  
  241.  
  242. CONFIGURATION with SSETUP.EXE
  243. -----------------------------
  244.  
  245. To change and/or make SBBSTATS.CFG file use SSETUP.EXE. This file is
  246. self explaining but there is some things to remember. 
  247.  
  248.  - In all dialog box, there is five check box to activate the bulletin
  249.    or the notify message. These check box are labels; This Week, Last Week,
  250.    This Month, Last Month, All Times. If there is no X, that option will
  251.    not be generated when SBBSTATS.EXE run.
  252.  
  253.  - If you want to enter a CTRl-A in the title or message field, just enter
  254.    "@" (without the quote). After you closed the dialog box, every @ will
  255.    be convert back into a ctrl-a ascii code.
  256.  
  257.      Example:
  258.               @n@cTopTen @hDnLoader @n@cfor this month.
  259.        
  260.      will be convert to:
  261.         
  262.               ncTopTen hDnLoader ncfor this month.                 
  263.  
  264.  - In the Notify messages field, you must provided a %s somewhere
  265.    in the string. This %s will be convert back to the actual amont
  266.    for that user when the notify message will be send.
  267.   
  268.      Example: 
  269.               You're the top Uploader of last week with %s bytes. 
  270.   
  271.      will be convert to:   
  272.  
  273.               You're the top Uploader of last week with 3,123,302 bytes.
  274.  
  275.  
  276.   SBBStats v2.0 - (C)Copyright 1994, Michel Pelletier. All rights reserved. 
  277.  
  278.  
  279. SUPDATE UTILITY
  280. ---------------
  281.  
  282. When you first install SBBStats v2.0, you must create your new database.
  283. The SUPDATE.EXE utility will get you up to date with all the statistics from
  284. your log file and your USER.DAT database. It may take a long time to complete
  285. the operation. (5 minutes for 300 users on a 486DX33). In order to work cor-
  286. rectly, the USER.DAT database must remained open for reading for a long period
  287. so I highly suggest that you put your BBS DOWN before using this utility.
  288. This is only for the first time in order to become up to date. If for any 
  289. raison in the futur the SBBSTATS.DAB database become corrupted or your data
  290. become out of sync with your log file, you just have to re-run this utility
  291. again and everything will be fine. The only field that is not going to be
  292. correct is the AllTimes Message Reader. That because the user database
  293. (USER.DAT) doesn't keep any record about this field. All the Messages Reader
  294. values are taken from the log file so I can't scan your log since the begining
  295. of your bbs.
  296.  
  297. During the beta testing of SBBStats v2.0, in some beta site there was some
  298. bad value found in the user database (USER.DAT). If you found such value in
  299. your AllTimes statistics, you can correct thoses by editing SBBSTATS.DAB data-
  300. base with the SEDIT.EXE utility provided. You can search for that user alias
  301. in SBBSTATS.DAB and/or USER.DAT database in order to corrected the problem,
  302. if any!
  303.  
  304.  
  305. SEDIT UTILITY
  306. -------------
  307.  
  308. To change and/or look at SBBSTATS.DAB database file use SEDIT.EXE. This file
  309. is self explaining and you should never have to use it, but if you find some
  310. bad value in your database you may changed thoses one with this utility. If
  311. you have bad value in your AllTimes statistics after you've ran SUPDATE.EXE,
  312. you can correct thoses by editing SBBSTATS.DAB database. 
  313.  
  314. The 9 buttons from the dialog box are:
  315.  
  316.     Next:      Go to the next user in database.   
  317.     Previous:  Go to the previous user in database.
  318.     Top:       Go to the first user in database.
  319.     Last:      Go to the last user in database.
  320.     
  321.     Search:    Find User Alias in database.
  322.     Go To:     Go to User Number.
  323.     
  324.     Save:      Save changed field to disk. (current user only)
  325.     Discard:   Restore changed field to previous value. (current user only)
  326.     
  327.     Exit:      Close the dialog box.
  328.  
  329. IMPORTANT: You must clic on the save button in order to save the current 
  330.            user on disk. Any other buttons discard any change you've made.
  331.  
  332.   SBBStats v2.0 - (C)Copyright 1994, Michel Pelletier. All rights reserved. 
  333.  
  334.  
  335.  
  336. COMMAND LINE ARGUMENTS
  337. ----------------------
  338.  
  339. Syntax:  SBBSTATS [[-E#][...]] [/NOUPDATE] [/NOOUTPUT]
  340.  
  341.     -E#      Exlude user number # from process. (up to 20 -E switch max).
  342.              This switch only prevent this user from been include in any
  343.              of the output files. The user is still compile for his own
  344.              statistics. That way, the statistic database remain
  345.              in sync for every user you have.
  346.                      
  347.  /NOUPDATE   This option is need when you changed your setup file and need
  348.              to create new bulletins and/or messages and SBBSTATS has been
  349.              already run for this day. (SBBSTATS won't run more than once
  350.              a day. It check the log file with crc-32).
  351.  
  352.  /NOOUTPUT   This option override the setup file. SBBSTATS need to run every
  353.              single day to keep your database file in sync with your log file.
  354.              Use this option if you don't want output bulletins and/or messages.
  355.              
  356.  
  357.  
  358.      
  359. INSTALLATION:
  360. -------------
  361. You will need to create a directory off of your Synchronet XTRN
  362. directory, call the directory SBBSTATS (\SBBS\XTRN\SBBSTATS), and unzip the
  363. archive into this sub-directory.
  364.  
  365. Run SSETUP.EXE file to configure SBBSTATS.CFG (For more info about 
  366. SSETUP
  367. look at the configuration section).  
  368.  
  369. To get your database up, run SUPDATE.EXE. It may take a couple of minutes
  370. to complete. (5 minutes for 300 users on a 486DX33)
  371.  
  372. Next you can verify your TopTen bulletins, if there is some strange value,
  373. you can correct thoses with the SEDIT.EXE utility provided.
  374.  
  375. Now you're ready to go!  Basic things to remember to do - Edit your main
  376. event batch file to call the program and don't forget, you must be in the
  377. current directory when you call SBBSTATS.EXE!!! You must call 
  378. SBBSTATS.EXE
  379. every single day to keep your database in sync with your log file.
  380.  
  381. Add the new descriptions to your BULLETIN.ASC file or Text Section.
  382.  
  383.   SBBStats v2.0 - (C)Copyright 1994, Michel Pelletier. All rights reserved. 
  384.  
  385.  
  386. Example of 
  387. MAINEVEN.BAT
  388. --------------------------------[cut here]------------------------------------
  389. @echo off
  390.  
  391. rem ******************
  392. rem * SBBSTATS' part *
  393. rem ******************
  394.  
  395. CD \SBBS\XTRN\SBBSTATS                         
  396. SBBSTATS -e1 -e88 
  397. COPY ..\BULLETIN\BULLET30.ASC ..\..\TEXT\MENU\LOGON3.ASC
  398. CD %SBBSNODE%
  399. --------------------------------[cut here]------------------------------------
  400.  
  401. Well, that's about it.  Please refer to REGISTER.FRM for registration
  402. information.  If you have any questions, leave e-mail for PiToNe #1 on 
  403. WaveRider BBS (418) 871-8079 (2400+ bps), or e-mail for Michel Pelletier
  404. on Vertrauen.  You can also contact me on DOVE-Net or Fidonet.  
  405. I'd like to hear any comments you may have.  
  406.  
  407. Thanks!
  408.  
  409.  
  410.