home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / bbs / lastcl14.zip / LASTCALL.DOC < prev    next >
Text File  |  1993-04-15  |  12KB  |  263 lines
  1. ---------------------------------------------------------------------------        
  2.       LastCallers v1.4  Copyright (c) 1993 by Bryan J. Nylin
  3.                         Written and compiled in QuickBASIC v4.5
  4. ---------------------------------------------------------------------------
  5.  
  6. LastCallers v1.4 is a utility designed for TriBBS sysops to create a 
  7. bulletin showing the latest users to call the BBS.  It is compatible 
  8. with TriBBS v3.3 and v4.0 (tested on beta #2 so far).  
  9.  
  10. This software is SHAREWARE.  You are granted permission to distribute
  11. the LASTCL14 archive freely, provided all the original files are kept 
  12. together, and only a nominal fee is charged.  The files in this archive 
  13. should be:
  14.  
  15.         LASTCALL.DOC      This documentation file.
  16.         LASTCALL.REG      Registration/order form
  17.         LASTCALL.EXE      Executable program.
  18.         LASTCALL.CFG      Configuration file
  19.         FILE_ID.DIZ       Program description for BBS posting.
  20.  
  21. The result of McAffee's VALIDATE program on LASTCALL.EXE is as follows:          
  22.  
  23.                   File Name:  LASTCALL.EXE
  24.                        Size:  69,626
  25.                        Date:  4-15-1993
  26.         File Authentication:
  27.              Check Method 1 - 7D11
  28.              Check Method 2 - 1BFC
  29.  
  30. If any of these numbers do not match, you have an invalid archive that
  31. might be infected with a virus.  Delete the archive and contact the
  32. person or BBS you received it from.
  33.  
  34. This SHAREWARE program is distributed with the concept that if you find
  35. it useful and continue to use it beyond a 30-day free trial period, you
  36. must send in the $10 registration fee (discounts available when registering
  37. multiple copies and/or additional utilities at the same time).
  38.  
  39. To help you evaluate the program, no features have been left out of this 
  40. shareware release.  See the file LASTCALL.REG for the order form.
  41.  
  42.  
  43. INSTALLATION INSTRUCTIONS:
  44. -------------------------------------------------------------------------
  45. Step 1.         Extract the files from the distribution archive into 
  46.                 your BBS utilities directory. (I use \BBS\UTIL)
  47.  
  48. Step 2.         Make your utilities directory the default (CD \BBS\UTIL)
  49.  
  50. Step 3.         Edit LASTCALL.CFG to match your system configuration.
  51.                 Each line is documented in a section below.
  52.  
  53. Step 4.         Run LASTCALL with the /R parameter to reset the datafile.
  54.                 This will create LASTCALL.DAT in your utilities directory.
  55.                                                                           
  56. Step 5.         Edit your TriBBS BETWEEN.BAT file to include LASTCALL.
  57.                 Example:
  58.                 ---------->File starts Here<-------------
  59.                 cd\bbs\util
  60.                 LASTCALL /L /E=999
  61.                 cd\bbs\tribbs
  62.                 ---------->File ends Here<-----------------
  63.  
  64. Step 6.         You are done!  The next time a caller logs off and 
  65.                 BETWEEN.BAT is executed, the bulletin is updated.
  66.                 
  67.  
  68. CONFIGURATION FILE
  69. -------------------------------------------------------------------------
  70. The sample file LASTCALL.CFG included in this archive looks like this:
  71.  
  72. ---------->File starts Here<-------------
  73. bbs=Jet City Connection
  74. log=J:\BBS\TRIBBS\MWORK\CALLERS.LOG
  75. dir=J:\BBS\TRIBBS
  76. max=15
  77. ansi=J:\BBS\tribbs\display\BULLET5.ANS
  78. ascii=J:\BBS\tribbs\display\BULLET5.BBS
  79. ---------->File ends Here<-----------------
  80.  
  81. Each line starts with a TAG and an equal sign.  These must be typed
  82. correctly in order for the LASTCALL program to recognize them.  It is
  83. not case sensitive, however.  Each tag is explained as follows:
  84.  
  85.         bbs=    Name of the BBS you want to appear at top of bulletin.
  86.  
  87.         log=    File name of caller log to read.  LASTCALL looks only at
  88.                 the last caller in the log file.
  89.  
  90.         dir=    Main TriBBS directory (Node 1).
  91.  
  92.         max=    Maximum number of lines to print in the bulletin.  A
  93.                 '15' here would indicate to only print the last 15
  94.                 callers.
  95.                 
  96.         ansi=   File name and path of the ANSI bulletin to create.
  97.  
  98.         ascii=  File name and path of the ASCII bulletin to create.
  99.  
  100.  
  101. COMMAND LINE PARAMETERS:
  102. --------------------------------------------------------------------------
  103. Usage:  LASTCALL [/F] [/R] [/L] [/E=nnn] [/X] [/?] [/HELP]
  104. Where:  /F      Forces bulletin output even if last caller was not new.
  105.         /R      Resets datafile
  106.         /L      Includes local logons
  107.         /E=nnn  Excludes callers at or above security level nnn.
  108.         /X      Excluded calls are deducted from the BBS call totals.
  109.  
  110. Explanation:
  111.  
  112.         /F      Normally, the program only generates the bulletin when
  113.                 the last caller was a new user.  This switch will force
  114.                 the output regardless of that fact.
  115.  
  116.         /R      This switch will cause LASTCALL.DAT to be cleared out
  117.                 before looking at the log file.
  118.  
  119.         /L      Includes local logons.  By default local logons are
  120.                 ignored and not recorded.
  121.  
  122.         /E=nnn  Excludes any caller with a security level at or above 
  123.                 'nnn'.  Useful to exclude sysop from list when calling
  124.                 from remote line.
  125.  
  126.         /X      Any excluded calls (from /E= or /L switches) are deducted
  127.                 from the BBS call totals.  If you specify the /X switch
  128.                 and a local logon or other call is excluded, LASTCALL 
  129.                 will deduct 1 from today's call count, and the total count.
  130.                 There is double checking to make sure it only happens once!
  131.  
  132.  
  133. EXAMPLE:        LASTCALL /L /E=999
  134.                 
  135.                 Includes local logons, but excludes any users at level 999
  136.                 (or above).  Handy if there are users other than the sysop
  137.                 that log on locally that should be on the list.  Also
  138.                 keeps a sysop from being recorded when calling by modem.
  139.  
  140.  
  141. LASTCALL.DAT Layout
  142. --------------------------------------------------------------------------
  143. This is a straight forward ASCII file.  It was programmed this way for
  144. easy access by the sysop in case it is necessary to edit out a name from
  145. the last caller list.  Generally speaking, you can delete records from this
  146. file without causing any problems, any empty space will be taken up the
  147. next time LASTCALL runs.  You must BE CAREFUL TO DELETE WHOLE RECORDS.
  148. One record consists of:
  149.  
  150.         Line 1          John Doe        User Name
  151.         Line 2          01/08/92        Date of first call
  152.         Line 3          2400            Baud rate
  153.         Line 4          Nowhere, WA     City, State
  154.         Line 5          21:01           Time On
  155.         Line 6          21:30           Time Off
  156.         Line 7          -               Dropped Carrier ('-'=d/c, ' '=no)
  157.         Line 8          1               Node #
  158.  
  159. Empty records are stored as "Empty, 00/00/00, 0, etc." and are easily 
  160. identifiable. If you add or delete from this file, make sure you work 
  161. with a GROUP OF 8 LINES ONLY.  If you don't, odd results will happen and 
  162. you will probably have to run LASTCALL /R to reset the datafile.
  163.  
  164. Notice the '-' dropped carrier flag.  This is a little obscure, but this
  165. character prints directly after the baud rate when the caller dropped
  166. carrier.  Since this is not something users generally concern themselves
  167. with, and the amount of data was already pretty jammed, this seemed
  168. sufficient.  A sysop can look at the list and see who dropped carrier
  169. very easily (a '2400-' is one that dropped carrier, '2400' was fine).
  170. If you happen to edit Line 7, it should either have a '-' or a space.
  171. If the line is empty or has several blanks the report format will be off.
  172.  
  173.  
  174. DESCRIPTION OF OPERATION
  175. --------------------------------------------------------------------------
  176. LASTCALL will open the LASTCALL.DAT file and add all the information 
  177. into the DAT file for the last caller.  It also opens the USERS.DAT file 
  178. in the Node 1 MWORK directory to get the City, State where the caller 
  179. is from and their call number.  If the number of records in LASTCALL.DAT 
  180. exceeds that specified by the "max=" tag in LASTCALL.CFG, the oldest 
  181. record will be scrolled off the list.   
  182.  
  183. If the /X switch is specified, LASTCALL will open and write to the 
  184. SYSDAT1.DAT file in the main TriBBS directory (to update the call numbers).
  185.  
  186.  
  187. VERSION HISTORY
  188. --------------------------------------------------------------------------
  189. v1.4    Released 4-15-93.
  190.       - Added /X switch so that certain calls can be excluded from the
  191.         BBS call counter (today's calls, total calls).
  192.       - Fixed bug related to DOS PATH searching.
  193.  
  194. v1.3    Released 3-29-93.
  195.       - Recognizes users who log on with their alias name.
  196.       - Fixed bug where new file reset (/R) didn't create LASTCALL.DAT.
  197.       - Fixed bug that didn't report the logon/logoff time correctly 
  198.         when the user name had a '.' in it.
  199.  
  200. v1.2    Released 2-15-93.
  201.       - Fixed bug caused by long logons where program did not find
  202.         the last caller log entry correctly.  This often resulted in
  203.         error messages, and/or stray letters in the date/time fields.
  204.       - Added support for finding .CFG, .KEY, and .DAT files on PATH.
  205.       - Enhanced file sharing for multi-node systems.  Requires DOS 3.0
  206.         or higher, and SHARE.EXE loaded.
  207.       - Tested on TriBBS v4.0 beta #2.
  208.  
  209. v1.1    Released 1-27-93.
  210.       - Improved rejection of bad logons recorded in CALLERS.LOG.  It
  211.         was recording some "...line noise..." users, one word logon
  212.         rejections, and so on.  It now detects these, does not update
  213.         the bulletin, and dumps a record in LASTCALL.ERR for posterity.
  214.       - Made a minor change to output columns, take 1 char away from
  215.         the caller name and giving it to the calling from column.
  216.       - Added registration code validation.
  217.  
  218. v1.0    Initial release date 1-11-93.
  219.  
  220.  
  221. DISCLAIMER
  222. --------------------------------------------------------------------------
  223. This software and accompanying materials are distributed "AS IS" and 
  224. without warranty, expressed or implied.  No implied warranty exists
  225. for merchantability and/or fitness for any particular purpose.  Under 
  226. no circumstances shall anyone involved in the creation, production, or
  227. sale of this product be liable for direct, indirect, consequential, or
  228. special damages arising out of any use of this product.
  229.  
  230. Use of this software beyond the initial 30 day evaluation period is
  231. strictly prohibited.
  232.  
  233. Once this software is registered, any unauthorized distribution of your 
  234. personalized registration code and/or the registration .KEY file will 
  235. invalidate your registration key for all releases of this product, and
  236. no product support will be given.
  237.  
  238.  
  239. TECHNICAL SUPPORT
  240. --------------------------------------------------------------------------
  241.         
  242.         Support questions can be left, and latest version downloaded
  243.         from the author's BBS near Seattle, WA:
  244.  
  245.         Jet City Connection BBS, (206)839-8843, v.32bis, Fido 1:343/140
  246.  
  247.         Messages can also be addressed to Bryan Nylin at:
  248.                 
  249.                 FidoNet 1:343/140
  250.                 CompuServe 71441,1420
  251.                 
  252. ---------------------------------------------------------------------------
  253.  
  254. This SHAREWARE program is distributed with the concept that if you find
  255. it useful and continue to use it beyond a 30-day free trial period, you
  256. must send in the $10 registration fee (discounts available when registering
  257. multiple copies and/or additional utilities at the same time).
  258.  
  259. To help you evaluate the program, no features have been left out of this 
  260. shareware release.  See the file LASTCALL.REG for the order form.
  261.  
  262. ---------------------------------------------------------------------------        
  263.