home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / sqmurd01.zip / sqmurder.doc < prev    next >
Text File  |  1995-12-18  |  4KB  |  142 lines
  1. What's this crap for?
  2. ---------------------
  3.  
  4. Please note, that this program is a really quick hack, which
  5. I programmed and tested in about three hours. It may contain
  6. fatal bugs.
  7.  
  8. SqMurder is an OS/2 program and may be used by Fido sysops to
  9. clean-up their Squish style echo base.
  10.  
  11. It will
  12.  
  13. 1) read the Squish configuration file,
  14. 2) test areas by running SqInfo,
  15. 3) optionally try to fix bad areas by running SqFix and
  16. 4) eventually create a batch to delete bad areas.
  17.  
  18. The included source code had been compiled with MSC 6.0A.
  19.  
  20.  
  21. Legal stuff
  22. -----------
  23.  
  24. Permission is granted to any individual or institution to use,
  25. copy, or redistribute this executable so long as it is not sold
  26. for profit.
  27.  
  28. LIKE ANYTHING ELSE THAT'S FREE, SQMURDER AND ALL ASSOCIATED FILES
  29. ARE PROVIDED AS IS AND COME WITH NO WARRANTY OF ANY KIND, EITHER
  30. EXPRESSED OR IMPLIED.
  31.  
  32.  
  33. Obtaining the latest version
  34. ----------------------------
  35.  
  36. Frequest with magic SQMURDER from 2:2448/434.
  37.  
  38.  
  39. How to install?
  40. ---------------
  41.  
  42. You need
  43.  
  44. 1) any version of OS/2,
  45. 2) SqInfoP.Exe, which is part of the Squish package and
  46. 3) SqFix32P.Exe, which is also part of the Squish package
  47.  
  48. Installation is very simple. Put SqMurder in the same directory
  49. where your other Squish programs are located.
  50.  
  51.  
  52. How to run?
  53. -----------
  54.  
  55. Note first, that you should not run SqMurder while Squish
  56. is running in the background.
  57.  
  58. If you enter
  59.  
  60. SQMURDER -?
  61.  
  62. on your command line, the program responds with
  63.  
  64. --------------------------------------------------------------
  65.                SqMurder version 0.1
  66.  written Dec 18 1995 by Harald Kipp
  67.  
  68. Illegal option -?
  69.  
  70. usage: sqmurder [options]
  71.  
  72. options:
  73.   -b<batchname>  name of batch output (murder.cmd)
  74.   -c<configfile> name of squish config file (squish.cfg)
  75.   -e<number>     maximum number of bad areas (20)
  76.   -f<fixprog>    name of program to fix area
  77.   -i<infoprog>   name of program to check area (sqinfop.exe)
  78.   -l<logfile>    name of the logfile
  79. --------------------------------------------------------------
  80.  
  81. and terminates. As you can see there are several command line
  82. options available.
  83.  
  84. -b<batchname>  You may specify a different name for the
  85.                command file created by SqMurder. The default
  86.                name is MURDER.CMD.
  87.  
  88. -c<configfile> Use this option if your Squish configuration
  89.                file is not called SQUISH.CFG or is not
  90.                located in the current directory.
  91.  
  92. -e<number>     SqMurder will abort with ERRORLEVEL 3 after
  93.                finding more than 20 bad areas. This option
  94.                may change the default number of bad areas.
  95.  
  96. -f<fixprog>    If you don't specify this option, SqMurder
  97.                will not try to fix bad areas. Usually you
  98.                should use '-fsqfix32p.exe'.
  99.  
  100. -i<infoprog>   By default SqMurder calls SqInfoP.Exe to check
  101.                your areas. This option allows you to specify
  102.                another program for this task.
  103.  
  104. -l<logfile>    Unless the name of a logfile is given with
  105.                this option, SqMurder will not create one.
  106.  
  107.  
  108. For example, this is how I prefer to call SqMurder:
  109.  
  110. sqmurder -fsqfix32p -l..\logfiles\sqmurder.log
  111.  
  112. It will scan Squish.Cfg in the local directory, use SqInfoP.Exe
  113. to check the areas, try to fix bad areas while running SqFix32P
  114. on them and create MURDER.CMD.
  115.  
  116. You may call MURDER.CMD either manually after inspecting it, or
  117. call it in a batch file based on the ERRORLEVEL returned by
  118. SqMurder.
  119.  
  120. The program returns
  121.  
  122.   0 if all areas are OK,
  123.   1 if all bad areas had been fixed,
  124.   2 if bad areas had been added to murder.cmd,
  125.   3 if bad areas were not listed in murder.cmd or
  126. 255 on nonrecoverable errors
  127.  
  128.  
  129. Have fun.
  130.  
  131.     Harald Kipp
  132.  
  133.  
  134.  
  135. Credits
  136. -------
  137.  
  138. Squish is (C) Copyright 1989, 1994 by Lanius Corporation.
  139. All rights reserved.
  140.  
  141. Many thanks to Scott Dudley for his great work.
  142.