Sync with filtering clarifications in 3.0 branch.

diff --git a/doc/source/faq.sgml b/doc/source/faq.sgml
index fa0d6e3..a11bf15 100644 (file)
--- a/doc/source/faq.sgml
+++ b/doc/source/faq.sgml
@@ -24,7 +24,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 

- $Id: faq.sgml,v 1.62 2002/06/03 00:28:16 hal9 Exp $
+ $Id: faq.sgml,v 1.63 2002/06/05 00:31:55 hal9 Exp $

 
  Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
  See LICENSE.
 
  Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
  See LICENSE.


@@ -70,7 +70,7 @@
  </subscript>
 </pubdate>
 
  </subscript>
 </pubdate>
 

-<pubdate>$Id: faq.sgml,v 1.62 2002/06/03 00:28:16 hal9 Exp $</pubdate>
+<pubdate>$Id: faq.sgml,v 1.63 2002/06/05 00:31:55 hal9 Exp $</pubdate>

 
 <!--
 
 
 <!--
 


@@ -112,7 +112,7 @@ Hal.
  This FAQ gives quick answers to frequently asked  questions about
  <ulink url="http://www.privoxy.org/">Privoxy</ulink> 
  <![%p-stable;[ v.&p-version]]>. It can't and doesn't replace the
  This FAQ gives quick answers to frequently asked  questions about
  <ulink url="http://www.privoxy.org/">Privoxy</ulink> 
  <![%p-stable;[ v.&p-version]]>. It can't and doesn't replace the

- <ulink url="../user-manual/index.html">user manual</ulink>.
+ <ulink url="../user-manual/index.html"><citetitle>User Manual</citetitle></ulink>.

  </para>
 
 <!-- Include privoxy.sgml boilerplate: -->
  </para>
 
 <!-- Include privoxy.sgml boilerplate: -->


@@ -122,7 +122,8 @@ Hal.
  <para>
   You can find the latest version of the document at <ulink
   url="http://www.privoxy.org/faq/">http://www.privoxy.org/faq/</ulink>.
  <para>
   You can find the latest version of the document at <ulink
   url="http://www.privoxy.org/faq/">http://www.privoxy.org/faq/</ulink>.

-  Please see the Contact section if you want to contact the developers.
+  Please see the <link linkend="contact">Contact section</link> if you want to
+  contact the developers. 

  </para>
 
 <!--   <para> -->
  </para>
 
 <!--   <para> -->


@@ -463,7 +464,7 @@ All the ads are there. What's wrong?</title>
  the browser's caches to force a full re-reading of pages. You can verify 
  that <application>Privoxy</application> is running, and your browser 
  is correctly configured by entering the special URL: 
  the browser's caches to force a full re-reading of pages. You can verify 
  that <application>Privoxy</application> is running, and your browser 
  is correctly configured by entering the special URL: 

- <ulink url="http:/config.privoxy.org/">http://config.privoxy.org/</ulink>.
+ <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>.

  This should take you to a page titled <quote>This is Privoxy..</quote> with
  access to <application>Privoxy's</application> internal configuration.
  If you see this, then you are good to go. If you receive a page saying 
  This should take you to a page titled <quote>This is Privoxy..</quote> with
  access to <application>Privoxy's</application> internal configuration.
  If you see this, then you are good to go. If you receive a page saying 


@@ -600,7 +601,7 @@ the differences?</title>
 </sect2>
 
 <sect2 renderas="sect3" id="configfiles"> <title>What's the difference between the
 </sect2>
 
 <sect2 renderas="sect3" id="configfiles"> <title>What's the difference between the

-<quote>Cautious</quote>, <quote>Medium</quote> and <quote>Advenced</quote> defaults?</title>
+<quote>Cautious</quote>, <quote>Medium</quote> and <quote>Advanced</quote> defaults?</title>

  <para>
   Configuring <application>Privoxy</application> is not entirely trivial. To help you get
   started, we provide you with three different default action <quote>packages</quote> in
  <para>
   Configuring <application>Privoxy</application> is not entirely trivial. To help you get
   started, we provide you with three different default action <quote>packages</quote> in


