more single file to be included at multiple points. make maintaining easier
[privoxy.git] / doc / source / user-manual.sgml
index cc2389b..3c2b827 100644 (file)
@@ -2,6 +2,20 @@
 <!entity % dummy "INCLUDE"> 
 <!entity supported SYSTEM "supported.sgml">
 <!entity newfeatures SYSTEM "newfeatures.sgml">
+<!entity p-intro SYSTEM "privoxy.sgml">
+<!entity seealso SYSTEM "seealso.sgml">
+<!entity buildsource SYSTEM "buildsource.sgml">
+<!entity contacting SYSTEM "contacting.sgml">
+<!entity history SYSTEM "history.sgml">
+<!entity copyright SYSTEM "copyright.sgml">
+<!entity p-version "2.9.13">
+<!entity p-status "BETA">
+<!entity % p-not-stable "INCLUDE"> <!-- set to IGNORE for stable release  -->
+<!entity % p-stable "IGNORE">      <!-- set INCLUDE for stable release    -->
+<!entity % p-text "IGNORE">        <!-- define we are not a text only doc -->
+<!entity % p-doc "INCLUDE">        <!-- and we are a formal doc           -->
+<!entity % p-readme "IGNORE">
+<!entity % p-supp-userman "IGNORE"> <!-- Omit some from supported.sgml    -->
 ]>
 <!--
  File        :  $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
@@ -10,7 +24,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: user-manual.sgml,v 1.62 2002/03/30 04:15:53 hal9 Exp $
+ $Id: user-manual.sgml,v 1.66 2002/04/04 06:48:37 hal9 Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  Privoxy team. http://www.privoxy.org/
  Based on the Internet Junkbuster originally written
  by and Copyright (C) 1997 Anonymous Coders and 
  Junkbusters Corporation.  http://www.junkbusters.com
--->
-
-<!--
-Sat 03/02/02 04:53:47 PM
 
-This should be ready for BETA release.
-
-Hal Burgiss <hal@foobox.net>
 -->
 
 <article id="index">
 <artheader>
 <title>Privoxy User Manual</title>
 
-<pubdate>$Id: user-manual.sgml,v 1.62 2002/03/30 04:15:53 hal9 Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.66 2002/04/04 06:48:37 hal9 Exp $</pubdate>
 
 <authorgroup>
  <author>
@@ -55,18 +62,18 @@ Hal Burgiss <hal@foobox.net>
 
  <para>
   The user manual gives users information on how to install, configure and use
-  <application>Privoxy</application>. <application>Privoxy</application> is a
-  web proxy with advanced filtering capabilities for protecting privacy,
-  filtering web page content, managing cookies, controlling access, and
-  removing ads, banners, pop-ups and other obnoxious Internet
-  Junk. <application>Privoxy</application> has a very flexible configuration
-  and can be customized to suit individual needs and
-  tastes. <application>Privoxy</application> has application for both
-  stand-alone systems and multi-user networks.
- </para>
+  <application>Privoxy</application>.
+  </para>
+
+<!--
+ Include privoxy.sgml boilerplate:
+-->
+ &p-intro;
+
  <para>
-You can find the latest version of the user manual at  <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink>.
- </para>
+  You can find the latest version of the user manual at  <ulink
+  url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink>.
+  </para>
 
 <!--   <para> -->
 <!--    Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
@@ -79,33 +86,9 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
 <!--   ~~~~~       New section      ~~~~~     -->
 
 <sect1 id="introduction"><title>Introduction</title>
-<para>
- <application>Privoxy</application> is a web proxy with advanced filtering
- capabilities for protecting privacy, filtering web page content, managing
- cookies, controlling access, and removing ads, banners, pop-ups and other
- obnoxious Internet junk. <application>Privoxy</application> has a very
- flexible configuration and can be customized to suit individual needs and
- tastes. <application>Privoxy</application> has application for both
- stand-alone systems and multi-user networks.
-</para>
-
-<para>
- <application>Privoxy</application> is based on the code of the 
- <application>Internet Junkbuster</application>.
- <application>Junkbuster</application> was originally written by JunkBusters
- Corporation, and was released as free open-source software under the GNU GPL.
- Stefan Waldherr made many improvements, and started the SourceForge project
- to continue development.
-</para>
-
-<para>
- <application>Privoxy</application> continues the
- <application>Junkbuster</application> tradition, but adds many 
- refinements and enhancements.
-</para>
 
 <para>
