home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / comm / mch19.lha / MCH.doc < prev   
Text File  |  1993-07-31  |  6KB  |  158 lines
  1.                     M a s t e r - C a l l   H i s t o r y
  2.  
  3.                                      v1.9
  4.  
  5.                        A superior caller history utility
  6.  
  7.                         (c) Phillip Eastham 1992, 1993
  8.  
  9. ------------------------------------------------------------------------------
  10.  
  11.  
  12. What is it:
  13. ~~~~~~~~~~~
  14.        Master-Call History is a utility which allows your users to see who
  15. has called the BBS.
  16.  
  17.        I was using DLG-LastCall Plus v3.0, but this had a few annoying
  18. features, so I decided to write my own. Some features are:
  19.  
  20.        o Unlimited number of last callers.
  21.        o No addition of sysop name if the sysop was the last caller.
  22.        o Update last caller and last user in above case.
  23.        o Add/Not add to call statistics in above case.
  24.        o Last callers list uses DLG % switches instead of ANSI ESCape codes.
  25.        o Doesn't display ANSI colours if the user has them turned off.
  26.        o Realtime display of last x callers during log-on.
  27.        o Turn verbose last caller details off.
  28.        o Custom header on last callers list.
  29.        o Exclude a user from being listed, eg a 'Guest' account.
  30.        o Exclude a certain port from being added.
  31.        o Choose to add time or not.
  32.        o Highlight new users.
  33.        o Now much safer for multi-line operation.
  34.        o Strips leading 0 from date field.
  35.        o Reduced command line.
  36.        o Uses dlg.library to get user information.
  37.        o Fast!
  38.  
  39.  
  40. Setting up:
  41. ~~~~~~~~~~~
  42.        First of all, copy the file 'MCH' to your DLG: directory, or anywhere
  43. else on your path.
  44.  
  45.        Then edit your DLGConfig:Batch/login.(dlg)batch file and insert the
  46. appropriate calling line.  The parameteres are discussed later.
  47.  
  48.        If you have been using DLG-LastCall Plus v3.0, you may simply copy the
  49. file 'DLGConfig:Misc/LCP.DAT' to 'DLGConfig:Misc/MCH.DAT'. MCH uses the same
  50. data file format. IT DOESN'T USE THE SAME LAST CALLER LIST HOWEVER.
  51.  
  52.        You will need to edit/add a menu item to your main menu, or another
  53. suitable menu, to display the last callers text file.  The included IFF picture
  54. shows how to set it up correctly.
  55.  
  56.        After the initial run of MCH, you may add/delete lines from the
  57. header. Remember to adjust the parameter in the calling program as well.
  58.  
  59.  
  60. Parameters:
  61. ~~~~~~~~~~~
  62.        Master-Call History has many parameters. You should call Master-Call
  63. History as follows:
  64.  
  65.   DLG:MCH [-D] [-E"Excluded name"] [-Hx] [-Ix] [-L[1]] [-N] -P%PORT
  66.         -> [-QExcluded_port] [-R] [-S"Phillip Eastham"] [-Tx] [-U] [-V]
  67.  
  68.        (This should all be on 1 line)
  69.  
  70.        Those parameters in []'s are optional. Order and case are unimportant.
  71.  
  72.   -D        - Add in time to list. Can be added/removed at anytime. Blanks
  73.               are simply inserted instead of a time value if switch is
  74.               active.
  75.  
  76.   -E"Excluded Name"
  77.             - "Excluded Name" is the name of the person you DON'T wish
  78.                added to the list.
  79.  
  80.   -Hx       - Number of header lines. x can be from 0 to 9. MCH defaults
  81.               to 3 header lines. If you wish to add lines into the header,
  82.               simply change this value. Make sure you also make changes to
  83.               the data file (DLGConfig:Text/MCHLastCall.TXT) as well or else
  84.               you will get odd results the next time MCH is run.
  85.  
  86.   -Ix       - Display last x callers during log-on. Doesn't display the usual
  87.               header. Reports to user 'The last x callers were:' and then
  88.               lists the number of callers set in x.
  89.  
  90.   -L        - When this option is on, and the last caller was the person
  91.               defined by the -S switch, details for this call are not added
  92.               to any of the data files.  As far as MCH is concerned, you
  93.               haven't called.
  94.  
  95.   -L1       - Updates the last caller and last user files with this calls
  96.               details, overwriting your last call.
  97.  
  98.   -N        - Used when you have either '-L' or '-L1' turned on. Will
  99.               update the call statistics.
  100.  
  101.   -P%PORT   - The port the user is on.
  102.  
  103.   -QExcluded_Port
  104.             - This is the port you wish to exclude from the list. DO NOT ADD
  105.               THE ':' TO THE PORT. LEAVE IT AS A 3 LETTER NAME.
  106.  
  107.   -R        - Clear the screen at the start. (Use to be switch -C)
  108.  
  109.   -S"Phillip Eastham"
  110.             - Place your name in the quotes. This is used in conjunction
  111.               with the -L parameter to determine if your details should
  112.               be added to the data files.
  113.  
  114.   -Tx       - Where x is a number greater than 0. This is the number of
  115.               callers to keep history on. If not included, MCH defaults to
  116.               the last 50 callers.
  117.  
  118.   -U        - Turn on new user highlighting.
  119.  
  120.   -V        - Turn verbose 'Last Caller' ON (Default is off).
  121.  
  122.  
  123. Redundant switches:
  124. ~~~~~~~~~~~~~~~~~~~
  125.        The following switches have been made redundant:
  126.  
  127.   -A%ANSI   - Now taken from USER:<%UNAME>/User.Data
  128.   -B%BAUD   - Now taken from T:<port>.User
  129.   -C%CALLS  - Now taken from USER:<%UNAME>/User.Data
  130.   -F"%CITY" - Now taken from USER:<%UNAME>/User.Data
  131.   -U"%NAME" - Now taken from T:<port>.User
  132.  
  133.  
  134. Anything else?
  135. ~~~~~~~~~~~~~~
  136.        Yes! If you create your own 'MCHLastCall.txt' file, make sure that you
  137. have an EOL at the end of the last line. This means pressing <RETURN> at the
  138. end of the last line. MCH will produce an error if you don't do this.
  139.  
  140.  
  141. Error output:
  142. ~~~~~~~~~~~~~
  143.        Should a fatal error occur with Master-Call History, the program will
  144. terminate cleanly. A file in 'USER:' will be created which will hold the last
  145. error messages produced.
  146.  
  147.  
  148. Program status:
  149. ~~~~~~~~~~~~~~~
  150.        Master-Call History is freeware. Use it as you please. I would
  151. appreciate a Mail message saying that you are using it and telling me what
  152. you think of it.  Any bug reports or suggestions for improvements can be sent
  153. to me via Fido or UUCP:
  154.  
  155.               Phillip Eastham@3:622/406
  156.               phillip_eastham@kumear.apana.org.au
  157.  
  158.