-<!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<!--
-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
File : $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
Purpose : user manual
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.18 2001/10/24 18:45:26 hal9 Exp $
+ $Id: user-manual.sgml,v 1.51 2002/03/23 15:13:11 swa Exp $
Written by and Copyright (C) 2001 the SourceForge
- IJBSWA team. http://ijbswa.sourceforge.net
+ Privoxy team. http://ijbswa.sourceforge.net
Based on the Internet Junkbuster originally written
by and Copyright (C) 1997 Anonymous Coders and
-->
<!--
-Sun 09/23/01 08:53:31 PM
+Sat 03/02/02 04:53:47 PM
-This is an unfinished, rough draft. Anyone reading this, believe let me
-know errors!!!!! Stefan, especially you!
+This should be ready for BETA release.
Hal Burgiss <hal@foobox.net>
-->
<article id="index">
<artheader>
-<title>Junkbuster User Manual</title>
+<title>Privoxy User Manual</title>
-<pubdate>$Id: user-manual.sgml,v 1.18 2001/10/24 18:45:26 hal9 Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.51 2002/03/23 15:13:11 swa Exp $</pubdate>
<authorgroup>
<author>
<affiliation>
- <orgname>By: Junkbuster Developers</orgname>
+ <orgname>By: Privoxy Developers</orgname>
</affiliation>
</author>
</authorgroup>
<abstract>
<para>
- The user manual gives the users information on how to install and configure
- <application>Internet Junkbuster</application>. <application>Internet
- Junkbuster</application> is an application that provides privacy and
- security to users of the World Wide Web.
+ 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>
<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>.
</para>
- <para>
- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>.
- </para>
+<!-- <para> -->
+<!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
+<!-- </para> -->
</abstract>
</artheader>
<sect1 id="introduction"><title>Introduction</title>
<para>
- <application>Internet Junkbuster</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>Junkbuster</application> has a
- very flexible configuration and can be customized to suit individual needs
- and tastes. <application>Internet Junkbuster</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 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.
</para>
<para>
- This documentation is included with the current development version of
- <application>Internet Junkbuster</application> and is incomplete at this
+ This documentation is included with the current BETA 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
- of version 3.0 is currently underway, and includes many significant changes and
- enhancements over earlier verions. The target release date for stable v3.0 is
- December 2001.
+ of version 3.0 is currently nearing completion, and includes many significant
+ changes and enhancements over earlier versions. The target release date for
+ stable v3.0 is <quote>soon</quote> ;-)
</para>
<para>
- Since this is a development version, some features are in the process of
- being implemented. This documentation may be slightly out of sync as a
- result. And there <emphasis>are</emphasis> bugs, though hopefully not many!
+ Since this is a BETA 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>
<sect2>
<title>New Features</title>
<para>
- In addition to <application>Junkbuster's</application> traditional features
- of ad and banner blocking and cookie management, this is a list of new
- features currently under development:
+ 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:
</para>
+<!--
+ The section is in both user-manual and faq. Please keep in sync.
+-->
<para>
<itemizedlist>
<listitem>
<para>
- A browser based configuration utility (WIP at
- <ulink url="http://i.j.b">http://i.j.b</ulink>).
+ Integrated browser based configuration and control utility (<ulink
+ url="http://i.j.b">http://i.j.b</ulink>). Browser-based tracing of rule
+ and filter effects.
</para>
</listitem>
-
+<!--
<listitem>
<para>
Modularized configuration that will allow for system wide settings, and
- individual user settings. (not implemented yet)
+ individual user settings. (not implemented yet, probably a 3.1 feature)
</para>
</listitem>
-
+-->
<listitem>
<para>
- Blocking of annoying pop-up browser windows (previously available as a
- patch).
+ Blocking of annoying pop-up browser windows.
</para>
</listitem>
<listitem>
<para>
- Support for HTTP/1.1 (partially implemented at this point).
+ HTTP/1.1 compliant (most, but not all 1.1 features are supported).
</para>
</listitem>
<listitem>
<para>
Support for Perl Compatible Regular Expressions in the configuration files, and
- generally a more sophisticated configuration syntax over previous versions.
+ generally a more sophisticated and flexible configuration syntax over
+ previous versions.
</para>
</listitem>
<listitem>
<para>
- Web page content filtering.
+ GIF de-animation.
</para>
</listitem>
<listitem>
<para>
- Multi-threaded.
+ Web page content filtering (removes banners based on size,
+ invisible <quote>web-bugs</quote>, JavaScript, pop-ups, status bar abuse,
+ etc.)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Bypass many click-tracking scripts (avoids script redirection).
+
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Multi-threaded (POSIX and native threads).
</para>
</listitem>
- </itemizedlist>
-</para>
+ <listitem>
+ <para>
+ Auto-detection and re-reading of config file changes.
+ </para>
+ </listitem>
-<para>
- In addition, the configuration is more versatile overall.
+ <listitem>
+ <para>
+ User-customizable HTML templates (e.g. 404 error page).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Improved cookie management features (e.g. session based cookies).
+ </para>
+</listitem>
+
+ <listitem>
+ <para>
+ Builds from source on most UNIX-like systems. Packages available for: Linux
+ (RedHat, SuSE, or Debian), Windows, Sun Solaris, Mac OSX, OS/2, HP-UX 11 and AmigaOS.
+
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In addition, the configuration is much more powerful and versatile over-all.
+ </para>
+</listitem>
+
+ </itemizedlist>
</para>
</sect2>
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="installation"><title>Installation</title>
<para>
- <application>Junkbuster</application> is available as raw source code, or
+ <application>Privoxy</application> is available as raw source code, or
pre-compiled binaries. See the <ulink
- url="http://sourceforge.net/projects/ijbswa/">Junkbuster Home Page</ulink>
- for current release info. <application>Junkbuster</application> is also available
- via <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
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.
<para>
<screen>
- tar zxvf ijb_source_2.9*
- cd ijb_source_2.9*
+ tar xzvf ijb_source_* [.tgz or .tar.gz]
+ cd ijb_source_2.9.11_beta
</screen>
</para>
</para>
<para>
- Then, in either case, to build from source:
+ Then, in either case, to build from tarball/CVS source:
</para>
<para>
<screen>
- autoconf #recommended for CVS source
- ./configure
- make
- su
- make install
+ ./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>
<para>
<screen>
- autoconf #recommended for CVS source
+ autoheader [suggested for CVS source]
+ autoconf [suggested for CVS source]
./configure
make redhat-dist
</screen>
</para>
<para>
- /usr/src/redhat/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
+ /usr/src/redhat/RPMS/i686/privoxy-2.9.11-1.i686.rpm
</para>
<para>
- /usr/src/redhat/SRPMS/junkbuster-2.9.9-1.src.rpm
+ /usr/src/redhat/SRPMS/privoxy-2.9.11-1.src.rpm
</para>
<para>
<para>
<screen>
- rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-2.9.11-1.i686.rpm
</screen>
</para>
<para>
- This will place the <application>Junkbuster</application> configuration
- files in <filename>/etc/junkbuster/</filename>, and log files in
- <filename>/var/log/junkbuster/</filename>.
+ This will place the <application>Privoxy</application> configuration
+ files in <filename>/etc/privoxy/</filename>, and log files in
+ <filename>/var/log/privoxy/</filename>.
</para>
</sect2>
<para>
<screen>
- autoconf #recommended for CVS source
+ autoheader [suggested for CVS source]
+ autoconf [suggested for CVS source]
./configure
make suse-dist
</screen>
</para>
<para>
- /usr/src/packages/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ /usr/src/packages/RPMS/i686/privoxy-2.9.11-1.i686.rpm
</para>
<para>
- /usr/src/packages/SRPMS/junkbuster-2.9.9-1.src.rpm
+ /usr/src/packages/SRPMS/privoxy-2.9.11-1.src.rpm
</para>
<para>
<para>
<screen>
- rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.11-1.i686.rpm
</screen>
</para>
<para>
- This will place the <application>Junkbuster</application> configuration
- files in <filename>/etc/junkbuster/</filename>, and log files in
- <filename>/var/log/junkbuster/</filename>.
+ This will place the <application>Privoxy</application> configuration
+ files in <filename>/etc/privoxy/</filename>, and log files in
+ <filename>/var/log/privoxy/</filename>.
</para>
</sect2>
-->
<para>
- The OS/2 version of <application>Junkbuster</application> requires the EMX
- runtime library to be installed. The EMX runtime library is available on
- the hobbes OS/2 archive, among many other locations:
- <ulink url="http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&button=Search&key=emxrt.zip&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fdev%2Femx%2Fv0.9d">http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&button=Search&key=emxrt.zip&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fdev%2Femx%2Fv0.9d</ulink>
-</para>
-
-<para>
- <application>Junkbuster</application> is packaged in a WarpIN self-
+ <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>ijbos123.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>Junkbuster</application>
+ <filename>ijbos2_setup_1.2.3.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
automatically whenever OS/2 starts.
</para>
<para>
- The directory you choose to install <application>Junkbuster</application>
+ The directory you choose to install <application>Privoxy</application>
into will contain all of the configuration files.
</para>
<para>
If you would like to build binary images on OS/2 yourself, you will need
- a working EMX/GCC environment, plus several Unix-like tools. The Hobbes
- OS/2 archive is a good place to start when building such an environment.
- A set of Unix-like tools named gnupack is located here:
- <ulink url="http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&key=gnupack&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fapps">http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&key=gnupack&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fapps</ulink>
-</para>
-<para>
- Once you have the source code unpacked as above, you can build the binaries
- from the <filename>current/</filename> directory:
+ a few Unix-like tools: autoconf, autoheader and sh. These tools will be
+ used to create the required config.h file, which is not part of the
+ source distribution because it differs based on platform. You will also
+ need a compiler.
+ The distribution has been created using IBM VisualAge compilers, but you
+ can use any compiler you like. GCC/EMX has the disadvantage of needing
+ to be single-threaded due to a limitation of EMX's implementation of the
+ select() socket call.
</para>
<para>
+ In addition to needing the source code distribution as outlined earlier,
+ you will want to extract the <filename>os2seutp</filename> directory from CVS:
+ <screen>
+ cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
+ cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
+ </screen>
+ This will create a directory named os2setup/, which will contain the
+ <filename>Makefile.vac</filename> makefile and <filename>os2build.cmd</filename>
+ which is used to completely create the binary distribution. The sequence
+ of events for building the executable for yourself goes something like this:
<screen>
+ cd current
+ autoheader
autoconf
sh configure
- make
+ cd ..\os2setup
+ nmake -f Makefile.vac
</screen>
+ You will see this sequence laid out in <filename>os2build.cmd</filename>.
</para>
</sect2>
</para>
<para>
- For FreeBSD (and other *BSDs?), the build will need <command>gmake</command>
+ For FreeBSD (and other *BSDs?), the build will require <command>gmake</command>
instead of the included <command>make</command>. <command>gmake</command> is
available from <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>.
The rest should be the same as above for Linux/Unix.
<!-- ~~~~~ New section ~~~~~ -->
-<sect1 id="configuration"><title>Junkbuster Configuration</title>
+<sect1 id="configuration"><title><application>Privoxy</application> Configuration</title>
+ <para>
+ All <application>Privoxy</application> configuration is kept
+ 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.
+
+ </para>
+
+
+<!-- ~~~~~ New section ~~~~~ -->
+
+<sect2>
+<title>Controlling <application>Privoxy</application> with Your Web Browser</title>
+<para>
+ <application>Privoxy</application> can be reached by the special
+ URL <ulink url="http://i.j.b/">http://i.j.b/</ulink> (or alternately
+ <ulink url="http://ijbswa.sourceforge.net/config/">http://ijbswa.sourceforge.net/config/</ulink>),
+ which is an internal page. You will see the following section:
+
+</para>
+
<para>
- For Unix, *BSD and Linux, all configuraton files are located in
- <filename>/etc/junkbuster/</filename> by default. For MS Windows and OS/2,
- these are all in the same directory as the
- <application>Junkbuster</application> executable. The name and number of
+ <screen>
+
+Please choose from the following options:
+
+ * Show information about the current configuration
+ * Show the source code version numbers
+ * Show the client's request headers.
+ * Show which actions apply to a URL and why
+ * Toggle Privoxy on or off
+ * Edit the actions list
+
+ </screen>
+</para>
+
+<para>
+ This should be self-explanatory. Note the last item is an editor for the
+ <quote>actions list</quote>, which is where much of the ad, banner, cookie,
+ and URL blocking magic is configured as well as other advanced features of
+ <application>Privoxy</application>. This is an easy way to adjust various
+ aspects of <application>Privoxy</application> configuration. The actions
+ file, and other configuration files, are explained in detail below.
+ <application>Privoxy</application> will automatically detect any changes
+ to these files.
+</para>
+
+<para>
+ <quote>Toggle Privoxy On or Off</quote> is handy for sites that might
+ have problems with your current actions and filters, or just to test if
+ a site misbehaves, whether it is <application>Privoxy</application>
+ causing the problem or not. <application>Privoxy</application> continues
+ to run as a proxy in this case, but all filtering is disabled.
+
+</para>
+
+</sect2>
+
+<!-- ~ End section ~ -->
+
+
+
+
+<!-- ~~~~~ New section ~~~~~ -->
+
+<sect2>
+<title>Configuration Files Overview</title>
+<para>
+ For Unix, *BSD and Linux, all configuration files are located in
+ <filename>/etc/privoxy/</filename> by default. For MS Windows, OS/2, and
+ AmigaOS these are all in the same directory as the
+ <application>Privoxy</application> executable. The name and number of
configuration files has changed from previous versions, and is subject to
change as development progresses.
</para>
<para>
- The installed defaults provide a reasonable starting point. For the
- time being, there are only three default configuration files (this will
- change in time):
+ The installed defaults provide a reasonable starting point, though possibly
+ aggressive by some standards. For the time being, there are only three
+ default configuration files (this will change in time):
</para>
<para>
<listitem>
<para>
The main configuration file is named <filename>config</filename>
- on Linux, Unix, BSD, and OS/2, and <filename>junkbustr.txt</filename> on
- Windows. On Amiga, it is
- <filename>AmiTCP:db/junkbuster/config</filename>.
+ on Linux, Unix, BSD, OS/2, and AmigaOS and <filename>config.txt</filename>
+ on Windows.
</para>
</listitem>
<listitem>
<para>
- The <filename>actionsfile</filename> file is used to define various
+ The <filename>ijb.action</filename> file is used to define various
<quote>actions</quote> relating to images, banners, pop-ups, access
restrictions, banners and cookies. There is a CGI based editor for this
file that can be accessed via <ulink
- url="http://i.j.b./">http://i.j.b./</ulink>. This is the easiest method of
- configuring actions. (Still under active development.)
+ url="http://i.j.b">http://i.j.b</ulink>. (Other actions
+ files are included as well with differing levels of filtering
+ and blocking, e.g. <filename>ijb-basic.action</filename>.)
</para>
</listitem>
<listitem>
<para>
- The <filename>re_filterfile</filename> file can be used to rewrite the raw
- page content, including text as well as embedded HTML and JavaScript.
+ The <filename>re_filterfile</filename> file can be used to re-write the raw
+ page content, including viewable text as well as embedded HTML and JavaScript,
+ and whatever else lurks on any given web page.
</para>
</listitem>
</para>
<para>
- <filename>actionsfile</filename> and <filename>re_filterfile</filename>
+ <filename>ijb.action</filename> and <filename>re_filterfile</filename>
can use Perl style regular expressions for maximum flexibility. All files use
the <quote><literal>#</literal></quote> character to denote a comment. Such
- lines are not processed by <application>Junkbuster</application>. After
- making any changes, restart <application>Junkbuster</application> in order
- for the changes to take effect.
+ lines are not processed by <application>Privoxy</application>. After
+ making any changes, there is no need to restart
+ <application>Privoxy</application> in order for the changes to take
+ effect. <application>Privoxy</application> should detect such changes
+ automatically.
</para>
<para>
Also, what constitutes a <quote>default</quote> setting, may change, so
please check all your configuration files on important issues.
</para>
+</sect2>
+
<!-- ~~~~~ New section ~~~~~ -->
<title>The Main Configuration File</title>
<para>
Again, the main configuration file is named <filename>config</filename> on
- Linux/Unix/BSD and OS/2, and <filename>junkbustr.txt</filename> on Windows.
+ Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
Configuration lines consist of an initial keyword followed by a list of
values, all separated by whitespace (any number of spaces or tabs). For
example:
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>blockfile blocklist.ini</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
- Indicates that the blockfile is named <quote>blocklist.ini</quote>.
+ Indicates that the blockfile is named <quote>blocklist.ini</quote>. (A
+ default installation does not use this.)
</para>
<para>
existing configuration line, you can make it a comment and it will be treated
as if it weren't there. This is called <quote>commenting out</quote> an
option and can be useful to turn off features: If you comment out the
- <quote>logfile</quote> line, <application>junkbuster</application> will not
+ <quote>logfile</quote> line, <application>Privoxy</application> will not
log to a file at all. Watch for the <quote>default:</quote> section in each
explanation to see what happens if the option is left unset (or commented
out).
</para>
<para>
- There are various aspects of <application>Junkbuster</application> behavior
+ There are various aspects of <application>Privoxy</application> behavior
that can be tuned.
</para>
<title>Defining Other Configuration Files</title>
<para>
- <application>Junkbuster</application> can use a number of other files to tell it
+ <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>Junkbuster</application> where to find
+ configuration file tells <application>Privoxy</application> where to find
all those other files.
</para>
<para>
- On <application>Windows</application>, <application>Junkbuster</application>
- looks for these files in the same directory as the executable. On Unix and
- OS/2, <application>Junkbuster</application> looks for these files in the current
- working directory. In either case, an absolute path name can be used to
+ On <application>Windows</application> and <application>AmigaOS</application>,
+ <application>Privoxy</application> looks for these files in the same
+ directory as the executable. On Unix and OS/2,
+ <application>Privoxy</application> looks for these files in the current
+ working directory. In either case, an absolute path name can be used to
avoid problems.
</para>
<para>
- When development goes modular and multiuser, the blocker, filter, and
+ When development goes modular and multi-user, the blocker, filter, and
per-user config will be stored in subdirectories of <quote>confdir</quote>.
For now, only <filename>confdir/templates</filename> is used for storing HTML
templates for CGI results.
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
- <emphasis>confdir /etc/junkbuster</emphasis> # No trailing /, please.
+ <emphasis>confdir /etc/privoxy</emphasis> # No trailing /, please.
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
- <emphasis>logdir /var/log/junkbuster</emphasis>
+ <emphasis>logdir /var/log/privoxy</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</para>
<para>
- The <quote>actionsfile</quote> contains patterns to specify the actions to
- apply to requests for each site. Default: Cookies to and from all
- destinations are filtered. Popups are disabled for all sites. All sites are
- filtered if re_filterfile specified. No sites are blocked. An empty image is
- displayed for filtered ads and other images (formerly
- <quote>tinygif</quote>). The syntax of this file is explained in detail
- <link linkend="actionsfile">below</link>.
+ The <quote>ijb.action</quote> file contains patterns to specify the actions
+ to apply to requests for each site. Default: Cookies to and from all
+ destinations are kept only during the current browser session (i.e. they are
+ not saved to disk). Pop-ups are disabled for all sites. All sites are
+ filtered through selected sections of <quote>re_filterfile</quote>. No sites
+ are blocked. The <application>Privoxy</application> logo is displayed for
+ filtered ads and other images. The syntax of this file is explained in detail
+ <link linkend="actionsfile">below</link>. Other <quote>actions</quote> files
+ are included, and you are free to use any of them. They have varying degrees
+ of aggressiveness.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
- <emphasis>actionsfile actionsfile</emphasis>
+ <emphasis>actionsfile ijb.action</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
- The <quote>re_filterfile</quote> file contains content modification rules.
- These rules permit powerful changes on the content of Web pages, e.g., you
- could disable your favourite JavaScript annoyances, rewrite the actual
- content, or just have some fun replacing <quote>Microsoft</quote> with
- <quote>MicroSuck</quote> wherever it appears on a Web page. Default: No
- content modification, or whatever the developers are playing with :-/
+ The <quote>re_filterfile</quote> file contains content modification rules
+ that use <quote>regular expressions</quote>. These rules permit powerful
+ changes on the content of Web pages, e.g., you could disable your favorite
+ JavaScript annoyances, re-write the actual displayed text, or just have some
+ fun replacing <quote>Microsoft</quote> with <quote>MicroSuck</quote> wherever
+ it appears on a Web page. Default: whatever the developers are playing with
+ :-/
+</para>
+
+<para>
+ Filtering requires buffering the page content, which may appear to slow down
+ page rendering since nothing is displayed until all content has passed
+ the filters. (It does not really take longer, but seems that way since
+ the page is not incrementally displayed.) This effect will be more noticeable
+ on slower connections.
+
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>re_filterfile re_filterfile</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
The logfile is where all logging and error messages are written. The logfile
can be useful for tracking down a problem with
- <application>Junkbuster</application> (e.g., it's not blocking an ad you
+ <application>Privoxy</application> (e.g., it's not blocking an ad you
think it should block) but in most cases you probably will never look at it.
</para>
</para>
<para>
- On SuSE Linux systems, you can place a line like <quote>/var/log/junkbuster.*
+ On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
+1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
the effect that cron.daily will automatically archive, gzip, and empty the
log, when it exceeds 1M size.
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>logfile logfile</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
The <quote>jarfile</quote> defines where
- <application>Junkbuster</application> stores the cookies it intercepts. Note
+ <application>Privoxy</application> stores the cookies it intercepts. Note
that if you use a <quote>jarfile</quote>, it may grow quite large. Default:
Don't store intercepted cookies.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>#jarfile jarfile</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
If you specify a <quote>trustfile</quote>,
- <application>Junkbuster</application> will only allow access to sites that
+ <application>Privoxy</application> will only allow access to sites that
are named in the trustfile. You can also mark sites as trusted referrers,
with the effect that access to untrusted sites will be granted, if a link
from a trusted referrer was used. The link target will then be added to the
<quote>trustfile</quote>. This is a very restrictive feature that typical
- users most propably want to leave disabled. Default: Disabled, don't use the
+ users most probably want to leave disabled. Default: Disabled, don't use the
trust mechanism.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>#trustfile trust</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
- If you use the trust mechanism, it is a good idea to write up some online
+ If you use the trust mechanism, it is a good idea to write up some on-line
documentation about your blocking policy and to specify the URL(s) here. They
will appear on the page that your users receive when they try to access
untrusted content. Use multiple times for multiple URLs. Default: Don't
<para>
<literal>
- <MSGText>
+ <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>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
This part of the configuration file contains options that control how
- <application>Junkbuster</application> operates.
+ <application>Privoxy</application> operates.
</para>
<para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>#admin-address fill@me.in.please</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<quote>Proxy-info-url</quote> can be set to a URL that contains more info
- about this <application>Junkbuster</application> installation, it's
+ about this <application>Privoxy</application> installation, it's
configuration and policies. It is used in many of the proxy-generated pages
and its use is highly recommended in multi-user installations, since your
users will want to know why certain content is blocked or modified. Default:
- Don't show a link to online documentation.
+ Don't show a link to on-line documentation.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>proxy-info-url http://www.your-site.com/proxy.html</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<quote>Listen-address</quote> specifies the address and port where
- <application>Junkbuster</application> will listen for connections from your
- Web browser. The default is to listen on the localhost port 8000, and
+ <application>Privoxy</application> will listen for connections from your
+ Web browser. The default is to listen on the localhost port 8118, and
this is suitable for most users. (In your web browser, under proxy
configuration, list the proxy server as <quote>localhost</quote> and the
- port as <quote>8000</quote>).
+ port as <quote>8118</quote>).
</para>
<para>
- If you already have another service running on port 8000, or if you want to
+ If you already have another service running on port 8118, or if you want to
serve requests from other machines (e.g. on your local network) as well, you
will need to override the default. The syntax is
<quote>listen-address [<ip-address>]:<port></quote>. If you leave
- out the IP address, <application>junkbuster</application> will bind to all
+ out the IP address, <application>Privoxy</application> will bind to all
interfaces (addresses) on your machine and may become reachable from the
Internet. In that case, consider using access control lists (acl's) (see
<quote>aclfile</quote> above), or a firewall.
</para>
<para>
- For example, suppose you are running <application>Junkbuster</application> on
+ For example, suppose you are running <application>Privoxy</application> on
a machine which has the address 192.168.0.1 on your local private network
(192.168.0.0) and has another outside connection with a different address.
You want it to serve requests from inside only:
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
- <emphasis>listen-address 192.168.0.1:8000</emphasis>
+ <emphasis>listen-address 192.168.0.1:8118</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
- <emphasis>listen-address :8000</emphasis>
+ <emphasis>listen-address :8118</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
If you do this, consider using ACLs (see <quote>aclfile</quote> above). Note:
you will need to point your browser(s) to the address and port that you have
- configured here. Default: localhost:8000 (127.0.0.1:8000).
+ configured here. Default: localhost:8118 (127.0.0.1:8118).
</para>
<para>
levels of debug are probably only of interest to developers.
</para>
-<Para>
- <Literal>
- <MSGText>
- <LiteralLayout>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
debug 1 # GPC = show each GET/POST/CONNECT request
debug 2 # CONN = show each connection status
debug 4 # IO = show I/O status
debug 32 # FRC = debug force feature
debug 64 # REF = debug regular expression filter
debug 128 # = debug fast redirects
- debug 256 # = debug GIF deanimation
+ debug 256 # = debug GIF de-animation
debug 512 # CLF = Common Log Format
- debug 1024 # = debug kill popups
+ debug 1024 # = debug kill pop-ups
debug 4096 # INFO = Startup banner and warnings.
debug 8192 # ERROR = Non-fatal errors
- </LiteralLayout>
- </MSGText>
- </Literal>
-</Para>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
<para>
It is <emphasis>highly recommended</emphasis> that you enable ERROR
- reporting (debug 8192), at least until the next stable release.
+ reporting (debug 8192), at least until v3.0 is released.
</para>
<para>
The reporting of FATAL errors (i.e. ones which crash
- <application>JunkBuster</application>) is always on and cannot be disabled.
+ <application>Privoxy</application>) is always on and cannot be disabled.
</para>
<para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>debug 15 # same as setting the first 4 listed above</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>debug 1 # URLs</emphasis>
<emphasis>debug 4096 # Info</emphasis>
<emphasis>debug 8192 # Errors - *we highly recommended enabling this*</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
- <application>Junkbuster</application> normally uses
+ <application>Privoxy</application> normally uses
<quote>multi-threading</quote>, a software technique that permits it to
handle many different requests simultaneously. In some cases you may wish to
disable this -- particularly if you're trying to debug a problem. The
<quote>single-threaded</quote> option forces
- <application>Junkbuster</application> to handle requests sequentially.
+ <application>Privoxy</application> to handle requests sequentially.
Default: Multi-threaded mode.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>#single-threaded</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<quote>toggle</quote> allows you to temporarily disable all
- <application>Junkbuster's</application> filtering. Just set <quote>toggle
+ <application>Privoxy's</application> filtering. Just set <quote>toggle
0</quote>.
</para>
<para>
- The Windows version of <application>Junkbuster</application> puts an icon in
+ The Windows version of <application>Privoxy</application> puts an icon in
the system tray, which also allows you to change this option. If you
right-click on that icon (or select the <quote>Options</quote> menu), one
choice is <quote>Enable</quote>. Clicking on enable toggles
- <application>Junkbuster</application> on and off. This is useful if you want
- to temporarily disable <application>Junkbuster</application>, e.g., to access
- a site that requires cookies which you normally have blocked. This can also
- be toggled via a web browser at the <application>Junkbuster</application>
- internal address of <ulink url="http://i.j.b./">http://i.j.b./</ulink> on
+ <application>Privoxy</application> on and off. This is useful if you want
+ to temporarily disable <application>Privoxy</application>, e.g., to access
+ a site that requires cookies which you would otherwise have blocked. This can also
+ be toggled via a web browser at the <application>Privoxy</application>
+ internal address of <ulink url="http://i.j.b">http://i.j.b</ulink> on
any platform.
</para>
<para>
- <quote>toggle 1</quote> means <application>Junkbuster</application> runs
+ <quote>toggle 1</quote> means <application>Privoxy</application> runs
normally, <quote>toggle 0</quote> means that
- <application>Junkbuster</application> becomes a non-anonymizing non-blocking
+ <application>Privoxy</application> becomes a non-anonymizing non-blocking
proxy. Default: 1 (on).
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>toggle 1</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
For content filtering, i.e. the <quote>+filter</quote> and
- <quote>+deanimate-gif</quote> actions, it is neccessary that
- <application>Junkbuster</application> buffers the entire document body.
+ <quote>+deanimate-gif</quote> actions, it is necessary that
+ <application>Privoxy</application> buffers the entire document body.
This can be potentially dangerous, since a server could just keep sending
data indefinitely and wait for your RAM to exhaust. With nasty consequences.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>buffer-limit 4069</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
- To enable the web-based actionsfile editor set
+ To enable the web-based <filename>ijb.action</filename> file editor set
<application>enable-edit-actions</application> to 1, or 0 to disable. Note
- that you must have compiled <application>JunkBuster</application> with
+ that you must have compiled <application>Privoxy</application> with
support for this feature, otherwise this option has no effect. This
internal page can be reached at <ulink
- url="http://i.j.b./">http://i.j.b./</ulink>.
+ url="http://i.j.b">http://i.j.b</ulink>.
</para>
<para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>enable-edit-actions 1</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
- Allow <application>JunkBuster</application> to be toggled on and off
+ Allow <application>Privoxy</application> to be toggled on and off
remotely, using your web browser. Set <quote>enable-remote-toggle</quote>to
1 to enable, and 0 to disable. Note that you must have compiled
- <application>JunkBuster</application> with support for this feature,
+ <application>Privoxy</application> with support for this feature,
otherwise this option has no effect.
</para>
<para>
Security note: If this is enabled, anyone who can use the proxy can toggle
- it on or off (see <ulink url="http://i.j.b./">http://i.j.b./</ulink>), and
+ it on or off (see <ulink url="http://i.j.b">http://i.j.b</ulink>), and
their changes will affect all users. For shared proxies, you probably want to
disable this. Default: enabled.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>enable-remote-toggle 1</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ]
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>ACTION</emphasis> = <quote>permit-access</quote> or <quote>deny-access</quote>
<emphasis>DST_ADDR</emphasis> = server or forwarder hostname or dotted IP address
<emphasis>DST_MASKLEN</emphasis> = number of bits in the subnet mask for the target
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</para>
<para>
- IMPORTANT NOTE: If the <application>junkbuster</application> is using a
+ IMPORTANT NOTE: If <application>Privoxy</application> is using a
forwarder (see below) or a gateway for a particular destination URL, the
<literal>DST_ADDR</literal> that is examined is the address of the forwarder
or the gateway and <emphasis>NOT</emphasis> the address of the ultimate
target. This is necessary because it may be impossible for the local
- <application>Junkbuster</application> to determine the address of the
+ <application>Privoxy</application> to determine the address of the
ultimate target (that's often what gateways are used for).
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>permit-access localhost</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
A silly example to illustrate permitting any host on the class-C subnet with
- <application>Junkbuster</application> to go anywhere:
+ <application>Privoxy</application> to go anywhere:
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
- <emphasis>permit-access www.junkbusters.com/24</emphasis>
+ <emphasis>permit-access www.privoxy.com/24</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
- <emphasis>deny-access ident.junkbusters.com</emphasis>
+ <emphasis>deny-access ident.privoxy.com</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>permit-access 207.153.200.0/24</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>permit-access 0.0.0.0/0</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>permit-access .org</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</para>
<para>
- An ISP may want to provide a <application>Junkbuster</application> that is
+ An ISP may want to provide a <application>Privoxy</application> that is
accessible by <quote>the world</quote> and yet restrict use of some of their
private content to hosts on its internal network (i.e. its own subscribers).
Say, for instance the ISP owns the Class-B IP address block 123.124.0.0 (a 16
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>permit-access 0.0.0.0/0 0.0.0.0/0</emphasis> # other clients can go anywhere
# with the following exceptions:
<emphasis>permit 123.124.0.0/16 0.0.0.0/0</emphasis> # the ISP's clients can go
# anywhere
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</para>
<para>
- Also specified here are SOCKS proxies. <application>Junkbuster</application>
+ Also specified here are SOCKS proxies. <application>Privoxy</application>
SOCKS 4 and SOCKS 4A. The difference is that SOCKS 4A will resolve the target
hostname using DNS on the SOCKS server, not our local DNS client.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>forward target_domain[:port] http_proxy_host[:port]</emphasis>
<emphasis>forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
<emphasis>forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>forward .* . </emphasis># implicit
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>forward .* lpwa.com:8000</emphasis>
<emphasis>forward :443 .</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
+<!--
See the FAQ for instructions on how to automate the login procedure for LPWA.
+-->
Some users have reported difficulties related to LPWA's use of
<quote>.</quote> as the last element of the domain, and have said that this
can be fixed with this:
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>forward lpwa. lpwa.com:8000</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
- (NOTE: the syntax for specifiying target_domain has changed since the
+ (NOTE: the syntax for specifying target_domain has changed since the
previous paragraph was written -- it will not work now. More information
is welcome.)
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>forward .* caching.myisp.net:8000</emphasis>
<emphasis>forward myisp.net .</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>forward .* proxy:8080</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
- Also, we're told they insist on getting cookies and JavaScript, so you need
- to add home.com to the cookie file. We consider JavaScript a security risk.
+ Also, we're told they insist on getting cookies and JavaScript, so you should
+ allow cookies from home.com. We consider JavaScript a potential security risk.
Java need not be enabled.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>forward-socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
<emphasis>forward my_company.com .</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>forward-socks4a .* . firewall.my_company.com:1080</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
host-a has a PPP connection to isp-a.com. And host-b has a PPP connection to
- isp-b.com. host-a can run a <application>Junkbuster</application> proxy with
+ isp-b.com. host-a can run a <application>Privoxy</application> proxy with
forwarding like this:
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>forward .* .</emphasis>
- <emphasis>forward isp-b.com host-b:8000</emphasis>
+ <emphasis>forward isp-b.com host-b:8118</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
- host-b can run a <application>Junkbuster</application> proxy with forwarding
+ host-b can run a <application>Privoxy</application> proxy with forwarding
like this:
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>forward .* .</emphasis>
- <emphasis>forward isp-a.com host-a:8000</emphasis>
+ <emphasis>forward isp-a.com host-a:8118</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>forward *. ssbcache.ukc.ac.uk:3128</emphasis> # Use the proxy, except for:
<emphasis>forward .ukc.ac.uk . </emphasis> # Anything on the same domain as us
<emphasis>forward localhost.localdomain . </emphasis> # Loopback address
<emphasis>forward www.ukc.mirror.ac.uk . </emphasis> # Specific host
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
- If you intend to chain <application>Junkbuster</application> and
+ If you intend to chain <application>Privoxy</application> and
<application>squid</application> locally, then chain as
- <literal>browser -> squid -> junkbuster</literal> is the recommended way.
+ <literal>browser -> squid -> privoxy</literal> is the recommended way.
</para>
<para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
- # Define junkbuster as parent cache
+ # Define Privoxy as parent cache
<!-- per feedback from user...
- cache_peer 127.0.0.1 8000 parent 0 no-query
+ cache_peer 127.0.0.1 8118 parent 0 no-query
-->
- cache_peer 127.0.0.1 parent 8000 0 no-query
+ cache_peer 127.0.0.1 parent 8118 0 no-query
# Define ACL for protocol FTP
acl FTP proto FTP
- # Do not forward ACL FTP to junkbuster
+ # Do not forward ACL FTP to privoxy
always_direct allow FTP
- # Do not forward ACL CONNECT (https) to junkbuster
+ # Do not forward ACL CONNECT (https) to privoxy
always_direct allow CONNECT
- # Forward the rest to junkbuster
+ # Forward the rest to privoxy
never_direct allow all
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
Removed references to Win32. HB 09/23/01
-->
<para>
- <application>Junkbuster</application> has a number of options specific to the
+ <application>Privoxy</application> has a number of options specific to the
Windows GUI interface:
</para>
<para>
If <quote>activity-animation</quote> is set to 1, the
- <application>Junkbuster</application> icon will animate when
- <quote>Junkbuster</quote> is active. To turn off, set to 0.
+ <application>Privoxy</application> icon will animate when
+ <quote>Privoxy</quote> is active. To turn off, set to 0.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>activity-animation 1</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
If <quote>log-messages</quote> is set to 1,
- <application>Junkbuster</application> will log messages to the console
+ <application>Privoxy</application> will log messages to the console
window:
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>log-messages 1</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>log-buffer-size 1</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>log-max-lines 200</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
If <quote>log-highlight-messages</quote> is set to 1,
- <application>Junkbuster</application> will highlight portions of the log
+ <application>Privoxy</application> will highlight portions of the log
messages with a bold-faced font:
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>log-highlight-messages 1</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>log-font-name Comic Sans MS</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>log-font-size 8</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<quote>show-on-task-bar</quote> controls whether or not
- <application>Junkbuster</application> will appear as a button on the Task bar
+ <application>Privoxy</application> will appear as a button on the Task bar
when minimized:
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>show-on-task-bar 0</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
If <quote>close-button-minimizes</quote> is set to 1, the Windows close
- button will minimize <application>Junkbuster</application> instead of closing
+ button will minimize <application>Privoxy</application> instead of closing
the program (close with the exit option on the File menu).
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>close-button-minimizes 1</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
The <quote>hide-console</quote> option is specific to the MS-Win console
- version of <application>JunkBuster</application>. If this option is used,
- <application>Junkbuster</application> will disconnect from and hide the
+ version of <application>Privoxy</application>. If this option is used,
+ <application>Privoxy</application> will disconnect from and hide the
command console.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
#hide-console
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<title>The Actions File</title>
<para>
- The <quote>actionsfile</quote> is used to define what actions
- <application>Junkbuster</application> takes, and thus determines how images,
+ The <quote>ijb.action</quote> file (formerly
+ <filename>actionsfile</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 image that you would rather not see. Cookies can be accepted
- or rejected. The default file is in fact named <filename>actionsfile</filename>.
+ 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>ijb.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
+ loading <ulink url="http://i.j.b/">http://i.j.b/</ulink>, and then select
+ <quote>Edit Actions List</quote>. A text editor can also be used.
</para>
<para>
url="http://i.j.b/show-url-info">http://i.j.b/show-url-info</ulink>.
</para>
-<para>
- The actions file can be edited with a browser by loading
- <ulink url="http://i.j.b">http://i.j.b</ulink>, and then select
- <quote>Edit Actions</quote>.
-</para>
<para>
There are four types of lines in this file: comments (begin with a
<quote>#</quote> character), actions, aliases and patterns, all of which are
explained below, as well as the configuration file syntax that
- <application>Junkbuster</application> understands.
+ <application>Privoxy</application> understands.
</para>
</para>
<para>
- Additionally, there are wildcards that you can use in the domain names
- themselves. They work pretty similar to shell wildcards: <quote>*</quote>
+ Additionally, there are wild-cards that you can use in the domain names
+ themselves. They work pretty similar to shell wild-cards: <quote>*</quote>
stands for zero or more arbitrary characters, <quote>?</quote> stands for
- any single character. And you can define charachter classes in square
+ any single character. And you can define character classes in square
brackets and they can be freely mixed:
</para>
</para>
<para>
- If <application>Junkbuster</application> was compiled with
+ 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> direcory or <quote>man
+ can be used. 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
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>{+name}</emphasis> # enable this action
<emphasis>{-name}</emphasis> # disable this action
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
<listitem>
<para>
- Parameterized (e.g. <quote>+/-hide-user-agent</quote>):
+ parameterized (e.g. <quote>+/-hide-user-agent</quote>):
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>{+name{param}}</emphasis> # enable action and set parameter to <quote>param</quote>
<emphasis>{-name}</emphasis> # disable action
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>{+name{param}}</emphasis> # enable action and add parameter <quote>param</quote>
<emphasis>{-name{param}}</emphasis> # remove the parameter <quote>param</quote>
<emphasis>{-name}</emphasis> # disable this action totally
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
<para>
If nothing is specified in this file, no <quote>actions</quote> are taken.
- So in this case <application>JunkBuster</application> would just be a
+ So in this case <application>Privoxy</application> would just be a
normal, non-blocking, non-anonymizing proxy. You must specifically
enable the privacy and blocking features you need (although the
- provided default <filename>actionsfile</filename> file will
+ provided default <filename>ijb.action</filename> file will
give a good starting point).
</para>
</para>
<para>
- The list of valid <application>Junkbuster</application> <quote>actions</quote> are:
+ The list of valid <application>Privoxy</application> <quote>actions</quote> are:
</para>
<para>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+add-header{Name: value}</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
<listitem>
<para>
- Block this URL totally.
+ 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.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+block</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
This will also shrink the images considerably (in bytes, not pixels!). If
the option <quote>first</quote> is given, the first frame of the animation
is used as the replacement. If <quote>last</quote> is given, the last frame
- of the animation is used instead, which propably makes more sense for most
+ of the animation is used instead, which probably makes more sense for most
banner animations, but also has the risk of not showing the entire last
frame (if it is only a delta to an earlier frame).
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+deanimate-gifs{last}</emphasis>
<emphasis>+deanimate-gifs{first}</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
<quote>+downgrade</quote> will downgrade HTTP/1.1 client requests to
HTTP/1.0 and downgrade the responses as well. Use this action for servers
that use HTTP/1.1 protocol features that
- <application>Junkbuster</application> doesn't handle well yet. HTTP/1.1
+ <application>Privoxy</application> doesn't handle well yet. HTTP/1.1
is only partially implemented. Default is not to downgrade requests.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+downgrade</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
</para>
<para>
Sometimes, there are even multiple consecutive redirects encoded in the
- URL. These redirections via scripts make your web browing more traceable,
+ URL. These redirections via scripts make your web browsing more traceable,
since the server from which you follow such a link can see where you go to.
Apart from that, valuable bandwidth and time is wasted, while your browser
ask the server for one redirect after the other. Plus, it feeds the
</para>
<para>
The <quote>+fast-redirects</quote> option enables interception of these
- requests by <application>Junkbuster</application>, who will cut off all but
+ requests by <application>Privoxy</application>, who will cut off all but
the last valid URL in the request and send a local redirect back to your
browser without contacting the remote site.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+fast-redirects</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
<listitem>
<para>
- Filter the website through the re_filterfile:
- </para>
+ Apply the filters in the <literal>section_header</literal>
+ section of the <filename>re_filterfile</filename> file to the site(s).
+ <filename>Re_filterfile</filename> sections are grouped according to like
+ functionality.
+ </para>
+
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
- <emphasis>+filter{filename}</emphasis>
+ <emphasis>+filter{section_header}</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
+
+ <para>
+ Filter sections that are pre-defined in the supplied
+ <filename>re_filterfile</filename> include:
+ </para>
+
+ <blockquote>
+ <simplelist>
+ <member>
+ <emphasis>html-annoyances</emphasis>: Get rid of particularly annoying HTML abuse.
+ </member>
+ </simplelist>
+ <simplelist>
+ <member>
+ <emphasis>js-annoyances</emphasis>: Get rid of particularly annoying JavaScript abuse
+ </member>
+ </simplelist>
+ <simplelist>
+ <member>
+ <emphasis>no-poups</emphasis>: Kill all popups in JS and HTML
+ </member>
+ </simplelist>
+ <simplelist>
+ <member>
+ <emphasis>frameset-borders</emphasis>: Give frames a border
+ </member>
+ </simplelist>
+ <simplelist>
+ <member>
+ <emphasis>webbugs</emphasis>: Squish WebBugs (1x1 invisible GIFs used for user tracking)
+ </member>
+ </simplelist>
+ <simplelist>
+ <member>
+ <emphasis>no-refresh</emphasis>: Automatic refresh sucks on auto-dialup lines
+ </member>
+ </simplelist>
+ <simplelist>
+ <member>
+ <emphasis>fun</emphasis>: Text replacements for subversive browsing fun!
+ </member>
+ </simplelist>
+ <simplelist>
+ <member>
+ <emphasis>nimda</emphasis>: Remove (virus) Nimda code.
+ </member>
+ </simplelist>
+ <simplelist>
+ <member>
+ <emphasis>banners-by-size</emphasis>: Kill banners by size
+ </member>
+ </simplelist>
+ <simplelist>
+ <member>
+ <emphasis>crude-parental</emphasis>: Kill all web pages that contain the words "sex" or "warez"
+ </member>
+ </simplelist>
+ </blockquote>
+
</listitem>
<listitem>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+hide-forwarded</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+hide-from{block}</emphasis>
<emphasis>+hide-from{spam@sittingduck.xqq}</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+hide-referer{block}</emphasis>
<emphasis>+hide-referer{forge}</emphasis>
<emphasis>+hide-referer{http://nowhere.com}</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+hide-referrer{...}</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)}</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<!--
<para>
- Or to identify yourself explicitly as a <quote>Junkbuster</quote> user:
+ Or to identify yourself explicitly as a <application>Privoxy</application> user:
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
- <emphasis>+hide-user-agent{JunkBuster/1.0}</emphasis>
+ <emphasis>+hide-user-agent{Privoxy/1.0}</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
(Don't change the version number from 1.0 - after all, why tell them?)
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+hide-user-agent{browser-type}</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
-->
<listitem>
<para>
Treat this URL as an image. This only matters if it's also <quote>+block</quote>ed,
- in which case a <quote>blocked</quote> image can be sent rather than a HTML page.
- See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
+ in which case a <quote>blocked</quote> image can be sent rather than a HTML page.
+ 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>.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+image</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
<listitem>
- <para>
- Decides what to do with URLs that end up tagged with <quote>{+block
- +image}</quote>. There are 4 options. <quote>-image-blocker</quote> will
- send a HTML <quote>blocked</quote> page, usually resulting in a
- <quote>broken image</quote> icon. <quote>+image-blocker{logo}</quote> will
- send a <quote>JunkBuster</quote> image.
- <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF image.
- And finally, <quote>+image-blocker{http://xyz.com}</quote> will send a HTTP
- temporary redirect to the specified image. This has the advantage of the
- icon being being cached by the browser, which will speed up the display.
+ <para> Decides what to do with URLs that end up tagged with <quote>{+block
+ +image}</quote>, e.g an advertizement. There are five options.
+ <quote>-image-blocker</quote> will send a HTML <quote>blocked</quote> page,
+ usually resulting in a <quote>broken image</quote> icon.
+ <quote>+image-blocker{logo}</quote> will send a
+ <application>Privoxy</application> logo
+ image. <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF
+ image. And finally, <quote>+image-blocker{http://xyz.com}</quote> will send
+ a HTTP temporary redirect to the specified image. This has the advantage of
+ the icon being being cached by the browser, which will speed up the display.
+ <quote>+image-blocker{pattern}</quote> will send a checkboard type pattern,
+ which scales better than the logo (which can get blocky if the browser
+ enlarges it too much).
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+image-blocker{logo}</emphasis>
<emphasis>+image-blocker{blank}</emphasis>
+ <emphasis>+image-blocker{pattern}</emphasis>
<emphasis>+image-blocker{http://i.j.b/send-banner}</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
<listitem>
<para>
By default (i.e. in the absence of a <quote>+limit-connect</quote>
- action), <application>Junkbuster</application> will only allow CONNECT
+ action), <application>Privoxy</application> will only allow CONNECT
requests to port 443, which is the standard port for https as a
precaution.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+limit-connect{443} # This is the default and need no be specified.</emphasis>
<emphasis>+limit-connect{80,443} # Ports 80 and 443 are OK.</emphasis>
<emphasis>+limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100</emphasis>
<emphasis> #and above 500 are OK.</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<quote>+no-compression</quote> prevents the website from compressing the
data. Some websites do this, which can be a problem for
- <application>Junkbuster</application>, since <quote>+filter</quote>,
+ <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.
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+nocompression</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
+ <listitem>
+ <para>
+ If the website sets cookies, <quote>no-cookies-keep</quote> will make sure
+ they are erased when you exit and restart your web browser. This makes
+ profiling cookies useless, but won't break sites which require cookies so
+ that you can log in for transactions. Default: on.
+ </para>
+ <para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>+no-cookies-keep</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+ </para>
+ </listitem>
+
<listitem>
<para>
Prevent the website from reading cookies:
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+no-cookies-read</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+no-cookies-set</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+no-popup</emphasis>
<emphasis>+no-popups</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+vanilla-wafer</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
<emphasis>+wafer{name=value}</emphasis>
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</listitem>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
- # Turn off all cookies
+ # Turn off all persistent cookies
{ +no-cookies-read }
{ +no-cookies-set }
+ # Allow cookies for this browser session ONLY
+ { +no-cookies-keep }
- # Execeptions to the above, sites that need cookies
+ # Exceptions to the above, sites that benefit from persistent cookies
{ -no-cookies-read }
{ -no-cookies-set }
+ { -no-cookies-keep }
.javasoft.com
.sun.com
.yahoo.com
.redhat.com
# Alternative way of saying the same thing
- {-no-cookies-set -no-cookies-read}
+ {-no-cookies-set -no-cookies-read -no-cookies-keep}
.sourceforge.net
.sf.net
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
# Turn them off!
{+fast-redirects}
www.ukc.ac.uk/cgi-bin/wac\.cgi\?
login.yahoo.com
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
- Turn on page filtering, with one exception for sourceforge:
-</para>
+ Turn on page filtering according to rules in the defined sections
+ of <filename>refilterfile</filename>, and make one exception for
+ sourceforge:
+ </para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
- # Run everything through the default filter file (<filename>re_filterfile</filename>):
- {+filter}
-
- # But please don't re_filter code from sourceforge!
+ # Run everything through the filter file, using only the
+ # specified sections:
+ +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}\
+ +filter{webbugs} +filter{nimda} +filter{banners-by-size}
+
+ # Then disable filtering of code from sourceforge!
{-filter}
.cvs.sourceforge.net
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
# Blocklist:
{+block}
/.*/adlib/server\.cgi
/autoads/
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
+<para>
+ Note that many of these actions have the potential to cause a page to
+ misbehave, possibly even not to display at all. There are many ways
+ a site designer may choose to design his site, and what HTTP header
+ content he may depend on. There is no way to have hard and fast rules
+ for all sites. See the <link linkend="ACTIONSANAT">Appendix</link>
+ for a brief example on troubleshooting actions.
+
+</para>
+
</sect3>
<!-- ~ End section ~ -->
<sect3>
<title>Aliases</title>
<para>
- Custom <quote>actions</quote>, known to <application>Junkbuster</application>
+ Custom <quote>actions</quote>, known to <application>Privoxy</application>
as <quote>aliases</quote>, can be defined by combining other <quote>actions</quote>.
These can in turn be invoked just like the built-in <quote>actions</quote>.
Currently, an alias can contain any character except space, tab, <quote>=</quote>,
<quote>{</quote> or <quote>}</quote>. But please use only <quote>a</quote>-
<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
- <filename>actionsfile</filename>! And there can only be one set of
+ <emphasis>must be defined before anything</emphasis> else in the
+ <filename>ijb.action</filename>file ! And there can only be one set of
<quote>aliases</quote> defined.
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
# Useful customer aliases we can use later. These must come first!
{{alias}}
c3 = +no-cookies-set -no-cookies-read
#... etc. Customize to your heart's content.
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
# These sites are very complex and require
# minimal interference.
.dabs.com
.overclockers.co.uk
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<sect2 id="filterfile">
<title>The Filter File</title>
<para>
- The filter file defines what filtering of web pages
- <application>Junkbuster</application> does. The default filter file is
- <filename>re_filterfile</filename>, located in the config directory. In this
- file, <emphasis>any document content</emphasis>, whether viewable text or
- embedded non-visible content, can be changed.
+ Any web page can be dynamically modified with the filter file. This
+ modification can be removal, or re-writing, of any web page content,
+ including tags and non-visible content. The default filter file is
+ <filename>re_filterfile</filename>, located in the config directory.
+</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>
This file uses regular expressions to alter or remove any string in the
- target page. Some examples from the included default <filename>re_filterfile</filename>:
+ target page. The expressions can only operate on one line at a time. Some
+ examples from the included default <filename>re_filterfile</filename>:
</para>
<para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
- # The status bar is for displaying link targets, not pointless buzzwords.
- # Again, check it out on http://www.airport-cgn.de/.
- s/status='.*?';*//ig
+ FILTER: html-annoyances
+
+ # New browser windows should be resizeable and have a location and status
+ # bar. Make it so.
+ #
+ s/resizable="?(no|0)"?/resizable=1/ig s/noresize/yesresize/ig
+ s/location="?(no|0)"?/location=1/ig s/status="?(no|0)"?/status=1/ig
+ s/scrolling="?(no|0|Auto)"?/scrolling=1/ig
+ s/menubar="?(no|0)"?/menubar=1/ig
+
+ # The <BLINK> tag was a crime!
+ #
+ s*<blink>|</blink>**ig
+
+ # Is this evil?
+ #
+ #s/framespacing="?(no|0)"?//ig
+ #s/margin(height|width)=[0-9]*//gi
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
Just for kicks, replace any occurrence of <quote>Microsoft</quote> with
- <quote>MicroSuck</quote>:
+ <quote>MicroSuck</quote>, and have a little fun with topical buzzwords:
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
+ FILTER: fun
+
s/microsoft(?!.com)/MicroSuck/ig
+
+ # Buzzword Bingo:
+ #
+ s/industry-leading|cutting-edge|award-winning/<font color=red><b>BINGO!</b></font>/ig
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
<para>
- Kill those auto-refresh tags:
+ Kill those pesky little web-bugs:
</para>
<para>
<literal>
- <MSGText>
+ <msgtext>
<literallayout>
- # Kill refresh tags. I like to refresh myself. Manually.
- # check it out on http://www.airport-cgn.de/ and go to the arrivals page.
- #
- s/<meta[^>]*http-equiv[^>]*refresh.*URL=([^>]*?)"?>/<link rev="x-refresh" href=$1>/i
- s/<meta[^>]*http-equiv="?page-enter"?[^>]*content=[^>]*>/<!--no page enter for me-->/i
+ # webbugs: Squish WebBugs (1x1 invisible GIFs used for user tracking)
+ FILTER: webbugs
+
+ s/<img\s+[^>]*?(width|height)\s*=\s*['"]?1\D[^>]*?(width|height)\s*=\s*['"]?1(\D[^>]*?)?>/<!-- Squished WebBug -->/sig
</literallayout>
- </MSGText>
+ </msgtext>
</literal>
</para>
</sect2>
+<!-- ~ End section ~ -->
+
+
+
+<!-- ~~~~~ New section ~~~~~ -->
+
+<sect2>
+<title>Templates</title>
+<para>
+ When <application>Privoxy</application> displays one of its internal
+ pages, such as a 404 Not Found error page, it uses the appropriate template.
+ On Linux, BSD, and Unix, these are located in
+ <filename>/etc/privoxy/templates</filename> by default. These may be
+ customized, if desired.
+
+</para>
+</sect2>
+
</sect1>
+<!-- ~ End section ~ -->
+
+
+
<!-- ~~~~~ New section ~~~~~ -->
-<sect1 id="quickstart"><title>Quickstart to Using Junkbuster</title>
+<sect1 id="quickstart"><title>Quickstart to Using <application>Privoxy</application></title>
<para>
- Install package, then run and enjoy! <application>Junbuster</application>
- accepts only one command line option -- the configuration file to be
- used. Example Unix startup command:
+ Install package, then run and enjoy! <application>Privoxy</application>
+ is typically started by specifying the main configuration file to be
+ used on the command line. Example Unix startup command:
</para>
<para>
<screen>
- # /usr/sbin/junkbuster /etc/junkbuster/config &
+ # /usr/sbin/privoxy /etc/privoxy/config
</screen>
</para>
+<para>
+ An init script is provided for SuSE and Redhat.
+</para>
+
+<para>
+For for SuSE: /etc/rc.d/privoxy start
+</para>
+
+<para>
+For RedHat: /etc/rc.d/init.d/privoxy start
+</para>
+
+
<para>
If no configuration file is specified on the command line,
- <application>Junkbuster</application> will look for a file named
- <filename>config</filename> in the current directory. Except on Amiga where
- it will look for <filename>AmiTCP:db/junkbuster/config</filename> and Win32
- where it will try <filename>junkbstr.txt</filename>. If no file is specified
- on the command line and no default configuration file can be found,
- <application>Junkbuster</application> will fail to start.
+ <application>Privoxy</application> will look for a file named
+ <filename>config</filename> in the current directory. Except on Win32 where
+ it will try <filename>config.txt</filename>. If no file is specified on the
+ command line and no default configuration file can be found,
+ <application>Privoxy</application> will fail to start.
</para>
<para>
Be sure your browser is set to use the proxy which is by default at
- localhost, port 8
000. With <application>Netscape</application> (and
+ localhost, port 8
118. With <application>Netscape</application> (and
<application>Mozilla</application>), this can be set under <literal>Edit
-> Preferences -> Advanced -> Proxies -> HTTP Proxy</literal>.
For <application>Internet Explorer</application>: <literal>Tools >
Internet Properties -> Connections -> LAN Setting</literal>. Then,
check <quote>Use Proxy</quote> and fill in the appropriate info (Address:
- localhost, Port: 8000). Include if HTTPS proxy support too.
+ localhost, Port: 8118). Include if HTTPS proxy support too.
</para>
<para>
The included default configuration files should give a reasonable starting
point, though may be somewhat aggressive in blocking junk. You will probably
- want to keep an eye out for sites that require cookies, and add these to
- <filename>actionsfile</filename> as needed. By default, most of these will
- be blocked until you add them to the configuration. If you want the browser
- to handle this instead, you will need to edit
- <filename>actionsfile</filename> and disable this feature. If you use more
- than one browser, it would make more sense to let
- <application>Junkbuster</application> handle this. In which case, the
+ want to keep an eye out for sites that require persistent cookies, and add these to
+ <filename>ijb.action</filename> as needed. By default, most of these will
+ be accepted only during the current browser session, until you add them to
+ the configuration. If you want the browser to handle this instead, you will
+ need to edit <filename>ijb.action</filename> and disable this feature. If you
+ use more than one browser, it would make more sense to let
+ <application>Privoxy</application> handle this. In which case, the
browser(s) should be set to accept all cookies.
</para>
<para>
If a particular site shows problems loading properly, try adding it
to the <literal>{fragile}</literal> section of
- <filename>actionsfile</filename>. This will turn off most actions for
+ <filename>ijb.action</filename>. This will turn off most actions for
this site.
</para>
<para>
- HTTP/1.1 support is not fully implemented. If browsers that
- support HTTP/1.1 (like <application>Mozilla</application> or recent versions
- of I.E.) experience problems, you might try to force HTTP/1.0 compatiblity.
- For Mozilla, look under <literal>Edit -> Preferences -> Debug ->
- Networking</literal>. Or set the <quote>+downgrade</quote> config option in
- <filename>actionsfile</filename>.
+ <application>Privoxy</application> is HTTP/1.1 compliant, but not all 1.1
+ features are as yet implemented. If browsers that support HTTP/1.1 (like
+ <application>Mozilla</application> or recent versions of I.E.) experience
+ problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look
+ under <literal>Edit -> Preferences -> Debug -> Networking</literal>.
+ Or set the <quote>+downgrade</quote> config option in
+ <filename>ijb.action</filename>.
</para>
<para>
- After running <application>Junkbuster</application> for a while, you can
+ After running <application>Privoxy</application> for a while, you can
start to fine tune the configuration to suit your personal, or site,
preferences and requirements. There are many, many aspects that can
- be customized. <quote>Actions</quote> (from <filename>actionsfile</filename>)
+ be customized. <quote>Actions</quote> (as specified in <filename>ijb.action</filename>)
can be adjusted by pointing your browser to
- <ulink url="http://i.j.b./">http://i.j.b./</ulink>,
+ <ulink url="http://i.j.b/">http://i.j.b/</ulink>,
and then follow the link to <quote>edit the actions list</quote>.
(This is an internal page and does not require Internet access.)
</para>
<para>
- In fact, various aspects of <application>Junkbuster</application>
+ In fact, various aspects of <application>Privoxy</application>
configuration can be viewed from this page, including
current configuration parameters, source code version numbers,
the browser's request headers, and <quote>actions</quote> that apply
- to a given URL. In addition to the <filename>actionsfile</filename>
- editor mentioned above, <application>Junkbuster</application> can also
+ to a given URL. In addition to the <filename>ijb.action</filename> file
+ editor mentioned above, <application>Privoxy</application> can also
be turned <quote>on</quote> and <quote>off</quote> from this page.
</para>
<para>
If you encounter problems, please verify it is a
- <application>Junkbuster</application> bug, by disabling
- <application>Junkbuster</application>, and then trying the same page.
+ <application>Privoxy</application> bug, by disabling
+ <application>Privoxy</application>, and then trying the same page.
Also, try another browser if possible to eliminate browser or site
problems. Before reporting it as a bug, see if there is not a configuration
option that is enabled that is causing the page not to load. You can
the developers (see below).
</para>
+
+
+<!-- ~~~~~ New section ~~~~~ -->
+
+<sect2>
+<title>Command Line Options</title>
+<para>
+ <application>Privoxy</application> may be invoked with the following
+ command-line options:
+</para>
+
+<para>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <emphasis>--version</emphasis>
+ </para>
+ <para>
+ Print version info and exit, Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>--help</emphasis>
+ </para>
+ <para>
+ Print a short usage info and exit, Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>--no-daemon</emphasis>
+ </para>
+ <para>
+ Don't become a daemon, i.e. don't fork and become process group
+ leader, don't detach from controlling tty. Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>--pidfile FILE</emphasis>
+
+ </para>
+ <para>
+ On startup, write the process ID to <emphasis>FILE</emphasis>. Delete the
+ <emphasis>FILE</emphasis> on exit. Failiure to create or delete the
+ <emphasis>FILE</emphasis> is non-fatal. If no <emphasis>FILE</emphasis>
+ option is given, no PID file will be used. Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>--user USER[.GROUP]</emphasis>
+
+ </para>
+ <para>
+ After (optionally) writing the PID file, assume the user ID of
+ <emphasis>USER</emphasis>, and if included the GID of GROUP. Exit if the
+ privileges are not sufficient to do so. Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>configfile</emphasis>
+ </para>
+ <para>
+ If no <emphasis>configfile</emphasis> is included on the command line,
+ <application>Privoxy</application> will look for a file named
+ <quote>config</quote> in the current directory (except on Win32
+ where it will look for <quote>config.txt</quote> instead). Specify
+ full path to avoid confusion.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+</para>
+
+</sect2>
+
</sect1>
+<!-- ~ End section ~ -->
+
+
<!-- ~~~~~ New section ~~~~~ -->
-<sect1 id="contact"><title>Contact the Developers</title>
+
+<sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
+Requests</title>
<para>
-<!--
-To be filled. mention the support forums as the primary channel of
-communication (bugs, feature requests, etc.)
--->
- Feature requests and other questions should be posted to the <ulink
- url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">Feature
- request page</ulink> at SourceForge. There is also an archive there.
+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&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&atid=111118">Sourceforge bug
+ forum</ulink>.
+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.</para>
+</listitem>
+
+
+ <listitem><para>Submit feature requests only thru our <ulink
+ url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">Sourceforge feature request forum</ulink>.</para></listitem>
+
+
+ </itemizedlist>
+
+</para>
+
+<para>
+For any other issues, feel free to use the <ulink url="http://sourceforge.net/mail/?group_id=11118">mailing lists</ulink>.
</para>
<para>
Archives are available here too.
</para>
-<para>
- Please report bugs, using the form at
- <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">Sourceforge</ulink>.
- Please try to verify that it is a <application>Junkbuster</application> bug,
- and not a browser or site bug first. Also, check to make sure this is not
- already a known bug.
-</para>
-
</sect1>
<sect2>
<title>License</title>
<para>
- <application>Internet Junkbuster</application> is free software; you can
+ <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.
<sect2>
<title>History</title>
<para>
- <application>Junkbuster</application> was originally written by Anonymous
+ <application>Junkbuster</application> was originally written by Anonymous
Coders and <ulink
- url="http://www.junkbusters.com/ht/en/ijbfaq.html">JunkBusters
+ url="http://www.junkbusters.com/ht/en/ijbfaq.html">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</ulink> to
- rekindle development. The last stable release was v2.0.2, which has now
+ 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
grown whiskers ;-).
</para>
</simplelist>
<simplelist>
<member>
- <ulink url="http://i.j.b./">http://i.j.b./</ulink>
+ <ulink url="http://i.j.b/">http://i.j.b/</ulink>
</member>
</simplelist>
<simplelist>
<sect2 id="regex">
<title>Regular Expressions</title>
<para>
- <application>Junkbuster</application> can use <quote>regular expressions</quote>
+ <application>Privoxy</application> can use <quote>regular expressions</quote>
in various config files. Assuming support for <quote>pcre</quote> (Perl
Compatible Regular Expressions) is compiled in, which is the default. Such
configuration directives do not require regular expressions, but they can be
- used to increase flexibility by matching a pattern with wildcards against
+ used to increase flexibility by matching a pattern with wild-cards against
URLs.
</para>
expression against another to see if it matches or not. One of the
<quote>expressions</quote> is a literal string of readable characters
(letter, numbers, etc), and the other is a complex string of literal
- characters combined with wildcards, and other special characters, called
- metacharacters. The <quote>metacharacters</quote> have special meanings and
+ characters combined with wild-cards, and other special characters, called
+ meta-characters. The <quote>meta-characters</quote> have special meanings and
are used to build the complex pattern to be matched against. Perl Compatible
Regular Expressions is an enhanced form of the regular expression language
with backward compatibility.
</para>
<para>
- To make a simple analogy, we do something similar when we use wildcard
+ To make a simple analogy, we do something similar when we use wild-card
characters when listing files with the <command>dir</command> command in DOS.
<literal>*.*</literal> matches all filenames. The <quote>special</quote>
- character here is the asterik which matches any and all characters. We can be
+ character here is the asterisk which matches any and all characters. We can be
more specific and use <literal>?</literal> to match just individual
characters. So <quote>dir file?.text</quote> would match
<quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
<emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
the following character should be taken literally. This is used where one of the
special characters (e.g. <quote>.</quote>) needs to be taken literally and
- not as a special metacharacter.
+ not as a special meta-character.
</member>
</simplelist>
<simplelist>
<member>
- <emphasis>()</emphasis> - Pararentheses are used to group a sub-expression,
+ <emphasis>()</emphasis> - parentheses are used to group a sub-expression,
or multiple sub-expressions.
</member>
</simplelist>
<para>
These are just some of the ones you are likely to use when matching URLs with
- <application>Junkbuster</application>, and is a long way from a definitive
+ <application>Privoxy</application>, and is a long way from a definitive
list. This is enough to get us started with a few simple examples which may
be more illuminating:
</para>
<para>
<emphasis><literal>s/microsoft(?!.com)/MicroSuck/i</literal></emphasis> - This is
- a substitution. <quote>MicroSuck</quote> will replace any occurence of
+ a substitution. <quote>MicroSuck</quote> will replace any occurrence of
<quote>microsoft</quote>. The <quote>i</quote> at the end of the expression
means ignore case. The <quote>(?!.com)</quote> means
the match should fail if <quote>microsoft</quote> is followed by
<para>
We are barely scratching the surface of regular expressions here so that you
- can understand the default <application>Junkbuster</application>
+ can understand the default <application>Privoxy</application>
configuration files, and maybe use this knowledge to customize your own
installation. There is much, much more that can be done with regular
expressions. Now that you know enough to get started, you can learn more on
</sect2>
+<!-- ~ End section ~ -->
+
+
+<!-- ~~~~~ New section ~~~~~ -->
+<sect2>
+<title><application>Privoxy</application>'s Internal Pages</title>
+
+<para>
+ Since <application>Privoxy</application> proxies each requested
+ web page, it is easy for <application>Privoxy</application> to
+ trap certain URLs. In this way, we can talk directly to
+ <application>Privoxy</application>, and see how it is
+ configured, see how our rules are being applied, change these
+ rules and other configuration options, and even turn
+ <application>Privoxy's</application> filtering off, all with
+ a web browser.
+
+</para>
+
+<para>
+ The URLs listed below are the special ones that allow direct access
+ to <application>Privoxy</application>. Of course,
+ <application>Privoxy</application> must be running to access these. If
+ not, you will get a friendly error message. Internet access is not
+ necessary either.
+</para>
+
+<para>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Privoxy main page:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/">http://ijbswa.sourceforge.net/config/</ulink>
+ </para>
+ </blockquote>
+ <para>
+ Alternately, this may be reached at <ulink url="http://i.j.b/">http://i.j.b/</ulink>,
+ but this variation may not work as reliably as the above in some
+ configurations.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Show information about the current configuration:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/show-status">http://ijbswa.sourceforge.net/config/show-status</ulink>
+ </para>
+ </blockquote>
+ </listitem>
+
+ <listitem>
+ <para>
+ Show the source code version numbers:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/show-version">http://ijbswa.sourceforge.net/config/show-version</ulink>
+ </para>
+ </blockquote>
+ </listitem>
+
+ <listitem>
+ <para>
+ Show the client's request headers:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/show-request">http://ijbswa.sourceforge.net/config/show-request</ulink>
+ </para>
+ </blockquote>
+ </listitem>
+
+ <listitem>
+ <para>
+ Show which actions apply to a URL and why:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/show-url-info">http://ijbswa.sourceforge.net/config/show-url-info</ulink>
+ </para>
+ </blockquote>
+ </listitem>
+
+ <listitem>
+ <para>
+ Toggle Privoxy on or off:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/toggle">http://ijbswa.sourceforge.net/config/toggle</ulink>
+ </para>
+ </blockquote>
+ <para>
+ Short cuts. Turn off, then on:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/toggle?set=disable">http://ijbswa.sourceforge.net/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>
+ </para>
+ </blockquote>
+ </listitem>
+
+ <listitem>
+ <para>
+ Edit the actions list file:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/edit-actions">http://ijbswa.sourceforge.net/config/edit-actions</ulink>
+ </para>
+ </blockquote>
+ </listitem>
+
+ </itemizedlist>
+</para>
+
+<para>
+ These may be bookmarked for quick reference.
+
+</para>
+
+</sect2>
+
+
+<!-- ~~~~~ New section ~~~~~ -->
+<sect2 id="actionsanat">
+<title>Anatomy of an Action</title>
+
+<para>
+ The way <application>Privoxy</application> applies <quote>actions</quote>
+ to any given URL can be complex, and not always so easy to understand what
+ is happening. And sometimes we need to be able to <emphasis>see</emphasis>
+ just what <application>Privoxy</application> is doing. Especially,
+ if something <application>Privoxy</application> is doing is causing
+ us a problem inadvertantly. It can be a little daunting to look at
+ 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>
+ 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>
+
+<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>re_filterfile</filename>! 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
+ actual URL that is pasted into the prompt area -- not any sub-URLs. If you
+ want to know about embedded URLs like ads, you will have to dig those out of
+ the HTML source. Use your browser's <quote>View Page Source</quote> option
+ for this.
+</para>
+
+<para>
+ Let's look at an example, <ulink url="http://google.com">google.com</ulink>,
+ one section at a time:
+</para>
+
+<para>
+ <screen>
+ System default actions:
+
+ { -add-header -block -deanimate-gifs -downgrade -fast-redirects -filter
+ -hide-forwarded -hide-from -hide-referer -hide-user-agent -image
+ -image-blocker -limit-connect -no-compression -no-cookies-keep
+ -no-cookies-read -no-cookies-set -no-popups -vanilla-wafer -wafer }
+
+ </screen>
+</para>
+
+<para>
+ This is the top section, and only tells us of the compiled in defaults. This
+ is basically what <application>Privoxy</application> would do if there
+ were not any <quote>actions</quote> defined, i.e. it does nothing. Every action
+ is disabled. This is not particularly informative for our purposes here. OK,
+ next section:
+</para>
+
+<para>
+ <screen>
+
+ Matches for http://google.com:
+
+ { -add-header -block +deanimate-gifs -downgrade +fast-redirects
+ +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
+ +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
+ +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
+ -hide-user-agent -image +image-blocker{blank} +no-compression
+ +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups
+ -vanilla-wafer -wafer }
+ /
+
+ { -no-cookies-keep -no-cookies-read -no-cookies-set }
+ .google.com
+
+ { -fast-redirects }
+ .google.com
+
+ </screen>
+</para>
+
+<para>
+ This is much more informative, and tells us how we have defined our
+ <quote>actions</quote>, and which ones match for our example,
+ <quote>google.com</quote>. The first grouping shows our default
+ settings, which would apply to all URLs. If you look at your <quote>actions</quote>
+ file, this would be the section just below the <quote>aliases</quote> section
+ near the top. This applies to all URLs as signified by the single forward
+ slash -- <quote>/</quote>.
+
+</para>
+
+<para>
+ These are the default actions we have enabled. But we can define additional
+ actions that would be exceptions to these general rules, and then list
+ specific URLs that these exceptions would apply to. Last match wins.
+ Just below this then are two explict matches for <quote>.google.com</quote>.
+ The first is negating our various cookie blocking actions (i.e. we will allow
+ cookies here). The second is allowing <quote>fast-redirects</quote>. Note
+ that there is a leading dot here -- <quote>.google.com</quote>. This will
+ match any hosts and sub-domains, in the google.com domain also, such as
+ <quote>www.google.com</quote>. So, apparently, we have these actions defined
+ somewhere in the lower part of our actions file, and
+ <quote>google.com</quote> is referenced in these sections.
+
+</para>
+
+<para>
+ And now we pull it altogether in the bottom section and summarize how
+ <application>Privoxy</application> is appying all its <quote>actions</quote>
+ to <quote>google.com</quote>:
+
+</para>
+
+<para>
+ <screen>
+
+ Final results:
+
+ -add-header -block -deanimate-gifs -downgrade -fast-redirects
+ +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
+ +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
+ +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
+ -hide-user-agent -image +image-blocker{blank} -limit-connect +no-compression
+ -no-cookies-keep -no-cookies-read -no-cookies-set +no-popups -vanilla-wafer
+ -wafer
+
+ </screen>
+</para>
+
+<para>
+ Now another example, <quote>ad.doubleclick.net</quote>:
+</para>
+
+<para>
+ <screen>
+
+ { +block +image }
+ .ad.doubleclick.net
+
+ { +block +image }
+ ad*.
+
+ { +block +image }
+ .doubleclick.net
+
+ </screen>
+</para>
+
+<para>
+ We'll just show the interesting part here, the explicit matches. It is
+ matched three different times. Each as an <quote>+block +image</quote>,
+ which is the expanded form of one of our aliases that had been defined as:
+ <quote>+imageblock</quote>. (<quote>Aliases</quote> are defined in the
+ first section of the actions file and typically used to combine more
+ than one action.)
+</para>
+
+<para>
+ Any one of these would have done the trick and blocked this as an unwanted
+ image. This is unnecessarily redundant since the last case effectively
+ would also cover the first. No point in taking chances with these guys
+ though ;-) Note that if you want an ad or obnoxious
+ URL to be invisible, it should be defined as <quote>ad.doubleclick.net</quote>
+ is done here -- as both a <quote>+block</quote> <emphasis>and</emphasis> an
+ <quote>+image</quote>. The custom alias <quote>+imageblock</quote> does this
+ for us.
+</para>
+
+<para>
+ One last example. Let's try <quote>http://www.rhapsodyk.net/adsl/HOWTO/</quote>.
+ This one is giving us problems. We are getting a blank page. Hmmm...
+</para>
+
+<para>
+ <screen>
+
+ Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
+
+ { -add-header -block +deanimate-gifs -downgrade +fast-redirects
+ +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
+ +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
+ +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
+ -hide-user-agent -image +image-blocker{blank} +no-compression
+ +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups
+ -vanilla-wafer -wafer }
+ /
+
+ { +block +image }
+ /ads
+
+ </screen>
+</para>
+
+<para>
+ Ooops, the <quote>/adsl/</quote> is matching <quote>/ads</quote>! But
+ we did not want this at all! Now we see why we get the blank page. We could
+ now add a new action below this that explictly does <emphasis>not</emphasis>
+ block (-block) pages with <quote>adsl</quote>. There are various ways to
+ handle such exceptions. Example:
+</para>
+
+<para>
+ <screen>
+
+ { -block }
+ /adsl
+
+ </screen>
+</para>
+
+<para>
+ Now the page displays ;-)
+
+</para>
+
+</sect2>
+
</sect1>
<!--
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
+ Revision 1.51 2002/03/23 15:13:11 swa
+ renamed every reference to the old name with foobar.
+ fixed "application foobar application" tag, fixed
+ "the foobar" with "foobar". left junkbustser in cvs
+ comments and remarks to history untouched.
+
+ Revision 1.50 2002/03/23 05:06:21 hal9
+ Touch up.
+
+ Revision 1.49 2002/03/21 17:01:05 hal9
+ New section in Appendix.
+
+ Revision 1.48 2002/03/12 06:33:01 hal9
+ Catching up to Andreas and re_filterfile changes.
+
+ Revision 1.47 2002/03/11 13:13:27 swa
+ correct feedback channels
+
+ Revision 1.46 2002/03/10 00:51:08 hal9
+ Added section on JB internal pages in Appendix.
+
+ Revision 1.45 2002/03/09 17:43:53 swa
+ more distros
+
+ Revision 1.44 2002/03/09 17:08:48 hal9
+ New section on Jon's actions file editor, and move some stuff around.
+
+ Revision 1.43 2002/03/08 00:47:32 hal9
+ Added imageblock{pattern}.
+
+ Revision 1.42 2002/03/07 18:16:55 swa
+ looks better
+
+ Revision 1.41 2002/03/07 16:46:43 hal9
+ Fix a few markup problems for jade.
+
+ Revision 1.40 2002/03/07 16:28:39 swa
+ provide correct feedback channels
+
+ Revision 1.39 2002/03/06 16:19:28 hal9
+ Note on perceived filtering slowdown per FR.
+
+ Revision 1.38 2002/03/05 23:55:14 hal9
+ Stupid I did it again. Double hyphen in comment breaks jade.
+
+ Revision 1.37 2002/03/05 23:53:49 hal9
+ jade barfs on '- -' embedded in comments. - -user option broke it.
+
+ Revision 1.36 2002/03/05 22:53:28 hal9
+ Add new - - user option.
+
+ Revision 1.35 2002/03/05 00:17:27 hal9
+ Added section on command line options.
+
+ Revision 1.34 2002/03/04 19:32:07 oes
+ Changed default port to 8118
+
+ Revision 1.33 2002/03/03 19:46:13 hal9
+ Emphasis on where/how to report bugs, etc
+
+ Revision 1.32 2002/03/03 09:26:06 joergs
+ AmigaOS changes, config is now loaded from PROGDIR: instead of
+ AmiTCP:db/junkbuster/ if no configuration file is specified on the
+ command line.
+
+ Revision 1.31 2002/03/02 22:45:52 david__schmidt
+ Just tweaking
+
+ Revision 1.30 2002/03/02 22:00:14 hal9
+ Updated 'New Features' list. Ran through spell-checker.
+
+ Revision 1.29 2002/03/02 20:34:07 david__schmidt
+ Update OS/2 build section
+
+ Revision 1.28 2002/02/24 14:34:24 jongfoster
+ Formatting changes. Now changing the doctype to DocBook XML 4.1
+ will work - no other changes are needed.
+
+ Revision 1.27 2002/01/11 14:14:32 hal9
+ Added a very short section on Templates
+
+ Revision 1.26 2002/01/09 20:02:50 hal9
+ Fix bug re: auto-detect config file changes.
+
+ Revision 1.25 2002/01/09 18:20:30 hal9
+ Touch ups for *.action files.
+
+ Revision 1.24 2001/12/02 01:13:42 hal9
+ Fix typo.
+
+ Revision 1.23 2001/12/02 00:20:41 hal9
+ Updates for recent changes.
+
+ Revision 1.22 2001/11/05 23:57:51 hal9
+ Minor update for startup now daemon mode.
+
+ Revision 1.21 2001/10/31 21:11:03 hal9
+ Correct 2 minor errors
+
Revision 1.18 2001/10/24 18:45:26 hal9
*** empty log message ***
projects / privoxy.git / blobdiff