- This documentation is included with the current BETA version of
+ This documentation is included with the current &p-status; version of
  <application>Privoxy</application> and is mostly complete at this
  point. The most up to date reference for the time being is still the comments
  in the source files and in the individual configuration files. Development
@@ -114,13 +97,15 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
  stable v3.0 is <quote>soon</quote> ;-)
 </para>
 
+<![%p-not-stable;[
+<!-- include only in non-stable versions -->
 <para>
- Since this is a BETA version, not all new features are well tested. This
+ Since this is a &p-status; version, not all new features are well tested. This
  documentation may be slightly out of sync as a result (especially with 
  CVS sources). And there <emphasis>may be</emphasis> bugs, though hopefully
  not many! 
 </para>
-
+]]>
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect2>
@@ -128,15 +113,13 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
 <para>
  In addition to <application>Internet Junkbuster's</application> traditional
  feature of ad and banner blocking and cookie management,
- <application>Privoxy</application> provides new features, some of them
currently under development:
+ <application>Privoxy</application> provides new features<![%p-not-stable;[,
some of them currently under development]]>:
 </para>
 
-<!--
- Include newfeatures.sgml here:
--->
-
-&newfeatures;
+<!-- Include newfeatures.sgml boilerplate here: -->
+ &newfeatures;
+<!-- end boilerplate -->
 
 </sect2>
 
@@ -148,72 +131,38 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="installation"><title>Installation</title>
 <para>
- <application>Privoxy</application> is available as raw source code, or
pre-compiled binaries. See the <ulink
- url="http://sourceforge.net/projects/ijbswa/">Privoxy Home Page</ulink>
- for binaries and current release info. <application>Privoxy</application>
- is also available via <ulink
+ <application>Privoxy</application> is available as raw source code (tarball 
or via CVS), or pre-compiled binaries for various platforms. See the <ulink
+ url="http://sourceforge.net/projects/ijbswa/">Privoxy Project Page</ulink> for
+ the most up to date release information.
<application>Privoxy</application> is also available via <ulink
  url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
- This is the recommended approach at this time. But please be aware that CVS 
- is constantly changing, and it may break in mysterious ways.
+ <![%p-not-stable;[This is the recommended approach at this time.]]> But
+ please be aware that CVS is constantly changing, and it may break in
+ mysterious ways.
 </para>
 
+<!-- Include supported.sgml boilerplate -->
+ &supported;
+<!-- end boilerplate -->
+
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect2 id="installation-source"><title>Source</title>
-<para>
- For gzipped tar archives, unpack the source:
-</para>
-
-<para>
- <screen>
- tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz]
- cd privoxy-2.9.13-beta
- </screen>
-</para>
-
-<para>
- For retrieving the current CVS sources, you'll need the CVS 
- package installed first. To download CVS source:
-</para>
-
-<para>
- <screen>
-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
-  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
-  cd current
- </screen>
-</para>
 
-<para>
- This will create a directory named <filename>current/</filename>, which will 
- contain the source tree.
-</para>
 
-<para>
- Then, in either case, to build from tarball/CVS source:
-</para>
-
-<para>
- <screen>
- ./configure      (--help to see options)
- make             (the make from gnu, gmake for *BSD) 
- su 
- make -n install  (to see where all the files will go)
- make install     (to really install)
- </screen>
-</para>
+<!-- include buildsource.sgml boilerplate: -->
+ &buildsource;
+<!-- end boilerplate -->
 
 <para>
  For Redhat and SuSE Linux RPM packages, see below.
 </para>
 
-</sect2>
-
 
 <!--   ~~~~~       New section      ~~~~~     -->
-<sect2 id="installation-rh"><title>Red Hat</title>
+<sect3 id="installation-rh"><title>Red Hat</title>
 <para>
