Fix link to Thomas's page (was 404).
[privoxy.git] / doc / source / user-manual.sgml
index b719408..1e9723e 100644 (file)
@@ -6,10 +6,10 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: user-manual.sgml,v 1.55 2002/03/24 16:08:08 swa Exp $
+ $Id: user-manual.sgml,v 1.59 2002/03/27 00:54:33 hal9 Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
- Privoxy team.  http://ijbswa.sourceforge.net
+ Privoxy team. http://www.privoxy.org/
 
  Based on the Internet Junkbuster originally written
  by and Copyright (C) 1997 Anonymous Coders and 
@@ -28,7 +28,7 @@ Hal Burgiss <hal@foobox.net>
 <artheader>
 <title>Privoxy User Manual</title>
 
-<pubdate>$Id: user-manual.sgml,v 1.55 2002/03/24 16:08:08 swa Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.59 2002/03/27 00:54:33 hal9 Exp $</pubdate>
 
 <authorgroup>
  <author>
@@ -51,7 +51,7 @@ Hal Burgiss <hal@foobox.net>
   stand-alone systems and multi-user networks.
  </para>
  <para>
-You can find the latest version of the user manual at  <ulink url="http://ijbswa.sourceforge.net/user-manual/">http://ijbswa.sourceforge.net/user-manual/</ulink>.
+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> -->
@@ -66,13 +66,28 @@ You can find the latest version of the user manual at  <ulink url="http://ijbswa
 
 <sect1 id="introduction"><title>Introduction</title>
 <para>
- <application>Privoxy</application> is a web proxy with advanced
- filtering capabilities for protecting privacy, filtering and modifying 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.
+ <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>
@@ -234,8 +249,8 @@ You can find the latest version of the user manual at  <ulink url="http://ijbswa
 
 <para>
  <screen>
- tar xzvf ijb_source_* [.tgz or .tar.gz]
- cd ijb_source_2.9.11_beta
+ tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz]
+ cd privoxy-2.9.13-beta
  </screen>
 </para>
 
@@ -472,7 +487,7 @@ configuration section below. HB.)
 <para>
  <application>Privoxy</application> can be reached by the special 
  URL <ulink url="http://p.p/">http://p.p/</ulink> (or alternately
- <ulink url="http://ijbswa.sourceforge.net/config/">http://ijbswa.sourceforge.net/config/</ulink>), 
+ <ulink url="http://www.privoxy.org/config/">http://www.privoxy.org/config/</ulink>), 
  which is an internal page. You will see the following section:
 
 </para>
@@ -1403,7 +1418,7 @@ Please choose from the following options:
 
 <!--   ~~~~~       New section      ~~~~~     -->
 
-<sect3>
+<sect3 id="forwarding">
 <title>Forwarding</title>
 
 <para>
@@ -1879,7 +1894,7 @@ Removed references to Win32. HB 09/23/01
 
 <para>
  The <quote>default.action</quote> file (formerly
- <filename>actionsfile</filename>) is used to define what actions
+ <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
@@ -3272,16 +3287,23 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
 
 <sect2>
 <title>History</title>
+<para>
+ <application>Privoxy</application> is 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/ht/en/ijbfaq.html">Junkbuster's
+ 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 was v2.0.2, which has now
+ developers contributing.  The last stable release of
+ <application>Junkbuster</application> was v2.0.2, which has now
  grown whiskers ;-).
 </para>
 
@@ -3300,7 +3322,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
  </simplelist>
  <simplelist>
   <member>
-   &nbsp; <ulink url="http://ijbswa.sourceforge.net/">http://ijbswa.sourceforge.net/</ulink>
+   &nbsp; <ulink url="http://www.privoxy.org/">http://www.privoxy.org/</ulink>
   </member>
  </simplelist>
  <simplelist>
@@ -3604,7 +3626,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
   </para>
   <blockquote>
    <para> 
-     <ulink url="http://ijbswa.sourceforge.net/config/">http://ijbswa.sourceforge.net/config/</ulink>
+     <ulink url="http://www.privoxy.org/config/">http://www.privoxy.org/config/</ulink>
    </para>
   </blockquote>
   <para>
@@ -3620,7 +3642,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
   </para>
    <blockquote>
    <para> 
-    <ulink url="http://ijbswa.sourceforge.net/config/show-status">http://ijbswa.sourceforge.net/config/show-status</ulink>
+    <ulink url="http://www.privoxy.org/config/show-status">http://www.privoxy.org/config/show-status</ulink>
    </para>
   </blockquote>
  </listitem>
@@ -3631,7 +3653,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
   </para>
   <blockquote>
    <para> 
-    <ulink url="http://ijbswa.sourceforge.net/config/show-version">http://ijbswa.sourceforge.net/config/show-version</ulink>
+    <ulink url="http://www.privoxy.org/config/show-version">http://www.privoxy.org/config/show-version</ulink>
    </para>
   </blockquote>
  </listitem>
@@ -3642,7 +3664,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
   </para>
   <blockquote>
    <para> 
