-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
+<!entity % dummy "INCLUDE">
+<!entity supported SYSTEM "supported.sgml">
+<!entity newfeatures SYSTEM "newfeatures.sgml">
+<!entity p-intro SYSTEM "privoxy.sgml">
+<!entity seealso SYSTEM "seealso.sgml">
+<!entity buildsource SYSTEM "buildsource.sgml">
+<!entity contacting SYSTEM "contacting.sgml">
+<!entity history SYSTEM "history.sgml">
+<!entity copyright SYSTEM "copyright.sgml">
+<!entity p-version "2.9.14">
+<!entity p-status "beta">
+<!entity % p-not-stable "INCLUDE">
+<!entity % p-stable "IGNORE">
+<!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
+<!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
+<!entity % p-readme "IGNORE">
+<!entity % p-supp-userman "IGNORE"> <!-- Omit some from supported.sgml -->
+]>
<!--
File : $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.49 2002/03/21 17:01:05 hal9 Exp $
+ $Id: user-manual.sgml,v 1.75 2002/04/12 02:08:48 david__schmidt Exp $
Written by and Copyright (C) 2001 the SourceForge
- IJBSWA team. http://ijbswa.sourceforge.net
+ Privoxy team. http://www.privoxy.org/
Based on the Internet Junkbuster originally written
by and Copyright (C) 1997 Anonymous Coders and
Junkbusters Corporation. http://www.junkbusters.com
--->
-<!--
-Sat 03/02/02 04:53:47 PM
-This should be ready for BETA release.
+ ========================================================================
+ NOTE: Please read developer-manual/documentation.html before touching
+ anything in this, or other Privoxy documentation.
+ ========================================================================
-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.49 2002/03/21 17:01:05 hal9 Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.75 2002/04/12 02:08:48 david__schmidt Exp $</pubdate>
<authorgroup>
<author>
<affiliation>
- <orgname>By: Junkbuster Developers</orgname>
+ <orgname>By: Privoxy Developers</orgname>
</affiliation>
</author>
</authorgroup>
<abstract>
+<![%dummy;[
<para>
- The user manual gives users information on how to install, configure and use
- <application>Internet Junkbuster</application>. <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. Junkbuster 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.
+ <comment>
+ This is here to keep vim syntax file from breaking :/
+ If I knew enough to fix it, I would.
+ PLEASE DO NOT REMOVE! HB: hal@foobox.net
+ </comment>
</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>
+ The user manual gives users information on how to install, configure and use
+ <ulink
+ url="http://www.privoxy.org/"><application>Privoxy</application></ulink>.
+ </para>
+
+<!-- Include privoxy.sgml boilerplate: -->
+ &p-intro;
+<!-- end privoxy.sgml -->
+
+ <para>
+ You can find the latest version of the user manual at <ulink
+ url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink>.
+ Please see the <ulink url="contact.html">Contact section</ulink> on how to
+ contact the developers.
+ </para>
<!-- <para> -->
<!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
</artheader>
+<!-- ~~~~~ New section ~~~~~ -->
+<sect1 id="intro" label=""><title></title>
+<!-- dummy section to force TOC on page by itself -->
+<!-- DO NOT REMOVE! please ;) -->
+<para> </para>
+</sect1>
<!-- ~~~~~ New section ~~~~~ -->
-<sect1 id="introduction"><title>Introduction</title>
-<para>
- <application>Internet Junkbuster</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>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.
-</para>
+<sect1 label="1" id="introduction"><title>Introduction</title>
<para>
- This documentation is included with the current BETA version of
- <application>Internet Junkbuster</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 nearing completion, and includes many significant
- changes and enhancements over earlier versions. The target release date for
- stable v3.0 is <quote>soon</quote> ;-)
+ This documentation is included with the current &p-status; version of
+ <application>Privoxy</application>, v.&p-version;<![%p-not-stable;[,
+ 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 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>
+<![%p-not-stable;[
+<!-- include only in non-stable versions -->
<para>
- Since this is a BETA version, not all new features are well tested. This
+ Since this is a &p-status; version, not all new features are well tested. This
documentation may be slightly out of sync as a result (especially with
CVS sources). And there <emphasis>may be</emphasis> bugs, though hopefully
not many!
</para>
-
+]]>
<!-- ~~~~~ New section ~~~~~ -->
-<sect2>
+<sect2 id="newfeatures">
<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:
-</para>
-
-<!--
- The section is in both user-manual and faq. Please keep in sync.
--->
-<para>
- <itemizedlist>
-
- <listitem>
- <para>
- 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, probably a 3.1 feature)
- </para>
- </listitem>
--->
- <listitem>
- <para>
- Blocking of annoying pop-up browser windows.
- </para>
- </listitem>
-
- <listitem>
- <para>
- 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 and flexible configuration syntax over
- previous versions.
- </para>
- </listitem>
-
- <listitem>
- <para>
- GIF de-animation.
- </para>
- </listitem>
-
- <listitem>
- <para>
- 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>
-
- <listitem>
- <para>
- Auto-detection and re-reading of config file changes.
- </para>
- </listitem>
-
- <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>
+ In addition to <application>Internet Junkbuster's</application> traditional
+ feature of ad and banner blocking and cookie management,
+ <application>Privoxy</application> provides new features<![%p-not-stable;[,
+ some of them currently under development]]>:
+<anchor id="testing"/>
</para>
+<!-- Include newfeatures.sgml boilerplate here: -->
+ &newfeatures;
+<!-- end boilerplate -->
</sect2>
</sect1>
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="installation"><title>Installation</title>
<para>
- <application>Junkbuster</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 binaries and current release info. <application>Junkbuster</application>
- is also available via <ulink
+ <application>Privoxy</application> is available as raw source code (tarball
+ or via CVS), or pre-compiled binaries for various platforms. See the <ulink
+ url="http://sourceforge.net/projects/ijbswa/">Privoxy Project Page</ulink> for
+ the most up to date release information.
+ <application>Privoxy</application> is also available via <ulink
url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
- This is the recommended approach at this time. But please be aware that CVS
- is constantly changing, and it may break in mysterious ways.
+ <![%p-not-stable;[This is the recommended approach at this time.]]> But
+ please be aware that CVS is constantly changing, and it may break in
+ mysterious ways.
</para>
+<!-- Include supported.sgml boilerplate -->
+ &supported;
+<!-- end boilerplate -->
+
<!-- ~~~~~ New section ~~~~~ -->
<sect2 id="installation-source"><title>Source</title>
-<para>
- For gzipped tar archives, unpack the source:
-</para>
-
-<para>
- <screen>
- tar xzvf ijb_source_* [.tgz or .tar.gz]
- cd ijb_source_2.9.11_beta
- </screen>
-</para>
-
-<para>
- For retrieving the current CVS sources, you'll need the CVS
- package installed first. To download CVS source:
-</para>
-<para>
- <screen>
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
- cd current
- </screen>
-</para>
-<para>
- This will create a directory named <filename>current/</filename>, which will
- contain the source tree.
-</para>
-
-<para>
- Then, in either case, to build from tarball/CVS source:
-</para>
-
-<para>
- <screen>
- ./configure (--help to see options)
- make (the make from gnu, gmake for *BSD)
- su
- make -n install (to see where all the files will go)
- make install (to really install)
- </screen>
-</para>
+<!-- include buildsource.sgml boilerplate: -->
+ &buildsource;
+<!-- end boilerplate -->
<para>
For Redhat and SuSE Linux RPM packages, see below.
</para>
-</sect2>
-
<!-- ~~~~~ New section ~~~~~ -->
-<sect2 id="installation-rh"><title>Red Hat</title>
+<sect3 id="installation-rh"><title>Red Hat</title>
<para>
- To build Redhat RPM packages, install source as above. Then:
+ To build Redhat RPM packages from source, install source as above. Then:
</para>
<para>
<screen>
- autoheader [suggested for CVS source]
- autoconf [suggested for CVS source]
+ autoheader
+ autoconf
./configure
make redhat-dist
</screen>
</para>
<para>
- /usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
+ /usr/src/redhat/RPMS/i686/privoxy-&p-version;-1.i686.rpm
</para>
<para>
- /usr/src/redhat/SRPMS/junkbuster-2.9.11-1.src.rpm
+ /usr/src/redhat/SRPMS/privoxy-&p-version;-1.src.rpm
</para>
<para>
<para>
<screen>
- rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
+ rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-&p-version;-1.i686.rpm
</screen>
</para>
<para>
- This will place the <application>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>. Run
+ <quote><command>chkconfig privoxy on</command></quote> to have
+ <application>Privoxy</application> start automatically during init.
+
</para>
-</sect2>
+</sect3>
<!-- ~~~~~ New section ~~~~~ -->
-<sect2 id="installation-suse"><title>SuSE</title>
+<sect3 id="installation-suse"><title>SuSE</title>
<para>
To build SuSE RPM packages, install source as above. Then:
</para>
<para>
<screen>
- autoheader [suggested for CVS source]
- autoconf [suggested for CVS source]
+ autoheader
+ autoconf
./configure
make suse-dist
</screen>
</para>
<para>
- /usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
+ /usr/src/packages/RPMS/i686/privoxy-&p-version;-1.i686.rpm
</para>
<para>
- /usr/src/packages/SRPMS/junkbuster-2.9.11-1.src.rpm
+ /usr/src/packages/SRPMS/privoxy-&p-version;-1.src.rpm
</para>
<para>
<para>
<screen>
- rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
+ rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-&p-version;-1.i686.rpm
</screen>
</para>
<para>
- This will place the <application>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>
+</sect3>
<!-- ~~~~~ New section ~~~~~ -->
-<sect2 id="installation-os2"><title>OS/2</title>
+<sect3 id="installation-os2"><title>OS/2</title>
<!--
Thanx David Schmidt!
-->
<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>ijbos2_setup_1.2.3.exe</filename>. In order to install it, simply
+ <filename>privoxyos2_setup_&p-version;.exe</filename>. In order to install it, simply
run this executable or double-click on its icon and follow the WarpIN
- installation panels. A shadow of the <application>Junkbuster</application>
+ 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>
+</sect3>
+
+
+<!-- ~~~~~ New section ~~~~~ -->
+<sect3 id="installation-win"><title>Windows</title>
+<para>Click-click. (I need help on this. Not a clue here. Also for
+configuration section below. HB.)
+</para>
+</sect3>
+
+<!-- ~~~~~ New section ~~~~~ -->
+<sect3 id="installation-other"><title>Other</title>
<para>
- If you would like to build binary images on OS/2 yourself, you will need
- 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.
+ Some quick notes on other Operating Systems.
</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
- cd ..\os2setup
- nmake -f Makefile.vac
- </screen>
- You will see this sequence laid out in <filename>os2build.cmd</filename>.
+ 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.
</para>
+</sect3>
</sect2>
+</sect1>
+
+<!-- ~ End section ~ -->
+
<!-- ~~~~~ New section ~~~~~ -->
-<sect2 id="installation-win"><title>Windows</title>
-<para>Click-click. (I need help on this. Not a clue here. Also for
-configuration section below. HB.)
+
+<sect1 id="quickstart"><title>Quickstart to Using <application>Privoxy</application></title>
+
+
+<!-- ~~~~~ New section ~~~~~ -->
+<sect2 id="upgradersnote">
+<title>Note to Upgraders</title>
+<para>
+ There are very significant changes from older versions of
+ <application>Junkbuster</application> to the current
+ <application>Privoxy</application>. Configuration is substantially
+ changed. <application>Junkbuster 2.0.x</application> and earlier
+ configuration files will not migrate. The functionality of the old
+ <filename>blockfile</filename>, <filename>cookiefile</filename> and
+ <filename>imagelist</filename>, are now combined into the
+ <quote><filename>actions file</filename></quote>
+ (<filename>default.action</filename> for most installations).
+</para>
+<para>
+ A <quote><filename>filterfile</filename></quote> (typically
+ <filename>default.filter</filename>) is new with
+ <application>Privoxy 2.9.x</application>, and provides some of the new
+ sophisticaton (explained below). <filename>config</filename> is
+ much the same.
+</para>
+<para>
+ If upgrading from a 2.0.x version, you will have to use the new config
+ files, and possibly adapt any personal rules from your older files.
+ If upgrading from 2.9.x development versions, it is still recommended
+ to use the new configuration files.
+</para>
+<para>
+ A quick list of things to be aware of before upgrading:
+</para>
+
+<para>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ The default listening port is now 8118 due to a conflict with another
+ service (NAS).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Some installers may remove earlier versions completely. Save any
+ important configuration files!
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <application>Privoxy</application> is reachable with a web browser
+ at the special URL: <ulink url="http://p.p/">http://p.p/</ulink>. Many
+ aspects of configuration can be done here, including temporarily disabling
+ <application>Privoxy</application>. Alternately,
+ <ulink url="http://config.privoxy.org/">http://config.privoxy.org</ulink>
+ may work in some rare cases where the former does not.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The primary configuration file for cookie management, ad and banner
+ blocking, and many other aspects of <application>Privoxy</application>
+ configuration is <filename>default.action</filename>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+<!-- I think it is best to keep this somewhat vague, in case -->
+<!-- the situation changes under our feet. -->
+ Some installers may not automatically start
+ <application>Privoxy</application> after installation.
+ </para>
+ </listitem>
+
+ </itemizedlist>
</para>
+
</sect2>
<!-- ~~~~~ New section ~~~~~ -->
-<sect2 id="installation-other"><title>Other</title>
+<sect2 id="startup">
+<title>Starting <application>Privoxy</application></title>
<para>
- Some quick notes on other Operating Systems.
+ Before launching <application>Privoxy</application> for the first time, you
+ will want to configure your browser(s) to use <application>Privoxy</application>
+ as a HTTP and HTTPS proxy. The default is localhost for the proxy address,
+ and port 8118 (earlier versions used port 8000). This is the one required
+ configuration that must be done!
+</para>
+
+<para>
+ 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: 8118). Include if HTTPS proxy support too.
</para>
<para>
- 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.
+ After doing this, flush your browser's disk and memory caches to force a
+ re-reading of all pages and get rid of any ads that may be cached. You
+ are now ready to start enjoying the benefits of using
+ <application>Privoxy</application>.
+</para>
+
+
+<para>
+ <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/privoxy /etc/privoxy/config
+
+ </screen>
+</para>
+
+<para>
+ An init script is provided for SuSE and Redhat.
+</para>
+
+<para>
+ For for SuSE: <command>/etc/rc.d/privoxy start</command>
+</para>
+
+<para>
+ For RedHat: <command>/etc/rc.d/init.d/privoxy start</command>
+</para>
+
+
+<para>
+ If no configuration file is specified on the command line,
+ <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>
+ The included default configuration files should give a reasonable starting
+ point. Most of the per site configuration is done in the
+ <quote>actions</quote> files. These are where various cookie actions are
+ defined, ad and banner blocking, and other aspects of
+ <application>Privoxy</application> configuration. There are several such
+ files included, with varying levels of aggressiveness.
+</para>
+
+<para>
+ You will probably want to keep an eye out for sites that require persistent
+ cookies, and add these to <filename>default.action</filename> as needed. By
+ default, most of these will be accepted only during the current browser
+ session (aka <quote>session cookies</quote>), until you add them to the
+ configuration. If you want the browser to handle this instead, you will need
+ to edit <filename>default.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>
+ <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>default.action</filename>.
+</para>
+
+<para>
+ 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> (as specified in <filename>default.action</filename>)
+ can be adjusted by pointing your browser to
+ <ulink url="http://p.p/">http://p.p/</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>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>default.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>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 then add
+ an exception for that page or site. For instance, try adding it to the
+ <literal>{fragile}</literal> section of <filename>default.action</filename>.
+ This will turn off most actions for this site. For more on troubleshooting
+ problem sites, see the <ulink
+ url="appendix.html#ACTIONSANAT">Appendix</ulink>. If a bug, please report it
+ to the developers (see below).
+</para>
+
+</sect2>
+
+
+<!-- ~~~~~ 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>
<!-- ~~~~~ New section ~~~~~ -->
-<sect1 id="configuration"><title>JunkBuster Configuration</title>
+<sect1 id="configuration"><title><application>Privoxy</application> Configuration</title>
<para>
- All <application>JunkBuster</application> configuration is kept
+ All <application>Privoxy</application> configuration is stored
in text files. These files can be edited with a text editor.
- Many important aspects of <application>JunkBuster</application> can
+ Many important aspects of <application>Privoxy</application> can
also be controlled easily with a web browser.
</para>
<!-- ~~~~~ New section ~~~~~ -->
<sect2>
-<title>Controlling Junkbuster with Your Web Browser</title>
+<title>Controlling <application>Privoxy</application> with Your Web Browser</title>
<para>
- <application>JunkBuster</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>),
+ <application>Privoxy</application> can be reached by the special
+ URL <ulink url="http://p.p/">http://p.p/</ulink> (or alternately
+ <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>),
which is an internal page. You will see the following section:
</para>
Please choose from the following options:
+ * Privoxy main page
* Show information about the current configuration
* Show the source code version numbers
- * Show the client's request headers.
+ * Show the request headers.
* Show which actions apply to a URL and why
- * Toggle JunkBuster on or off
+ * Toggle Privoxy on or off
* Edit the actions list
</screen>
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>Junkbuster</application>. This is an easy way to adjust various
- aspects of <application>Junkbuster</application> configuration. The actions
+ <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>Junkbuster</application> will automatically detect any changes
- to these files.
+ <application>Privoxy</application> will automatically detect any changes
+ to these files. Note: one or two requests to the proxy might required to
+ <quote>wake up</quote> <application>Privoxy</application>,
+ and force a re-reading of the configuration. It is not necessarily
+ instantaneous.
</para>
<para>
- <quote>Toggle JunkBuster On or Off</quote> is handy for sites that might
+ <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>JunkBuster</application>
- causing the problem or not. <application>Junkbuster</application> continues
+ 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>
<title>Configuration Files Overview</title>
<para>
For Unix, *BSD and Linux, all configuration files are located in
- <filename>/etc/junkbuster/</filename> by default. For MS Windows, OS/2, and
+ <filename>/etc/privoxy/</filename> by default. For MS Windows, OS/2, and
AmigaOS these are all in the same directory as the
- <application>Junkbuster</application> executable. The name and number of
- configuration files has changed from previous versions, and is subject to
- change as development progresses.
+ <application>Privoxy</application> executable. <![%p-not-stable;[ 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, though possibly
aggressive by some standards. For the time being, there are only three
- default configuration files (this will change in time):
+ default configuration files (this may change in time):
</para>
<para>
<listitem>
<para>
- The <filename>ijb.action</filename> file is used to define various
+ The <filename>default.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>. (Other actions
+ url="http://p.p">http://p.p</ulink>. (Other actions
files are included as well with differing levels of filtering
- and blocking, e.g. <filename>ijb-basic.action</filename>.)
+ and blocking, e.g. <filename>basic.action</filename>.)
</para>
</listitem>
<listitem>
<para>
- The <filename>re_filterfile</filename> file can be used to re-write the raw
+ The <filename>default.filter</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>
</para>
<para>
- <filename>ijb.action</filename> and <filename>re_filterfile</filename>
+ <filename>default.action</filename> and <filename>default.filter</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
+ lines are not processed by <application>Privoxy</application>. After
making any changes, there is no need to restart
- <application>Junkbuster</application> in order for the changes to take
- effect. <application>Junkbuster</application> should detect such changes
+ <application>Privoxy</application> in order for the changes to take
+ effect. <application>Privoxy</application> should detect such changes
automatically.
</para>
+<![%p-not-stable;[
<para>
While under development, the configuration content is subject to change.
The below documentation may not be accurate by the time you read this.
Also, what constitutes a <quote>default</quote> setting, may change, so
please check all your configuration files on important issues.
</para>
+]]>
</sect2>
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
- what ads to block, what cookies to accept, etc. This section of the
- configuration file tells <application>Junkbuster</application> where to find
- all those other files.
+ <application>Privoxy</application> can use a number of other files to tell it
+ what ads to block, what cookies to accept, and perform other functions. This
+ section of the configuration file tells <application>Privoxy</application>
+ where to find all those other files.
</para>
<para>
On <application>Windows</application> and <application>AmigaOS</application>,
- <application>Junkbuster</application> looks for these files in the same
+ <application>Privoxy</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
+ <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>
<literal>
<msgtext>
<literallayout>
- <emphasis>confdir /etc/junkbuster</emphasis> # No trailing /, please.
+ <emphasis>confdir /etc/privoxy</emphasis> # No trailing /, please.
</literallayout>
</msgtext>
</literal>
<literal>
<msgtext>
<literallayout>
- <emphasis>logdir /var/log/junkbuster</emphasis>
+ <emphasis>logdir /var/log/privoxy</emphasis>
</literallayout>
</msgtext>
</literal>
</para>
<para>
- 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 JunkBuster 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.
+ The <quote>default.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>default.filter</quote>. No sites
+ are blocked. <application>Privoxy</application> displays a checkboard type
+ pattern 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>
<literallayout>
- <emphasis>actionsfile ijb.action</emphasis>
+ <emphasis>actionsfile default.action</emphasis>
</literallayout>
</msgtext>
</literal>
</para>
<para>
- The <quote>re_filterfile</quote> file contains content modification rules
+ The <quote>default.filter</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
<literal>
<msgtext>
<literallayout>
- <emphasis>re_filterfile re_filterfile</emphasis>
+ <emphasis>filterfile default.filter</emphasis>
</literallayout>
</msgtext>
</literal>
<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>
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>
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
<literal>
<msgtext>
<literallayout>
- <emphasis>trust-info-url http://www.your-site.com/why_we_block.html</emphasis>
- <emphasis>trust-info-url http://www.your-site.com/what_we_allow.html</emphasis>
+ <emphasis>trust-info-url http://www.example.com/why_we_block.html</emphasis>
+ <emphasis>trust-info-url http://www.example.com/what_we_allow.html</emphasis>
</literallayout>
</msgtext>
</literal>
<para>
This part of the configuration file contains options that control how
- <application>Junkbuster</application> operates.
+ <application>Privoxy</application> operates.
</para>
<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:
<literal>
<msgtext>
<literallayout>
- <emphasis>proxy-info-url http://www.your-site.com/proxy.html</emphasis>
+ <emphasis>proxy-info-url http://www.example.com/proxy.html</emphasis>
</literallayout>
</msgtext>
</literal>
<para>
<quote>Listen-address</quote> specifies the address and port where
- <application>Junkbuster</application> will listen for connections from your
+ <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
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:
</literal>
</para>
+<![%p-not-stable;[
<para>
It is <emphasis>highly recommended</emphasis> that you enable ERROR
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>
<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>
<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
+ <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>Junkbuster</application>
- internal address of <ulink url="http://i.j.b">http://i.j.b</ulink> on
+ be toggled via a web browser at the <application>Privoxy</application>
+ internal address of <ulink url="http://p.p">http://p.p</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>
For content filtering, i.e. the <quote>+filter</quote> and
<quote>+deanimate-gif</quote> actions, it is necessary that
- <application>Junkbuster</application> buffers the entire document body.
+ <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>
<literal>
<msgtext>
<literallayout>
- <emphasis>buffer-limit 4069</emphasis>
+ <emphasis>buffer-limit 4096</emphasis>
</literallayout>
</msgtext>
</literal>
</para>
<para>
- To enable the web-based <filename>ijb.action</filename> file editor set
+ To enable the web-based <filename>default.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://p.p">http://p.p</ulink>.
</para>
<para>
</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://p.p">http://p.p</ulink>), and
their changes will affect all users. For shared proxies, you probably want to
disable this. Default: enabled.
</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>
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>
<literallayout>
- <emphasis>permit-access www.junkbusters.com/24</emphasis>
+ <emphasis>permit-access www.privoxy.com/24</emphasis>
</literallayout>
</msgtext>
</literal>
<literal>
<msgtext>
<literallayout>
- <emphasis>deny-access ident.junkbusters.com</emphasis>
+ <emphasis>deny-access ident.privoxy.com</emphasis>
</literallayout>
</msgtext>
</literal>
</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
<!-- ~~~~~ New section ~~~~~ -->
-<sect3>
+<sect3 id="forwarding">
<title>Forwarding</title>
<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>
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>
<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>
<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>
- Your squid configuration could then look like this:
+Your squid configuration could then look like this (assuming that the IP
+address of the box is <literal>192.168.0.1</literal> ):
</para>
<para>
<literal>
<msgtext>
<literallayout>
- # Define junkbuster as parent cache
+ # Define Privoxy as parent cache
<!-- per feedback from user...
cache_peer 127.0.0.1 8118 parent 0 no-query
-->
- cache_peer 127.0.0.1 parent 8118 0 no-query
+ cache_peer 192.168.0.1 parent 8118 0 no-query
+
+ # don't listen to the whole world
+ http_port 192.168.0.1:3128
+
+ # define the local lan
+ acl mylocallan src 192.168.0.1-192.168.0.5/255.255.255.255
+
+ # grant access for http to local lan
+ http_access allow mylocallan
# Define ACL for protocol FTP
acl FTP proto FTP
- # 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>
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>
<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>
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>
<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>
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>
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>
<title>The Actions File</title>
<para>
- The <quote>ijb.action</quote> file (formerly
- <filename>actionsfile</filename>) is used to define what actions
- <application>Junkbuster</application> takes, and thus determines how images,
- cookies and various other aspects of HTTP content and transactions are
- handled. Images can be anything you want, including ads, banners, or just
- some obnoxious URL that you would rather not see. Cookies can be accepted
- or rejected, or accepted only during the current browser session (i.e.
- not written to disk). Changes to <filename>ijb.action</filename> should
- be immediately visible to <application>Junkbuster</application> without
- the need to restart.
+ The <quote>default.action</quote> file (formerly
+ <filename>actionsfile</filename> or <filename>ijb.action</filename>) is used
+ to define what actions <application>Privoxy</application> takes, and thus
+ determines how ad images, cookies and various other aspects of HTTP content
+ and transactions are handled. These can be accepted or rejected for all
+ sites, or just those sites you choose. See below for a complete list of
+ actions.
+</para>
+<para>
+ Anything you want can blocked, including ads, banners, or just some obnoxious
+ URL that you would rather not see. Cookies can be accepted or rejected, or
+ accepted only during the current browser session (i.e. not written to disk).
+ Changes to <filename>default.action</filename> should be immediately visible
+ to <application>Privoxy</application> without the need to restart.
</para>
<para>
- The easiest way to edit <quote>actions</quote> file is with a browser by
- loading <ulink url="http://i.j.b/">http://i.j.b/</ulink>, and then select
+ Note that some sites may misbehave, or possibly not work at all with some
+ actions. This may require some tinkering with the rules to get the most
+ mileage of <application>Privoxy's</application> features, and still be
+ able to see and enjoy just what you want to. There is no general rule of
+ thumb on these things. There just are too many variables, and sites are
+ always changing.
+
+</para>
+
+<para>
+ The easiest way to edit the <quote>actions</quote> file is with a browser by
+ loading <ulink url="http://p.p/">http://p.p/</ulink>, and then select
<quote>Edit Actions List</quote>. A text editor can also be used.
</para>
compared to all patterns in this file. Every time it matches, the list of
applicable actions for the URL is incrementally updated. You can trace
this process by visiting <ulink
- url="http://i.j.b/show-url-info">http://i.j.b/show-url-info</ulink>.
+ url="http://p.p/show-url-info">http://p.p/show-url-info</ulink>.
</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>
- <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>, regardless of
- the domain.
+ <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>,
+ regardless of the domain. So would match any page named <quote>index.html</quote>
+ on any site.
</para>
<para>
</para>
<para>
- <emphasis>.example.com</emphasis> - matches any domain that <emphasis>ENDS</emphasis> in
- <quote>.example.com</quote>.
+ <emphasis>.example.com</emphasis> - matches any domain or sub-domain that
+ <emphasis>ENDS</emphasis> in <quote>.example.com</quote>.
</para>
<para>
</para>
<para>
- If <application>Junkbuster</application> was compiled with
- <quote>pcre</quote> support (default), Perl compatible regular expressions
- can be used. See the <filename>pcre/docs/</filename> directory or <quote>man
+ If <application>Privoxy</application> was compiled with
+ <quote>pcre</quote> support (the default), Perl compatible regular expressions
+ can be used. These are more flexible and powerful than other types
+ of <quote>regular expressions</quote>. See the <filename>pcre/docs/</filename> directory or <quote>man
perlre</quote> (also available on <ulink
url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
for details. A brief discussion of regular expressions is in the
<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>ijb.action</filename> file will
+ provided default <filename>default.action</filename> file will
give a good starting point).
</para>
<para>
- Later defined actions always over-ride earlier ones. For multi-valued
- actions, the actions are applied in the order they are specified.
+ Later defined actions always over-ride earlier ones. So exceptions
+ to any rules you make, should come in the latter part of the file. For
+ multi-valued actions, the actions are applied in the order they are
+ specified.
</para>
<para>
- 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>
Block this URL totally. In a default installation, a <quote>blocked</quote>
URL will result in bright red banner that says <quote>BLOCKED</quote>,
- with a reason why it is being blocked.
+ with a reason why it is being blocked, and an option to see it anyway.
+ The page displayed for this is the <quote>blocked</quote> template
+ file.
</para>
<para>
<literal>
<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>
will link to some script on their own server, giving the destination as a
parameter, which will then redirect you to the final target. URLs resulting
from this scheme typically look like:
- http://some.place/some_script?http://some.where-else.
+ <emphasis>http://some.place/some_script?http://some.where-else</emphasis>.
</para>
<para>
Sometimes, there are even multiple consecutive redirects encoded in the
</para>
<para>
The <quote>+fast-redirects</quote> option enables interception of these
- requests by <application>Junkbuster</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.
+ types of 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 intermediate site(s).
</para>
<para>
<literal>
<listitem>
<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.
+ section of the <filename>default.filter</filename> file to the site(s).
+ <filename>default.filter</filename> sections are grouped according to like
+ functionality. <application>Filters</application> can be used to
+ re-write any of the raw page content. This is a potentially a
+ very powerful feature!
</para>
<para>
<para>
Filter sections that are pre-defined in the supplied
- <filename>re_filterfile</filename> include:
+ <filename>default.filter</filename> include:
</para>
<blockquote>
Don't send the <quote>Referer:</quote> (sic) header to the web site. You
can block it, forge a URL to the same server as the request (which is
preferred because some sites will not send images otherwise) or set it to a
- constant string of your choice.
+ constant, user defined string of your choice.
</para>
<para>
<literal>
</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>
<literallayout>
- <emphasis>+hide-user-agent{JunkBuster/1.0}</emphasis>
+ <emphasis>+hide-user-agent{Privoxy/1.0}</emphasis>
</literallayout>
</msgtext>
</literal>
See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
If you want <emphasis>invisible</emphasis> ads, they should be defined as
<emphasis>images</emphasis> and <emphasis>blocked</emphasis>. And also,
- <quote>image-blocker</quote> should be set to <quote>blank</quote>.
+ <quote>image-blocker</quote> should be set to <quote>blank</quote>. Note you
+ cannot treat HTML pages as images in most cases. For instance, frames
+ require an HTML page to display. So a frame that is an ad, cannot be
+ treated as an image. Forcing an <quote>image</quote> in this
+ situation just will not work.
</para>
<para>
<literal>
</listitem>
<listitem>
- <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 <quote>JunkBuster</quote>
- 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> 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>
<literallayout>
- <emphasis>+image-blocker{logo}</emphasis>
+<!-- <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>
+ <emphasis>+image-blocker{http://p.p/send-banner}</emphasis>
</literallayout>
</msgtext>
</literal>
<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>
<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.
+ though. Default is <quote>no-compression</quote> is turned on.
</para>
<para>
</para>
<para>
- Now some URLs that we want <quote>blocked</quote>, ie we won't see them.
- Many of these use regular expressions that will expand to match multiple
- URLs:
+ Now some URLs that we want <quote>blocked</quote> (normally generates
+ the <quote>blocked</quote> banner). Many of these use regular expressions
+ that will expand to match multiple URLs:
</para>
<para>
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>
<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>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
<quote>-</quote>. Alias names are not case sensitive, and
<emphasis>must be defined before anything</emphasis> else in the
- <filename>ijb.action</filename>file ! And there can only be one set of
+ <filename>default.action</filename>file! And there can only be one set of
<quote>aliases</quote> defined.
</para>
<literal>
<msgtext>
<literallayout>
- # Useful customer aliases we can use later. These must come first!
+ # Useful custom aliases we can use later. These must come first!
{{alias}}
+no-cookies = +no-cookies-set +no-cookies-read
-no-cookies = -no-cookies-set -no-cookies-read
</literal>
</para>
+<para>
+ The <quote>shop</quote> and <quote>fragile</quote> aliases are often used for
+ <quote>problem</quote> sites that require most actions to be disabled
+ in order to function properly.
+
+</para>
+
</sect3>
</sect2>
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.
+ <filename>default.filter</filename>, located in the config directory.
+</para>
+
+<para>
+ This is potentially a very powerful feature, and requires knowledge of both
+ <quote>regular expression</quote> and HTML in order create custom
+ filters. But, there are a number of useful filters included with
+ <application>Privoxy</application> for many common situations.
</para>
<para>
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. The expressions can only operate on one line at a time. Some
- examples from the included default <filename>re_filterfile</filename>:
+ examples from the included default <filename>default.filter</filename>:
</para>
<para>
</para>
<para>
- Kill those pesky little web-bugs:
-</para>
-
-<para>
- <literal>
- <msgtext>
- <literallayout>
- # 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>
- </literal>
-</para>
-
-</sect2>
-
-<!-- ~ End section ~ -->
-
-
-
-<!-- ~~~~~ New section ~~~~~ -->
-
-<sect2>
-<title>Templates</title>
-<para>
- When <application>Junkbuster</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/junkbuster/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>
-<para>
- Install package, then run and enjoy! <application>JunkBuster</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
-
- </screen>
-</para>
-
-<para>
- An init script is provided for SuSE and Redhat.
-</para>
-
-<para>
-For for SuSE: /etc/rc.d/junkbuster start
-</para>
-
-<para>
-For RedHat: /etc/rc.d/init.d/junkbuster 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 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>Junkbuster</application> will fail to start.
-</para>
-
-<para>
- Be sure your browser is set to use the proxy which is by default at
- localhost, port 8118. 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: 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 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>Junkbuster</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>ijb.action</filename>. This will turn off most actions for
- this site.
-</para>
-
-<para>
- <application>Junkbuster</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
- 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> (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>,
- 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>
- 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>ijb.action</filename> file
- editor mentioned above, <application>Junkbuster</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.
- 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
- then add an exception for that page or site. If a bug, please report it to
- the developers (see below).
+ Kill those pesky little web-bugs:
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ # 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>
+ </literal>
</para>
+</sect2>
+
+<!-- ~ End section ~ -->
+
<!-- ~~~~~ New section ~~~~~ -->
<sect2>
-<title>Command Line Options</title>
+<title>Templates</title>
<para>
- <application>JunkBuster</application> may be invoked with the following
- command-line options:
+ 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. <filename>cgi-style.css</filename> is
+ used to control the HTML attributes (fonts, etc).
</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>JunkBuster</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>
+ The default <quote>Blocked</quote> banner page with the bright red top
+ banner, is called just <quote><filename>blocked</filename></quote>. This
+ may be customized or replaced with something else if desired.
- </itemizedlist>
</para>
-
</sect2>
</sect1>
<sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
Requests</title>
-<para>
-We value your feedback. However, to provide you with the best support,
-please note:
-
- <itemizedlist>
-
- <listitem><para>Use the <ulink url="http://sourceforge.net/tracker/?group_id=11118&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>Junkbuster</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>
+<!-- Include contacting.sgml boilerplate: -->
+ &contacting;
+<!-- end boilerplate -->
- </itemizedlist>
+<!-- ~~~~~ New section ~~~~~ -->
+<sect2 id="submitactions">
+<title>Submitting Ads and <quote>Action</quote> Problems</title>
+<para>
+ Ads and banners that are not stopped by <application>Privoxy</application>
+ can be submitted to the developers by accessing a special page and filling
+ out the brief, required form. Conversely, you can also report pages, images,
+ etc. that <application>Privoxy</application> is blocking, but should not.
+ The form itself does require Internet access.
</para>
-
<para>
-For any other issues, feel free to use the <ulink url="http://sourceforge.net/mail/?group_id=11118">mailing lists</ulink>.
+ To do this, point your browser to <application>Privoxy</application>
+ at <ulink url="http://p.p/">http://p.p/</ulink>, and then select
+ <ulink url="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(window.open('http://www.privoxy.org/actions','Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Actions file feedback system</ulink>,
+ near the bottom of the page. Paste in the URL that is the cause of the
+ unwanted behavior, and follow the prompts. The developers will
+ try to incorporate your submission into future versions.
</para>
<para>
- Anyone interested in actively participating in development and related
- discussions can join the appropriate mailing list
- <ulink url="http://sourceforge.net/mail/?group_id=11118">here</ulink>.
- Archives are available here too.
+ New <filename>default.actions</filename> files will occasionally be made
+ available based on your feedback. These
+ will be announced on the
+ <ulink
+ url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce">ijbswa-announce</ulink>
+ list.
</para>
+</sect2>
</sect1>
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="copyright"><title>Copyright and History</title>
-<sect2>
-<title>License</title>
-<para>
- <application>Internet Junkbuster</application> is free software; you can
- redistribute it and/or modify it under the terms of the GNU General Public
- License as published by the Free Software Foundation; either version 2 of the
- License, or (at your option) any later version.
-</para>
-
-<para>
- This program is distributed in the hope that it will be useful, but WITHOUT
- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
- details, which is available from <ulink
- url="http://www.gnu.org/copyleft/gpl.html">the Free Software Foundation,
- Inc</ulink>, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-</para>
-
+<sect2><title>Copyright</title>
+<!-- Include copyright.sgml: -->
+ ©right;
+<!-- end copyright -->
</sect2>
<!-- ~ End section ~ -->
<!-- ~~~~~ New section ~~~~~ -->
-<sect2>
-<title>History</title>
-<para>
- <application>Junkbuster</application> was originally written by Anonymous
- Coders and <ulink
- 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. There are now several active developers contributing.
- The last stable release was v2.0.2, which has now grown whiskers ;-).
-</para>
-
+<sect2 id="history"><title>History</title>
+<!-- Include history.sgml: -->
+ &history;
+<!-- end history -->
</sect2>
-
</sect1>
<!-- ~~~~~ New section ~~~~~ -->
-<sect1 id="seealso"><title>See also</title>
-<para>
-
- <simplelist>
- <member>
- <ulink url="http://sourceforge.net/projects/ijbswa">http://sourceforge.net/projects/ijbswa</ulink>
- </member>
- </simplelist>
- <simplelist>
- <member>
- <ulink url="http://ijbswa.sourceforge.net/">http://ijbswa.sourceforge.net/</ulink>
- </member>
- </simplelist>
- <simplelist>
- <member>
- <ulink url="http://i.j.b/">http://i.j.b/</ulink>
- </member>
- </simplelist>
- <simplelist>
- <member>
- <ulink url="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</ulink>
- </member>
- </simplelist>
- <simplelist>
- <member>
- <ulink url="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</ulink>
- </member>
- </simplelist>
- <simplelist>
- <member>
- <ulink url="http://privacy.net/analyze/">http://privacy.net/analyze/</ulink>
- </member>
- </simplelist>
- <simplelist>
- <member>
- <ulink url="http://www.squid-cache.org/">http://www.squid-cache.org/</ulink>
- </member>
- </simplelist>
-
-</para>
+<sect1 id="seealso"><title>See Also</title>
+<!-- Include seealso.sgml: -->
+ &seealso;
+<!-- end seealso -->
</sect1>
<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
<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>
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
<!-- ~~~~~ New section ~~~~~ -->
<sect2>
-<title>JunkBuster's Internal Pages</title>
+<title><application>Privoxy</application>'s Internal Pages</title>
<para>
- Since <application>JunkBuster</application> proxies each requested
- web page, it is easy for <application>JunkBuster</application> to
- trap certain URLs. In this way, we can talk directly to
- <application>JunkBuster</application>, and see how it is
+ Since <application>Privoxy</application> proxies each requested
+ web page, it is easy for <application>Privoxy</application> to
+ trap certain special 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>JunkBuster's</application> filtering off, all with
+ <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>JunkBuster</application>. Of course,
- <application>JunkBuster</application> must be running to access these. If
+ 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>
<listitem>
<para>
- Junkbuster main page:
+ Privoxy main page:
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/">http://ijbswa.sourceforge.net/config/</ulink>
+ <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</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.
+ Alternately, this may be reached at <ulink
+ url="http://p.p/">http://p.p/</ulink>, but this
+ variation may not work as reliably as the above in some configurations.
</para>
</listitem>
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/show-status">http://ijbswa.sourceforge.net/config/show-status</ulink>
+ <ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
</para>
</blockquote>
</listitem>
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/show-version">http://ijbswa.sourceforge.net/config/show-version</ulink>
+ <ulink url="http://config.privoxy.org/show-version">http://config.privoxy.org/show-version</ulink>
</para>
</blockquote>
</listitem>
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/show-request">http://ijbswa.sourceforge.net/config/show-request</ulink>
+ <ulink url="http://config.privoxy.org/show-request">http://config.privoxy.org/show-request</ulink>
</para>
</blockquote>
</listitem>
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/show-url-info">http://ijbswa.sourceforge.net/config/show-url-info</ulink>
+ <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
</para>
</blockquote>
</listitem>
<listitem>
<para>
- Toggle JunkBuster on or off:
+ Toggle Privoxy on or off. In this case, <quote>Privoxy</quote> continues
+ to run, but only as a pass-through proxy, with no actions taking place:
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/toggle">http://ijbswa.sourceforge.net/config/toggle</ulink>
+ <ulink url="http://config.privoxy.org/toggle">http://config.privoxy.org/toggle</ulink>
</para>
</blockquote>
<para>
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/toggle?set=disable">http://ijbswa.sourceforge.net/config/toggle?set=disable</ulink>
+ <ulink url="http://config.privoxy.org/toggle?set=disable">http://config.privoxy.org/toggle?set=disable</ulink>
</para>
</blockquote>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/toggle?set=enable">http://ijbswa.sourceforge.net/config/toggle?set=enable</ulink>
+ <ulink url="http://config.privoxy.org/toggle?set=enable">http://config.privoxy.org/toggle?set=enable</ulink>
</para>
</blockquote>
</listitem>
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/edit-actions">http://ijbswa.sourceforge.net/config/edit-actions</ulink>
+ <ulink url="http://config.privoxy.org/edit-actions">http://config.privoxy.org/edit-actions</ulink>
</para>
</blockquote>
</listitem>
</para>
+<sect3 id="bookmarklets">
+<title>Bookmarklets</title>
+<para>
+ Below are some <quote>bookmarklets</quote> to allow you to easily access a
+ <quote>mini</quote> version of some of <application>Privoxy's</application>
+ special pages. They are designed for MS Internet Explorer, but should work
+ equally well in Netscape, Mozilla, and other browsers which support
+ JavaScript. They are designed to run directly from your bookmarks - not by
+ clicking the links below (although that should work for testing).
+</para>
+<para>
+ To save them, right-click the link and choose <quote>Add to Favorites</quote>
+ (IE) or <quote>Add Bookmark</quote> (Netscape). You will get a warning that
+ the bookmark <quote>may not be safe</quote> - just click OK. Then you can run the
+ Bookmarklet directly from your favourites/bookmarks. For even faster access,
+ you can put them on the <quote>Links</quote> bar (IE) or the <quote>Personal
+ Toolbar</quote> (Netscape), and run them with a single click.
+</para>
+
+<para>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <ulink url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=enabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Enable Privoxy</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=disabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Disable Privoxy</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=toggle','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Toggle Privoxy</ulink> (Toggles between enabled and disabled)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y','ijbstatus','width=250,height=2,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">View Privoxy Status</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(window.open('http://www.privoxy.org/actions','Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Actions file feedback system</ulink>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+</para>
+
+
+
+<para>
+ Credit: The site which gave me the general idea for these bookmarklets is
+ <ulink url="http://www.bookmarklets.com">www.bookmarklets.com</ulink>. They
+ have more information about bookmarklets.
+</para>
+
+
+</sect3>
+
</sect2>
<title>Anatomy of an Action</title>
<para>
- The way <application>Junkbuster</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>Junkbuster</application> is doing. Especially,
- if something <application>Junkbuster</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
+ The way <application>Privoxy</application> applies <quote>actions</quote>
+ and <quote>filters</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 and filters files themselves, since they tend to be filled with
<quote>regular expressions</quote> whose consequences are not always
- so obvious. <application>Junkbuster</application> provides the
- <ulink url="http://ijbswa.sourceforge.net/config/show-url-info">http://ijbswa.sourceforge.net/config/show-url-info</ulink>
+ so obvious. <application>Privoxy</application> provides the
+ <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/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>Junkbuster</application> will tell us
- how current configuration will handle it. This will not
- help with filtering effects from the <filename>re_filterfile</filename>! It
+ <application>Privoxy</application> will tell us
+ how the current configuration will handle it. This will not
+ help with filtering effects from the <filename>default.filter</filename> file! It
also will not tell you about any other URLs that may be embedded within the
URL you are testing. For instance, images such as ads are expressed as URLs
within the raw page source of HTML pages. So you will only get info for the
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.
+ for this. Or right click on the ad, and grab the URL.
</para>
<para>
<para>
This is the top section, and only tells us of the compiled in defaults. This
- is basically what <application>Junkbuster</application> would do if there
+ 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>
And now we pull it altogether in the bottom section and summarize how
- <application>Junkbuster</application> is appying all its <quote>actions</quote>
+ <application>Privoxy</application> is appying all its <quote>actions</quote>
to <quote>google.com</quote>:
</para>
</para>
<para>
- Now the page displays ;-)
+ Now the page displays ;-) Be sure to flush your browser's caches when
+ making such changes. Or, try using <literal>Shift+Reload</literal>.
+</para>
+
+<para>
+ But now what about a situation where we get no explicit matches like
+ we did with:
+</para>
+
+<para>
+ <screen>
+
+ { -block }
+ /adsl
+
+ </screen>
+</para>
+
+<para>
+ That actually was very telling and pointed us quickly to where the problem
+ was. If you don't get this kind of match, then it means one of the default
+ rules in the first section is causing the problem. This would require some
+ guesswork, and maybe a little trial and error to isolate the offending rule.
+ One likely cause would be one of the <quote>{+filter}</quote> actions. Try
+ adding the URL for the site to one of aliases that turn off <quote>+filter</quote>:
+</para>
+
+<para>
+ <screen>
+
+ {shop}
+ .quietpc.com
+ .worldpay.com # for quietpc.com
+ .jungle.com
+ .scan.co.uk
+ .forbes.com
+
+ </screen>
+</para>
+
+<para>
+ <quote>{shop}</quote> is an <quote>alias</quote> that expands to
+ <quote>{ -filter -no-cookies -no-cookies-keep }</quote>. Or you could do
+ your own exception to negate filtering:
+
+</para>
+
+<para>
+ <screen>
+ {-filter}
+ .forbes.com
+
+ </screen>
+</para>
+
+<para>
+ <quote>{fragile}</quote> is an alias that disables most actions. This can be
+ used as a last resort for problem sites. Remember to flush caches! If this
+ still does not work, you will have to go through the remaining actions one by
+ one to find which one(s) is causing the problem.
</para>
</sect2>
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
+ Revision 1.75 2002/04/12 02:08:48 david__schmidt
+ Remove OS/2 building info... it is already in the developer-manual
+
+ Revision 1.74 2002/04/11 00:54:38 hal9
+ Add small section on submitting actions.
+
+ Revision 1.73 2002/04/10 18:45:15 swa
+ generated
+
+ Revision 1.72 2002/04/10 04:06:19 hal9
+ Added actions feedback to Bookmarklets section
+
+ Revision 1.71 2002/04/08 22:59:26 hal9
+ Version update. Spell chkconfig correctly :)
+
+ Revision 1.70 2002/04/08 20:53:56 swa
+ ?
+
+ Revision 1.69 2002/04/06 05:07:29 hal9
+ -Add privoxy-man-page.sgml, for man page.
+ -Add authors.sgml for AUTHORS (and p-authors.sgml)
+ -Reworked various aspects of various docs.
+ -Added additional comments to sub-docs.
+
+ Revision 1.68 2002/04/04 18:46:47 swa
+ consistent look. reuse of copyright, history et. al.
+
+ Revision 1.67 2002/04/04 17:27:57 swa
+ more single file to be included at multiple points. make maintaining easier
+
+ Revision 1.66 2002/04/04 06:48:37 hal9
+ Structural changes to allow for conditional inclusion/exclusion of content
+ based on entity toggles, e.g. 'entity % p-not-stable "INCLUDE"'. And
+ definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
+ eventually be set by Makefile.
+ More boilerplate text for use across multiple docs.
+
+ Revision 1.65 2002/04/03 19:52:07 swa
+ enhance squid section due to user suggestion
+
+ Revision 1.64 2002/04/03 03:53:43 hal9
+ A few minor bug fixes, and touch ups. Ready for review.
+
+ Revision 1.63 2002/04/01 16:24:49 hal9
+ Define entities to include boilerplate text. See doc/source/*.
+
+ Revision 1.62 2002/03/30 04:15:53 hal9
+ - Fix privoxy.org/config links.
+ - Paste in Bookmarklets from Toggle page.
+ - Move Quickstart nearer top, and minor rework.
+
+ Revision 1.61 2002/03/29 01:31:08 hal9
+ Minor update.
+
+ Revision 1.60 2002/03/27 01:57:34 hal9
+ Added more to Anatomy section.
+
+ Revision 1.59 2002/03/27 00:54:33 hal9
+ Touch up intro for new name.
+
+ Revision 1.58 2002/03/26 22:29:55 swa
+ we have a new homepage!
+
+ Revision 1.57 2002/03/24 20:33:30 hal9
+ A few minor catch ups with name change.
+
+ Revision 1.56 2002/03/24 16:17:06 swa
+ configure needs to be generated.
+
+ Revision 1.55 2002/03/24 16:08:08 swa
+ we are too lazy to make a block-built
+ privoxy logo. hence removed the option.
+
+ Revision 1.54 2002/03/24 15:46:20 swa
+ name change related issue.
+
+ Revision 1.53 2002/03/24 11:51:00 swa
+ name change. changed filenames.
+
+ Revision 1.52 2002/03/24 11:01:06 swa
+ name change
+
+ 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.