- To build Redhat RPM packages, install source as above. Then:
+ To build Redhat RPM packages from source, install source as above. Then:
 </para>
 
 <para>
@@ -230,10 +179,10 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
 </para>
 
 <para>
- &nbsp;&nbsp;&nbsp;/usr/src/redhat/RPMS/i686/privoxy-2.9.11-1.i686.rpm
+ &nbsp;&nbsp;&nbsp;/usr/src/redhat/RPMS/i686/privoxy-&p-version;-1.i686.rpm
 </para>
 <para>
- &nbsp;&nbsp;&nbsp;/usr/src/redhat/SRPMS/privoxy-2.9.11-1.src.rpm
+ &nbsp;&nbsp;&nbsp;/usr/src/redhat/SRPMS/privoxy-&p-version;-1.src.rpm
 </para>
 
 <para>
@@ -242,20 +191,23 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
 
 <para>
  <screen>
- rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-2.9.11-1.i686.rpm
+ rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-&p-version;-1.i686.rpm
  </screen>
 </para>
 
 <para>
  This will place the <application>Privoxy</application> configuration 
  files in <filename>/etc/privoxy/</filename>, and log files in 
- <filename>/var/log/privoxy/</filename>.
+ <filename>/var/log/privoxy/</filename>. Run 
+ <command>ckconfig privoxy on</command> to have
+ <application>Privoxy</application> start automatically during init.
+
 </para>
 
-</sect2>
+</sect3>
 
 <!--   ~~~~~       New section      ~~~~~     -->
-<sect2 id="installation-suse"><title>SuSE</title>
+<sect3 id="installation-suse"><title>SuSE</title>
 <para>
  To build SuSE RPM packages, install source as above. Then:
 </para>
@@ -274,10 +226,10 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
 </para>
 
 <para>
- &nbsp;&nbsp;&nbsp;/usr/src/packages/RPMS/i686/privoxy-2.9.11-1.i686.rpm
+ &nbsp;&nbsp;&nbsp;/usr/src/packages/RPMS/i686/privoxy-&p-version;-1.i686.rpm
 </para>
 <para>
- &nbsp;&nbsp;&nbsp;/usr/src/packages/SRPMS/privoxy-2.9.11-1.src.rpm
+ &nbsp;&nbsp;&nbsp;/usr/src/packages/SRPMS/privoxy-&p-version;-1.src.rpm
 </para>
 
 <para>
@@ -286,21 +238,21 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
 
 <para>
  <screen>
- rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.11-1.i686.rpm
+ rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-&p-version;-1.i686.rpm
  </screen>
 </para>
 
 <para>
  This will place the <application>Privoxy</application> configuration 
  files in <filename>/etc/privoxy/</filename>, and log files in 
- <filename>/var/log/privoxy/</filename>.
+ <filename>/var/log/privoxy/</filename>. 
 </para>
 
-</sect2>
+</sect3>
 
 
 <!--   ~~~~~       New section      ~~~~~     -->
-<sect2 id="installation-os2"><title>OS/2</title>
+<sect3 id="installation-os2"><title>OS/2</title>
 
 <!--
 Thanx David Schmidt!
@@ -310,7 +262,7 @@ Thanx David Schmidt!
  <application>Privoxy</application> is packaged in a WarpIN self-
  installing archive.  The self-installing program will be named depending
  on the release version, something like:
- <filename>ijbos2_setup_1.2.3.exe</filename>.  In order to install it, simply
+ <filename>privoxyos2_setup_&p-version;.exe</filename>.  In order to install it, simply
  run this executable or double-click on its icon and follow the WarpIN
  installation panels.  A shadow of the <application>Privoxy</application>
  executable will be placed in your startup folder so it will start 
@@ -356,18 +308,18 @@ Thanx David Schmidt!
  You will see this sequence laid out in <filename>os2build.cmd</filename>.
 </para>
 
-</sect2>
+</sect3>
 
 
 <!--   ~~~~~       New section      ~~~~~     -->
-<sect2 id="installation-win"><title>Windows</title>
+<sect3 id="installation-win"><title>Windows</title>
 <para>Click-click. (I need help on this. Not a clue here. Also for 
 configuration section below. HB.)
 </para>