@@ -761,20 +762,24 @@ with a browser? Does that not raise security issues?</title>
 <para>
  The <ulink url="../user-manual/filter-file.html"><filename>default.filter</filename></ulink>
  file is where <emphasis>filters</emphasis> are defined, which can be used to modify or
 <para>
  The <ulink url="../user-manual/filter-file.html"><filename>default.filter</filename></ulink>
  file is where <emphasis>filters</emphasis> are defined, which can be used to modify or

- remove, web page content on the fly. This applies to <emphasis>anything</emphasis>
+ remove, web page content on the fly. Filters apply to <emphasis>anything</emphasis>

  in the page source, including HTML tags, and JavaScript. Regular expressions are used
  to accomplish this. There are a number of pre-defined filters to deal with common
  annoyances. The filters are only defined here, to invoke them, you need to use the
  in the page source, including HTML tags, and JavaScript. Regular expressions are used
  to accomplish this. There are a number of pre-defined filters to deal with common
  annoyances. The filters are only defined here, to invoke them, you need to use the

- <ulink url="../user-manual/actions-file.html#FILTER"><literal>filter</literal> action</ulink>.
+ <ulink
+ url="../user-manual/actions-file.html#FILTER"><literal>filter</literal>
+ action</ulink> in one of the actions files. Filtering is automatically
+ disabled for inappropriate MIME types.

 </para>
 
 <para>
  If you are familiar with regular expressions, and HTML, you can look at 
  the provided <filename>default.filter</filename> with a text editor and define
  your own filters.  This is potentially a very powerful feature, but
 </para>
 
 <para>
  If you are familiar with regular expressions, and HTML, you can look at 
  the provided <filename>default.filter</filename> with a text editor and define
  your own filters.  This is potentially a very powerful feature, but

- requires some expertise. 
+ requires some expertise in both regular expressions and HTML/HTTP. 

 </para>
 
 </para>
 

+

 <para>
  Presently, there is no GUI editor option for this part of the configuration, 
  but you can disable/enable the various pre-defined filters of the included 
 <para>
  Presently, there is no GUI editor option for this part of the configuration, 
  but you can disable/enable the various pre-defined filters of the included 


@@ -1066,6 +1071,9 @@ delays in page requests compared to the old Junkbuster. What's wrong?</title>
  content, giving the user a feeling of "it works". This effect is especially
  noticeable on slow dialup connections.
  </para>
  content, giving the user a feeling of "it works". This effect is especially
  noticeable on slow dialup connections.
  </para>

+<para>
+ Filtering is automatically disabled for inappropriate MIME types.
+</para>

 </sect2>
 
 
 </sect2>
 
 


@@ -1358,15 +1366,32 @@ secure is it? Do I need to take any special precautions?</title>
 
 </sect2>
 
 
 </sect2>
 

+

 <sect2 renderas="sect3" id="turnoff">
 <title>How can I temporarily disable <application>Privoxy</application>?</title>
 <para>
  The easiest way is to access <application>Privoxy</application> with your 
  browser by using the remote toggle URL: <ulink
  url="http://config.privoxy.org/toggle">http://config.privoxy.org/toggle</ulink>.
 <sect2 renderas="sect3" id="turnoff">
 <title>How can I temporarily disable <application>Privoxy</application>?</title>
 <para>
  The easiest way is to access <application>Privoxy</application> with your 
  browser by using the remote toggle URL: <ulink
  url="http://config.privoxy.org/toggle">http://config.privoxy.org/toggle</ulink>.

+ See the <ulink url="../user-manual/appendix.html#BOOKMARKLETS">Bookmarklets section</ulink> 
+ of the <citetitle>User Manual</citetitle> for an easy way to access this 
+ feature.
+</para>
+</sect2>
+
+<sect2 renderas="sect3" id="reallyoff">
+<title>When <quote>disabled</quote> is <application>Privoxy</application> totally 
+out of the picture?</title>
+<para>
+ No, this just means all filtering and actions are disabled.
+ <application>Privoxy</application> is still acting as a proxy, but just not 
+ doing any of the things that <application>Privoxy</application> would
+ normally be expected to do. It is still a <quote>middle-man</quote> in 
+ the interaction between your browser and web sites.

 </para>
 </sect2>
 
 </para>
 </sect2>
 

+

 <sect2 renderas="sect3" id="seealso">
 <title>Where can I find more information about <application>Privoxy</application>
 and related issues?</title>
 <sect2 renderas="sect3" id="seealso">
 <title>Where can I find more information about <application>Privoxy</application>
 and related issues?</title>


