From: hal9 <hal9@users.sourceforge.net>
Date: Sun, 9 Jun 2002 00:29:34 +0000 (+0000)
Subject: Touch ups on filtering, in actions section and Anatomy.
X-Git-Tag: v_2_9_16~44
X-Git-Url: http://www.privoxy.org/gitweb/-%22http:/sourceforge.net/static/git-logo.png?a=commitdiff_plain;h=dbcd58a59bb5d209f7378c4d1d678779728c2ae8;p=privoxy.git

Touch ups on filtering, in actions section and Anatomy.
---

diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index 21858150..a2a9823a 100644
--- a/doc/source/user-manual.sgml
+++ b/doc/source/user-manual.sgml
@@ -32,7 +32,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
 
- $Id: user-manual.sgml,v 1.123.2.5 2002/05/29 02:01:02 hal9 Exp $
+ $Id: user-manual.sgml,v 1.123.2.6 2002/06/06 23:11:03 hal9 Exp $
 
  Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
  See LICENSE.
@@ -58,7 +58,7 @@
  </subscript>
 </pubdate>
 
-<pubdate>$Id: user-manual.sgml,v 1.123.2.5 2002/05/29 02:01:02 hal9 Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.123.2.6 2002/06/06 23:11:03 hal9 Exp $</pubdate>
 
 <!--
 
@@ -2331,8 +2331,9 @@ problem-host.example.com</screen>
   <term>Effect:</term>
   <listitem>
    <para>
-    Text documents, including HTML and JavaScript, to which this action applies, are filtered on-the-fly
-    through the specified regular expression based substitutions.    
+    Text documents, including HTML and JavaScript, to which this action
+    applies, are filtered on-the-fly through the specified regular expression
+    based substitutions.
    </para>
   </listitem>
  </varlistentry>
@@ -2352,7 +2353,15 @@ problem-host.example.com</screen>
     The name of a filter, as defined in the <link linkend="filter-file">filter file</link>
     (typically <filename>default.filter</filename>, set by the
     <literal><link linkend="filterfile">filterfile</link></literal>
-    option in the <link linkend="config">config file</link>)
+    option in the <link linkend="config">config file</link>). Filtering 
+    can be completely disabled without the use of parameters. Example:
+   </para>
+   <para>
+    <screen>  { -filter }
+     .example.com</screen>
+   </para>
+   <para>
+    Disables filters for that site.
    </para>
   </listitem>
  </varlistentry>
@@ -2361,8 +2370,8 @@ problem-host.example.com</screen>
   <term>Notes:</term>
   <listitem>
    <para>
-    For your convenience, there are a bunch of pre-defined filters available 
-    in the distribution filter file that you can use. See the example below for
+    For your convenience, there are a number of pre-defined filters available 
+    in the distribution filter file that you can use. See the examples below for
     a list.
    </para>
    <para>
@@ -2376,6 +2385,13 @@ problem-host.example.com</screen>
     since the page is not incrementally displayed.) This effect will be more
     noticeable on slower connections.
    </para>
+   <para>
+    The amount of data that can be filtered is limited to the 
+    <literal><link linkend="buffer-limit">buffer-limit</link></literal>
+    option in the main <link linkend="config">config file</link>. The 
+    default is 4096 KB (4 Megs). Once this limit is exceeded, the buffered
+    data, and all pending data, is passed through unfiltered.
+   </para>
    <para>
     At this time, <application>Privoxy</application> cannot (yet!) uncompress compressed
     documents. If you want filtering to work on all documents, even those that
@@ -2384,13 +2400,16 @@ problem-host.example.com</screen>
     action in conjunction with <literal>filter</literal>.
    </para>
    <para>
-    Filtering can achieve some of the effects as the 
+    Filtering can achieve some of the same effects as the 
     <literal><link linkend="block">block</link></literal>
-    action, i.e. it can be used to block ads and banners. 
+    action, i.e. it can be used to block ads and banners. But the mechanism 
+    works quite differently. One effective use, is to block ad banners 
+    based on their size (see below), since many of these seem to be somewhat 
+    standardized.
    </para>
    <para>
-    <link linkend="contact">Feedback</link> with suggestions for new or improved filters is particularly
-    welcome!
+    <link linkend="contact">Feedback</link> with suggestions for new or
+    improved filters is particularly welcome!
    </para>
   </listitem>
  </varlistentry>
@@ -2408,7 +2427,7 @@ problem-host.example.com</screen>
    </para>
    <para>
     <anchor id="filter-banners-by-size">
-    <screen>+filter{banners-by-size}     # Kill banners by size (<emphasis>very</emphasis> efficient!)</screen>
+    <screen>+filter{banners-by-size}     # Kill banners based on their size for this page (<emphasis>very</emphasis> efficient!)</screen>
    </para>
    <para>
     <anchor id="filter-content-cookies">
@@ -4393,7 +4412,7 @@ s/microsoft(?!\.com)/MicroSuck/ig</screen>
  Note the <literal>(?!\.com)</literal> part (a so-called negative lookahead)
  in the job's pattern, which means: Don't match, if the string 
  <quote>.com</quote> appears directly following <quote>microsoft</quote>
- in the page. This prevents links to microsoft.com from being messed, while
+ in the page. This prevents links to microsoft.com from being trashed, while
  still replacing the word everywhere else.
 </para>
 
@@ -5143,7 +5162,8 @@ Requests</title>
  One quick test to see if <application>Privoxy</application> is causing a problem 
  or not, is to disable it temporarily. This should be the first troubleshooting 
  step. See <link linkend="bookmarklets">the Bookmarklets</link> section on a quick 
- and easy way to do this (be sure to flush caches afterward!).
+ and easy way to do this (be sure to flush caches afterward!). Looking at the 
+ logs is a good idea too.
 </para>
 
 <para>
@@ -5439,8 +5459,9 @@ In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibut
  was. If you don't get this kind of match, then it means one of the default 
  rules in the first section is causing the problem. This would require some 
  guesswork, and maybe a little trial and error to isolate the offending rule.
- One likely cause would be one of the <quote>{+filter}</quote> actions. Try 
- adding the URL for the site to one of aliases that turn off <quote>+filter</quote>:
+ One likely cause would be one of the <quote>{+filter}</quote> actions. These 
+ tend to be harder to troubleshoot. Try adding the URL for the site to one of
+ aliases that turn off <quote>+filter</quote>:
 </para>
 
 <para>
@@ -5471,8 +5492,16 @@ In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibut
 </para>
 
 <para>
- This would probably be most appropriately put in <filename>user.action</filename>, 
- for local site exceptions.
+ This would turn off all filtering for that site. This would probably be most
+ appropriately put in <filename>user.action</filename>, for local site
+ exceptions.
+</para>
+
+<para>
+ Images that are inexplicably being blocked, may well be hitting the 
+ <quote>+filter{banners-by-size}</quote> rule, which assumes 
+ that images of certain sizes are ad banners (works well most of the time 
+ since these tend to be standardized).
 </para>
 
 <para>
@@ -5507,6 +5536,9 @@ In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibut
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
  $Log: user-manual.sgml,v $
+ Revision 1.123.2.6  2002/06/06 23:11:03  hal9
+ Fix broken link. Linkchecked all docs.
+
  Revision 1.123.2.5  2002/05/29 02:01:02  hal9
  This is break out of the entire config section from u-m, so it can
  eventually be used to generate the comments, etc in the main config file