-</sect2>
+</sect3>
 
 <!--   ~~~~~       New section      ~~~~~     -->
-<sect2 id="installation-other"><title>Other</title>
+<sect3 id="installation-other"><title>Other</title>
 <para>
  Some quick notes on other Operating Systems.
 </para>
@@ -379,6 +331,7 @@ configuration section below. HB.)
  The rest should be the same as above for Linux/Unix.
 </para>
 
+</sect3>
 </sect2>
 
 </sect1>
@@ -392,7 +345,7 @@ configuration section below. HB.)
 <para>
  Before launching <application>Privoxy</application> for the first time, you 
  will want to configure your browser(s) to use <application>Privoxy</application>
- and the HTTP and HTTPS proxy. The default is localhost for the proxy address,
+ as a HTTP and HTTPS proxy. The default is localhost for the proxy address,
  and port 8118 (earlier versions used port 800). This is the one required 
  configuration that must be done! 
 </para>
@@ -401,7 +354,7 @@ configuration section below. HB.)
  With <application>Netscape</application> (and
  <application>Mozilla</application>), this can be set under <literal>Edit
  -&gt; Preferences -&gt; Advanced -&gt; Proxies -&gt; HTTP Proxy</literal>.
- For <application>Internet Explorer</application>: <literal>Tools &gt;
+ For <application>Internet Explorer</application>: <literal>Tools -&gt;
  Internet Properties -&gt; Connections -&gt; LAN Setting</literal>. Then,
  check <quote>Use Proxy</quote> and fill in the appropriate info (Address:
  localhost, Port: 8118). Include if HTTPS proxy support too.
@@ -606,7 +559,7 @@ For RedHat: /etc/rc.d/init.d/privoxy start
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="configuration"><title><application>Privoxy</application> Configuration</title>
  <para>
-  All <application>Privoxy</application> configuration is kept 
+  All <application>Privoxy</application> configuration is stored  
   in text files. These files can be edited with a text editor.
   Many important aspects of <application>Privoxy</application> can 
   also be controlled easily with a web browser.
@@ -706,7 +659,7 @@ Please choose from the following options:
     file that can be accessed via <ulink
     url="http://p.p">http://p.p</ulink>. (Other actions 
     files are included as well with differing levels of filtering 
-    and blocking, e.g. <filename>ijb-basic.action</filename>.)
+    and blocking, e.g. <filename>basic.action</filename>.)
    </para>
   </listitem> 
 
@@ -804,9 +757,9 @@ Please choose from the following options:
 
 <para>
  <application>Privoxy</application> can use a number of other files to tell it
- what ads to block, what cookies to accept, etc.  This section of the
- configuration file tells <application>Privoxy</application> where to find
- all those other files. 
+ what ads to block, what cookies to accept, and perform other functions.  This
+ section of the configuration file tells <application>Privoxy</application>
where to find all those other files. 
 </para>
 
 <para>
@@ -998,8 +951,8 @@ Please choose from the following options:
  <literal>
   <msgtext> 
    <literallayout>
-  <emphasis>trust-info-url http://www.your-site.com/why_we_block.html</emphasis>
-  <emphasis>trust-info-url http://www.your-site.com/what_we_allow.html</emphasis>
+  <emphasis>trust-info-url http://www.example.com/why_we_block.html</emphasis>
+  <emphasis>trust-info-url http://www.example.com/what_we_allow.html</emphasis>
    </literallayout>
   </msgtext> 
  </literal>
@@ -1050,7 +1003,7 @@ Please choose from the following options:
  <literal>
   <msgtext> 
    <literallayout>
-  <emphasis>proxy-info-url  http://www.your-site.com/proxy.html</emphasis>
+  <emphasis>proxy-info-url  http://www.example.com/proxy.html</emphasis>
    </literallayout>
   </msgtext> 
  </literal>
@@ -1809,7 +1762,8 @@ Please choose from the following options:
 </para>
 
 <para>
- Your squid configuration could then look like this:
+Your squid configuration could then look like this (assuming that the IP
+address of the box is <literal>192.168.0.1</literal> ):
 </para>
 
 <para>