-    <ulink url="http://ijbswa.sourceforge.net/config/show-request">http://ijbswa.sourceforge.net/config/show-request</ulink>
+    <ulink url="http://www.privoxy.org/config/show-request">http://www.privoxy.org/config/show-request</ulink>
    </para>
   </blockquote>
  </listitem>
@@ -3653,7 +3675,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
   </para>
    <blockquote>
    <para> 
-    <ulink url="http://ijbswa.sourceforge.net/config/show-url-info">http://ijbswa.sourceforge.net/config/show-url-info</ulink>
+    <ulink url="http://www.privoxy.org/config/show-url-info">http://www.privoxy.org/config/show-url-info</ulink>
    </para>
   </blockquote>
  </listitem>
@@ -3664,7 +3686,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
   </para>
    <blockquote>
    <para> 
-    <ulink url="http://ijbswa.sourceforge.net/config/toggle">http://ijbswa.sourceforge.net/config/toggle</ulink>
+    <ulink url="http://www.privoxy.org/config/toggle">http://www.privoxy.org/config/toggle</ulink>
    </para>
   </blockquote>
   <para>
@@ -3672,12 +3694,12 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
   </para>
    <blockquote>
    <para> 
-     <ulink url="http://ijbswa.sourceforge.net/config/toggle?set=disable">http://ijbswa.sourceforge.net/config/toggle?set=disable</ulink>
+     <ulink url="http://www.privoxy.org/config/toggle?set=disable">http://www.privoxy.org/config/toggle?set=disable</ulink>
    </para>
   </blockquote>
    <blockquote>
    <para> 
-     <ulink url="http://ijbswa.sourceforge.net/config/toggle?set=enable">http://ijbswa.sourceforge.net/config/toggle?set=enable</ulink>
+     <ulink url="http://www.privoxy.org/config/toggle?set=enable">http://www.privoxy.org/config/toggle?set=enable</ulink>
    </para>
   </blockquote>
  </listitem>
@@ -3688,7 +3710,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
   </para>
    <blockquote>
    <para> 
-    <ulink url="http://ijbswa.sourceforge.net/config/edit-actions">http://ijbswa.sourceforge.net/config/edit-actions</ulink>
+    <ulink url="http://www.privoxy.org/config/edit-actions">http://www.privoxy.org/config/edit-actions</ulink>
    </para>
   </blockquote>
  </listitem>
@@ -3718,7 +3740,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
  the actions files themselves, since they tend to be filled with 
  <quote>regular expressions</quote> whose consequences are not always 
  so obvious. <application>Privoxy</application> provides the 
- <ulink url="http://ijbswa.sourceforge.net/config/show-url-info">http://ijbswa.sourceforge.net/config/show-url-info</ulink>
+ <ulink url="http://www.privoxy.org/config/show-url-info">http://www.privoxy.org/config/show-url-info</ulink>
  page that can show us very specifically how <application>actions</application>
  are being applied to any given URL. This is a big help for troubleshooting.
  </para>
@@ -3726,8 +3748,8 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
 <para>
  First, enter one URL (or partial URL) at the prompt, and then
  <application>Privoxy</application> will tell us 
- how current configuration will handle it. This will not
- help with filtering effects from the <filename>default.filter</filename>! It
+ how the current configuration will handle it. This will not
+ help with filtering effects from the <filename>default.filter</filename> file! It
  also will not tell you about any other URLs that may be embedded within the
  URL you are testing. For instance, images such as ads are expressed as URLs
  within the raw page source of HTML pages. So you will only get info for the
@@ -3920,6 +3942,59 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
 
 </para>
 
+<para>
+ But now what about a situation where we get no explicit matches like 
+ we did with:
+
+</para>
+
+<para>
+ <screen>
+
+ { -block }
+  /adsl
+ </screen>
+</para>
+
+<para>
+ That actually was very telling and pointed us quickly to where the problem
+ 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>:
+</para>
+
+<para>
+ <screen>
+
+ {shop}
+ .quietpc.com
+ .worldpay.com   # for quietpc.com
+ .jungle.com
+ .scan.co.uk
+ .forbes.com
+ </screen>
+</para>
+
+<para>
+ <quote>{shop}</quote> is an <quote>alias</quote> that expands to 
+ <quote>{ -filter -no-cookies -no-cookies-keep }</quote>. Or you could do 
+ your own exception to negate filtering:
+
+</para>
+
+<para>
+ <screen>
+
+ {-filter}
+ .forbes.com
+ </screen>
+</para>
+
 </sect2>
 
 </sect1>
@@ -3945,6 +4020,18 @@ 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.59  2002/03/27 00:54:33  hal9
+ Touch up intro for new name.
+
+ Revision 1.58  2002/03/26 22:29:55  swa
+ we have a new homepage!
+
+ Revision 1.57  2002/03/24 20:33:30  hal9
+ A few minor catch ups with name change.
+
+ Revision 1.56  2002/03/24 16:17:06  swa
+ configure needs to be generated.
+
  Revision 1.55  2002/03/24 16:08:08  swa
  we are too lazy to make a block-built
  privoxy logo. hence removed the option.