home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / muprg110.zip / MUPURGE.DOC < prev    next >
Text File  |  1995-09-09  |  4KB  |  105 lines
  1.  
  2.                              MUPURGE / MUPURGEP
  3.                                 Version 1.10
  4.              Copyright (c) Bob Swift, 1995.  All Rights Reserved.
  5.  
  6.    This program is used to read the Max 3.00 USER.BBS file in the
  7.    current directory and purge users based on a combination of access,
  8.    number of calls, and days since the last call.  Purge criteria are
  9.    determined by the Sysop in a control file.  The first record in
  10.    USER.BBS (usually the sysop) is ignored, as are any records marked as
  11.    "Permanent".  Records marked as "Deleted" are purged.
  12.  
  13.    The format for using this program is as follows:
  14.  
  15.                 MUPURGE  [ctlfile]            (for DOS)
  16.                 MUPURGEP [ctlfile]            (for OS/2)
  17.  
  18.    Where [ctlfile] is the path and name of the control file (default is
  19.                    MUPURGE.CTL in the current directory).
  20.  
  21.    Examples:        MUPURGE  c:\max\misc\usrpurge.cfg
  22.                     MUPURGEP ctlfiles\mupurge.ctl
  23.                     MUPURGEP
  24.  
  25.    The program will display a VERY brief set of instructions if it encounters
  26.    an error.  The following is a list of the error codes returned by the
  27.    program:
  28.  
  29.                   0 - No errors.  Normal termination.
  30.                   1 - Bad / Extra command line argument.
  31.                   2 - Unable to open the control file.
  32.                   3 - No purge criteria specified.
  33.                   4 - Unable to create the backup files.
  34.                   5 - Unable to read the input files.
  35.                   6 - Unable to write the output files.
  36.                   7 - Unable to write the log file.
  37.  
  38.    When an error is encountered, the program will exit immediately and will
  39.    attempt to properly close all files.
  40.  
  41.    Although I have chosen to retain all rights to this program, you are free
  42.    to use it under the following conditions:
  43.  
  44.             - You realize that there is NO Warrantee of any sort.
  45.               It was tested pretty thoroughly here before release
  46.               but who knows what bugs may be lurking within.
  47.  
  48.             - You will not modify the code and release a new version
  49.               of the program.  I welcome suggestions for improvement
  50.               (especially when accompanied by code) but I make no
  51.               guarantee of future releases.
  52.  
  53.             - You drop me a note to let me know that you use the
  54.               program.  That way, I know who to inform if there are
  55.               any future releases.  Please either send netmail to:
  56.  
  57.                         Bob Swift
  58.                         1:342/5 @ fidonet
  59.  
  60.               or a postcard to:
  61.  
  62.                         Bob Swift
  63.                         5708 - 47th Street
  64.                         Stony Plain, Alberta
  65.                         T7Z 1C6, Canada
  66.  
  67.             - If you find the program useful, I ask that you do
  68.               something to brighten somebody else's day.  Just
  69.               exactly what, I will leave up to you.
  70.  
  71.    You may freely distribute this program provided that you distribute only
  72.    the complete archive which includes the files:
  73.  
  74.         MUPURGE.EXE     -   Program File for DOS
  75.         MUPURGEP.EXE    -   Program File for OS/2
  76.         MUPURGE.CTL     -   Sample Control File
  77.         MUPURGE.C       -   'C' Source Code
  78.         MAX_U.H         -   Maximus User Structures
  79.         STAMP.H         -   Maximus Stamp Structures
  80.         TYPEDEFS.H      -   Maximus Type Definitions
  81.         MUPURGE.DOC     -   Program Documentation
  82.         FILE_ID.DIZ     -   Program Description File
  83.  
  84.    If you run across any bugs with this program, please report them to the
  85.    address listed above.  Thanks for giving MUPURGE(P) a try.
  86.  
  87.  
  88.                                                    Bob Swift (1:342/5)
  89.  
  90.  
  91.    Revision History
  92.    ----------------
  93.  
  94.    1.00     95/09/06    First release version.
  95.  
  96.    1.10     95/09/09    Added log style option.  Removed the code to
  97.                         read / write the USER.IDX file because it seems
  98.                         that Maximus rebuilds this file whenever it starts
  99.                         up, so I don't have to worry about keeping it in
  100.                         sync.  Besides, the code would potentially cause
  101.                         other problems if the .IDX file was not synchronized
  102.                         with the .BBS file.
  103.  
  104.  
  105.