@@ -1820,7 +1774,16 @@ Please choose from the following options:
  <!-- per feedback from user...
   cache_peer 127.0.0.1 8118 parent 0 no-query 
  --> 
-  cache_peer 127.0.0.1 parent 8118 0 no-query
+  cache_peer 192.168.0.1 parent 8118 0 no-query
+
+  # don't listen to the whole world
+  http_port 192.168.0.1:3128
+
+  # define the local lan
+  acl mylocallan src 192.168.0.1-192.168.0.5/255.255.255.255
+
+  # grant access for http to local lan
+  http_access allow mylocallan
   
   # Define ACL for protocol FTP 
   acl FTP proto FTP 
@@ -2028,19 +1991,33 @@ Removed references to Win32. HB 09/23/01
 
 <para>
  The <quote>default.action</quote> file (formerly
- <filename>actionsfile</filename> or <filename>ijb.action</filename>) is used to define what actions
- <application>Privoxy</application> takes, and thus determines how images,
- cookies and various other aspects of HTTP content and transactions are
- handled. Images can be anything you want, including ads, banners, or just
- some obnoxious URL that you would rather not see. Cookies can be accepted
- or rejected, or accepted only during the current browser session (i.e. 
- not written to disk). Changes to <filename>default.action</filename> should 
- be immediately visible to <application>Privoxy</application> without 
- the need to restart.
+ <filename>actionsfile</filename> or <filename>ijb.action</filename>) is used
+ to define what actions <application>Privoxy</application> takes, and thus
+ determines how ad images, cookies and various other aspects of HTTP content
+ and transactions are handled. These can be accepted or rejected for all
+ sites, or just those sites you choose. See below for a complete list of 
+ actions. 
+</para>
+<para> 
+ Anything you want can blocked, including ads, banners, or just some obnoxious
+ URL that you would rather not see. Cookies can be accepted or rejected, or
+ accepted only during the current browser session (i.e. not written to disk).
+ Changes to <filename>default.action</filename> should be immediately visible
+ to <application>Privoxy</application> without the need to restart.
 </para>
 
 <para>
- The easiest way to edit <quote>actions</quote> file is with a browser by
+ Note that some sites may misbehave, or possibly not work at all with some 
+ actions. This may require some tinkering with the rules to get the most 
+ mileage of <application>Privoxy's</application> features, and still be 
+ able to see and enjoy just what you want to. There is no general rule of
+ thumb on these things. There just are too many variables, and sites are 
+ always changing.
+
+</para>
+
+<para>
+ The easiest way to edit the <quote>actions</quote> file is with a browser by
  loading <ulink url="http://p.p/">http://p.p/</ulink>, and then select
  <quote>Edit Actions List</quote>. A text editor can also be used.
 </para>
@@ -2087,8 +2064,9 @@ Removed references to Win32. HB 09/23/01
 </para>
 
 <para>
- <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>, regardless of
- the domain.
+ <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>, 
+ regardless of the domain. So would match any page named <quote>index.html</quote>
+ on any site.
 </para>
 
 <para>
@@ -2104,8 +2082,8 @@ Removed references to Win32. HB 09/23/01
 </para>
 
 <para>
- <emphasis>.example.com</emphasis> - matches any domain that <emphasis>ENDS</emphasis> in 
- <quote>.example.com</quote>.
+ <emphasis>.example.com</emphasis> - matches any domain or sub-domain that
+ <emphasis>ENDS</emphasis> in <quote>.example.com</quote>.
 </para>
 
 <para>
@@ -2144,8 +2122,9 @@ Removed references to Win32. HB 09/23/01
 
 <para>
  If <application>Privoxy</application> was compiled with
