home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / TRIPF10.ZIP / FILTER.DOC < prev    next >
Text File  |  1997-09-28  |  7KB  |  154 lines
  1. ────────────────────────────────────────────────────────────────────────────
  2.  
  3.                        TriBBS Profanity Filter v1.0
  4.                                by SaltySoft
  5.  
  6.                     Copyright (C) 1997 David Kiesling
  7.                            All rights reserved.
  8.  
  9.  
  10.                                Support BBS:
  11.                   Shoe Salt BBS  707-465-3087  33.6 kbps
  12.  
  13.                              World Wide Web:
  14.                       http://www.vpdev.com/saltysoft                    
  15.  
  16.                                          SaltySoft Software
  17.            Internet Email:               c/o David Kiesling
  18.          saltysoft@vpdev.com             550 Sandhill Rd.
  19.                                          Crescent City, CA 95531 USA
  20. ────────────────────────────────────────────────────────────────────────────
  21.  
  22.  
  23.  
  24. Table of Contents
  25.  
  26.      I. Introduction
  27.     II. Setup
  28.    III. Support
  29.     IV. Attention Programmers!
  30.  
  31.  
  32.  
  33. ------------------------------ Disclaimer ------------------------------
  34.  
  35.  The author of this program and his affiliates cannot be held legally
  36.  responsible for any damage caused as a result of the use or misuse of
  37.  this program, nor for the precious bytes it takes up on your HD.
  38.  
  39. ------------------------------------------------------------------------
  40. -------------------------- License Agreement ---------------------------
  41.  
  42.  This program is distributed under the freeware concept. You are granted
  43.  a license to use and distribute this .ZIP archive as you wish. However,
  44.  the contents of the compressed .ZIP archive or the uncompressed EXE file
  45.  may NOT be modified in any respect by anyone other than the author.
  46.  
  47. ------------------------------------------------------------------------
  48.  
  49. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  50.  I.  Introduction
  51. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  52.  
  53.  Requirements:  * 8086 or higher processor (you should be FINE)
  54.                 * TriBBS 10.x or 11.x
  55.                 * $0 (FREEWARE!!)
  56.  
  57.  TriBBS Profanity Filter finds profanity words or phrases in your message
  58.  base. When it finds profanity it can either replace it with something 
  59.  else (like a bunch of "*" characters) or mark the message for deletion.
  60.  It will search for profanity in the Subject line as well! There's also
  61.  an option to neglect filtering private mail (perhaps you don't care what
  62.  users say to each other in *private*!).
  63.  
  64.  There's one requirement not mentioned above because I don't want to scare
  65.  you off before I have a chance to explain. For this program to work, you
  66.  must have less than 32,769 messages in any given message conference. In
  67.  all probability they should all be well under that. Even if you have
  68.  999,999 messages in a conference you probably have less than 32,769
  69.  actual *undeleted* messages in there. By the small chance you have more
  70.  than that, the program will just terminate with a runtime error and not
  71.  harm TriBBS's data files in the slightest.
  72.  
  73.  
  74. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  75.  II.  Setup
  76. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  77.  
  78.  TriBBS Profanity Filter is run with the following syntax:
  79.  
  80.        filter.exe <config file>
  81.   ex:  filter.exe filter.cfg
  82.  
  83.  If no config file is passed on the command line it will find and use
  84.  filter.cfg if it exists in the current directory.
  85.  
  86.  The format of the config file is....
  87.  
  88.   LINE 1: c:\tribbs       <- path to main TriBBS directory
  89.   LINE 2: N               <- When profanity is found...
  90.                              "Y" = flag message for deletion
  91.                              "N" = Replace profanity with a set of filler
  92.                                    characters (defined on line 5 below).
  93.   LINE 3: Y               <- Filter private mail?  "Y" or "N"
  94.   LINE 4: 1               <- (LINES 4 & 5)  Lowest and highest message
  95.   LINE 5: 2                  conferences to filter. To filter conferences
  96.                              2 to 17, put a "2" on line 3 and a "17" on
  97.                              line 4.
  98.   LINE 6: *               <- Character to replace profanity with. A "*"
  99.                              here tells it to replace "damn" with "****"
  100.                              in a message.
  101.   LINE 7: badwords.lst    <- Profanity words list file. You may edit this
  102.                              file with any text editor. Each line of this
  103.                              file has one profane word or phrase. The
  104.                              program will search for these profane words
  105.                              in a message and take appropriate action if
  106.                              found.
  107.  
  108.  Filter.cfg included with this archive is a sample config file.
  109.  
  110.  You can have as many config files as you wish. A possible use of that
  111.  would be if you want to filter different words from certain conferences.
  112.  
  113.  If you wish, you can set it up in your nightly event batch file by
  114.  adding two lines such as the following to it:
  115.  
  116.        cd\tribbs\other\filter
  117.        filter.exe filter.cfg
  118.  
  119.  
  120. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  121.  III.  Support
  122. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  123.  
  124.  Please contact me in any of the ways mentioned at the beginning of
  125.  this file for support. I'd love to hear any and all comments,
  126.  questions, or suggestions. There is always room for improvement!
  127.  
  128.  Comments (and donations! <g>) are the small things I need to believe
  129.  my programming is of use to sysops. If you find this program useful,
  130.  please let me know. I don't have the heart to keep working on this
  131.  stuff if I don't get many responses. :)
  132.  
  133.  
  134. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  135.  IV.  Attention Programmers!
  136. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  137.  
  138.  Are you a programmer?
  139.  The new owner (as of 01/01/97) of TriBBS, Gary Price, has made a
  140.  new API for PowerBasic for easier creation of programs that access
  141.  TriBBS's data files. I used it for this and all other recent TriBBS
  142.  utilities I've made. It's completely FREE for anyone that wants it
  143.  and I highly recommend it. It is strictly for PowerBasic 3.2. You
  144.  may contact Gary Price:
  145.  
  146.  by email - gwprice@worldnet.att.net
  147.  by BBS   - Freejack's Place (Home of TriBBS) 207-739-7121
  148.  by web   - http://www.tribbs.com
  149.  
  150.  PowerBasic is a programming language which is quickly rising in
  151.  popularity and that some say rivals even the legendary C++ in DOS
  152.  programming. Many parts are similar to QB4.5 but far more advanced.
  153.  Check it out at http://www.powerbasic.com
  154.