home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 September / Simtel20_Sept92.cdr / msdos / telix / tlxlog31.arc / LOGGIT.DOC next >
Text File  |  1989-04-12  |  20KB  |  536 lines
  1.         LOGGIT -- TELIX USE FILE ANALYZER
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                         LOGGIT -- TELIX USE FILE ANALYZER
  10.                               (C) 1988 by Vic Baron
  11.                            Version 3.1 -- Apr 12, 1989
  12.         ____________________________________________________________
  13.  
  14.  
  15.  
  16.                                 TABLE OF CONTENTS
  17.  
  18.  
  19.         Overview...................................................1
  20.  
  21.         Command Line Options.......................................1
  22.  
  23.         Pathnames..................................................1
  24.  
  25.         Conventions................................................1
  26.  
  27.         Starting LOGGIT............................................2
  28.  
  29.         Selecting Date Range.......................................2
  30.  
  31.         Scan Criteria..............................................2
  32.  
  33.         Up/Download analysis.......................................3
  34.  
  35.         Output Modes...............................................3
  36.  
  37.         Batch Files................................................4
  38.  
  39.         Cautions...................................................4
  40.  
  41.         Shareware Concept..........................................5
  42.  
  43.         Appendix A.................................................6
  44.  
  45.         Appendix B.................................................7
  46.  
  47.         Appendix C.................................................8
  48.         LOGGIT -- TELIX USE FILE ANALYZER
  49.  
  50.  
  51.  
  52.  
  53.                                      LOGGIT
  54.  
  55.                              Telix Use Log Analyzer
  56.  
  57.  
  58.         OVERVIEW
  59.  
  60.         LOGGIT is a screen oriented, menu driven program that is designed
  61.         to provide an analysis of the Telix logfile. It will provide  the
  62.         user with several different analysis options and output.
  63.  
  64.  
  65.         COMMAND LINE OPTIONS
  66.  
  67.         The  only  command line option that LOGGIT supports is  /t  which
  68.         will disable the default file integrity check. It will,  however,
  69.         accept  input  from  a program such as Key-Fake.  Key-fake  or  a
  70.         similar  program may be used in a batch file to pass commands  to
  71.         LOGGIT thereby creating an automated analysis procedure.
  72.  
  73.         PATHNAMES
  74.  
  75.         LOGGIT  supports the standard DOS conventions for  pathnames  for
  76.         all  files  and may be run from any directory as long  as  it  is
  77.         included  in  your PATH. If a pathname is not specified  for  the
  78.         input and output files, the default is the current directory.
  79.  
  80.         CONVENTIONS
  81.  
  82.         When asking for input, as in a filename, LOGGIT will display  the
  83.         default value in  angle brackets <>. Thus, hitting return without
  84.         any input will use the data contained within the brackets.
  85.  
  86.         On  the occasions that a yes or no input is required LOGGIT  will
  87.         display  (y/N)  or (Y/n) indicating the default  value  in  upper
  88.         case.
  89.  
  90.         In  using the menus, the default value is the selection  that  is
  91.         highlighted  when  the menu is first presented.  Pressing  return
  92.         will  select  the  highlighted function.  The  selection  may  be
  93.         changed in two ways, either by using the cursor keys to highlight
  94.         another  selection  or  by entering the first  character  of  the
  95.         selection.
  96.  
  97.         Ctl-C  or  Ctl-Break will exit from any part of  LOGGIT  but  may
  98.         leave  incomplete files on the disk if the file output  mode  was
  99.         selected.
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.                                         1
  109.         LOGGIT -- TELIX USE FILE ANALYZER
  110.  
  111.  
  112.  
  113.  
  114.         STARTING LOGGIT
  115.  
  116.         Running LOGGIT is as simple as entering LOGGIT  at the DOS prompt
  117.         and  pressing <return>. You will then be presented with a  series
  118.         of menus which will define the input file and the scan  criteria.
  119.         At  the top center of the screen will be a message  window  which
  120.         will  prompt  you for the correct response. The menus  and  their
  121.         options  should  be  self explanatory  but  a  brief  description
  122.         follows:
  123.  
  124.         Enter Input filename <TELIX.USE>
  125.  
  126.         Hitting  <return>  at  this prompt will default  to  the  current
  127.         directory  and  the  TELIX.USE file.  For  any  other  selection,
  128.         maintained  in  the  format  of the  TELIX.USE  file,  enter  the
  129.         complete  pathname  of  the input file. Your  selection  will  be
  130.         displayed in the Input Window in the upper left of the screen.
  131.  
  132.         SELECTING DATE RANGE
  133.  
  134.         Next  is  displayed the menu which allows the  selection  of  the
  135.         range of dates upon which LOGGIT will operate.
  136.  
  137.         Alldates <default>-- compile data from the first date entered  in
  138.         the file to the last entry.
  139.  
  140.         Select dates -- allows the  selection of START and END dates as a
  141.         range  for compiling the data. LOGGIT will start  compiling  data
  142.         from the start date specified and will continue compiling data UP
  143.         TO but not including the END date. Dates are entered in the  form
  144.         MM-DD-YY.  To scan from a specified start date to the end of  the
  145.         file, you could enter any date that is beyond the end of the data
  146.         in the file. LOGGIT will continue to compile data until it reach-
  147.         es the end date or the end of the file.
  148.  
  149.         SCAN CRITERIA
  150.  
  151.         The  next  menu  presented tells LOGGIT whether  to  scan  for  a
  152.         specific BBS or to compile data on all calls made.
  153.  
  154.         Allcalls <default> -- compile data on all calls made. LOGGIT will
  155.         tally   all  calls,  keeping  track  of  time   online,   average
  156.         time/call,total calls to each number, total of uploads, downloads
  157.         and aborts. The output will be sorted by name and the  individual
  158.         results will be displayed as in appendix A.
  159.  
  160.         Individual  --  compile data on the specified  BBS.  LOGGIT  will
  161.         tally  all  calls  to  the specific BBS  keeping  track  of  time
  162.         online,total  calls,  average time/call, uploads,  downloads  and
  163.         aborts.
  164.  
  165.  
  166.  
  167.  
  168.  
  169.                                         2
  170.         LOGGIT -- TELIX USE FILE ANALYZER
  171.  
  172.  
  173.         UP/DOWNLOAD ANALYSIS
  174.  
  175.         If  the Individual mode has been selected, a submenu  of  choices
  176.         will appear allowing you to further define the analysis.
  177.  
  178.         Detailed  <default>  -- Compile the individual  up  and  download
  179.         activity  for  the  selected BBS,  showing  the  date,  protocol,
  180.         filename  and  transfer speed in CPS. A sample of the  output  is
  181.         shown in appendix B.
  182.  
  183.         Summary  --  Accumulate and display the totals for  the  selected
  184.         BBS.
  185.  
  186.         PcPursuit  --  Compensates for inaccuracy in Telix  logfile  when
  187.         accessing  PCP.  Use this mode for a more  accurate  time  online
  188.         calculation for your PCPursuit main number.
  189.  
  190.         OUTPUT MODES
  191.  
  192.         If  Allcalls or Individual Detailed has been selected,  the  next
  193.         menu presented is the output mode menu, allowing three  different
  194.         types of output.
  195.  
  196.         Screen <default> -- Sends all output to console. This is the only
  197.         output  mode  available  when using  the  Individual  Summary  or
  198.         Individual PcPursuit modes.
  199.  
  200.         Printer -- Sends all output to standard printer port.
  201.  
  202.         File -- Sends all output to data file.
  203.  
  204.  
  205.         If File is selected you are prompted for an output filename.
  206.  
  207.         Enter output filename <TELIX.RPT>
  208.  
  209.         Pressing <return> will use the default file TELIX.RPT or you  may
  210.         enter any valid DOS filename. LOGGIT will check for the existence
  211.         of the selected file and if present will allow you the option  to
  212.         overwrite the file.
  213.  
  214.         If the Individual mode has been selected, you are now prompted to
  215.         enter  the BBS name to analyze. The input is CASE  SENSITIVE  and
  216.         all  that need be entered is enough of the BBS name to  make  the
  217.         search unique. LOGGIT will attempt to locate the BBS name entered
  218.         and,  if  unable to find it, will display an  error  message  and
  219.         request another name.
  220.  
  221.         LOGGIT  will now scan the file and compile the data according  to
  222.         the  parameters that have been selected. The message window  will
  223.         display  an "Analyzing -- Please Wait" message. When the scan  is
  224.         completed  the  data will be output to the file  or  the  printer
  225.         directly.  If  the  screen  mode has been  chosen,  you  will  be
  226.         prompted to strike a key to page the output.
  227.  
  228.  
  229.  
  230.                                         3
  231.         LOGGIT -- TELIX USE FILE ANALYZER
  232.  
  233.  
  234.  
  235.  
  236.                               DISTRIBUTION PACKAGE
  237.  
  238.         The files in the distribution package are:
  239.  
  240.         LOGGIT.EXE               LOGGIT executable
  241.         LOGGIT.DOC               Docs for LOGGIT
  242.         LOGGIT.HIS               LOGGIT History file
  243.  
  244.         BATCH FILE OPERATION
  245.  
  246.         LOGGIT may be run from a batch file if you use a program such  as
  247.         KEY-FAKE. Some sample batch files are described in appendix C.
  248.  
  249.         CAUTIONS
  250.  
  251.         Due  to  power failures and improper use of  the  program,  TELIX
  252.         Version 3.11 has, on occasion, entered some strange entries  into
  253.         the  TELIX.USE  file. LOGGIT makes every attempt to  catch  these
  254.         errors  and instruct the user to correct them before  proceeding.
  255.         The usual error is the combining of two lines of the log onto one
  256.         line.  These  errors are easy to spot and correct. There  is  one
  257.         particular  error, however, that can cause some strange  results.
  258.         Occasionally, TELIX will insert an Elapsed Time Online entry into
  259.         the  log  which  signifies the end of  the  connection  when  the
  260.         connection  has not ended at all. This can produce  some  strange
  261.         elapsed times and may even miss logging some up/downloads. If you
  262.         notice some strange results, look closely at the TELIX.USE  file.
  263.         Chances  are you'll find some subtle error in the file. This  can
  264.         produce incorrect results but can do no harm at all.
  265.  
  266.         The built-in file integrity check may be overridden by the use of
  267.         the command line switch /t.
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.                                         4
  292.         LOGGIT -- TELIX USE FILE ANALYZER
  293.  
  294.  
  295.  
  296.  
  297.                               THE SHAREWARE CONCEPT
  298.  
  299.         This  program is being distributed under the  shareware  concept.
  300.         There  are many advantages to using this method of  distribution,
  301.         some of which are:
  302.  
  303.         o    People can try programs before paying for them to
  304.              determine if they are useful to their needs.
  305.  
  306.         o    Software authors can be supported directly by the
  307.              users, which keeps software costs down.
  308.  
  309.  
  310.         You are granted the right to use this program for a trial  period
  311.         of  thirty  days, at which time you are requested to  stop  using
  312.         it, or pay the registration fee.  You can register your copy  for
  313.         $12 and receive the latest version on a 5.25" disk.
  314.  
  315.  
  316.         Please remit to:
  317.  
  318.                                     Vic Baron
  319.                                        GTX
  320.                                 54 Panorama Mall
  321.                              Panorama City, CA 91402
  322.  
  323.  
  324.                                     WARRANTY
  325.  
  326.         THE  AUTHOR MAKES NO WARRANTY OF ANY KIND, WHETHER WRITTEN,  ORAL
  327.         OR  IMPLIED,  INCLUDING  WITHOUT  LIMITATION  THE  WARRANTIES  OF
  328.         FITNESS  FOR  A PARTICULAR PURPOSE OR OF MERCHANTABILITY.  IN  NO
  329.         EVENT  SHALL  THE AUTHOR BE LIABLE FOR SPECIAL  OR  CONSEQUENTIAL
  330.         DAMAGES FROM THE USE OF THIS PROGRAM, EITHER IN BINARY OR  SOURCE
  331.         FORM. THE USE OF THIS PROGRAM CONSTITUTES ACCEPTANCE OF THE TERMS
  332.         AND  CONDITIONS OF THIS AGREEMENT. IF YOU DO NOT AGREE  TO  THESE
  333.         TERMS, PLEASE DON'T USE THIS PROGRAM.
  334.  
  335.                               TECHNICAL INFORMATION
  336.  
  337.         This  program  was written and compiled  with  Borland's  TurboC,
  338.         Version  2.0.  Many  specific functions were  created  in  C  and
  339.         Assembly language.Extensive use was made of the fine CXL  Library
  340.         functions by Mike Smedley.
  341.  
  342.  
  343.  
  344.  
  345.         CXL            Copyright Mike Smedley
  346.         TurboC         Copyright Borland International
  347.         Telix          Copyright Exis,Inc and Colin Sampaleanu
  348.  
  349.  
  350.  
  351.  
  352.                                         5
  353.  
  354.         LOGGIT -- TELIX USE FILE ANALYZER
  355.         APPENDIX A
  356.  
  357.         Sample output for Allcalls --
  358.  
  359.         ================================================================
  360.              BBS         TELEPHONE     Total Total  Avg   UP  DN   FILE
  361.              NAME         NUMBER       CALLS TIME   TIME  LDS LDS ABORTS
  362.         ================================================================
  363.         A.M.U.L.E.T.           989-5054    3   0:26  8 min   2   0   0
  364.         A.S.T.E. BBS           443-0242    1   0:16 16 min   1   0   1
  365.         AAAExecpc              622-1138   54   8:55  9 min   5  20   3
  366.         AAALaTelenet           624-2251    8   2:02 15 min   0   0   0
  367.         AAALaTelenet24         622-1138   67   4:21  3 min   0   0   0
  368.         AT&T Communicator      983-5090    1   0:00  0 min   0   0   0
  369.         Albedo 0.39            822-8520    2   0:12  6 min   1   0   0
  370.         BBS1-PC!               623-8451    2   1:02 31 min   2   2   0
  371.          +   +   +   +   +   +   +   +   +   +   +   +   +   +   +  +
  372.  
  373.           +   +   +   +   +   +   +   +   +   +   +   +   +   +   +  +
  374.  
  375.          +   +   +   +   +   +   +   +   +   +   +   +   +   +   +  +
  376.  
  377.           +   +   +   +   +   +   +   +   +   +   +   +   +   +   +  +
  378.         qhost                  547-1549    6   1:03 10 min   6   2   0
  379.         sunrise omega          452-0350    1   0:01  1 min   0   0   0
  380.         swap                   861-0925    1   0:05  5 min   0   0   0
  381.         unix                   530-3013    1   0:00  0 min   0   0   0
  382.         unk16            1-818-961-7903    2   0:12  6 min   0   0   0
  383.         xanth West       1-818-710-9998    1   0:18 18 min   0   1   0
  384.  
  385.                          Start Date --------   12-01-88
  386.                          End Date ----------   01-02-89
  387.                          Total Calls -------   0399
  388.                          Numbers Called ----   0122
  389.                          Total Uploads -----   0090
  390.                          Total Downloads ---   0103
  391.                          Total Aborted -----   0009
  392.                          Total Time Online -   054:48
  393.                          Average Time/Call -    8 min
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.                                         6
  414.  
  415.         LOGGIT -- TELIX USE FILE ANALYZER
  416.         APPENDIX B
  417.  
  418.         Sample output for Individual - Detailed
  419.  
  420.         ================================================================
  421.         Upload/Download Activity for:    AAAExecpc
  422.         ================================================================
  423.         88-12-01 Upload      External       YmOdem-g protocol.       CPS
  424.         88-12-03 Upload      External       YmOdem-g protocol.       CPS
  425.         88-12-10 Upload      External       ZmodemH protocol.        CPS
  426.         88-12-11 Download    External       YmOdem-g protocol.       CPS
  427.         88-12-11 Download    thelist2.zip   Zmodem protocol.     220 CPS
  428.         88-12-14 Download    External       YmOdem-g protocol.       CPS
  429.         88-12-15 Download    External       YmOdem-g protocol.       CPS
  430.         88-12-16 Download    vircom.zip     YmodEm-g protocol.   192 CPS
  431.         88-12-20 Upload      External       ZmodemH protocol.        CPS
  432.         88-12-20 Download    pk361pat.zip   YmodEm-g protocol.   175 CPS
  433.         88-12-20             ABORTED                                 CPS
  434.         88-12-20 Download    dsz1220.zip    Zmodem protocol.     219 CPS
  435.         88-12-20             superk.pak                          177 CPS
  436.         88-12-20             cudmx.zip                           164 CPS
  437.         88-12-21 Download    toots.gif      Zmodem protocol.     196 CPS
  438.         88-12-22 Download    mnp.doc        Zmodem protocol.       0 CPS
  439.         88-12-22 Download    mnemonic.txt   Zmodem protocol.     204 CPS
  440.         88-12-22 Download    pcpchek.zip    Zmodem protocol.     226 CPS
  441.         88-12-22 Upload      External       ZmodemH protocol.        CPS
  442.         88-12-24 Download    ABORTED        YmodEm-g protocol.       CPS
  443.         88-12-24 Download    dszreg.zip     Zmodem protocol.     221 CPS
  444.         88-12-24             mn1221.zip                           23 CPS
  445.         88-12-24             td1pat.zip                           93 CPS
  446.         88-12-24             tc2pat_2.zip                         96 CPS
  447.         88-12-24             noah2.zip                           116 CPS
  448.         88-12-24 Download    External       YmOdem-g protocol.       CPS
  449.         88-12-28 Download    ABORTED        YmodEm-g protocol.       CPS
  450.         88-12-28 Download    External       Dszmodem protocol.       CPS
  451.  
  452.                          Start Date --------   12-01-88
  453.                          End Date ----------   01-02-89
  454.                          Total Calls -------   0129
  455.                          Total Uploads -----   0005
  456.                          Total Downloads ---   0020
  457.                          Total Aborted -----   0003
  458.                          Total Time Online -   015:20
  459.                          Average Time/Call -    7 min
  460.  
  461.  
  462.         Sample output for Individual - Summary
  463.  
  464.         ================================================================
  465.              BBS         TELEPHONE     Total Total  Avg   UP  DN   FILE
  466.              NAME         NUMBER       CALLS TIME   TIME  LDS LDS ABORTS
  467.         ================================================================
  468.         Execpc                 622-1138   54   8:55  9 min   5  20   3
  469.  
  470.  
  471.  
  472.  
  473.  
  474.                                         7
  475.  
  476.         LOGGIT -- TELIX USE FILE ANALYZER
  477.         APPENDIX C
  478.  
  479.         Sample Batch Files
  480.         This  batch  file  will  automatically  scan  the  default  file,
  481.         TELIX.USE  scanning  Allfiles  for Alldates with  output  to  the
  482.         console.
  483.  
  484.  
  485.         REM Batch file for complete scan
  486.  
  487.         key-fake 13 "A" "A" "S"
  488.                  |   |   |   |_____Screen output
  489.                  |   |   |_________Allfiles
  490.                  |   |_____________Alldates
  491.                  |_________________Use default input file
  492.  
  493.         loggit
  494.  
  495.         REM End of batch file
  496.  
  497.  
  498.  
  499.  
  500.         This batch file will allow for entry of an input filename at  the
  501.         command  line. Command would be..batch myfile.ext  <return>.  The
  502.         <myfile.ext> will be substituted for LOGGIT'S default filename.
  503.  
  504.  
  505.         REM Batch file for complete scan of specified file
  506.  
  507.         key-fake "%1" 13 "A" "A" "S"
  508.                   |   |   |   |   |_____Screen output
  509.                   |   |   |   |_________Allfiles
  510.                   |   |   |_____________Alldates
  511.                   |   |_________________Carriage return character
  512.                   |_____________________Filename will be substituted
  513.  
  514.         loggit
  515.  
  516.         REM End of batch file
  517.  
  518.         Any of LOGGIT's input may be generated by key-fake or any similar
  519.         program.  Use the unique character that starts each command in  a
  520.         menu  and LOGGIT will recognize the input. Decimal 13 (c/r)  must
  521.         be added to all filename inputs.
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.                                         8
  536.