@@ -1483,6 +1508,57 @@ What can I do?</title>
 
 </sect2>
 
 
 </sect2>
 

+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect2 id="dun">
+<title>After installing <application>Privoxy</application>, I have to log in
+every time I start IE. What gives?</title>
+
+<para>
+ This is a quirk that effects the installation of
+ <application>Privoxy</application>, in conjunction with Internet Explorer and
+ Internet Connection Sharing on Windows 2000 and Windows XP. The symptoms may
+ appear to be corrupted or invalid DUN settings, or passwords.
+</para>
+
+<para>
+ When setting up an NT based Windows system with
+ <application>Privoxy</application> you may find that things do not seem to be
+ doing what you expect. When you set your system up you will probably have set
+ up Internet Connection Sharing (ICS) with Dial up Networking (DUN) when
+ logged in with administrator privileges. You will probably have made this DUN
+ connection available to other accounts that you may have set-up on your
+ system. E.g. Mum or Dad sets up the system and makes accounts suitably
+ configured for the kids.
+</para>
+
+<para>
+ When setting up <application>Privoxy</application> in this environment you
+ will have to alter the proxy set-up of Internet Explorer (IE) for the
+ specific DUN connection on which you wish to use
+ <application>Privoxy</application>. When you do this the ICS DUN set-up
+ becomes user specific. In this instance you will see no difference if you
+ change the DUN connection under the account used to set-up the connection.
+ However when you do this from another user you will notice that the DUN
+ connection changes to make available to "Me only". You will also find that
+ you have to store the password under each different user!
+</para>
+
+<para>
+ The reason for this is that each user's set-up for IE is user specific. Each
+ set-up DUN connection and each LAN connection in IE store the settings for
+ each user individually. As such this enforces individual configurations
+ rather than common ones. Hence the first time you use a DUN connection after
+ re-booting your system it may not perform as you expect, and prompt you for 
+ the password. Just set and save the password again and all should be OK.
+</para>
+
+<para>
+[Thanks to Ray Griffith for this submission.]
+</para>
+</sect2>
+
+

 </sect1>
 <!--
 </sect1>
 </sect1>
 <!--
 </sect1>


@@ -1575,6 +1651,11 @@ FIXME: Commented out until we have something to put here. HB 03/18/02.
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 $Log: faq.sgml,v $
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 $Log: faq.sgml,v $

+Revision 1.63  2002/06/05 00:31:55  hal9
+Mass commit for new entities, most significantly so docs can read version
+and code status info from tmp files, so perl is no longer used. Also, docs can
+differentiate on alpha -> beta -> stable now.
+

 Revision 1.62  2002/06/03 00:28:16  hal9
 Sync with various changes from 3.0 branch. Add two new files for config stuff.
 
 Revision 1.62  2002/06/03 00:28:16  hal9
 Sync with various changes from 3.0 branch. Add two new files for config stuff.
 

diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index 76fcb62..7a9db75 100644 (file)
--- 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/
 
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
 

- $Id: user-manual.sgml,v 1.125 2002/06/03 00:28:17 hal9 Exp $
+ $Id: user-manual.sgml,v 1.126 2002/06/05 00:31:55 hal9 Exp $

 
  Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
  See LICENSE.
 
  Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
  See LICENSE.


@@ -58,7 +58,7 @@
  </subscript>
 </pubdate>
 
  </subscript>
 </pubdate>
 

-<pubdate>$Id: user-manual.sgml,v 1.125 2002/06/03 00:28:17 hal9 Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.126 2002/06/05 00:31:55 hal9 Exp $</pubdate>

 
 <!--
 
 
 <!--
 


@@ -2352,7 +2352,8 @@ 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>
     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.

    </para>
   </listitem>
  </varlistentry>
    </para>
   </listitem>
  </varlistentry>


@@ -2361,8 +2362,8 @@ problem-host.example.com</screen>
   <term>Notes:</term>
   <listitem>
    <para>
   <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>
     a list.
    </para>
    <para>


@@ -2376,6 +2377,14 @@ problem-host.example.com</screen>
     since the page is not incrementally displayed.) This effect will be more
     noticeable on slower connections.
    </para>
     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. Inappropriate 
