home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / TLA31.ZIP / TLA.DOC < prev    next >
Encoding:
Text File  |  1992-10-03  |  19.0 KB  |  497 lines

  1.                                                 
  2.                                                 │  The Log Analyzer v3.1       │
  3.                                                 │  Documentation               │
  4.                                                 │                              │
  5.                                                 │  Written by:  Don MacElrath  │
  6.  
  7.  
  8.  
  9.  
  10. Legal BS
  11. ────────
  12.  
  13. This software package is released under the FREEWARE concept.  I don't believe
  14. in SHAREWARE (or TRY BEFORE YOU BUY).  This package is fully functional.
  15. It may not be offered as an incentive towards the purchase of another product.
  16. It may not be distributed by any organization that requires a fee. 
  17. This program can be distributed as long as it is made available to everyone
  18. FREE OF CHARGE.  
  19.  
  20. Although I have tested & use this program personally, I will not be held
  21. responsible for any damages that may occur by use of this program.  
  22. I will also not be responsible for any misleading information that this
  23. program may provide.  Use this program at your own risk.
  24.  
  25.  
  26.  
  27.  
  28. Why TLA?
  29. ──────────
  30.  
  31. The purpose of this program is simple, to keep tack of the amount of time you
  32. spend on a BBS in a 1 month period.  It should help to reduce the 
  33. "PHONE BILL SHOCK" syndrome.  Although most communication packages keep a log 
  34. of all the boards that you call, it doesn't add up the total time you spend on 
  35. each board - A very valuable piece of information.
  36.  
  37. Suppose you are registered with the phone company and their SELECTIVE CALLING
  38. PLAN (or SCOPE).  Wouldn't it be nice to know if you were approaching your 20
  39. hour limit?
  40.  
  41. Or suppose you wanted to make "JUST 1 MORE LONG DISTANCE PHONE CALL".  
  42. Thinking to yourself that you really haven't made that many long distance
  43. calls this month, you decide to go for it.  This process does have a way
  44. of repeating itself.  Well, now you will know just how much time you spent
  45. calling out.  NO MORE EXCUSES WHEN YOU GET YOUR MONTHLY PHONE BILL!  *grin*
  46.  
  47. * SPECIAL NOTE ON THE SELECTIVE CALLING PLAN.
  48.  
  49. The Selective Calling Plan is not available in all states.  What it allows you
  50. to do is add a group of TOLL exchanges to your LOCAL calling area.  There is a
  51. monthly fee for this service (couple dollars, not much at all).  It will
  52. let you call those exchanges FREE OF CHARGE (There is a 20 hour limit per 
  53. month).  Check with your local telephone company and see if it is available
  54. in your area.  I know it is available in Southern NJ.                       
  55.  
  56.  
  57.  
  58.        
  59. Requirements
  60. ────────────
  61.  
  62. 1) A computer (yes, you do need a computer to run this software).
  63.  
  64. 2) A supported communication software package (See SUPPORT.LST).
  65.  
  66.  
  67.  
  68.  
  69. Optional Equipment (For PEAK Performance)
  70. ─────────────────────────────────────────
  71.  
  72. 1) 5 Gigabillion Megabyte Hard Drive. 
  73.  
  74. 2) 1,423 Megs of RAM.
  75.  
  76. 3) ZZGA Video Support.
  77.  
  78. 4) 7 High Density Floppy Drives (required for the Install).
  79.  
  80. 5) Asprin and/or Beer.
  81.  
  82.  
  83.  
  84.  
  85. Miscellaneous Stuff - General
  86. ─────────────────────────────
  87.  
  88. When entering a date to calculate, you must provide a number that is 5
  89. characters in length.  1/92 is not acceptable, 01/92 is the proper format.
  90.  
  91. If you have a habit of changing the board names (or the phone numbers),
  92. they will appear as separate entries in the TLA output.
  93. For Example, lets say 1 entry in your dialing directory is JOE'S PLACE,
  94. but you realize that the actual bbs name is JOE'S BBS.  Naturally you change
  95. it.  The TLA output will show both names!  When you change the name in the
  96. dialing directory, the DIALING DIRECTORY gets updated, not the
  97. LOG file!  Remember that.  That's why the output shows the BBS name
  98. and Phone number - to clear up any doubts as to why there might be 2 entries
  99. for the same bbs.
  100.  
  101. It might be a good idea to make sure you have a few entries in your log
  102. file before running TLA.
  103.  
  104.  
  105.  
  106.  
  107. TLA Syntax
  108. ──────────
  109.  
  110.        TLA [/OPTION]
  111.                 
  112.             /SETUP - Run Configuration Program
  113.             /MONO  - Force Monochrome Display
  114.                      (Don't ask me why I included it, it just looks
  115.                      better now that I have 2 OPTIONS)
  116.                      
  117.        Only 1 option can be entered on the command line.
  118.        TLA /SETUP /MONO is invalid.  (Setup defaults to monochrome anyway)
  119.  
  120.  
  121.  
  122.  
  123. Getting Started
  124. ─────────────── 
  125.  
  126. 1)  Place each of the files in your communications directory.
  127.     NOTE:  you can use whatever directory you like, but the 2 files
  128.     TLA.EXE and TLA.CFG must be in the same directory.    
  129.  
  130.  
  131. 2)  Type:  TLA /SETUP  <ENTER>
  132.     Just answer the questions and you're all set.  Enjoy!
  133.     
  134.  
  135.  
  136.  
  137. Setup Help
  138. ──────────
  139.  
  140. Question :   Select the Communications Software that you use:
  141.              
  142.              1) Procomm Plus 2.01 or compatible
  143.              2) Qmodem 4.5/5.0 or compatible
  144.              3) Telix 3.15 or compatible
  145.  
  146. Answer   :   Just pick the number that corresponds to your communication
  147.              software.  EASY!
  148.              
  149.  
  150. Question :   Provide the complete NAME and PATH to your LOG file:
  151.  
  152.              Examples - C:\PCPLUS\PCPLUS.FON
  153.                         C:\QMODEM\QMODEM.LOG   
  154.                         C:\TELIX\TELIX.USE     
  155.  
  156. Answer   :   This is the path and name of the log that your software creates.
  157.              The examples above are probably where you will find those files,
  158.              providing that you used the defaults when installing your
  159.              communication software.  Check your communication software
  160.              to make sure that you have calling logging automatically start.
  161.  
  162. Question :   Select Output.
  163.              
  164.              1) Screen
  165.              2) DOS Text File.
  166.  
  167. Answer   :   You have a choice of sending the data created by TLA to the 
  168.              Screen, or to a DOS TEXT file.  Select 1 or 2.
  169.              
  170.              If you select an output to a text file, the next question
  171.              will prompt you for the name and location of the file you want
  172.              to create.
  173.  
  174. Question :   Name and location of output text file.
  175.                 
  176.              Example:  C:\TLA.LOG
  177.              
  178. Answer   :   This question is not displayed if you 
  179.              choose SCREEN as your output.
  180.              
  181.              This is just the name & location of the TEXT file to 
  182.              create / overwrite.  
  183.              
  184.              Should you choose to create a text file instead of 
  185.              sending the results to the screen, the text file will
  186.              be over 80 characters in length.  If you choose to print
  187.              this file, you may want to set your printer up in LANDSCAPE
  188.              mode (or 132 column mode).  See your printer manual for help.
  189.              See you DOS manual for help printing TEXT files from dos
  190.              (look under the TYPE command).
  191.  
  192.  
  193.  
  194.  
  195. Procomm Plus General Help
  196. ─────────────────────────
  197.  
  198. Although I have tried to make setting up this software as easy as possible,
  199. some users maybe a little confused.  Hopefully reading my vague remarks
  200. below will clear up any problems you might be having.
  201.  
  202. There is on option in Procomm plus to enable/disable call logging.  Go into
  203. Procomm Plus Setup, and under GENERAL OPTIONS you want the one that
  204. corresponds to the letter H.  Make sure it is ON.
  205.  
  206.  
  207.  
  208.  
  209. Sample PCPLUS.FON File
  210. ──────────────────────
  211.  
  212. NAME                                NUMBER    DATE    ONLINE  OFFLINE  ELAPSED
  213. Bogus Board                  ?-???-???-???? 09/24/92 19:39:09 19:42:13 00:03:04
  214. Just Another Board                 ???-???? 09/24/92 20:31:11                  
  215. Just Another Board                 ???-???? 09/24/92 21:08:02 21:09:47 00:01:45
  216. The Bar                            ???-???? 09/24/92 21:11:14 21:12:31 00:01:17
  217. John Doe's BBS                     ???-???? 09/24/92 22:45:18 22:45:43 00:00:25
  218. Computer BBS                       ???-???? 09/24/92 22:58:54 23:09:42 00:10:48
  219. Bogus Board                  ?-???-???-???? 09/24/92 23:21:31 23:24:57 00:03:26
  220. John Doe's BBS                     ???-???? 09/24/92 23:26:16 23:27:51 00:01:35
  221. John Doe's BBS                     ???-???? 09/24/92 23:28:17 23:43:08 00:14:51
  222. John Doe's BBS                     ???-???? 09/24/92 23:46:17 23:48:49 00:02:32
  223.  
  224. NOTE ENTRY #2.  This is an example of an invalid entry.  This could have been
  225. caused by the user rebooting while online, or perhaps there was a power
  226. failure.  Obviously, it isn't good to have this kind of entry.  Shit happens.
  227.  
  228. If your communication package outputs a file similar to the one above, then
  229. you should be able to use this package.  Just change the the name of the FON
  230. file to your file log name when you run setup.
  231.  
  232.  
  233.  
  234.  
  235. Invalid PCPLUS.FON Entries
  236. ──────────────────────────
  237.  
  238. There will be times while you are ONLINE and your computer locks up (or some 
  239. other odd thing happens like a power failure).  This will leave blanks in
  240. the PCPLUS.FON file in the ELAPSED & OFFLINE fields (see the example .FON file
  241. above).  Since there is no way to determine the actual time you spent on the
  242. board, those entries are skipped.  All of the invalid entries will be displayed
  243. to you at the end of the program.  That information could be important,
  244. especially if you have 10 invalid entries to 1 long distance board.  That's at
  245. least an additional 10 minutes of LONG DISTANCE calling!
  246.  
  247. If there are no invalid entries, that screen will be skipped.
  248.  
  249.  
  250.  
  251.  
  252. Qmodem General Help
  253. ───────────────────
  254.  
  255. Again, I have tried to make setting up TLA as easy as possible.  If you are
  256. confused, read on and hopefully things will become clear.  Or, try reading
  257. the Procomm Plus section.  There might be a similar situation there that
  258. was explained a little bit better.
  259.  
  260. Qmodem gives the user an option of having the QMODEM.LOG file automatically
  261. start whenever you run Qmodem.  YOU MUST SET THIS TO AUTOMATICALLY LOG ALL
  262. YOUR CALLS!!  Once you are in Qmodem, type ALT N/O/T.  Look for the
  263. autolog on/off question.  Make sure it is ON!  If it is off, and you have to     
  264. turn it on, make sure you save your changes when you exit Qmodem's setup.
  265.  
  266. The first time you turn the LOG file on and go to call a BBS, you will 
  267. be prompted for the LOG filename.  The default is QMODEM.LOG.  You can change
  268. this if you want, just make sure that the name you give the LOG file is the same     
  269. name that you enter in TLA SETUP.
  270.  
  271. If you are still having problems with the QMODEM.LOG file, read the manual that
  272. came with Qmodem.  It probably can help you more than I can.
  273.  
  274.  
  275.  
  276.  
  277. Sample QMODEM.LOG File
  278. ──────────────────────
  279.  
  280. 08:03:46  09-29-92  Connected With  : Joes Place   
  281. 08:03:46  09-29-92  ++ Phone Number : ???-????
  282. 08:03:46  09-29-92  ++ Comm Speed   : 2400-8-N-1
  283. 08:03:46  09-29-92  Online Timer Started
  284. 08:05:45  09-29-92  Elapsed Online 00:01:59
  285. 08:06:23  09-29-92  Connected With  : Bills Place
  286. 08:06:23  09-29-92  ++ Phone Number : ???-????
  287. 08:06:23  09-29-92  ++ Comm Speed   : 57600-8-N-1
  288. 08:06:23  09-29-92  Online Timer Started
  289. 08:08:55  09-29-92  Elapsed Online 00:02:32
  290. 08:09:14  09-29-92  Connected With  : Just Another BBS
  291. 08:09:14  09-29-92  ++ Phone Number : ???-????
  292. 08:09:14  09-29-92  ++ Comm Speed   : 57600-8-N-1
  293. 08:09:14  09-29-92  Online Timer Started
  294. 08:10:25  09-29-92  Elapsed Online 00:01:11
  295. 08:11:02  09-29-92  @SHELL 
  296. 08:11:36  09-29-92  ++ @SHELL Successful
  297. 08:14:17  09-29-92  ********** HOST STARTED **********
  298. 08:14:17  09-29-92  ++ HOST Header file created
  299. 08:14:17  09-29-92  ++ HOST Detail file created
  300. 08:14:37  09-29-92  ++ HOST CALLER > DON MACELRATH
  301. 08:14:37  09-29-92  Online Timer Started
  302. 08:14:47  09-29-92  ++ HOST HANGUP > DON MACELRATH
  303. 08:14:53  09-29-92  Elapsed Online 00:00:16
  304. 08:15:00  09-29-92  *********** HOST ENDED ***********
  305. 13:18:34  09-29-92  Connected With  : Really Bad BBS
  306. 13:18:34  09-29-92  ++ Phone Number : ?-???-???-????
  307. 13:18:34  09-29-92  ++ Comm Speed   : 57600-8-N-1
  308. 13:18:34  09-29-92  Online Timer Started
  309. 13:19:26  09-29-92  Hangup Command entered
  310. 13:19:29  09-29-92  Elapsed Online 00:00:55
  311. 07:24:37  09-30-92  Connected With  : ModemSex 
  312. 07:24:37  09-30-92  ++ Phone Number : 1-900-WAS-TE$$
  313. 07:24:37  09-30-92  ++ Comm Speed   : 57600-8-N-1
  314. 07:24:37  09-30-92  Online Timer Started
  315. 07:25:00  09-30-92  @SHELL 
  316. 07:25:07  09-30-92  ++ @SHELL Successful
  317. 07:26:38  09-30-92  Download Batch
  318. 07:26:38  09-30-92  ++ Protocol : Zmodem
  319. 07:26:39  09-30-92  ++ File C:\DOWN\TEST.ZIP
  320. 07:31:09  09-30-92  ++ Chars Per Second    : 1387
  321. 07:31:09  09-30-92  ++ Effective Percent   : 96.3 
  322. 07:31:16  09-30-92  @SHELL 
  323. 07:31:22  09-30-92  ++ @SHELL Successful
  324. 07:31:25  09-30-92  @SHELL 
  325. 07:31:30  09-30-92  ++ @SHELL Successful
  326. 07:31:45  09-30-92  Elapsed Online 00:07:08
  327.  
  328.  
  329.  
  330.  
  331. Invalid QMODEM.LOG Entries
  332. ──────────────────────────
  333.  
  334. I tried to find out what happens when there is a power failure while you
  335. are online with a BBS.  Apparently, Qmodem makes ALL log entries after
  336. you hangup.  I called a board and rebooted my machine while I was online
  337. (my apologies to the sysop...*grin*).  There was NO ENTRY for that call!
  338. Not even a start time.  Where Procomm plus at least provides a start time,
  339. but no ending time.  Oh well.  It looks like there can't be an invalid 
  340. log entry for Qmodem.  Watch out for that in case I'm wrong.
  341.  
  342. I did include some error checking for the QMODEM log file.  If TLA does
  343. find an error, please report it so I can fix it.
  344.  
  345.  
  346.  
  347.  
  348. Miscellaneous Stuff - Qmodem Specific
  349. ─────────────────────────────────────
  350.  
  351. The BBS name field will get truncated if it is over 24 characters.
  352.  
  353. The QMODEM.LOG file looks like it could grow rather quickly.  You may want
  354. to consider deleting it every 4th month or so to save on calculating time,
  355. and disk storage space.
  356.  
  357.  
  358.  
  359.  
  360. Telix General Help
  361. ──────────────────
  362.  
  363. Since this log is so similar to Qmodem's log, there isn't much difference
  364. between the Telix and Qmodem.
  365.  
  366. There is an option in the Telix setup to AUTOMATICALLY start the log
  367. everytime you start Telix.  Make sure this is ON.  After turning it on,
  368. you may have to exit Telix and reload it in order for the logging
  369. process starts.
  370.  
  371. BBS name field length shouldn't be a problem with Telix.
  372.  
  373. This file will also grow rather quickly.  You may want to delete every
  374. once in a while to save on calculating time and disk space.
  375.  
  376. I don't think you can have Invalid entries for Telix either.  Keep an eye
  377. out in case there is such a thing as an Invalid Entry for Telix.
  378.  
  379.  
  380.  
  381.  
  382. Sample TELIX.USE File
  383. ─────────────────────
  384.  
  385. 92-09-30  16:51:26  Telix Usage Log Created.
  386. 92-09-30  16:51:26  Telix Usage Log Opened.
  387. 92-09-30  16:51:29  Elapsed time online 00:00:00
  388. 92-09-30  16:52:13  Connected with : Jimmy Joe's BBS
  389. 92-09-30  16:52:13  ++ At phone #  : ???-????
  390. 92-09-30  16:52:13  ++ Settings    : 2400,N,8,1
  391. 92-09-30  16:53:33  Elapsed time online 00:01:18
  392. 92-09-30  16:54:42  Exiting Telix.
  393. 92-09-30  16:54:42  Telix Usage Log Closed.
  394. 92-09-30  20:18:36  Telix Usage Log Opened.
  395. 92-09-30  20:18:39  Elapsed time online 00:00:00
  396. 92-09-30  20:20:01  Exiting Telix.
  397. 92-09-30  20:20:01  Telix Usage Log Closed.
  398. 92-10-01  05:30:42  Telix Usage Log Opened.
  399. 92-10-01  05:30:46  Elapsed time online 00:00:00
  400. 92-10-01  05:32:54  Connected with : Lame BBS   
  401. 92-10-01  05:32:54  ++ At phone #  : ???-????
  402. 92-10-01  05:32:54  ++ Settings    : 57600,N,8,1
  403. 92-10-01  05:34:34  Download using YmodEm-g protocol.
  404. 92-10-01  05:34:35  ++ File : test.zip
  405. 92-10-01  05:38:25  ++ Chars per second : 1705
  406. 92-10-01  05:38:41  Elapsed time online 00:05:47
  407. 92-10-01  05:38:58  Exiting Telix.
  408. 92-10-01  05:38:58  Telix Usage Log Closed.
  409.  
  410.  
  411.  
  412.  
  413. TLA Output Explanation
  414. ────────────────────────
  415.  
  416. There isn't really much to explain.  It should be self explanatory.  The only
  417. thing that I would like to point out here is the 2 time columns.  One is labeled
  418. ELAPSED 1 and the other is labeled ELAPSED 2.
  419.         
  420.       ELAPSED 1:  This is the actual time that you spent on a BBS.
  421.                   This field contains hours, minutes and seconds.
  422.                   
  423.       ELAPSED 2:  Since the phone company charges by minutes and not
  424.                   seconds, the ELAPSED 1 field isn't very useful.
  425.                   If you called a board and spent 25 seconds on it,
  426.                   the phone company will charge you for a full minute!
  427.                   This field takes that into consideration and rounds    
  428.                   the results.  The time is displayed in hour:minutes.
  429.                   
  430. There can be a large difference between the 2 ELAPSED fields.
  431. It isn't uncommon for me to get results that vary by as much as an hour!
  432. All those seconds rounded up to the next minute really add up!         
  433.  
  434. I DON"T HAVE A CLUE AS TO HOW THE PHONE COMPANY GETS THEIR INFORMATION.
  435. No matter how much I try to keep track of my calls, the phone company
  436. seems to always have some unique figures on my phone bill.  At least this
  437. program should give you a ballpark idea on your phone calls.  Much better
  438. than actual guesswork (or figuring it out by hand!).
  439.  
  440.  
  441.  
  442.  
  443. USER RESPONSIBILITY
  444. ───────────────────
  445.  
  446. I use Procomm Plus.  It is up to you to let me know if there are any bugs
  447. or screw ups in the other parts of the program.  I have tried to cover all
  448. the bases, but not being a regular user, I may have overlooked something.
  449. If something goes wrong LET ME KNOW ABOUT IT!  See the information towards
  450. the end of this document on how to get in touch with me. 
  451.  
  452. NOTE:  I no longer use Procomm Plus.  There were just to many problems
  453.        with it at high speeds.  Help screens, etc. were just to poorly
  454.        written for me to figure out the problem.  I have switced to
  455.        Qmodem (using all the defaults) and have not had a problem yet!
  456.  
  457.  
  458.  
  459.  
  460. Final Words
  461. ───────────
  462.  
  463. I can be reached via ILINK in the appropriate conference.  Procomm Plus
  464. users should get in touch with me in the Procomm Plus conference, and 
  465. Qmodem users in the Qmodem conference...etc..,make sense?  *grin*
  466. Be careful not to upset the conference moderators with off the wall
  467. topics.  And try to be careful when spelling my name, I just might miss
  468. your message if it isn't spelled correctly.
  469.  
  470. I am looking to support as many different software packages as I can.
  471. If you know of someone that could benefit from this software but doesn't
  472. use any of the supported packages.  Drop me a note.  I would be happy to
  473. *try* and include that particular communication package in the next release.
  474.  
  475. If you are using a different version of a SUPPORTED software package,
  476. please let me know so I can add that version number to the SUPPORT.LST file.
  477.  
  478. As far as releases go, I will release a new version whenever there is a 
  479. need for one.  If I released a version yesterday, there could be a new
  480. version tomorrow.  It all depends.  Keep an eye out for the HISTORY.TXT
  481. file to see if you could benefit from upgrading to a newer version.
  482.  
  483.  
  484.  
  485.  
  486. Opps, I have to put this in:
  487. ────────────────────────────
  488.  
  489. Consider becoming a member of an Environmentally Aware Organization, such
  490. as Green Peace.  We all have to live on this planet and I would prefer
  491. to live in a clean environment.  Lets keep all the crap IN the politicians
  492. and OUT of the environment.  (What else could I say?  It's election year.)
  493.  
  494.  
  495.                               Happy Modeming!
  496.  
  497.