- <quote>pcre</quote> support (default), Perl compatible regular expressions
- can be used. See the <filename>pcre/docs/</filename> directory or <quote>man
+ <quote>pcre</quote> support (the default), Perl compatible regular expressions
+ can be used. These are more flexible and powerful than other types 
+ of <quote>regular expressions</quote>. See the <filename>pcre/docs/</filename> directory or <quote>man
  perlre</quote> (also available on  <ulink
  url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
  for details. A brief discussion of regular expressions is in the 
@@ -2259,8 +2238,10 @@ Removed references to Win32. HB 09/23/01
 </para>
 
 <para>
- Later defined actions always over-ride earlier ones.  For multi-valued
- actions, the actions are applied in the order they are specified.
+ Later defined actions always over-ride earlier ones.  So exceptions 
+ to any rules you make, should come in the latter part of the file. For
+ multi-valued actions, the actions are applied in the order they are
+ specified.
 </para>
 
 <para>
@@ -2291,7 +2272,9 @@ Removed references to Win32. HB 09/23/01
   <para>  
    Block this URL totally. In a default installation, a <quote>blocked</quote>
    URL will result in bright red banner that says <quote>BLOCKED</quote>, 
-   with a reason why it is being blocked. 
+   with a reason why it is being blocked, and an option to see it anyway.
+   The page displayed for this is the <quote>blocked</quote> template 
+   file.
   </para>
   <para>
    <literal>
@@ -2384,7 +2367,9 @@ Removed references to Win32. HB 09/23/01
    Apply the filters in the <literal>section_header</literal> 
    section of the <filename>default.filter</filename> file to the site(s).
    <filename>default.filter</filename> sections are grouped according to like
-   functionality. 
+   functionality. <application>Filters</application> can be used to 
+   re-write any of the raw page content. This is a potentially a 
+   very powerful feature!
   </para> 
    
   <para>
@@ -2495,7 +2480,7 @@ Removed references to Win32. HB 09/23/01
    Don't send the <quote>Referer:</quote> (sic) header to the web site.  You
    can block it, forge a URL to the same server as the request (which is
    preferred because some sites will not send images otherwise) or set it to a
-   constant string of your choice.
+   constant, user defined string of your choice.
   </para>
   <para>
    <literal>
@@ -2579,7 +2564,10 @@ Removed references to Win32. HB 09/23/01
    See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
    If you want <emphasis>invisible</emphasis> ads, they should be defined as 
    <emphasis>images</emphasis> and <emphasis>blocked</emphasis>. And also, 
-   <quote>image-blocker</quote>  should be set to <quote>blank</quote>.
+   <quote>image-blocker</quote>  should be set to <quote>blank</quote>. Note you 
+   cannot treat HTML pages as images in most cases. For instance, frames 
+   require an HTML page to display. Forcing an <quote>image</quote> in this 
+   situation just will not work.
   </para>
   <para>
    <literal>
@@ -2669,7 +2657,7 @@ icon being being cached by the browser, which will speed up the display.
    <application>Privoxy</application>, since <quote>+filter</quote>,
    <quote>+no-popup</quote> and <quote>+gif-deanimate</quote> will not work on
    compressed data. This will slow down connections to those websites,
-   though. Default is <quote>nocompression</quote> is turned on.
+   though. Default is <quote>no-compression</quote> is turned on.
   </para>
 
   <para>
@@ -2873,9 +2861,9 @@ icon being being cached by the browser, which will speed up the display.
 </para>
 
 <para>
- Now some URLs that we want <quote>blocked</quote>, ie we won't see them.
- Many of these use regular expressions that will expand to match multiple 
- URLs:
+ Now some URLs that we want <quote>blocked</quote> (normally generates 
+ the <quote>blocked</quote> banner). Many of these use regular expressions
that will expand to match multiple URLs:
 </para>
 
 <para>
@@ -2959,7 +2947,7 @@ icon being being cached by the browser, which will speed up the display.
  <quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
  <quote>-</quote>. Alias names are not case sensitive, and 
  <emphasis>must be defined  before anything</emphasis> else in the
- <filename>default.action</filename>file ! And there can only be one set of
+ <filename>default.action</filename>file! And there can only be one set of
  <quote>aliases</quote> defined.
 </para>
 
@@ -3022,6 +3010,13 @@ icon being being cached by the browser, which will speed up the display.
  </literal>
 </para>
 
+<para>
+ The <quote>shop</quote> and <quote>fragile</quote> aliases are often used for 
+ <quote>problem</quote> sites that require most actions to be disabled 
+ in order to function properly.
+
+</para>
+
 </sect3>
 </sect2>
 
@@ -3038,12 +3033,18 @@ icon being being cached by the browser, which will speed up the display.
  <filename>default.filter</filename>, located in the config directory. 
 </para>
 
+<para>
+ This is potentially a very powerful feature, and requires knowledge of both 
+ <quote>regular expression</quote> and HTML in order create custom 
+ filters. But, there are a number of useful filters included with 
+ <application>Privoxy</application> for many common situations.
+</para>
+
 <para>
  The included example file is divided into sections. Each section begins 
  with the <literal>FILTER</literal> keyword, followed by the identifier 
  for that section, e.g. <quote>FILTER: webbugs</quote>. Each section performs
  a similar type of filtering, such as <quote>html-annoyances</quote>.
-
 </para>
 
 <para>
@@ -3138,6 +3139,11 @@ icon being being cached by the browser, which will speed up the display.
  On Linux, BSD, and Unix, these are located in
  <filename>/etc/privoxy/templates</filename> by default. These may be
  customized, if desired.
+</para>
+<para>
+ The default <quote>Blocked</quote> banner page with the bright red top 
+ banner, is called just <quote><filename>blocked</filename></quote>. This 
+ may be customized or replaced with something else if desired.
 
 </para>
 </sect2>
@@ -3152,50 +3158,12 @@ icon being being cached by the browser, which will speed up the display.
 
 <sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
 Requests</title>
-<para>
-We value your feedback. However, to provide you with the best support,
-please note:
-
- <itemizedlist>
 
-  <listitem><para>Use the <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118">Sourceforge support forum</ulink> to get
-  help.</para></listitem>
-  <listitem><para>Submit bugs only thru our <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=111118">Sourceforge bug
-      forum</ulink>. 
-  </para>
-  <para>
-   Make sure that the bug has not already been submitted.  Please try to
-   verify that it is a <application>Privoxy</application> bug, and not a
-   browser or site bug first. If you are using your own custom configuration,
-   please try the stock configs to see if the problem is a configuration
-   related bug.  And if not using the latest development snapshot, please try
-   the latest one. Or even better, CVS sources. Please be sure to include the
-   <application>Privoxy</application>/<application>Junkbuster</application>
-   version, platform, browser, any pertinent log data, any other relevant
-   details (please be specific) and, if possible, some way to reproduce the
-   bug.
-  </para>
- </listitem>
-  <listitem><para>Submit feature requests only thru our <ulink
-      url="http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118&#38;func=browse">Sourceforge feature request forum</ulink>.</para></listitem>
-
-
- </itemizedlist>
-
-</para>
+<!-- Include contacting.sgml boilerplate: -->
 
-<para>
-For any other issues, feel free to use the <ulink url="http://sourceforge.net/mail/?group_id=11118">mailing lists</ulink>.
-</para>
+ &contacting;
 
-<para>
- Anyone interested in actively participating in development and related 
- discussions can join the appropriate mailing list  
- <ulink url="http://sourceforge.net/mail/?group_id=11118">here</ulink>.
- Archives are available here too.
-</para>
+<!-- end boilerplate -->
 
 </sect1>
 
@@ -3203,24 +3171,10 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="copyright"><title>Copyright and History</title>
 
-<sect2>
-<title>License</title>
-<para>
- <application>Privoxy</application> is free software; you can
- redistribute it and/or modify it under the terms of the GNU General Public
- License as published by the Free Software Foundation; either version 2 of the
- License, or (at your option) any later version.
-</para>
-
-<para>
- This program is distributed in the hope that it will be useful, but WITHOUT
- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
- details, which is available from <ulink
- url="http://www.gnu.org/copyleft/gpl.html">the Free Software Foundation,
- Inc</ulink>, 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-</para>
-
+<sect2><title>Copyright</title>
+<!-- Include copyright.sgml: -->
+ &copyright;
+<!-- end copyright -->
 </sect2>
 
 <!--  ~  End section  ~  -->
@@ -3228,74 +3182,18 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
 
 <!--   ~~~~~       New section      ~~~~~     -->
 
-<sect2 id="history">
-<title>History</title>
-<para>
- <application>Privoxy</application> is evolved, and derived from, 
- <application>the Internet Junkbuster</application>, with many 
- improvments and enhancements over the original.
-</para>
-
-<para>
- <application>Junkbuster</application> was originally written by Anonymous
- Coders and <ulink
- url="http://www.junkbusters.com">Junkbuster's
- Corporation</ulink>, and was released as free open-source software under the
- GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
- Waldherr</ulink> made many improvements, and started the <ulink
- url="http://sourceforge.net/projects/ijbswa/">SourceForge project
- Privoxy</ulink> to rekindle development. There are now several active
- developers contributing.  The last stable release of
- <application>Junkbuster</application> was v2.0.2, which has now
- grown whiskers ;-).
-</para>
-
+<sect2 id="history"><title>History</title>
+<!-- Include history.sgml: -->
+ &history;
+<!-- end history -->
 </sect2>
