home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / DORLOG16.ZIP / DOORLOG.DOC < prev    next >
Encoding:
Text File  |  1989-07-13  |  11.4 KB  |  328 lines
  1.                DOORLOG.DOC          S/L Doors Log Manual       Page 1.
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.                             D O O R L O G   S U I T E
  25.  
  26.                                    Version 1.6                          
  27.  
  28.                         A Searchlight BBS "Useful Utility"
  29.  
  30.                DOORLOG is Copyright (C) 1989  ASTORSOFT Programming
  31.  
  32.  
  33.            The DOORLOG suite was written by:   James Roberts-Thomson,
  34.                                                22 Rodrigo Road,
  35.                                                Kilbirnie,
  36.                                                Wellington,
  37.                                                New Zealand.
  38.  
  39.  
  40.         This software is supported through FEELING BAUD, the NZ & OZ
  41.              Searchlight Support BBS, on 64 4 264 276  24hrs.
  42.            DOORLOG.DOC          S/L Doors Log Manual       Page 2.
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.       1.  Table of Contents 
  57.            
  58.            
  59.           1.  Table of Contents . . . . . . . . . . . . . . . . . .   2
  60.  
  61.            
  62.           2.  Notice: . . . . . . . . . . . . . . . . . . . . . . .   3
  63.  
  64.                2.1   Licence Agreement  . . . . . . . . . . . . . .   3
  65.  
  66.                2.2   SUPPORT FREEWARE!  . . . . . . . . . . . . . .   3
  67.  
  68.                2.3   DISCLAIMER OF WARRANTY . . . . . . . . . . . .   3
  69.  
  70.            
  71.           3.  What is The Door Log Suite? . . . . . . . . . . . . .   4
  72.  
  73.            
  74.           4.  Using The Door Log Suite  . . . . . . . . . . . . . .   4
  75.  
  76.                4.1   Equipment Needed . . . . . . . . . . . . . . .   4
  77.  
  78.                4.2   Using the Programmes . . . . . . . . . . . . .   4
  79.  
  80.                      4.2.1   LOG.EXE  . . . . . . . . . . . . . . .   4
  81.  
  82.                      4.2.2   LOGANAL.EXE  . . . . . . . . . . . . .   5
  83.  
  84.                      4.2.3   The LOG.CFG file . . . . . . . . . . .   5
  85.  
  86.            
  87.           5.  Notes on Version 1.6  . . . . . . . . . . . . . . . .   6
  88.  
  89.                5.1   Any Problems?  . . . . . . . . . . . . . . . .   6
  90.  
  91.                5.2   Development  . . . . . . . . . . . . . . . . .   6
  92.  
  93.                5.3   Known problems . . . . . . . . . . . . . . . .   6
  94.  
  95.                5.4   Future enhancements  . . . . . . . . . . . . .   6
  96.  
  97.            DOORLOG.DOC          S/L Doors Log Manual       Page 3.
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.       2.  Notice: 
  107.            
  108.            
  109.           2.1   Licence Agreement 
  110.            
  111.           You may make copies of this program, manual,  and other files
  112.           and give it to your friends, upload it to bulletin boards, or
  113.           include it in the library of a non-profit  computer club. You
  114.           may not distribute The Door Log Suite without the DOORLOG.DOC
  115.           file, or without the LOG.EXE and LOGANAL.EXE files.   You may
  116.           not  modify  the DOORLOG.DOC  file,  nor the  LOG.EXE or  the
  117.           LOGANAL.EXE file. 
  118.            
  119.           I forbid  any for-profit  venture from  selling this software
  120.           and manual, either  separately  or  as  part  of  a "library"
  121.           diskette.
  122.  
  123.           By using  the software,  you indicate your acceptance of this
  124.           licence agreement.
  125.            
  126.            
  127.           2.2   SUPPORT FREEWARE! 
  128.            
  129.           If you find this software has any value for  you,  congratul-
  130.           ations.  You didn't even pay a cent  for it!    There  are no
  131.           registration fees for this  programme,  and no  contributions
  132.           are required.
  133.  
  134.           However, if you feel you must reward my intensive programming
  135.           effort, feel free to send some money.  I'll gladly take it  - 
  136.           I'm not a fool!  
  137.  
  138.           Send  any comments  or  suggestions  about The Door Log Suite
  139.           to the above address, or via e-mail on any of the BBS systems
  140.           listed below.  Your letters will provide the incentive needed
  141.           for  me to continue to improve  this  product  by  adding new
  142.           features,  or fixing any  bugs. 
  143.            
  144.           Please feel free to  share  this software with others. 
  145.            
  146.  
  147.           2.3   DISCLAIMER OF WARRANTY 
  148.  
  149.           THIS  SOFTWARE  AND  MANUAL  ARE  PROVIDED  "AS  IS"  WITHOUT
  150.           WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
  151.           BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  152.           AND FITNESS OF PURPOSE.  THE USER OF THIS SOFTWARE AND MANUAL
  153.           ASSUME ALL RISKS.
  154.            DOORLOG.DOC          S/L Doors Log Manual       Page 4.
  155.  
  156.  
  157.       3.  What is The Door Log Suite ?
  158.  
  159.  
  160.           The Door Log Suite is  a  small  suite  of  programmes  which
  161.           provide a Searchlight (tm) BBS  Sysop to log and then analyse
  162.           the usage of his (or her) Door programmes.
  163.  
  164.           There are two programmes which make up the suite.  These are:
  165.  
  166.           1)  The LOG.EXE programme, which is  placed in the  DOORS.DEF
  167.              file, and which logs the information about the doors usage
  168.  
  169.           2)  The LOGANAL.EXE programme, which  analyses  the file made
  170.              by the LOG programme, and produces  the Top Ten print-out.
  171.  
  172.  
  173.  
  174.  
  175.       4.  Using The Door Log Suite
  176.            
  177.            
  178.           4.1   Equipment Needed 
  179.            
  180.           The Door Log Suite uses quite a bit of memory, but not nearly
  181.           as much as Searchlight, so if you can run The Searchlight BBS
  182.           software, you will be able to use The Door Log Suite software
  183.  
  184.            
  185.           4.2   Using the Programmes
  186.  
  187.           4.2.1   LOG.EXE
  188.  
  189.           To  use LOG to log stats for a door, you  have to  modify the
  190.           DOORS.DEF file, and place  a call to  LOG.EXE instead  of the
  191.           door programme.  
  192.  
  193.           For example, assume that you have ASTORSOFT's TRIVIA  game as
  194.           a door on your BBS.   You would have a line like this in your
  195.           DOORS.DEF file:
  196.  
  197.           1;0;1;20;Trivia Game;c:\doors\trivia;trivia.exe
  198.  
  199.           You add LOG.EXE to this line so it looks like this:
  200.  
  201.           1;0;1;20;Trivia Game;c:\doors\trivia;\log.exe trivia.exe
  202.  
  203.           NOTE:
  204.           -----
  205.                 This example assumes that the LOG.EXE programme is kept
  206.           in the root directory of the hard-disk.  This is where ASTOR-
  207.           SOFT recommend you put LOG.EXE, but you can put  it  anywhere
  208.           you like, but you MUST make sure that the path is supplied in
  209.           the DOORS.DEF entry.  For example:
  210.  
  211.           1;0;1;20;Trivia Game;c:\doors\trivia;c:\bbs\log.exe trivia.exe
  212.            DOORLOG.DOC          S/L Doors Log Manual       Page 5.
  213.  
  214.  
  215.           If the door programme needs any parameters passed to it, then
  216.           just include them on the command-line, and LOG will pass them
  217.           thru to the door.   For example:
  218.  
  219.           1;0;1;20;Anydoor;c:\door;\log.exe doorname.exe %w FRED!@# %g
  220.  
  221.           will cause the  %w FRED!@#  and %g parameters to be passed to
  222.           the doorname.exe programme. 
  223.  
  224.           4.2.2   LOGANAL.EXE
  225.  
  226.           To  use LOGANAL to analyse  the data captured by LOG.EXE, you
  227.           simply call:
  228.  
  229.                       LOGANAL
  230.  
  231.           The programme will then read the LOG.EXE logfile, and produce
  232.           the top-ten printout on the screen.  You can use the  DOS I/O
  233.           redirection facility to re-direct the output into a file,  so
  234.           that the information may be included in a bulletin.  
  235.  
  236.           For example:
  237.                         LOGANAL > C:\BBS\INCLUDE\DOORTOP.TEN
  238.  
  239.           will routine the output from the programme to the DOORTOP.TEN
  240.           file in the C:\BBS\INCLUDE sub-directory.  This file  will be
  241.           automatically created if it doesn't exist, otherwise  the old
  242.           file contents will be automatically over-written.
  243.  
  244.           
  245.           4.2.3   The LOG.CFG file
  246.  
  247.           Both LOG.EXE  and  LOGANAL.EXE rely, for correct logging  and
  248.           analysing, on a file called LOG.CFG.   In this release of The
  249.           Door Log Suite, this file MUST be kept in the  C: drive  ROOT
  250.           directory  (ie it MUST be called C:\LOG.CFG).   The file con-
  251.           tains two records, and can be easily created via the DOS COPY
  252.           command (ie COPY CON: C:\LOG.CFG).  The  two records  contain
  253.           the FULL path and filename of the file to which  LOG uses  to
  254.           record its stats in, and which  LOGANAL will  analyse.    The
  255.           second record  contains  a path to  the Searchlight (tm)  BBS
  256.           'home' directory.   This is required so  that the  programmes
  257.           can  read  the .BBS  files to  find out  about who the online
  258.           caller is.
  259.  
  260.           If this file cannot be found, or if the information in  it is
  261.           not  correct, then the LOGANAL programme will FAIL.  The  LOG
  262.           programme, however, will not fail, but will be unable  to log
  263.           any stats.  It will still execute  the command  passed as the
  264.           first parameter, however, so the door will still execute.
  265.  
  266.            DOORLOG.DOC          S/L Doors Log Manual       Page 6.
  267.  
  268.  
  269.           5.  Notes on Version 1.6
  270.            
  271.            
  272.           5.1   Any Problems? 
  273.            
  274.           Are you having problems with this program? Would  you like to
  275.           see any  extra features added? Any comments you would like to
  276.           make? 
  277.            
  278.           Leave me a note on: The Magic Tower,      Ph.  64 4  767 326, or
  279.                               The Cave  BBS,        Ph.  64 4  697 379, or
  280.            Contact New Zealands Searchlight Support BBS
  281.                               FEELING BAUD,         Ph.  64 4  264 276.
  282.                                                     300/1200/2400 24hrs
  283.           Or write to: James Roberts-Thomson,
  284.                        22 Rodrigo Road,
  285.                        Kilbirnie,
  286.                        Wellington,
  287.                        NEW ZEALAND. 
  288.            
  289.  
  290.           5.2   Development 
  291.            
  292.           The Door Log Suite was developed using Turbo Pascal v5.0. The
  293.           hardware  used was a DG-1 Laptop, with CGA and running MS-DOS
  294.           version  3.2, with Searchlight (tm) version 1.30.    No other
  295.           hardware/software combinations  have been tried, but there is 
  296.           no reason  why  any  generic  MS-DOS machine  shouldn't  work
  297.           correctly.
  298.  
  299.           v 1.0 - Initial "quick-hack" to get the concept working.
  300.           v 1.1 - Tided up v1.0, and corrected sorting routine.
  301.           v 1.2 - Added Door duration to output chart.
  302.           v 1.3 - Added Number of Calls to Top Ten User display.
  303.           v 1.4 - Fixed a 'midnight-rollover' problem.
  304.                 - First version released for Public Use.
  305.           v 1.5 - Fixed a bug in the Top Ten User display.
  306.           v 1.6 - Tided up documentation, and fixed a bug introduced in
  307.                   v1.5 fix.
  308.  
  309.           
  310.           5.3   Known problems 
  311.            
  312.           I am  not aware  of any  problems, and  it is  up to you, the
  313.           user, to point them out to me. 
  314.  
  315.           This software has been extensively tested and used online  on
  316.           The Dragon's Tower BBS.
  317.            
  318.           5.4   Future enhancements 
  319.            
  320.           Again, it's up to you as the user, to suggest new features to
  321.           me. 
  322.  
  323.  
  324.           Turbo Pascal is a trademark of Borland, Ltd.
  325.  
  326.           Searchlight is a trademark of Frank LaRosa and Seachlight
  327.           software.
  328.