Muffin 0.6 README
Copyright (C) 1996-98 Mark Boyns <boyns@sdsu.edu>
___  ___       __  __ _       
|  \/  |      / _|/ _(_)      
| .  . |_   _| |_| |_ _ _ __  
| |\/| | | | |  _|  _| | '_ \ 
| |  | | |_| | | | | | | | | |
\_|  |_/\__,_|_| |_| |_|_| |_|

Muffin - Filter the Web

Muffin is filtering proxy server for the World-Wide Web.  Anything sent
between the web browser and server can be filtered.  This includes HTTP
headers and content types such as text/html and image/gif.  Muffin filters
are add-on modules loaded at runtime.  Several example filters are
included, but users are encouraged to write their own using the provided
ReplyFilter, RequestFilter, RedirectFilter, and ContentFilter API.

See the COPYING file for license information.
See the INSTALL file for compilation and installation instructions.
See the MAILINGLIST file for information about the muffin mailing list.
See the NEWS file for a list of user-visible changes.
See the TODO file to find out what may be fixed/changed/implemented.
See the BUGS file for a list of known problems.

Filters:

* muffin.filter.AnimationKiller

  Kill GIF89a animations by either limiting the number
  of loops or turning them into broken images.

* muffin.filter.CookieMonster

  Remove HTTP Cookie headers `Cookie' and `Set-Cookie'.

* muffin.filter.Decaf

  Remove all signs of JavaScript and/or Java from HTML pages.

* muffin.filter.DocumentInfo

  Display information about the current document.

* muffin.filter.ForwardedFor

  Insert X-Forwarded-For headers.

* muffin.filter.Glossary

  Markup glossary words in an HTML document.

* muffin.filter.HostnameExpander

  Attempt to expand non-local hostnames without dots to valid
  www.HOSTNAME.{com,edu,net,org} hosts.

* muffin.filter.Logger

  Keep a log of accessed URLs.

* muffin.filter.NoThanks

  Remove HTML tags based on tag names, URL patterns, comment blocks, and
  content-type.  This can be used to remove advertisements and block access
  to certain sites.  URL patterns can also be redirected to other sites.

* muffin.filter.Painter

  Control the colors used in HTML documents.  bgcolor, text, link, alink,
  vlink, and background can all be modified.  This can also be used to
  remove or replace background images.

* muffin.filter.Preview

  View and/or modify content before being sent to the browser.  Previewed
  content can be accepted or rejected.  Text and images are supported.
  Edit HTML on-the-fly.

* muffin.filter.Referer

  Change the HTTP referer header to any URL or choose from a list.

* muffin.filter.Secretary

  Automatically fill-in HTML forms with your name, email address, etc.

* muffin.filter.SecretAgent

  Change the HTTP User-Agent header to any web browser or choose from a
  list.

* muffin.filter.SecretServer

  Change the HTTP Server header.

* muffin.filter.Snoop

  View all HTTP headers.

* muffin.filter.Stats

  Maintain various stats about your HTTP session. Useful to calculate the
  exact size of a web page.

More filter documenation is located in the doc/filter directory.

Availability:

Muffin is free software distributed with the GNU General Public
License. Please see http://www.fsf.org/ if you don't understand what this
means.  The main distribution site is http://muffin.doit.org/

Requirements:

This version requires a Java 1.1.x Runtime Environment.  This includes the
following:

* JDK 1.1.x - http://java.sun.com/products/jdk/1.1/

* JRE 1.1.x - http://java.sun.com/products/jdk/1.1/jre/

* Solaris JDK 1.1 + JIT - http://www.sun.com/solaris/jit/

* Java Linux 1.1 - http://www.blackdown.org/java-linux.html

* SGI JDK/JRE 1.1.3 port - http://www.sgi.com/Fun/Free_webtools.html

* Kaffe 0.9.1 - http://www.kaffe.org/

* Any other Java 1.1 compatible environment.  See Sun's
  list of Java ports - http://java.sun.com/products/jdk/jdk-ports.html

Tested environments:

* Solaris 2.5 - JDK 1.1.2, JDK 1.1.3, JRE 1.1.2, JRE 1.1.3,
  JDK 1.1.3 + JIT, JDK 1.1.4, JDK 1.1.5, Kaffe 0.9.1, Kaffe 0.9.2

* Debian GNU/Linux 1.3 (2.0.33) - JDK 1.1.1, JDK 1.1.3, Kaffe 0.9.2

* Windows 95 - JDK 1.1.3, JDK 1.1.4

* Windows NT - JDK 1.1.3, JDK 1.1.4

* OS/2 Warp version 4 - JDK 1.1.1

* Irix 6.2 - SGI JDK 1.1.2

Any JDK version less than 1.1 will *not* work.

Tested browsers:

Muffin is known to work with the following web browsers

  Amaya, Chimera, Lynx, HotJava, MSIE, Mosaic, Netscape, and W3.

Also included in this distribution is:

* regex-0_11 - Regular expression package JP.ac.osaka_u.ender.util.regex
  by Shugo Maeda <ender@pic-internet.or.jp>
  See the README.regex file for further information
  http://www.pic-internet.or.jp/user/kojin/ender/

* glossary - Jigsaw Glossary filter
  by Joel Crisp <joelc@bristol.st.com> and the W3C & Jigsaw teams
  See the README.glossary file for further information
  http://www.asmodeus.demon.co.uk/glossary.htm
  http://www.w3.org/

* Parts of the SDSU java library
  by Roger Whitney <whitney@cs.sdsu.edu>
  http://www.eli.sdsu.edu/java-SDSU/

Send suggestions and bug reports to Mark Boyns <boyns@sdsu.edu>

                  __  __ _            _       _ _                    
                 / _|/ _(_)          | |     (_) |                   
 _ __ ___  _   _| |_| |_ _ _ __    __| | ___  _| |_   ___  _ __ __ _ 
| '_ ` _ \| | | |  _|  _| | '_ \  / _` |/ _ \| | __| / _ \| '__/ _` |
| | | | | | |_| | | | | | | | | || (_| | (_) | | |_ | (_) | | | (_| |
|_| |_| |_|\__,_|_| |_| |_|_| |_(_)__,_|\___/|_|\__(_)___/|_|  \__, |
                                                                __/ |
                                                               |___/ 