-
 </sect1>
 
 <!--   ~~~~~       New section      ~~~~~     -->
-<sect1 id="seealso"><title>See also</title>
-<para>
- <simplelist>
-  <member>
-   &nbsp; <ulink url="http://sourceforge.net/projects/ijbswa">http://sourceforge.net/projects/ijbswa</ulink>, 
-   the Project Page for <application>Privoxy</application>.
-  </member>
- </simplelist>
- <simplelist>
-  <member>
-   &nbsp; <ulink url="http://www.privoxy.org/">http://www.privoxy.org/</ulink>
-  </member>
- </simplelist>
- <simplelist>
-  <member>
-   &nbsp; <ulink url="http://p.p/">http://p.p/</ulink>
-  </member>
- </simplelist>
- <simplelist>
-  <member>
-   &nbsp; <ulink url="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</ulink>
-  </member>
- </simplelist>
- <simplelist>
-  <member>
-   &nbsp; <ulink url="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</ulink>
-  </member>
- </simplelist>
- <simplelist>
-  <member>
-   &nbsp; <ulink url="http://privacy.net/analyze/">http://privacy.net/analyze/</ulink>
-  </member>
- </simplelist>
- <simplelist>
-  <member>
-   &nbsp;<ulink url="http://www.squid-cache.org/">http://www.squid-cache.org/</ulink>
-  </member>
- </simplelist>
-
-</para>
+<sect1 id="seealso"><title>See Also</title>
+<!-- Include seealso.sgml: -->
+ &seealso;
+<!-- end seealso -->
 </sect1>
 
 
