home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / steil95p.zip / steillog.doc < prev    next >
Text File  |  1996-07-08  |  20KB  |  557 lines
  1.                            Version 0.95
  2.            Steillog for MAX/2 BINK/2 XEN/2 CL/2 and SQUISH/2
  3.        This program was written in Pascal.  All Rights reserved.
  4.       The Copyright holds: Michael Weinert 2:2471/2410@FIDONET.ORG
  5.                (c) 1995,1996 by Michael Weinert
  6.  
  7.  
  8.  
  9. Contents
  10. --------
  11.  
  12. 1.0     General
  13.   1.1     Registration
  14.   1.2     Overview
  15.   1.3     Installation
  16. 2.0     Maximus part
  17.   2.1     Macro definitions
  18.   2.2     Outputs for Max
  19.   2.3     Including the Mailer stats in Max
  20. 3.0     Mailer part
  21. 4.0     Squish part
  22. 5.0     Cost Manager
  23. 6.0     Configuration
  24.   6.1     Command line parameters    
  25. 7.0     After all ......
  26.   7.1     Known Bugs and Features
  27. 8.0     Thanks to ......
  28. 9.0     Hints for contacting the author
  29.  
  30.  
  31.  
  32. 1.0 General
  33. ------------------------------------
  34.  
  35. What the hack a docu for a Logfileprogram ????
  36. Well, I've chosen to make the program very flexibel. You have different
  37. kind of settings, called Macros. You can define them in the STEILLOG.CFG.
  38. You now have the opportunity to give the output your own touch. 
  39. The way Steillog works for your part is quiet simple. It will read through
  40. the STEILLOG.CFG which is located in the same direcory or in the directory
  41. you defined with e.g. SET STEILLOG=E:\BBS\LOG\STEIL.
  42. If an error occurs STEILLOG ends with an errorlevel. If erverything's allright
  43. STEILLOG begins reading the logfiles. While reading it Steillog searches for 
  44. all kind of macros which are shown in the output afterwards.
  45. There's absolutly no sorting done at all, because the Log-Files are already 
  46. sorted for lines, date and time.
  47.  
  48. Well, now comes the tuff part. The Mailerpart was a hell of lotta work for
  49. me. STEILLOGs main work is to present the sysop's logfile in a nice and
  50. simple style. Who does really want to read those chaotic logfiles ? ;)
  51.  
  52. I don't guarantee functionality on other PC's with MAX/2 BINK/2 XEN/2 CL/2 or
  53. SQUISH/2. It could be possible that the program does not function right if
  54. the keyword Logging Mode in MAX.CTL is not TRACE !  And make sure your Log-
  55. Part in the *.MAD is still in the original version, or Steillog won't work
  56. at all !
  57.    I will guarantee, that my program will use disk space on your
  58. hard disk. In no circumstances I will be liable for any damage of your hard-
  59. or software which this program may cause.
  60.  
  61. BTW: No batteries included !
  62.  
  63. Maximus & Squish are registered trademarks of Lanius Corporation.
  64.  
  65.  
  66. 1.1 Registration
  67. ----------------
  68.  
  69. This peace of soft is shareware. Ya know what this means, right ?
  70. No ? Test this soft for 30 days:
  71. if soft=good then pay else kill....
  72. See the hints in REGISTER.DOC (this one is german right now, didn't find
  73. time to translate)
  74.  
  75. BTW: If you like that song too much you can have it for free. Just request HALL ;-)
  76.  
  77. Theres a little limit for the Max and the Mailerpart. The most actions you
  78. can log in ONE Session is 8000 for MAX and 5000 Connects for the Mailer. I think
  79. this is enough for you. If you really really need more, just write a little
  80. mail to me.
  81.  
  82.  
  83. 1.2 Overview
  84. -------------------------------
  85.  
  86.   a) Reads the MaximusLogFiles and writes an output with
  87.      the actions you can define with macros
  88.   b) Reads the MailerLogs /Cantaloup, BjnkleyTerm, Xenia) an
  89.      writes out all connects with time/date in/out.
  90.   c) Starts the CostMan, adds user in/outs and checks if the 
  91.      date matches with the one in the CFG. If this is true
  92.      STEILLOG writes an statistic about the costs. In this 
  93.      case ist end with the specific errorlevel 50 !
  94.   d) Reads the SQUISH.STT, creates an output. It will be
  95.      sorted by groups.
  96.   e) Writes the outputs in a SQUISH base if you want it to
  97.   f) Reads the USER.BBS of Max and writes a statistic.
  98.      Ready to include in Max !
  99.   g) Writes the ECHOTOSS.LOG for Squish.
  100.   h) If the parameter OVERVIEW  (-v) is set just an overview
  101.      is created. 
  102.  
  103.  
  104. 1.3 Installation
  105. -------------------------------
  106.  
  107. Steillog comes now with multiple language support. If you want to use the
  108. english Version, just rename the ENGLISH.DLL to STLANG.DLL and you're ready
  109. to go. Well almost, cause you have to adjust the STEILLOG.CFG to your needs
  110. and system.
  111.  
  112.  
  113. 2.0 Maximus part
  114. -------------------------------
  115.  
  116. The Max-part almost didn't change from the Ver. 0.6x on. Only a couple
  117. of bugfixes are included. If you use the american/english Version of
  118. the LanguageFile (Max) you should have no problem running Steillog.
  119. Still there 2 hardcoded Macros which you can enable. 
  120. First one is the Passwordcheck. If a user enters a wrong password you
  121. will see it in the output.
  122. Same with the Mailcheck, which is another hardcoded Macro.
  123. In the first column you will see the area in which to user entered a
  124. mail, and in the last column you will see to whom he wrote.
  125.  
  126.  
  127. 2.1 Macro definitions for Maximus
  128. --------------------------------
  129.  
  130. You can now setup your macros like this:
  131. Forget running through megs of logs. With Steillog you got an easy way finding
  132. out what happened on your BBS.
  133. Call your doors through a meccafile, and write the following in it:
  134.  
  135. [log]* word 
  136.  
  137. In Steillog.cfg it will be setup like this:
  138. ;
  139. Macro    word      did_whatever_!     Uhrzeit
  140.  
  141. ;                  ^  ^  ^   ^  beware max. 14 Chrs !!
  142. Steillog will check if you wrote the word right. Beware ! "WORD" is not
  143. the same as "word" !!!
  144.  
  145. "Macro" defines a Macro ;-). The second word defines for what to search for.
  146. The 3rd word (watch out for underscores) will be the output, e.g. what the user
  147. did. 
  148.  
  149. If you wish to have other predifened functions, feel free to contact me.
  150. I think that should be enough to get the program working. 
  151.  
  152. If you got all this done, you're a couple of seconds away from the first
  153. run.... Uhhhh here we go. Make sure that your LOGS are NOT in USE !!!! Or
  154. SteilLog can't read them. 
  155.  
  156.  
  157. 2.2 The Outputs of the MailerStats and the UserStats
  158. ----------------------------------------------------
  159.  
  160. There is a little feature of Steillog ;-) You can include the Mailer-
  161. Stats in MAX/2 with no recompile. You can even define how it should
  162. look like, with defining the colors.
  163. Another one is to enable the UserStats. Steillog will read the USER.BBS
  164. of MAX and writes a BBS-File (ready to include in MAX) with an Overview.
  165. Guess you almost don't need any more tools.
  166.  
  167. 2.3 Including the Mailer stats in Max
  168. -------------------------------------- 
  169.  
  170. At first the switch MaxMailStat has to be enabled. Adjust the path to
  171. the file. Every time you run Steillog, an new MaxMailStat will be created.
  172. For this reason, let Steillog only run once in the night (only in the 
  173. OverViewMode nothing will be written)
  174. Back to Max and the MailerStats. Here is a sample entry in MENUS.CTL :
  175.  
  176. Display_File    main2\maxstat         Demoted  "MailerStats"
  177.  
  178. You don't need to recompile with MECCA. The colors are defined in the
  179. STEILLOG.CFG. Also there is an ENTER after all is displayed.
  180.  
  181.  
  182. 3.0 Mailer part
  183. --------------------------------------
  184.  
  185. I spended the most time on the MailerPart. I had to take care of 3 different
  186. types of Mailers (Binkley, Cantaloup and Xenia). Every Mailer has each 
  187. features which I wanted to use. 
  188. You also have to switch the MailerPart on, if you want to use it. You can
  189. see everything in the output what happened. For example a call out will 
  190. have a * and a password error a ! in front of the AKA. You also have the
  191. choice to switch the call outs off. So you wont see who you called.
  192. There are a couple of more settings which are pretty tuff to explain. 
  193. Just go through the sample CFG below.
  194.  
  195. 4.0 Squish part
  196. --------------------------------------
  197.  
  198. This part was done pretty quick. I only added a couple of new features
  199. recently. Steillog reads the SQUISH.STT in and writes out the messages
  200. tossed in each area. You can define groups for the output. So your own
  201. nets have an own group. You also see a total of all tossed messages and
  202. a total of a group.
  203.  
  204. 5.0 Cost manager
  205. --------------------------------------
  206.  
  207. A lotta work had to be done to bring the Costman there where it's today.
  208. It was important for my BBS to make a costsharing depending on the downloads.
  209. With Costman I can say my Meg. costs 20 Cents, and Steillog will print out
  210. either a monthly or a weekly Costs. Where is the border ? You can define
  211. a Round by 500KB. That means everything >500KB will be a Meg.
  212.  
  213.  
  214. 6.0 Sample CFG of Steillog with Desc. 
  215. -------------------------------------
  216.  
  217.  
  218. I will not write any more descriptions in the sample, cause I'm sick and
  219. tired of gett'n questions about the same old stuff which is already written
  220. in the DOC. Yes I'm kinda lazy too ;-)
  221. Also you are enforced to read the Doc at least once.
  222.  
  223. Ok, let's have a look at a Sample-CFG-File: (I know theres a lotta German in
  224. there ;-) As usual comments start with a ; 
  225.  
  226. Gee, so many keywords are making me dizzy :)
  227.  
  228. ; ========================= CUT HERE =======================================
  229.  
  230. ; SysName = the name of your BBS... It doesn't matter how long this name is,
  231. ; as long as you put the underscores between them.
  232. ; Surely I putted a little bit of work in here too. If ya've seen one of
  233. ; my first CFG you can tell.
  234. ; **************************************************************************
  235. ; *         Steillog Sample configurations file for Version 0.95           *
  236. ; **************************************************************************
  237.  
  238. ; Your BBS-Name. I don't think you need any comments here. If yes,
  239. ; shut down your BBS ;-)
  240. SysName     Steils_Böxle
  241.  
  242. ; Now comes the tuff part, your name:
  243. SysOp Michael_Weinert
  244.  
  245. ; Your key if you pay you get one free.
  246. RegKey KeyKeyKeyKeyKeyKey
  247.  
  248. ; Where should Steillog write the Echotoss.log ?
  249. ECHOTOSS E:\BBS\SQUISH\ECHOTOSS.LOG
  250.  
  251. ; **************************************************************************
  252. ; *                       M A X I M U S P A R T                            *
  253. ; **************************************************************************
  254.  
  255. ; Enable the MAX-Part of SteilLog
  256. ; if this is commented out, then Steillog will ignore all MAX-specific
  257. ; keywords. 
  258. Enable MaximusLog
  259.  
  260. ; Enable or Disable Mailcheck or Passwordcheck
  261. ; in another words, these are hardcoded checks for Max, because they won't
  262. ; fit in the macros, and besides this way its faster.
  263.  
  264. ; This one will write out to whom the user wrote and in which area.
  265. Enable Mail
  266. ; This one will write out when the user entered a wrong password, and
  267. ; what the wrong psw was.
  268. Enable Password
  269.  
  270. ; The name & path of the outputfile ?
  271. ; DATUM means that Steillog will write the filename with the first date found
  272. ; in the LOG. For the mailer it's like 13SEP.BTL and for MAX it's 13SEP.MAX ok ?
  273. ; Just don't forget that SteilLog needs a blank between path and DATUM.
  274. MaxLogOut      F:\LOG\TEMP.LOG    ; Instead of TEMP.LOG you can user DATUM
  275.  
  276. ; Definition of the Max-Log-Files
  277. MaxLogFile   E:\BBS\MAX\task1.LOG        ; MAX Line 1
  278. MaxLogFile   E:\BBS\MAX\task2.LOG        ; MAX Line 2
  279. MaxLogFile   E:\BBS\MAX\task3.LOG        ; MAX Line 3
  280. MaxLogFile   E:\BBS\MAX\task4.LOG        ; MAX Line 4
  281. MaxLogFile   E:\BBS\MAX\task5.LOG        ; MAX Line 5
  282.  
  283. ;How many Macros ?
  284. Anzahl 5
  285.  
  286. ; Macros:  the underscores are very important
  287. ; Keyword: search for:          Output:        2. Predifined Macro:
  288. Macro      Given                Got                   Zeit
  289. Macro      dropped              Carrier_drop          Uhrzeit
  290. Macro      Sysop                called_SysOp          Uhrzeit
  291. Macro      DL-Z                 Download              Datei
  292. Macro      UL-Z                 Upload                Datei
  293.  
  294. ; Here comes a little dictionary:
  295. ; ZEIT    = Gets minutes online
  296. ; UHRZEIT = actual time 16:45
  297. ; DATEI   = FILE down/uploaded
  298. ; See hints in DOC above for more informations about Macros.
  299.  
  300. ; And finally: do you want that Steillog kills your LogFiles ?
  301. ; (YES after they are read ;-)))
  302. Enable MaxLogKill
  303.  
  304. ; If the next keyword and Maximuslog are enabled STEILLOG will write
  305. ; a notify in a SquishbaseEcho or Netmail...
  306. Enable MaxNotify
  307.  
  308. ; From whom ?      AKA
  309. MaxFrom Steillog 2:2471/2410
  310.  
  311. ; To whom               AKA
  312. MaxTo  Michael Weinert 2:2471/2410
  313.  
  314. ; What's this about ?
  315. MaxSubject MaxUserStats from Steillog
  316.  
  317. ; Watch out that this exists. Path and name of the Area WITHOUT .SQD !!!!!!!!
  318. ; Behind this write the tag of this area. This will be written to ECHOTOSS.LOG
  319. MaxArea G:\MSGBASE\FIDO\NETMAIL NETMAIL
  320.  
  321. ; **************************************************************************
  322. ; *                        M A I L E R P A R T                             *
  323. ; **************************************************************************
  324. ; Enable the BINK/XEN/CL-Part of SteilLog
  325. ; Surely means the same as the Maximuslog. But this is for your Mailer.
  326. Enable    MailerLog
  327.  
  328. ; MailerLogOut; same as MaxLogOut but for the mailer.
  329. MailerLogOut     E:\BBS\LOG\MAILER.LOG   ; same as MaxLogOut just for the mailer....
  330.  
  331. ; Which LogFiles of Mailer should be read ?
  332. MailerLogFile E:\BBS\BINK\LOG\BT01.LOG     ; Binkley Line 1
  333. MailerLogFile E:\BBS\BINK\LOG\XN02.LOG     ; Line 2 is the XENIA-Mailer
  334. MailerLogFile E:\BBS\BINK\LOG\CL03.LOG     ; Line 3 is the Cantaloup-Mailer
  335. MailerLogFile E:\BBS\BINK\LOG\BT04.LOG     ; Binkley Line 4
  336. MailerLogFile E:\BBS\BINK\LOG\BT05.LOG     ; Binkley Line 5
  337.  
  338. ; If this switch is ON the first row of the output will be the
  339. ; date. But therefore 'Net' will be missing. 
  340. Enable    MailerDatum
  341.  
  342. ; If your want an output for each MailerLine enable this keyword,
  343. ; and see what happens. Be sure if you don't use DATUM for the output,
  344. ; that the name of the output is like this: MAILER.OU 
  345. ;                                                   ^^ For Lines 1-9
  346. ; Steillog writes then MAILER.OU1 MAILER.OU2 and so on.
  347. Enable SingleOut
  348.  
  349. ; This one is for SingleOut. If you want both, an overview of ALL lines and
  350. ; each line, enable this keyword.
  351. Enable ViewAll
  352.  
  353. ; Well if ya don't like the nice sorting in Zones this ones for you.
  354. ; Date and Time Sorting
  355. Enable D&T-Sort
  356.  
  357. ; This one is a special one. Unlike my personal favour I don't like 
  358. ; this switch very much. Ok it will show the MailerLine in the connect.
  359. ; Sample speed was 14400 BPS and line 3 => 14403 Got the point ?
  360. Enable ShowLines
  361.  
  362. ; If this switch is ON your Callouts will be logged too.
  363. Enable CallOut
  364.  
  365. ; Want to see incoming FAXes ?
  366. Enable FAX
  367.  
  368. ; The same as above....
  369. Enable MailerNotify
  370. MailerFrom Steillog 2:2471/2410
  371. MailerTo Alle 2:2471/2410
  372. MailerSubject MailerStatistiken von Steillog
  373. ; Behind this write the tag of this area. This will be written to ECHOTOSS.LOG
  374. MailerArea G:\MSGBASE\STEIL\TEST NEWS.STATISTICS
  375.  
  376.  
  377. ; And the same now for the MailerLogs.
  378. Enable MailerLogKill
  379.  
  380.  
  381. ; **************************************************************************
  382. ; *                      C O S T M A N A G E R                             *
  383. ; **************************************************************************
  384. ; Switch that Costman on, so I get some money.
  385. Enable CostMan
  386.  
  387. ; Hihihi, >500KB means 1MB
  388. Enable Round
  389.  
  390. ; Here comes the day of month or day of week, when the output should
  391. ; be started
  392. ; CostOutput 1      ; First day of each month
  393. CostOutput Sunday   ; Every Sunday
  394.  
  395. ; Only nodes which caused cost will be logged.
  396. CostOnly
  397.  
  398. ; Need hints ?
  399. CostLogOut F:\BBS\LOGS\COSTMAN.TXT
  400.  
  401. ; Costs in Cents per Meg
  402. Price 15
  403.  
  404.  
  405. ; Again a notify. 
  406. Enable CostNotify
  407. CostFrom Steillog CostMan 2:2471/2410
  408. CostTo Michael Weinert 2:2471/2410
  409. CostSubject Weekly CostStats from Steillog
  410. CostArea G:\MSGBASE\FIDO\NETMAIL NEWS.COSTS
  411. ;  DO not forget the Echotoss    ^^^^^^^^^^ Tag !
  412.  
  413.  
  414. ; **************************************************************************
  415. ; *                       S Q U I S H P A R T                              *
  416. ; **************************************************************************
  417. ; This keyword forces Steillog to read the SQUISH.STT-File.
  418. Enable SQUISH
  419.  
  420. ; But it needs to know where it is, and how it's called.
  421. STTIN  E:\BBS\LOG\SQUISH.STT
  422.  
  423. ; Output in ...
  424. STTOUT F:\VP\STEIL\REP\SQUISH.STS
  425.  
  426.  
  427. ; Groupdefinitions:
  428. ; You can define up to 20 groups with 10 includes and 10 excludes.
  429. ; An include * shows all echos, but still have excludes...
  430. EchoGroup Fidonet Germany
  431. Include *.GER
  432. Include *.2471
  433. Include *.STGT
  434. Include BW.*
  435. Exclude OS2NET.*
  436. EndGroup
  437.  
  438. ; Steillog searches for matches at the start and the end of the echoname.
  439. ; If ya got an netmailarea called OS2NET remove the point.
  440. EchoGroup OS/2-Netz Germany
  441. Include OS2NET.*
  442. EndGroup
  443.  
  444. ; and so on ...
  445.  
  446.  
  447. ; I guess ya already know what this is, right ?
  448. Enable SquishNotify
  449. SquishFrom Steillog 2:2471/2410
  450. SquishTo All 2:2471/2410
  451. SquishSubject EchoStats for Steils Böxle Stuttgart
  452. SquishArea G:\MSGBASE\STEIL\TEST ECHO.STATISTICS
  453. ;  DO not forget the Echotoss    ^^^^^^^^^^ Tag !
  454.  
  455.  
  456. ; **************************************************************************
  457. ; *                 S T A T S   F O R  M A X I M U S                       *
  458. ; **************************************************************************
  459.  
  460. ; A little MailerStat for MAX/2
  461. Enable MaxMailStat
  462.  
  463. MaxStatFile F:\VP\STEIL\REP\MAXSTAT.BBS
  464.  
  465. ; Colordefinition (see MAX-DOC)
  466. COLOR FRAME YELLOW
  467. COLOR TEXT WHITE
  468. COLOR DATE LGREEN
  469. COLOR TIME LRED
  470. COLOR SPEED RED
  471. COLOR NET WHITE
  472. COLOR SYSOP GREEN
  473. COLOR BYTEIN CYAN
  474. COLOR BYTEOUT CYAN
  475.  
  476. ; Switch on the UserStats. You get an overview of your Users.
  477. Enable MaxUserStats
  478.  
  479. ; Where is that USER.BBS from MAX, and how it's called.
  480. MaxUsers E:\BBS\MAX\USER\USER.BBS
  481.  
  482. ; This is finally the output, and the last keyword ;-)            
  483. MaxUserOut E:\BBS\MAX\STATS\USTAT.BBS
  484.  
  485.  
  486. ; ========================= CUT HERE =======================================
  487.  
  488. 6.1 Commandline switches
  489. ------------------------
  490. ┌────────────────────────────────────────────────────────────────────────────┐
  491. │    SteilLog/2 0.95 LogFileAnalyzer for CL/2 MAX/2 BINK/2 XEN/2 SQUISH/2    │
  492. │                      (c) 1995,1996 by Michael Weinert.                     │
  493. └────────────────────────────────────────────────────────────────────────────┘
  494.  
  495.  Available Switches:
  496.  
  497.  -H      = this Help
  498.  -M      = do not write mails !
  499.  -V      = Output on screen (OverViewmode)
  500.  
  501. 7.0 After all....
  502. ------------------
  503.  
  504. After all a couple of words from me even no one will read it. Steillog at
  505. first was programmed in REXX. This is about a year ago. Many hard and tuff
  506. times of debugging code had to be done to let you see this Steillog !
  507. Many many features had to be implemented. A couple of guys always told me,
  508. hey Mike how about an overview what happened till now ? 
  509. And just what 'bout them DOS-Users ? Sorry guys, in my head DOS is dead.
  510. I'm tired of playing 'round with 64K pointers. I need more for Steillog.
  511. It ain't simple, but I gave up. If you got the final idea, you can write
  512. me a hint....
  513.  
  514. 7.1 Known Bugs / Features
  515. ----------------------------
  516.  
  517. Right now I only know 2 of em. 1) If you start in OverViewmode and Steillog
  518. can't find a MailerLogfile, it will stop with a runtime-error. The other
  519. one is the output of errors in the Overview. I'm still working on it, but
  520. it will probably fixed with the next version. This btw: will get the 
  521. OverView-Mode on PM ! 
  522.  
  523. 8.0 Thanx to...
  524. ----------------
  525.  
  526. Well guess that's it, but still I want to thank my first Betatester (uuhhh,
  527. she's female ;-) Claudi. Thanx a lot for annouying ya in the middle of the
  528. night.
  529.  
  530. 2 special thanx to Peter Meerwald and Thomas Waldmann.
  531.  
  532. More thanks to :
  533.                  Jörg Berg
  534.                  Oliver Kopp
  535.                  Ronald Hagenbusch
  536.  
  537. And now have fun with Steillog/2
  538.  
  539. 9.0 How to contact the author:
  540. ------------------------------
  541. Bugs ? Use the file BUGREP.TXT !
  542. Hints, Comments ? I will appreciate it ;-)
  543.  
  544. If you wish to be informed 'bout new Bugfixes, News and new Features,
  545. just write me a mail, so I can throw ya in my bombing run list.
  546.  
  547. Michael Weinert FIDO:    2:2471/2410
  548.                 OS/2NET: 81:449/7100
  549.                 TWI-NET: 180:180/0 
  550. Snailmailadress:
  551.  
  552.                  Michael Weinert
  553.                 Schlierseestr. 62
  554.                  70378 Stuttgart
  555.                   FR of Germany
  556.  
  557. <eod>