+    MIME types are not filtered.
+   </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
    <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 +2393,16 @@ problem-host.example.com</screen>
     action in conjunction with <literal>filter</literal>.
    </para>
    <para>
     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>
     <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>
    </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>
    </para>
   </listitem>
  </varlistentry>


@@ -2408,7 +2420,7 @@ problem-host.example.com</screen>
    </para>
    <para>
     <anchor id="filter-banners-by-size">
    </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">
    </para>
    <para>
     <anchor id="filter-content-cookies">


@@ -4186,7 +4198,7 @@ another.popular.site.net/more/junk/here/</screen>
  in a syntax that imitates <ulink url="http://www.perl.org/">Perl</ulink>'s
  <literal>s///</literal> operator. If you are familiar with Perl, you
  will find this to be quite intuitive, and may want to look at the
  in a syntax that imitates <ulink url="http://www.perl.org/">Perl</ulink>'s
  <literal>s///</literal> operator. If you are familiar with Perl, you
  will find this to be quite intuitive, and may want to look at the

- <ulink url="http://www.oesterhelt.org/pcrs/pcrs.1.html">PCRS man page</ulink>
+ <ulink url="http://www.oesterhelt.org/pcrs/pcrs.3.html">PCRS man page</ulink>

  for the subtle differences to Perl behaviour. Most notably, the non-standard
  option letter <literal>U</literal> is supported, which turns the default
  to ungreedy matching.
  for the subtle differences to Perl behaviour. Most notably, the non-standard
  option letter <literal>U</literal> is supported, which turns the default
  to ungreedy matching.


@@ -4393,7 +4405,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>
  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>
 
  still replacing the word everywhere else.
 </para>
 


@@ -5143,7 +5155,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 
  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>
 </para>
 
 <para>


@@ -5439,8 +5452,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.
  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>
 </para>
 
 <para>


@@ -5471,8 +5485,16 @@ In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibut
 </para>
 
 <para>
 </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>
 </para>
 
 <para>


@@ -5507,6 +5529,11 @@ In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibut
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
  $Log: user-manual.sgml,v $
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
  $Log: user-manual.sgml,v $

+ Revision 1.126  2002/06/05 00:31:55  hal9
+ Mass commit for new entities, most significantly so docs can read version
+ and code status info from tmp files, so perl is no longer used. Also, docs can
+ differentiate on alpha -> beta -> stable now.
+

  Revision 1.125  2002/06/03 00:28:17  hal9
  Sync with various changes from 3.0 branch. Add two new files for config stuff.
 
  Revision 1.125  2002/06/03 00:28:17  hal9
  Sync with various changes from 3.0 branch. Add two new files for config stuff.
 

diff --git a/doc/source/webserver/index.sgml b/doc/source/webserver/index.sgml
index 6371814..8ba1697 100644 (file)
--- a/doc/source/webserver/index.sgml
+++ b/doc/source/webserver/index.sgml
@@ -20,7 +20,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 

- $Id: index.sgml,v 1.19 2002/06/03 00:28:17 hal9 Exp $
+ $Id: index.sgml,v 1.20 2002/06/05 00:31:55 hal9 Exp $

 
  Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
  See LICENSE.
 
  Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
  See LICENSE.


@@ -75,11 +75,12 @@
 
 <![%p-homepage;[
   <para>
 
 <![%p-homepage;[
   <para>

-   The most recent version is &p-version; (&p-status;). (Odd numbered versions 
-   are available only through CVS.)
+  <!-- FIXME: Temporarily hard coding this. HB.  -->
+   The most recent release is 2.9.14 (&p-status;). 

   </para>
 ]]>
 
   </para>
 ]]>
 

+

  </abstract>
 </artheader>
 
  </abstract>
 </artheader>
 


@@ -245,6 +246,11 @@
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
  $Log: index.sgml,v $
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
  $Log: index.sgml,v $

+ Revision 1.20  2002/06/05 00:31:55  hal9
+ Mass commit for new entities, most significantly so docs can read version
+ and code status info from tmp files, so perl is no longer used. Also, docs can
+ differentiate on alpha -> beta -> stable now.
+

  Revision 1.19  2002/06/03 00:28:17  hal9
  Sync with various changes from 3.0 branch. Add two new files for config stuff.
 
  Revision 1.19  2002/06/03 00:28:17  hal9
  Sync with various changes from 3.0 branch. Add two new files for config stuff.