@@ -3941,7 +3839,8 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
 </para>
 
 <para>
- Now the page displays ;-)
+ Now the page displays ;-) Be sure to flush your browser's caches when 
+ making such changes. Or, try using <literal>Shift+Reload</literal>.
 
 </para>
 
@@ -3998,6 +3897,13 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
  </screen>
 </para>
 
+<para>
+ <quote>{fragile}</quote> is an alias that disables most actions. This can be 
+ used as a last resort for problem sites. Remember to flush caches! If this 
+ still does not work, you will have to go through the remaining actions one by
+ one to find which one(s) is causing the problem.
+</para>
+
 </sect2>
 
 </sect1>
@@ -4023,6 +3929,22 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
  $Log: user-manual.sgml,v $
+ Revision 1.66  2002/04/04 06:48:37  hal9
+ Structural changes to allow for conditional inclusion/exclusion of content
+ based on entity toggles, e.g. 'entity % p-not-stable  "INCLUDE"'. And
+ definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
+ eventually be set by Makefile.
+ More boilerplate text for use across multiple docs.
+
+ Revision 1.65  2002/04/03 19:52:07  swa
+ enhance squid section due to user suggestion
+
+ Revision 1.64  2002/04/03 03:53:43  hal9
+ A few minor bug fixes, and touch ups. Ready for review.
+
+ Revision 1.63  2002/04/01 16:24:49  hal9
+ Define entities to include boilerplate text. See doc/source/*.
+
  Revision 1.62  2002/03/30 04:15:53  hal9
  - Fix privoxy.org/config links.
  - Paste in Bookmarklets from Toggle page.