<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-<!entity % dummy "IGNORE">
+<!entity % dummy "IGNORE">
<!entity supported SYSTEM "supported.sgml">
<!entity newfeatures SYSTEM "newfeatures.sgml">
<!entity p-intro SYSTEM "privoxy.sgml">
<!entity license SYSTEM "license.sgml">
<!entity p-authors SYSTEM "p-authors.sgml">
<!entity config SYSTEM "p-config.sgml">
-<!entity p-version "3.0.9">
+<!entity p-version "3.0.20">
<!entity p-status "UNRELEASED">
<!entity % p-authors-formal "INCLUDE"> <!-- include additional text, etc -->
<!entity % p-not-stable "INCLUDE">
<!entity % p-supp-userman "IGNORE"> <!-- Omit some from supported.sgml -->
<!entity my-copy "©"> <!-- kludge for docbook2man -->
<!entity % draft "IGNORE"> <!-- WIP stuff -->
+<!entity % seealso-extra "INCLUDE"> <!-- extra stuff from seealso.sgml -->
<!entity my-app "<application>Privoxy</application>">
]>
<!--
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 2.63 2008/02/22 05:50:37 markm68k Exp $
+ $Id: user-manual.sgml,v 2.153 2012/11/09 10:49:59 fabiankeil Exp $
- Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/
See LICENSE.
========================================================================
- NOTE: Please read developer-manual/documentation.html before touching
+ NOTE: Please read developer-manual/documentation.html before touching
anything in this, or other Privoxy documentation.
========================================================================
<subscript>
<!-- Completely the wrong markup, but very little is allowed -->
<!-- in this part of an article. FIXME -->
- <link linkend="copyright">Copyright</link> &my-copy; 2001 - 2008 by
+ <link linkend="copyright">Copyright</link> &my-copy; 2001-2011 by
<ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
</subscript>
</pubdate>
-<pubdate>$Id: user-manual.sgml,v 2.63 2008/02/22 05:50:37 markm68k Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 2.153 2012/11/09 10:49:59 fabiankeil Exp $</pubdate>
<!--
<sect1 label="1" id="introduction"><title>Introduction</title>
<para>
This documentation is included with the current &p-status; version of
- <application>Privoxy</application>, v.&p-version;<![%p-not-stable;[,
+ <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 a new version is currently nearing
completion, and includes significant changes and enhancements over
- earlier versions. ]]>.
+ earlier versions]]>.
</para>
<!-- include only in non-stable versions -->
<![%p-not-stable;[
<para>
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
+ 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!
+ not many!
</para>
]]>
<!-- ~~~~~ New section ~~~~~ -->
<sect2 id="features"><title>Features</title>
<para>
- In addition to the core
- features of ad blocking and
+ In addition to the core
+ features of ad blocking and
<ulink url="http://en.wikipedia.org/wiki/Browser_cookie">cookie</ulink> management,
<application>Privoxy</application> provides many supplemental
- features<![%p-not-stable;[, some of them currently under development]]>,
+ features<![%p-not-stable;[, some of them currently under development]]>,
that give the end-user more control, more privacy and more freedom:
</para>
<!-- Include newfeatures.sgml boilerplate here: -->
</para>
<para>
- Note:
- On some platforms, the installer may remove previously installed versions, if
+ Note:
+ On some platforms, the installer may remove previously installed versions, if
found. (See below for your platform). In any case <emphasis>be sure to backup
your old configuration if it is valuable to you.</emphasis> See the <link
linkend="upgradersnote">note to upgraders</link> section below.
</para>
-<!-- ~~~~~ New section ~~~~~ -->
+<!-- ~~~~~ New section ~~~~~ -->
<sect2 id="installation-packages"><title>Binary Packages</title>
<para>
How to install the binary packages depends on your operating system:
<para>
RPMs can be installed with <literal>rpm -Uvh privoxy-&p-version;-1.rpm</literal>,
- and will use <filename>/etc/privoxy</filename> for the location
+ and will use <filename>/etc/privoxy</filename> for the location
of configuration files.
</para>
Note that on Red Hat, <application>Privoxy</application> will
<emphasis>not</emphasis> be automatically started on system boot. You will
need to enable that using <command>chkconfig</command>,
- <command>ntsysv</command>, or similar methods.
+ <command>ntsysv</command>, or similar methods.
</para>
<para>
- If you have problems with failed dependencies, try rebuilding the SRC RPM:
- <literal>rpm --rebuild privoxy-&p-version;-1.src.rpm</literal>. This
- will use your locally installed libraries and RPM version.
+ If you have problems with failed dependencies, try rebuilding the SRC RPM:
+ <literal>rpm --rebuild privoxy-&p-version;-1.src.rpm</literal>. This
+ will use your locally installed libraries and RPM version.
</para>
<para>
<sect3 id="installation-deb"><title>Debian and Ubuntu</title>
<para>
DEBs can be installed with <literal>apt-get install privoxy</literal>,
- and will use <filename>/etc/privoxy</filename> for the location of
+ and will use <filename>/etc/privoxy</filename> for the location of
configuration files.
</para>
</sect3>
<para>
Just double-click the installer, which will guide you through
the installation process. You will find the configuration files
- in the same directory as you installed <application>Privoxy</application> in.
+ in the same directory as you installed <application>Privoxy</application> in.
</para>
<para>
Version 3.0.5 beta introduced full <application>Windows</application> service
command: <command>services.msc</command>. If you do not take the manual step
of modifying <application>Privoxy's</application> service settings, it will
not start. Note too that you will need to give Privoxy a user account that
- actually exists, or it will not be permitted to
+ actually exists, or it will not be permitted to
write to its log and configuration files.
</para>
<para>
First, make sure that no previous installations of
- <application>Junkbuster</application> and / or
+ <application>Junkbuster</application> and / or
<application>Privoxy</application> are left on your
system. Check that no <application>Junkbuster</application>
or <application>Privoxy</application> objects are in
<!-- ~~~~~ New section ~~~~~ -->
<sect3 id="installation-mac"><title>Mac OS X</title>
<para>
- Unzip the downloaded file (you can either double-click on the zip file
- icon from the Finder, or from the desktop if you downloaded it there).
- Then, double-click on the package installer icon and follow the
- installation process.
+ Installation instructions for the OS X platform depend upon whether
+ you downloaded a ready-built installation package (.pkg or .mpkg) or have
+ downloaded the source code.
+</para>
+<sect3 renderas="sect4" id="OS-X-install-from-package">
+<title>Installation from ready-built package</title>
+<para>
+ The downloaded file will either be a .pkg (for OS X 10.5 upwards) or a bzipped
+ .mpkg file (for OS X 10.4). The former can be double-clicked as is and the
+ installation will start; double-clicking the latter will unzip the .mpkg file
+ which can then be double-clicked to commence the installation.
+</para>
+<para>
+ The privoxy service will automatically start after a successful installation
+ (and thereafter every time your computer starts up) however you will need to
+ configure your web browser(s) to use it. To do so, configure them to use a
+ proxy for HTTP and HTTPS at the address 127.0.0.1:8118.
+</para>
+<para>
+ To prevent the privoxy service from automatically starting when your computer
+ starts up, remove or rename the file <literal>/Library/LaunchDaemons/org.ijbswa.privoxy.plist</literal>
+ (on OS X 10.5 and higher) or the folder named
+ <literal>/Library/StartupItems/Privoxy</literal> (on OS X 10.4 'Tiger').
+</para>
+<para>
+ To manually start or stop the privoxy service, use the scripts startPrivoxy.sh
+ and stopPrivoxy.sh supplied in /Applications/Privoxy. They must be run from an
+ administrator account, using sudo.
+</para>
+<para>
+ To uninstall, run /Applications/Privoxy/uninstall.command as sudo from an
+ administrator account.
+</para>
+<sect3 renderas="sect4" id="OS-X-install-from-source">
+<title>Installation from source</title>
+<para>
+ To build and install the Privoxy source code on OS X you will need to obtain
+ the macsetup module from the Privoxy Sourceforge CVS repository (refer to
+ Sourceforge help for details of how to set up a CVS client to have read-only
+ access to the repository). This module contains scripts that leverage the usual
+ open-source tools (available as part of Apple's free of charge Xcode
+ distribution or via the usual open-source software package managers for OS X
+ (MacPorts, Homebrew, Fink etc.) to build and then install the privoxy binary
+ and associated files. The macsetup module's README file contains complete
+ instructions for its use.
+</para>
+<para>
+ The privoxy service will automatically start after a successful installation
+ (and thereafter every time your computer starts up) however you will need to
+ configure your web browser(s) to use it. To do so, configure them to use a
+ proxy for HTTP and HTTPS at the address 127.0.0.1:8118.
</para>
<para>
- The privoxy service will automatically start after a successful
- installation (in addition to every time your computer starts up). To
- prevent the privoxy service from automatically starting when your
- computer starts up, remove or rename the folder named
- <literal>/Library/StartupItems/Privoxy</literal>.
+ To prevent the privoxy service from automatically starting when your computer
+ starts up, remove or rename the file <literal>/Library/LaunchDaemons/org.ijbswa.privoxy.plist</literal>
+ (on OS X 10.5 and higher) or the folder named
+ <literal>/Library/StartupItems/Privoxy</literal> (on OS X 10.4 'Tiger').
</para>
<para>
To manually start or stop the privoxy service, use the Privoxy Utility
- for Mac OS X. This application controls the privoxy service (e.g.
- starting and stopping the service as well as uninstalling the software).
+ for Mac OS X (also part of the macsetup module). This application can start
+ and stop the privoxy service and display its log and configuration files.
+</para>
+<para>
+ To uninstall, run the macsetup module's uninstall.sh as sudo from an
+ administrator account.
</para>
</sect3>
<!-- ~~~~~ New section ~~~~~ -->
<sect3 id="installation-amiga"><title>AmigaOS</title>
<para>
- Copy and then unpack the <filename>lha</filename> archive to a suitable location.
+ Copy and then unpack the <filename>lha</filename> archive to a suitable location.
All necessary files will be installed into <application>Privoxy</application>
- directory, including all configuration and log files. To uninstall, just
+ directory, including all configuration and log files. To uninstall, just
remove this directory.
</para>
</sect3>
<!-- ~~~~~ New section ~~~~~ -->
<sect3 id="installattion-gentoo"><title>Gentoo</title>
<para>
- Gentoo source packages (Ebuilds) for <application>Privoxy</application> are
- contained in the Gentoo Portage Tree (they are not on the download page,
- but there is a Gentoo section, where you can see when a new
+ Gentoo source packages (Ebuilds) for <application>Privoxy</application> are
+ contained in the Gentoo Portage Tree (they are not on the download page,
+ but there is a Gentoo section, where you can see when a new
<application>Privoxy</application> Version is added to the Portage Tree).
</para>
<para>
- Before installing <application>Privoxy</application> under Gentoo just do
- first <literal>emerge rsync</literal> to get the latest changes from the
- Portage tree. With <literal>emerge privoxy</literal> you install the latest
+ Before installing <application>Privoxy</application> under Gentoo just do
+ first <literal>emerge --sync</literal> to get the latest changes from the
+ Portage tree. With <literal>emerge privoxy</literal> you install the latest
version.
</para>
<para>
- Configuration files are in <filename>/etc/privoxy</filename>, the
+ Configuration files are in <filename>/etc/privoxy</filename>, the
documentation is in <filename>/usr/share/doc/privoxy-&p-version;</filename>
and the Log directory is in <filename>/var/log/privoxy</filename>.
</para>
<para>
The most convenient way to obtain the <application>Privoxy</application> sources
- is to download the source tarball from our
+ is to download the source tarball from our
<ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118&package_id=10571">project download
page</ulink>.
</para>
If you like to live on the bleeding edge and are not afraid of using
possibly unstable development versions, you can check out the up-to-the-minute
version directly from <ulink url="http://sourceforge.net/cvs/?group_id=11118">the
- CVS repository</ulink>.
-<!--
+ CVS repository</ulink>.
+<!--
deprecated...out of business.
or simply download <ulink
url="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.bz2">the nightly CVS
<!-- end boilerplate -->
</sect2>
-<!-- ~~~~~ New section ~~~~~ -->
+<!-- ~~~~~ New section ~~~~~ -->
<sect2 id="installation-keepupdated"><title>Keeping your Installation Up-to-Date</title>
<para>
As user feedback comes in and development continues, we will make updated versions
<para>
In order not to lose your personal changes and adjustments when updating
to the latest <literal>default.action</literal> file we <emphasis>strongly
- recommend</emphasis> that you use <literal>user.action</literal> and
+ recommend</emphasis> that you use <literal>user.action</literal> and
<literal>user.filter</literal> for your local
customizations of <application>Privoxy</application>. See the <link
linkend="actions-file">Chapter on actions files</link> for details.
<sect1 id="whatsnew">
<title>What's New in this Release</title>
<para>
- There are many improvements and new features since <application>Privoxy 3.0.6</application>, the last stable release:
+ <application>Privoxy 3.0.19</application> is a stable release.
+ The changes since 3.0.18 stable are:
</para>
<para>
<itemizedlist>
- <listitem>
- <para>
- Two new actions <link
- linkend="server-header-tagger">server-header-tagger</link>
- and <link
- linkend="client-header-tagger">client-header-tagger</link>
- that can be used to create arbitrary <quote>tags</quote>
- based on client and server headers.
- These <quote>tags</quote> can then subsequently be used
- to control the other actions used for the current request,
- greatly increasing &my-app;'s flexibility and selectivity. See <link
- linkend="tag-pattern">tag patterns</link> for more information on tags.
- </para>
- </listitem>
-
- <listitem>
+ <listitem>
<para>
- Header filtering is done with dedicated header filters now. As a result
- the actions <quote>filter-client-headers</quote> and <quote>filter-server-headers</quote>
- that were introduced with <application>Privoxy 3.0.5</application> to apply
- content filters to the headers have been removed.
- See the new actions <link
- linkend="server-header-filter">server-header-filter</link>
- and <link
- linkend="client-header-filter">client-header-filter</link> for details.
+ Bug fixes:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Prevent a segmentation fault when de-chunking buffered content.
+ It could be triggered by malicious web servers if Privoxy was
+ configured to filter the content and running on a platform
+ where SIZE_T_MAX isn't larger than UINT_MAX, which probably
+ includes most 32-bit systems. On those platforms, all Privoxy
+ versions before 3.0.19 appear to be affected.
+ To be on the safe side, this bug should be presumed to allow
+ code execution as proving that it doesn't seems unrealistic.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Do not expect a response from the SOCKS4/4A server until it
+ got something to respond to. This regression was introduced
+ in 3.0.18 and prevented the SOCKS4/4A negotiation from working.
+ Reported by qqqqqw in #3459781.
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
</listitem>
<listitem>
<para>
- There are four new options for the main <filename>config</filename> file:
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- <link
- linkend="allow-cgi-request-crunching">allow-cgi-request-crunching</link>
- which allows requests for Privoxy's internal CGI pages to be
- blocked, redirected or (un)trusted like ordinary requests.
- </para>
- </listitem>
- <listitem>
- <para>
- <link
- linkend="split-large-forms">split-large-forms</link>
- that will work around a browser bug that caused IE6 and IE7 to
- ignore the Submit button on the Privoxy's edit-actions-for-url CGI
- page.
- </para>
- </listitem>
- <listitem>
- <para>
- <link
- linkend="accept-intercepted-requests">accept-intercepted-requests</link>
- which allows to combine Privoxy with any packet filter to create an
- intercepting proxy for HTTP/1.1 requests (and for HTTP/1.0 requests
- with Host header set). This means clients can be forced to use
- &my-app; even if their proxy settings are configured differently.
- </para>
- </listitem>
- <listitem>
- <para>
- <link
- linkend="templdir">templdir</link>
- to designate an alternate location for &my-app;'s
- locally customized CGI templates so that
- these are not overwritten during upgrades.
- </para>
- </listitem>
- </itemizedlist>
+ General improvements:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Fix an off-by-one in an error message about connect failures.
+ </para>
</listitem>
-
- <listitem>
- <para>
- A new command line option <literal>--pre-chroot-nslookup hostname</literal> to
- initialize the resolver library before chroot'ing. On some systems this
- reduces the number of files that must be copied into the chroot tree.
- (Patch provided by Stephen Gildea)
+ <listitem>
+ <para>
+ Use a GNUMakefile variable for the webserver root directory and
+ update the path. Sourceforge changed it which broke various
+ web-related targets.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Update the CODE_STATUS description.
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
</listitem>
+ </itemizedlist>
+</para>
- <listitem>
- <para>
- The <link
- linkend="forward-override">forward-override</link> action
- allows changing of the forwarding settings through the actions files.
- Combined with tags, this allows to choose the forwarder based on
- client headers like the <literal>User-Agent</literal>, or the request origin.
- </para>
- </listitem>
+<para>
+ The following changes were made between 3.0.17 and 3.0.18:
+</para>
+<para>
+ <itemizedlist>
<listitem>
<para>
- The <link
- linkend="redirect">redirect</link> action can now use regular
- expression substitutions against the original URL.
+ Bug fixes:
+ <itemizedlist>
+ <listitem>
+ <para>
+ If a generated redirect URL contains characters RFC 3986 doesn't
+ permit, they are (re)encoded. Not doing this makes Privoxy versions
+ from 3.0.5 to 3.0.17 susceptible to HTTP response splitting (CWE-113)
+ attacks if the +fast-redirects{check-decoded-url} action is used.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fix a logic bug that could cause Privoxy to reuse a server
+ socket after it got tainted by a server-header-tagger-induced
+ block that was triggered before the whole server response had
+ been read. If keep-alive was enabled and the request following
+ the blocked one was to the same host and using the same forwarding
+ settings, Privoxy would send it on the tainted server socket.
+ While the server would simply treat it as a pipelined request,
+ Privoxy would later on fail to properly parse the server's
+ response as it would try to parse the unread data from the
+ first response as server headers for the second one.
+ Regression introduced in 3.0.17.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ When implying keep-alive in client_connection(), remember that
+ the client didn't. Fixes a regression introduced in 3.0.13 that
+ would cause Privoxy to wait for additional client requests after
+ receiving a HTTP/1.1 request with "Connection: close" set
+ and connection sharing enabled.
+ With clients which terminates the client connection after detecting
+ that the whole body has been received it doesn't really matter,
+ but with clients that don't the connection would be kept open until
+ it timed out.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fix a subtle race condition between prepare_csp_for_next_request()
+ and sweep(). A thread preparing itself for the next client request
+ could briefly appear to be inactive.
+ If all other threads were already using more recent files,
+ the thread could get its files swept away under its feet.
+ So far this has only been reproduced while stress testing in
+ valgrind while touching action files in a loop. It's unlikely
+ to have caused any actual problems in the real world.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Disable filters if SDCH compression is used unless filtering is forced.
+ If SDCH was combined with a supported compression algorithm, Privoxy
+ previously could try to decompress it and ditch the Content-Encoding
+ header even though the SDCH compression wasn't dealt with.
+ Reported by zebul666 in #3225863.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Make a copy of the --user value and only mess with that when splitting
+ user and group. On some operating systems modifying the value directly
+ is reflected in the output of ps and friends and can be misleading.
+ Reported by zepard in #3292710.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ If forwarded-connect-retries is set, only retry if Privoxy is actually
+ forwarding the request. Previously direct connections would be retried
+ as well.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fixed a small memory leak when retrying connections with IPv6
+ support enabled.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Remove an incorrect assertion in compile_dynamic_pcrs_job_list()
+ It could be triggered by a pcrs job with an invalid pcre
+ pattern (for example one that contains a lone quantifier).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ If the --user argument user[.group] contains a dot, always bail out
+ if no group has been specified. Previously the intended, but undocumented
+ (and apparently untested), behaviour was to try interpreting the whole
+ argument as user name, but the detection was flawed and checked for '0'
+ instead of '\0', thus merely preventing group names beginning with a zero.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In html_code_map[], use a numeric character reference instead of '
+ which wasn't standardized before XHTML 1.0.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fix an invalid free when compiled with FEATURE_GRACEFUL_TERMINATION
+ and shut down through http://config.privoxy.org/die
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In get_actions(), fix the "temporary" backwards compatibility hack
+ to accept block actions without reason.
+ It also covered other actions that should be rejected as invalid.
+ Reported by Billy Crook.
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
</listitem>
-
<listitem>
<para>
- <application>zlib</application> support is now available as a compile
- time option to filter compressed content. Patch provided by Wil Mahan.
- </para>
- </listitem>
+ General improvements:
+ <itemizedlist>
<listitem>
- <para>
- Improve various filters, and add new ones.
+ <para>
+ Privoxy can (re)compress buffered content before delivering
+ it to the client. Disabled by default as most users wouldn't
+ benefit from it.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The +fast-redirects{check-decoded-url} action checks URL
+ segments separately. If there are other parameters behind
+ the redirect URL, this makes it unnecessary to cut them off
+ by additionally using a +redirect{} pcrs command.
+ Initial patch submitted by Jamie Zawinski in #3429848.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ When loading action sections, verify that the referenced filters
+ exist. Currently missing filters only result in an error message,
+ but eventually the severity will be upgraded to fatal.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Allow to bind to multiple separate addresses.
+ Patch set submitted by Petr Pisar in #3354485.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Set socket_error to errno if connecting fails in rfc2553_connect_to().
+ Previously rejected direct connections could be incorrectly reported
+ as DNS issues if Privoxy was compiled with IPv6 support.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Adjust url_code_map[] so spaces are replaced with %20 instead of '+'
+ While '+' can be used by client's submitting form data, this is not
+ actually what Privoxy is using the lookups for. This is more of a
+ cosmetic issue and doesn't fix any known problems.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ When compiled without FEATURE_FAST_REDIRECTS, do not silently
+ ignore +fast-redirect{} directives
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Added a workaround for GNU libc's strptime() reporting negative
+ year values when the parsed year is only specified with two digits.
+ On affected systems cookies with such a date would not be turned
+ into session cookies by the +session-cookies-only action.
+ Reported by Vaeinoe in #3403560
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fixed bind failures with certain GNU libc versions if no non-loopback
+ IP address has been configured on the system. This is mainly an issue
+ if the system is using DHCP and Privoxy is started before the network
+ is completely configured.
+ Reported by Raphael Marichez in #3349356.
+ Additional insight from Petr Pisar.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Privoxy log messages now use the ISO 8601 date format %Y-%m-%d.
+ It's only slightly longer than the old format, but contains
+ the full date including the year and allows sorting by date
+ (when grepping in multiple log files) without hassle.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In get_last_url(), do not bother trying to decode URLs that do
+ not contain at least one '%' sign. It reduces the log noise and
+ a number of unnecessary memory allocations.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In case of SOCKS5 failures, dump the socks response in the log message.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Simplify the signal setup in main().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Streamline socks5_connect() slightly.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In socks5_connect(), require a complete socks response from the server.
+ Previously Privoxy didn't care how much data the server response
+ contained as long as the first two bytes contained the expected
+ values. While at it, shrink the buffer size so Privoxy can't read
+ more than a whole socks response.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In chat(), do not bother to generate a client request in case of
+ direct CONNECT requests. It will not be used anyway.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Reduce server_last_modified()'s stack size.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Shorten get_http_time() by using strftime().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Constify the known_http_methods pointers in unknown_method().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Constify the time_formats pointers in parse_header_time().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Constify the formerly_valid_actions pointers in action_used_to_be_valid().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Introduce a GNUMakefile MAN_PAGE variable that defaults to privoxy.1.
+ The Debian package uses section 8 for the man page and this
+ should simplify the patch.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Deduplicate the INADDR_NONE definition for Solaris by moving it to jbsockets.h
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In block_url(), ditch the obsolete workaround for ancient Netscape versions
+ that supposedly couldn't properly deal with status code 403.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Remove a useless NULL pointer check in load_trustfile().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Remove two useless NULL pointer checks in load_one_re_filterfile().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Change url_code_map[] from an array of pointers to an array of arrays
+ It removes an unnecessary layer of indirection and on 64bit system reduces
+ the size of the binary a bit.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fix various typos. Fixes taken from Debian's 29_typos.dpatch by Roland Rosenfeld.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Add a dok-tidy GNUMakefile target to clean up the messy HTML
+ generated by the other dok targets.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ GNUisms in the GNUMakefile have been removed.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Change the HTTP version in static responses to 1.1
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Synced config.sub and config.guess with upstream
+ 2011-11-11/386c7218162c145f5f9e1ff7f558a3fbb66c37c5.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Add a dedicated function to parse the values of toggles. Reduces duplicated
+ code in load_config() and provides better error handling. Invalid or missing
+ toggle values are now a fatal error instead of being silently ignored.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Terminate HTML lines in static error messages with \n instead of \r\n.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Simplify cgi_error_unknown() a bit.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In LogPutString(), don't bother looking at pszText when not
+ actually logging anything.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Change ssplit()'s fourth parameter from int to size_t.
+ Fixes a clang complaint.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Add a warning that the statistics currently can't be trusted.
+ Mention Privoxy-Log-Parser's --statistics option as
+ an alternative for the time being.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In rfc2553_connect_to(), start setting cgi->error_message on error.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Change the expected status code returned for http://p.p/die depending
+ on whether or not FEATURE_GRACEFUL_TERMINATION is available.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In cgi_die(), mark the client connection for closing.
+ If the client will fetch the style sheet through another connection
+ it gets the main thread out of the accept() state and should thus
+ trigger the actual shutdown.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Add a proper CGI message for cgi_die().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Don't enforce a logical line length limit in read_config_line().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Slightly refactor server_last_modified() to remove useless gmtime*() calls.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In get_content_type(), also recognize '.jpeg' as JPEG extension.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Add '.png' to the list of recognized file extensions in get_content_type().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In block_url(), consistently use the block reason "Request blocked by Privoxy"
+ In two places the reason was "Request for blocked URL" which hides the
+ fact that the request got blocked by Privoxy and isn't necessarily
+ correct as the block may be due to tags.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In listen_loop(), reload the configuration files after accepting
+ a new connection instead of before.
+ Previously the first connection that arrived after a configuration
+ change would still be handled with the old configuration.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In chat()'s receive-data loop, skip a client socket check if
+ the socket will be written to right away anyway. This can
+ increase the transfer speed for unfiltered content on fast
+ network connections.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The socket timeout is used for SOCKS negotiations as well which
+ previously couldn't timeout.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Don't keep the client connection alive if any configuration file
+ changed since the time the connection came in. This is closer to
+ Privoxy's behaviour before keep-alive support for client connection
+ has been added and also less confusing in general.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Treat all Content-Type header values containing the pattern
+ 'script' as a sign of text. Reported by pribog in #3134970.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Action file improvements:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Moved the site-specific block pattern section below the one for the
+ generic patterns so for requests that are matched in both, the block
+ reason for the domain is shown which is usually more useful than showing
+ the one for the generic pattern.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Remove -prevent-compression from the fragile alias. It's no longer
+ used anywhere by default and isn't known to break stuff anyway.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Add a (disabled) section to block various Facebook tracking URLs.
+ Reported by Dan Stahlke in #3421764.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Add a (disabled) section to rewrite and redirect click-tracking
+ URLs used on news.google.com.
+ Reported by Dan Stahlke in #3421755.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Unblock linuxcounter.net/.
+ Reported by Dan Stahlke in #3422612.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Block 'www91.intel.com/' which is used by Omniture.
+ Reported by Adam Piggott in #3167370.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Disable the handle-as-empty-doc-returns-ok option and mark it as deprecated.
+ Reminded by tceverling in #2790091.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Add ".ivwbox.de/" to the "Cross-site user tracking" section.
+ Reported by Nettozahler in #3172525.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Unblock and fast-redirect ".awin1.com/.*=http://".
+ Reported by Adam Piggott in #3170921.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Block "b.collective-media.net/".
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Widen the Debian popcon exception to "qa.debian.org/popcon".
+ Seen in Debian's 05_default_action.dpatch by Roland Rosenfeld.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Block ".gemius.pl/" which only seems to be used for user tracking.
+ Reported by johnd16 in #3002731. Additional input from Lee and movax.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Disable banners-by-size filters for '.thinkgeek.com/'.
+ The filter only seems to catch pictures of the inventory.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Block requests for 'go.idmnet.bbelements.com/please/showit/'.
+ Reported by kacperdominik in #3372959.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Unblock adainitiative.org/.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Add a fast-redirects exception for '.googleusercontent.com/.*=cache'.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Add a fast-redirects exception for webcache.googleusercontent.com/.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Unblock http://adassier.wordpress.com/ and http://adassier.files.wordpress.com/.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Filter file improvements:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Let the yahoo filter hide '.ads'.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Let the msn filter hide overlay ads for Facebook 'likes' in search
+ results and elements with the id 's_notf_div'. They only seem to be
+ used to advertise site 'enhancements'.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Let the js-events filter additionally disarm setInterval().
+ Suggested by dg1727 in #3423775.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Documentation improvements:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Clarify the effect of compiling Privoxy with zlib support.
+ Suggested by dg1727 in #3423782.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Point out that the SourceForge messaging system works like a black
+ hole and should thus not be used to contact individual developers.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Mention some of the problems one can experience when not explicitly
+ configuring an IP addresses as listen address.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Explicitly mention that hostnames can be used instead of IP addresses
+ for the listen-address, that only the first address returned will be
+ used and what happens if the address is invalid.
+ Requested by Calestyo in #3302213.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Log message improvements:
+ <itemizedlist>
+ <listitem>
+ <para>
+ If only the server connection is kept alive, do not pretend to
+ wait for a new client request.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Remove a superfluous log message in forget_connection().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In chat(), properly report missing server responses as such
+ instead of calling them empty.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In forwarded_connect(), fix a log message nobody should ever see.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fix a log message in socks5_connect(), a failed write operation
+ was logged as failed read operation.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Let load_one_actions_file() properly complain about a missing
+ '{' at the beginning of the file.
+ Simply stating that a line is invalid isn't particularly helpful.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Do not claim to listen on a socket until Privoxy actually does.
+ Patch submitted by Petr Pisar #3354485
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Prevent a duplicated LOG_LEVEL_CLF message when sending out
+ the "no-server-data" response.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Also log the client socket when dropping a connection.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Include the destination host in the 'Request ... marked for
+ blocking. limit-connect{...} doesn't allow CONNECT ...' message
+ Patch submitted by Saperski in #3296250.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Prevent a duplicated log message if none of the resolved IP
+ addresses were reachable.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In connect_to(), do not pretend to retry if forwarded-connect-retries
+ is zero or unset.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ When a specified user or group can't be found, put the name in
+ single-quotes when logging it.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In rfc2553_connect_to(), explain getnameinfo() errors better.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Remove a useless log message in chat().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ When retrying to connect, also log the maximum number of connection
+ attempts.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Rephrase a log message in compile_dynamic_pcrs_job_list().
+ Divide the error code and its meaning with a colon. Call the pcrs
+ job dynamic and not the filter. Filters may contain dynamic and
+ non-dynamic pcrs jobs at the same time. Only mention the name of
+ the filter or tagger, but don't claim it's a filter when it could
+ be a tagger.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In a fatal error message in load_one_actions_file(), cover both
+ URL and TAG patterns.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In pcrs_strerror(), properly report unknown positive error code
+ values as such. Previously they were handled like 0 (no error).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In compile_dynamic_pcrs_job_list(), also log the actual error code as
+ pcrs_strerror() doesn't handle all errors reported by pcre.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Don't bother trying to continue chatting if the client didn't ask for it.
+ Reduces log noise a bit.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Make two fatal error message in load_one_actions_file() more descriptive.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In cgi_send_user_manual(), log when rejecting a file name due to '/' or '..'.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In load_file(), log a message if opening a file failed.
+ The CGI error message alone isn't too helpful.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In connection_destination_matches(), improve two log messages
+ to help understand why the destinations don't match.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Rephrase a log message in serve(). Client request arrival
+ should be differentiated from closed client connections now.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In serve(), log if a client connection isn't reused due to a
+ configuration file change.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Let mark_server_socket_tainted() always mark the server socket tainted,
+ just don't talk about it in cases where it has no effect. It doesn't change
+ Privoxy's behaviour, but makes understanding the log file easier.
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
</listitem>
-
-
<listitem>
<para>
- Include support for RFC 3253 so that <filename>Subversion</filename> works
- with &my-app;. Patch provided by Petr Kadlec.
+ configure:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Added a --disable-ipv6-support switch for platforms where support
+ is detected but doesn't actually work.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Do not check for the existence of strerror() and memmove() twice
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Remove a useless test for setpgrp(2). Privoxy doesn't need it and
+ it can cause problems when cross-compiling.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Rename the --disable-acl-files switch to --disable-acl-support.
+ Since about 2001, ACL directives are specified in the standard
+ config file.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Update the URL of the 'Removing outdated PCRE version after the
+ next stable release' posting. The old URL stopped working after
+ one of SF's recent site "optimizations". Reported by Han Liu.
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
</listitem>
-
<listitem>
<para>
- Logging can be completely turned off by not specifying a logfile directive.
+ Privoxy-Regression-Test:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Added --shuffle-tests option to increase the chances of detection race conditions.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Added a --local-test-file option that allows to use Privoxy-Regression-Test without Privoxy.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Added tests for missing socks4 and socks4a forwarders.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The --privoxy-address option now works with IPv6 addresses containing brackets, too.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Perform limited sanity checks for parameters that are supposed to have numerical values.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Added a --sleep-time option to specify a number of seconds to
+ sleep between tests, defaults to 0.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Disable the range-requests tagger for tests that break if it's enabled.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Log messages use the ISO 8601 date format %Y-%m-%d.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fix spelling in two error messages.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In the --help output, include a list of supported tests and their default levels.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Adjust the tests to properly deal with FEATURE_TOGGLE being disabled.
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
</listitem>
-
-
<listitem>
<para>
- A number of improvements to Privoxy's internal CGI pages, including the
- use of favicons for error and control pages.
+ Privoxy-Log-Parser:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Perform limited sanity checks for command line parameters that
+ are supposed to have numerical values.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Implement a --unbreak-lines-only option to try to revert MUA breakage.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Accept and highlight: Added header: Content-Encoding: deflate
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Accept and highlight: Compressed content from 29258 to 8630 bytes.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Accept and highlight: Client request arrived in time on socket 21.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Highlight: Didn't receive data in time: a.fsdn.com:443
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Accept log messages with ISO 8601 time stamps, too.
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
</listitem>
-
<listitem>
<para>
- Many bugfixes, memory leaks addressed, code improvements, and logging
- improvements.
+ uagen:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Bump generated Firefox version to 8.0.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Only randomize the release date if the new --randomize-release-date
+ option is enabled. Firefox versions after 4 use a fixed date string
+ without meaning.
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
</listitem>
-
</itemizedlist>
</para>
-<para>
- For a more detailed list of changes please have a look at the ChangeLog.
-</para>
+
<!-- ~~~~~ New section ~~~~~ -->
<title>Note to Upgraders</title>
<para>
- A quick list of things to be aware of before upgrading from earlier
+ A quick list of things to be aware of before upgrading from earlier
versions of <application>Privoxy</application>:
</para>
<listitem>
<para>
- The recommended way to upgrade &my-app; is to backup your old
+ The recommended way to upgrade &my-app; is to backup your old
configuration files, install the new ones, verify that &my-app;
is working correctly and finally merge back your changes using
<application>diff</application> and maybe <application>patch</application>.
</para>
</listitem>
<listitem>
- <para>
+ <para>
Note that some installers remove earlier versions completely,
including configuration files, therefore you should really save
any important configuration files!
</para>
</listitem>
<listitem>
- <para>
- On the other hand, other installers don't overwrite existing configuration
+ <para>
+ On the other hand, other installers don't overwrite existing configuration
files, thinking you will want to do that yourself.
</para>
</listitem>
<listitem>
- <para>
- <filename>standard.action</filename> now only includes the enabled actions.
- Not all actions as before.
+ <para>
+ <filename>standard.action</filename> has been merged into
+ the <filename>default.action</filename> file.
</para>
</listitem>
<listitem>
<listitem>
<para>
- Three other config file settings are now off by default:
+ Three other config file settings are now off by default:
<link linkend="enable-remote-toggle">enable-remote-toggle</link>,
<link linkend="enable-remote-http-toggle">enable-remote-http-toggle</link>,
- and <link linkend="enable-edit-actions">enable-edit-actions</link>.
+ and <link linkend="enable-edit-actions">enable-edit-actions</link>.
If you use or want these, you will need to explicitly enable them, and
- be aware of the security issues involved.
+ be aware of the security issues involved.
</para>
</listitem>
- <listitem>
- <para>
- The <quote>filter-client-headers</quote> and
- <quote>filter-server-headers</quote> actions that were introduced with
- <application>Privoxy 3.0.5</application> to apply content filters to
- the headers have been removed and replaced with new actions.
- See the <link
- linkend="whatsnew">What's New section</link> above.
- </para>
- </listitem>
-
-
<!--
<listitem>
- <para>
- What constitutes a <quote>default</quote> configuration has changed,
- and you may want to review which actions are <quote>on</quote> by
- default. This is primarily a matter of emphasis, but some features
+ <para>
+ What constitutes a <quote>default</quote> configuration has changed,
+ and you may want to review which actions are <quote>on</quote> by
+ default. This is primarily a matter of emphasis, but some features
you may have been used to, may now be <quote>off</quote> by default.
There are also a number of new actions and filters you may want to
consider, most of which are not fully incorporated into the default
Or if you use a number of filters, or filter many sites, you may just want
to turn off compression for all sites in
<filename>default.action</filename> (or
- <filename>user.action</filename>).
+ <filename>user.action</filename>).
</para>
</listitem>
<listitem>
<para>
- Also, <link linkend="SESSION-COOKIES-ONLY">session-cookies-only</link> is
- off by default now. If you've liked this feature in the past, you may want
+ Also, <link linkend="SESSION-COOKIES-ONLY">session-cookies-only</link> is
+ off by default now. If you've liked this feature in the past, you may want
to turn it back on in <filename>user.action</filename> now.
</para>
</listitem>
Some installers may not automatically start
<application>Privoxy</application> after installation.
</para>
- </listitem>
+ </listitem>
-->
</itemizedlist>
<para>
Install <application>Privoxy</application>. See the <link
linkend="installation">Installation Section</link> below for platform specific
- information.
+ information.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Advanced users and those who want to offer <application>Privoxy</application>
service to more than just their local machine should check the <link
linkend="config">main config file</link>, especially the <link
- linkend="access-control">security-relevant</link> options. These are
+ linkend="access-control">security-relevant</link> options. These are
off by default.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
HTTPS (SSL) <ulink url="http://en.wikipedia.org/wiki/Proxy_server">proxy</ulink>
by setting the proxy configuration for address of
<literal>127.0.0.1</literal> and port <literal>8118</literal>.
- <emphasis>DO NOT</emphasis> activate proxying for <literal>FTP</literal> or
+ <emphasis>DO NOT</emphasis> activate proxying for <literal>FTP</literal> or
any protocols besides HTTP and HTTPS (SSL) unless you intend to prevent your
browser from using these protocols.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Flush your browser's disk and memory caches, to remove any cached ad images.
- If using <application>Privoxy</application> to manage
+ If using <application>Privoxy</application> to manage
<ulink url="http://en.wikipedia.org/wiki/Browser_cookie">cookies</ulink>,
you should remove any currently stored cookies too.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- A default installation should provide a reasonable starting point for
+ A default installation should provide a reasonable starting point for
most. There will undoubtedly be occasions where you will want to adjust the
- configuration, but that can be dealt with as the need arises. Little
+ configuration, but that can be dealt with as the need arises. Little
to no initial configuration is required in most cases, you may want
to enable the
<ulink url="config.html#ENABLE-EDIT-ACTIONS">web-based action editor</ulink> though.
introduction to how <application>Privoxy</application> blocks ads and
banners.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Action</link></quote> has hints on how to understand and debug actions that
<quote>misbehave</quote>.
</para>
- </listitem>
+ </listitem>
<!--
Did anyone test these lately?
<link linkend="bookmarklets">Bookmarklets</link> into your browser's
personal toolbar.
</para>
- </listitem>
+ </listitem>
-->
<listitem>
<para>
Please see the section <link linkend="contact">Contacting the
Developers</link> on how to report bugs, problems with websites or to get
- help.
+ help.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Now enjoy surfing with enhanced control, comfort and privacy!
</para>
- </listitem>
+ </listitem>
</itemizedlist>
</para>
<sect2 id="quickstart-ad-blocking">
<title>Quickstart to Ad Blocking</title>
<!--
- NOTE: This section is deliberately redundant for those that don't
+ NOTE: This section is deliberately redundant for those that don't
want to read the whole thing (which is getting lengthy).
-->
<para>
Ad blocking is but one of <application>Privoxy's</application>
- array of features. Many of these features are for the technically minded advanced
+ array of features. Many of these features are for the technically minded advanced
user. But, ad and banner blocking is surely common ground for everybody.
</para>
-<para>
- This section will provide a quick summary of ad blocking so
+<para>
+ This section will provide a quick summary of ad blocking so
you can get up to speed quickly without having to read the more extensive
information provided below, though this is highly recommended.
</para>
<para>
First a bit of a warning ... blocking ads is much like blocking SPAM: the
- more aggressive you are about it, the more likely you are to block
- things that were not intended. And the more likely that some things
+ more aggressive you are about it, the more likely you are to block
+ things that were not intended. And the more likely that some things
may not work as intended. So there is a trade off here. If you want
extreme ad free browsing, be prepared to deal with more
<quote>problem</quote> sites, and to spend more time adjusting the
- configuration to solve these unintended consequences. In short, there is
- not an easy way to eliminate <emphasis>all</emphasis> ads. Either take
+ configuration to solve these unintended consequences. In short, there is
+ not an easy way to eliminate <emphasis>all</emphasis> ads. Either take
the easy way and settle for <emphasis>most</emphasis> ads blocked with the
default configuration, or jump in and tweak it for your personal surfing
habits and preferences.
</para>
<para>
Secondly, a brief explanation of <application>Privoxy's </application>
- <quote>actions</quote>. <quote>Actions</quote> in this context, are
+ <quote>actions</quote>. <quote>Actions</quote> in this context, are
the directives we use to tell <application>Privoxy</application> to perform
some task relating to HTTP transactions (i.e. web browsing). We tell
<application>Privoxy</application> to take some <quote>action</quote>. Each
</para>
<para>
Actions are specified in <application>Privoxy's</application> configuration,
- followed by one or more URLs to which the action should apply. URLs
+ followed by one or more URLs to which the action should apply. URLs
can actually be URL type <link linkend="af-patterns">patterns</link> that use
wildcards so they can apply potentially to a range of similar URLs. The
actions, together with the URL patterns are called a section.
<para>
The most important actions for basic ad blocking are: <literal><link
linkend="block">block</link></literal>, <literal><link
- linkend="handle-as-image">handle-as-image</link></literal>,
+ linkend="handle-as-image">handle-as-image</link></literal>,
<literal><link
linkend="handle-as-empty-document">handle-as-empty-document</link></literal>,and
<literal><link linkend="set-image-blocker">set-image-blocker</link></literal>:
<para>
<itemizedlist>
-
+
<listitem>
<para>
- <literal><link linkend="block">block</link></literal> - this is perhaps
+ <literal><link linkend="block">block</link></literal> - this is perhaps
the single most used action, and is particularly important for ad blocking.
This action stops any contact between your browser and any URL patterns
that match this action's configuration. It can be used for blocking ads,
<application>Privoxy</application>'s own built-in BLOCKED page instead to
let you now what has happened (with some exceptions, see below).
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- <literal><link linkend="handle-as-image">handle-as-image</link></literal> -
+ <literal><link linkend="handle-as-image">handle-as-image</link></literal> -
tells <application>Privoxy</application> to treat this URL as an image.
<application>Privoxy</application>'s default configuration already does this
for all common image types (e.g. GIF), but there are many situations where this
is not so easy to determine. So we'll force it in these cases. This is particularly
important for ad blocking, since only if we know that it's an image of
- some kind, can we replace it with an image of our choosing, instead of the
+ some kind, can we replace it with an image of our choosing, instead of the
<application>Privoxy</application> BLOCKED page (which would only result in
a <quote>broken image</quote> icon). There are some limitations to this
though. For instance, you can't just brute-force an image substitution for
an entire HTML page in most situations.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- <literal><link linkend="handle-as-empty-document">handle-as-empty-document</link></literal> -
- sends an empty document instead of <application>Privoxy's</application>
- normal BLOCKED HTML page. This is useful for file types that are neither
+ <literal><link linkend="handle-as-empty-document">handle-as-empty-document</link></literal> -
+ sends an empty document instead of <application>Privoxy's</application>
+ normal BLOCKED HTML page. This is useful for file types that are neither
HTML nor images, such as blocking JavaScript files.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
</para>
<simplelist>
<member>
- <emphasis>pattern</emphasis> - a checkerboard pattern, so that an ad
+ <emphasis>pattern</emphasis> - a checkerboard pattern, so that an ad
replacement is obvious. This is the default.
</member>
</simplelist>
of the user's choosing (advanced usage).
</member>
</simplelist>
- </listitem>
+ </listitem>
</itemizedlist>
</para>
<para>
Advanced users will eventually want to explore &my-app;
- <literal><link linkend="filter">filters</link></literal> as well. Filters
+ <literal><link linkend="filter">filters</link></literal> as well. Filters
are very different from <literal><link
linkend="block">blocks</link></literal>.
A <quote>block</quote> blocks a site, page, or unwanted contented. Filters
The quickest way to adjust any of these settings is with your browser through
the special <application>Privoxy</application> editor at <ulink
url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
- (shortcut: <ulink url="http://p.p/">http://p.p/show-status</ulink>). This
+ (shortcut: <ulink url="http://p.p/">http://p.p/show-status</ulink>). This
is an internal page, and does not require Internet access.
</para>
<listitem>
<para>
- Right click on the ad image to be blocked, then select
+ Right click on the ad image to be blocked, then select
<quote><guimenuitem>Copy Link Location</guimenuitem></quote> from the
- pop-up menu.
+ pop-up menu.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- Set your browser to
+ Set your browser to
<ulink
url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- Find <filename>user.action</filename> in the top section, and click
+ Find <filename>user.action</filename> in the top section, and click
on <quote><guibutton>Edit</guibutton></quote>:
</para>
<mediaobject>
<imageobject>
<imagedata fileref="files-in-use.jpg" format="jpg">
- </imageobject>
+ </imageobject>
<textobject>
<phrase>[ Screenshot of Actions Files in Use ]</phrase>
</textobject>
</mediaobject>
</figure>
</para>
- </listitem>
-
+ </listitem>
+
<listitem>
<para>
You should have a section with only
- <literal><link linkend="block">block</link></literal> listed under
+ <literal><link linkend="block">block</link></literal> listed under
<quote>Actions:</quote>.
If not, click a <quote><guibutton>Insert new section below</guibutton></quote>
- button, and in the new section that just appeared, click the
+ button, and in the new section that just appeared, click the
<guibutton>Edit</guibutton> button right under the word <quote>Actions:</quote>.
This will bring up a list of all actions. Find
<literal><link linkend="block">block</link></literal> near the top, and click
in the <quote>Enabled</quote> column, then <quote><guibutton>Submit</guibutton></quote>
just below the list.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Now, in the <literal><link linkend="block">block</link></literal> actions section,
<quote><guibutton>Submit</guibutton></quote> (or
<quote><guibutton>OK</guibutton></quote> if in a pop-up window).
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Now go back to the original page, and press <keycap>SHIFT-Reload</keycap>
(or flush all browser caches). The image should be gone now.
</para>
- </listitem>
-
+ </listitem>
+
</itemizedlist>
</para>
<para>
- This is a very crude and simple example. There might be good reasons to use a
+ This is a very crude and simple example. There might be good reasons to use a
wildcard pattern match to include potentially similar images from the same
- site. For a more extensive explanation of <quote>patterns</quote>, and
+ site. For a more extensive explanation of <quote>patterns</quote>, and
the entire actions concept, see <link linkend="actions-file">the Actions
section</link>.
</para>
The ideas explained therein also apply to the web-based editor.
</para>
<para>
- There are also various
- <link linkend="filter">filters</link> that can be used for ad blocking
- (filters are a special subset of actions). These
+ There are also various
+ <link linkend="filter">filters</link> that can be used for ad blocking
+ (filters are a special subset of actions). These
fall into the <quote>advanced</quote> usage category, and are explained in
- depth in later sections.
+ depth in later sections.
</para>
</sect2>
<para>
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 (SSL)
+ <application>Privoxy</application> as a HTTP and HTTPS (SSL)
<ulink url="http://en.wikipedia.org/wiki/Proxy_server">proxy</ulink>. The default is
127.0.0.1 (or localhost) for the proxy address, and port 8118 (earlier versions
used port 8000). This is the one configuration step <emphasis>that must be done
</emphasis>!
</para>
<para>
- Please note that <application>Privoxy</application> can only proxy HTTP and
+ Please note that <application>Privoxy</application> can only proxy HTTP and
HTTPS traffic. It will not work with FTP or other protocols.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="proxy_setup.jpg" format="jpg">
- </imageobject>
+ </imageobject>
<textobject>
<phrase>[ Screenshot of Mozilla Proxy Configuration ]</phrase>
</textobject>
</mediaobject>
</figure>
</para>
-
-<para>
+
+<para>
With <application>Firefox</application>, this is typically set under:
</para>
-
+
<literallayout>
<guibutton>Tools</guibutton> -> <guibutton>Options</guibutton> -> <guibutton>Advanced</guibutton> -> <guibutton>Network</guibutton> -><guibutton>Connection</guibutton> -> <guibutton>Settings</guibutton>
</literallayout>
-<para>
+<para>
Or optionally on some platforms:
</para>
-
+
<literallayout>
<guibutton>Edit</guibutton> -> <guibutton>Preferences</guibutton> -> <guibutton>General</guibutton> -> <guibutton>Connection Settings</guibutton> -> <guibutton>Manual Proxy Configuration</guibutton>
</literallayout>
-<para>
+<para>
With <application>Netscape</application> (and
<application>Mozilla</application>), this can be set under:
</para>
</literallayout>
<para>
- For <application>Internet Explorer v.5-7</application>:
+ For <application>Internet Explorer v.5-7</application>:
</para>
<literallayout>
<mediaobject>
<imageobject>
<imagedata fileref="proxy2.jpg" format="jpg">
- </imageobject>
+ </imageobject>
<textobject>
<phrase>[ Screenshot of IE Proxy Configuration ]</phrase>
</textobject>
<para>
After doing this, flush your browser's disk and memory caches to force a
- re-reading of all pages and to get rid of any ads that may be cached. Remove
+ re-reading of all pages and to get rid of any ads that may be cached. Remove
any <ulink url="http://en.wikipedia.org/wiki/Browser_cookie">cookies</ulink>,
if you want <application>Privoxy</application> to manage that. You are now
ready to start enjoying the benefits of using
<para>
<application>Privoxy</application> can run with full Windows service functionality.
On Windows only, the &my-app; program has two new command line arguments
- to install and uninstall &my-app; as a service. See the
+ to install and uninstall &my-app; as a service. See the
<link linkend="installation-pack-win">Windows Installation
instructions</link> for details.
</para>
An administrator username and password must be supplied in order for
the Privoxy Utility to perform any of the tasks.
</para>
-<para>
- During installation, <application>Privoxy</application> is configured to
- start automatically when the system restarts. To start &my-app; manually,
- double-click on the <literal>StartPrivoxy.command</literal> icon in the
- <literal>/Library/Privoxy</literal> folder. Or, type this command
- in the Terminal:
-</para>
-<para>
- <screen>
- /Library/Privoxy/StartPrivoxy.command
- </screen>
-</para>
-<para>
- You will be prompted for the administrator password.
-</para>
</sect2>
Start <application>Privoxy</application> (with RUN <>NIL:) in your
<filename>startnet</filename> script (AmiTCP), in
<filename>s:user-startup</filename> (RoadShow), as startup program in your
- startup script (Genesis), or as startup action (Miami and MiamiDx).
+ startup script (Genesis), or as startup action (Miami and MiamiDx).
<application>Privoxy</application> will automatically quit when you quit your
TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that
<application>Privoxy</application> is still running).
<sect2 id="start-gentoo">
<title>Gentoo</title>
<para>
- A script is again used. It will use the file <filename>/etc/privoxy/config
+ A script is again used. It will use the file <filename>/etc/privoxy/config
</filename> as its main configuration file.
</para>
<para>
</screen>
</para>
<para>
- Note that <application>Privoxy</application> is not automatically started at
- boot time by default. You can change this with the <literal>rc-update</literal>
+ Note that <application>Privoxy</application> is not automatically started at
+ boot time by default. You can change this with the <literal>rc-update</literal>
command.
</para>
-<para>
+<para>
<screen>
rc-update add privoxy default
</screen>
<ulink url="actions-file.html"><quote>actions</quote></ulink> 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.
+ such files included, with varying levels of aggressiveness.
</para>
<para>
<para>
Another feature where you will probably want to define exceptions for trusted
- sites is the popup-killing (through the <ulink
- url="actions-file.html#KILL-POPUPS"><quote>+kill-popups</quote></ulink> and
- <ulink
- url="actions-file.html#FILTER-POPUPS"><quote>+filter{popups}</quote></ulink>
- actions), because your favorite shopping, banking, or leisure site may need
- popups (explained below).
+ sites is the popup-killing (through <ulink
+ url="actions-file.html#FILTER-POPUPS"><quote>+filter{popups}</quote></ulink>),
+ because your favorite shopping, banking, or leisure site may need
+ popups (explained below).
</para>
<para>
</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>
- can be adjusted by pointing your browser to
+ 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>
+ can be adjusted by pointing your browser to
<ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
- (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>),
- and then follow the link to <quote>View & Change the Current Configuration</quote>.
+ (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>),
+ and then follow the link to <quote>View & Change the Current Configuration</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 actions file
- editor mentioned above, <application>Privoxy</application> can also
+ 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 actions file
+ editor mentioned above, <application>Privoxy</application> can also
be turned <quote>on</quote> and <quote>off</quote> (toggled) from this page.
</para>
<para>
If you can't get rid of the problem at all, think you've found a bug in
- Privoxy, want to propose a new feature or smarter rules, please see the
+ Privoxy, want to propose a new feature or smarter rules, please see the
section <link linkend="contact"><quote>Contacting the
- Developers</quote></link> below.
+ Developers</quote></link> below.
</para>
-->
<para>
<itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>--config-test</emphasis>
+ </para>
+ <para>
+ Exit after loading the configuration files before binding to
+ the listen address. The exit code signals whether or not the
+ configuration files have been successfully loaded.
+ </para>
+ <para>
+ If the exit code is 1, at least one of the configuration files
+ is invalid, if it is 0, all the configuration files have been
+ successfully loaded (but may still contain errors that can
+ currently only be detected at run time).
+ </para>
+ <para>
+ This option doesn't affect the log setting, combination with
+ <emphasis>--no-daemon</emphasis> is recommended if a configured
+ log file shouldn't be used.
+ </para>
+ </listitem>
<listitem>
<para>
<emphasis>--version</emphasis>
<para>
Print version info and exit. Unix only.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
<emphasis>--help</emphasis>
<para>
Print short usage info and exit. Unix only.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
<emphasis>--no-daemon</emphasis>
Don't become a daemon, i.e. don't fork and become process group
leader, and don't detach from controlling tty. Unix only.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
<emphasis>--pidfile FILE</emphasis>
<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>
<listitem>
<para>
<emphasis>--user USER[.GROUP]</emphasis>
<emphasis>--chroot</emphasis>
</para>
<para>
- Before changing to the user ID given in the <emphasis>--user</emphasis> option,
+ Before changing to the user ID given in the <emphasis>--user</emphasis> option,
chroot to that user's home directory, i.e. make the kernel pretend to the &my-app;
- process that the directory tree starts there. If set up carefully, this can limit
+ process that the directory tree starts there. If set up carefully, this can limit
the impact of possible vulnerabilities in &my-app; to the files contained in that hierarchy.
Unix only.
</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. If no config file is found,
+ 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. If no config file is found,
<application>Privoxy</application> will fail to start.
</para>
- </listitem>
+ </listitem>
</itemizedlist>
</para>
<para>
- On <application>MS Windows</application> only there are two additional
- command-line options to allow <application>Privoxy</application> to install and
- run as a <emphasis>service</emphasis>. See the
-<link linkend="installation-pack-win">Window Installation section</link>
+ On <application>MS Windows</application> only there are two additional
+ command-line options to allow <application>Privoxy</application> to install and
+ run as a <emphasis>service</emphasis>. See the
+<link linkend="installation-pack-win">Window Installation section</link>
for details.
</para>
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="configuration"><title>Privoxy Configuration</title>
<para>
- All <application>Privoxy</application> configuration is stored
+ All <application>Privoxy</application> configuration is stored
in text files. These files can be edited with a text editor.
- Many important aspects of <application>Privoxy</application> can
+ Many important aspects of <application>Privoxy</application> can
also be controlled easily with a web browser.
</para>
<sect2>
<title>Controlling Privoxy with Your Web Browser</title>
<para>
- <application>Privoxy</application>'s user interface can be reached through the special
+ <application>Privoxy</application>'s user interface can be reached through the special
URL <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
- (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>),
+ (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>),
which is a built-in page and works without Internet access.
You will see the following section:
▪ <ulink url="http://config.privoxy.org/toggle">Toggle Privoxy on or off</ulink>
</member>
<member>
- ▪ <ulink url="http://www.privoxy.org/
- &p-version;/user-manual/">Documentation</ulink>
+ ▪ <ulink
+ url="http://www.privoxy.org/&p-version;/user-manual/">Documentation</ulink>
</member>
</simplelist>
</msgtext>
cookie, and URL blocking magic is configured as well as other advanced features of
<application>Privoxy</application>. This is an easy way to adjust various
aspects of <application>Privoxy</application> configuration. The actions
- file, and other configuration files, are explained in detail below.
+ file, and other configuration files, are explained in detail below.
</para>
<para>
- <quote>Toggle Privoxy 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. You can in fact use
- it as a test to see whether it is <application>Privoxy</application>
- causing the problem or not. <application>Privoxy</application> continues
+ it as a test to see 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 manipulation is disabled, i.e.
<application>Privoxy</application> acts like a normal forwarding proxy. There
is even a toggle <link linkend="bookmarklets">Bookmarklet</link> offered, so
<para>
For Unix, *BSD and Linux, all configuration files are located in
<filename>/etc/privoxy/</filename> by default. For MS Windows, OS/2, and
- AmigaOS these are all in the same directory as the
+ AmigaOS these are all in the same directory as the
<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
+ The installed defaults provide a reasonable starting point, though
some settings may be aggressive by some standards. For the time being, the
principle configuration files are:
</para>
on Linux, Unix, BSD, OS/2, and AmigaOS and <filename>config.txt</filename>
on Windows. This is a required file.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- <filename>default.action</filename> (the main <link linkend="actions-file">actions file</link>)
- is used to define which <quote>actions</quote> relating to banner-blocking, images, pop-ups,
- content modification, cookie handling etc should be applied by default. It also defines many
- exceptions (both positive and negative) from this default set of actions that enable
- <application>Privoxy</application> to selectively eliminate the junk, and only the junk, on
- as many websites as possible.
+ <filename>match-all.action</filename> is used to define which <quote>actions</quote>
+ relating to banner-blocking, images, pop-ups, content modification, cookie handling
+ etc should be applied by default. It should be the first actions file loaded.
+ </para>
+ <para>
+ <filename>default.action</filename> defines many exceptions (both positive and negative)
+ from the default set of actions that's configured in <filename>match-all.action</filename>.
+ It should be the second actions file loaded and shouldn't be edited by the user.
</para>
<para>
- Multiple actions files may be defined in <filename>config</filename>. These
- are processed in the order they are defined. Local customizations and locally
- preferred exceptions to the default policies as defined in
- <filename>default.action</filename> (which you will most probably want
- to define sooner or later) are probably best applied in
- <filename>user.action</filename>, where you can preserve them across
- upgrades. <filename>standard.action</filename> is only for
- <application>Privoxy's</application> internal use.
+ Multiple actions files may be defined in <filename>config</filename>. These
+ are processed in the order they are defined. Local customizations and locally
+ preferred exceptions to the default policies as defined in
+ <filename>match-all.action</filename> (which you will most probably want
+ to define sooner or later) are best applied in <filename>user.action</filename>,
+ where you can preserve them across upgrades. The file isn't installed by all
+ installers, but you can easily create it yourself with a text editor.
</para>
- <para>
+ <para>
There is also a web based editor that can be accessed from
<ulink
url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
(Shortcut: <ulink
url="http://p.p/show-status">http://p.p/show-status</ulink>) for the
- various actions files.
+ various actions files.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
file</link>) 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. The filtering jobs are only pre-defined here;
- whether to apply them or not is up to the actions files.
- <filename>default.filter</filename> includes various filters made
- available for use by the developers. Some are much more intrusive than
- others, and all should be used with caution. You may define additional
- filter files in <filename>config</filename> as you can with
- actions files. We suggest <filename>user.filter</filename> for any
+ whether to apply them or not is up to the actions files.
+ <filename>default.filter</filename> includes various filters made
+ available for use by the developers. Some are much more intrusive than
+ others, and all should be used with caution. You may define additional
+ filter files in <filename>config</filename> as you can with
+ actions files. We suggest <filename>user.filter</filename> for any
locally defined filters or customizations.
</para>
- </listitem>
+ </listitem>
</itemizedlist>
</para>
</para>
<para>
- The actions files and filter files
+ The actions files and filter files
can use Perl style <link linkend="regex">regular expressions</link> for
- maximum flexibility.
+ maximum flexibility.
</para>
<para>
After making any changes, there is no need to restart
<application>Privoxy</application> in order for the changes to take
- effect. <application>Privoxy</application> detects such changes
+ effect. <application>Privoxy</application> detects such changes
automatically. Note, however, that it may take one or two additional
requests for the change to take effect. When changing the listening address
of <application>Privoxy</application>, these <quote>wake up</quote> requests
<![%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
+ 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>
]]>
<sect1 id="actions-file"><title>Actions Files</title>
+
+<!--
+ XXX: similar descriptions are in the Configuration Files sections.
+ We should only describe them at one place.
+-->
<para>
The actions files are used to define what <emphasis>actions</emphasis>
<application>Privoxy</application> takes for which URLs, and thus determines
how ad images, cookies and various other aspects of HTTP content and
- transactions are handled, and on which sites (or even parts thereof).
+ transactions are handled, and on which sites (or even parts thereof).
There are a number of such actions, with a wide range of functionality.
Each action does something a little different.
- These actions give us a veritable arsenal of tools with which to exert
- our control, preferences and independence. Actions can be combined so that
+ These actions give us a veritable arsenal of tools with which to exert
+ our control, preferences and independence. Actions can be combined so that
their effects are aggregated when applied against a given set of URLs.
-</para>
+</para>
<para>
- There
+ There
are three action files included with <application>Privoxy</application> with
differing purposes:
- </para>
-
- <para>
- <itemizedlist>
- <listitem>
- <para>
- <filename>default.action</filename> - is the primary action file
- that sets the initial values for all actions. It is intended to
- provide a base level of functionality for
- <application>Privoxy's</application> array of features. So it is
- a set of broad rules that should work reasonably well as-is for most users.
- This is the file that the developers are keeping updated, and <link
- linkend="installation-keepupdated">making available to users</link>.
- The user's preferences as set in <filename>standard.action</filename>,
- e.g. either <literal>Cautious</literal> (the default),
- <literal>Medium</literal>, or <literal>Advanced</literal> (see
- below).
- </para>
- </listitem>
- <listitem>
- <para>
- <filename>user.action</filename> - is intended to be for local site
- preferences and exceptions. As an example, if your ISP or your bank
- has specific requirements, and need special handling, this kind of
- thing should go here. This file will not be upgraded.
- </para>
- </listitem>
- <listitem>
- <para>
- <filename>standard.action</filename> - is used only by the web based editor
- at <ulink url="http://config.privoxy.org/edit-actions-list?f=default">
- http://config.privoxy.org/edit-actions-list?f=default</ulink>,
- to set various pre-defined sets of rules for the default actions section
- in <filename>default.action</filename>.
- </para>
- <para>
- <guibutton>Edit</guibutton> <guibutton>Set to Cautious</guibutton> <guibutton>Set to Medium</guibutton> <guibutton>Set to Advanced</guibutton>
- </para>
- <para>
- These have increasing levels of aggressiveness <emphasis>and have no
- influence on your browsing unless you select them explicitly in the
- editor</emphasis>. A default installation should be pre-set to
- <literal>Cautious</literal> (versions prior to 3.0.5 were set to
- <literal>Medium</literal>). New users should try this for a while before
- adjusting the settings to more aggressive levels. The more aggressive
- the settings, then the more likelihood there is of problems such as sites
- not working as they should.
- </para>
- <para>
- The <guibutton>Edit</guibutton> button allows you to turn each
- action on/off individually for fine-tuning. The <guibutton>Cautious</guibutton>
- button changes the actions list to low/safe settings which will activate
- ad blocking and a minimal set of &my-app;'s features, and subsequently
- there will be less of a chance for accidental problems. The
- <guibutton>Medium</guibutton> button sets the list to a medium level of
- other features and a low level set of privacy features. The
- <guibutton>Advanced</guibutton> button sets the list to a high level of
- ad blocking and medium level of privacy. See the chart below. The latter
- three buttons over-ride any changes via with the
- <guibutton>Edit</guibutton> button. More fine-tuning can be done in the
- lower sections of this internal page.
- </para>
- <para>
- It is not recommend to edit the <filename>standard.action</filename> file
- itself.
- </para>
- <para>
- The default profiles, and their associated actions, as pre-defined in
- <filename>standard.action</filename> are<!-- different than this table which is out of date -->:
- </para>
- <para>
+</para>
+<para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <filename>match-all.action</filename> - is used to define which
+ <quote>actions</quote> relating to banner-blocking, images, pop-ups,
+ content modification, cookie handling etc should be applied by default.
+ It should be the first actions file loaded
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <filename>default.action</filename> - defines many exceptions (both
+ positive and negative) from the default set of actions that's configured
+ in <filename>match-all.action</filename>. It is a set of rules that should
+ work reasonably well as-is for most users. This file is only supposed to
+ be edited by the developers. It should be the second actions file loaded.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <filename>user.action</filename> - is intended to be for local site
+ preferences and exceptions. As an example, if your ISP or your bank
+ has specific requirements, and need special handling, this kind of
+ thing should go here. This file will not be upgraded.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guibutton>Edit</guibutton> <guibutton>Set to Cautious</guibutton> <guibutton>Set to Medium</guibutton> <guibutton>Set to Advanced</guibutton>
+ </para>
+ <para>
+ These have increasing levels of aggressiveness <emphasis>and have no
+ influence on your browsing unless you select them explicitly in the
+ editor</emphasis>. A default installation should be pre-set to
+ <literal>Cautious</literal>. New users should try this for a while before
+ adjusting the settings to more aggressive levels. The more aggressive
+ the settings, then the more likelihood there is of problems such as sites
+ not working as they should.
+ </para>
+ <para>
+ The <guibutton>Edit</guibutton> button allows you to turn each
+ action on/off individually for fine-tuning. The <guibutton>Cautious</guibutton>
+ button changes the actions list to low/safe settings which will activate
+ ad blocking and a minimal set of &my-app;'s features, and subsequently
+ there will be less of a chance for accidental problems. The
+ <guibutton>Medium</guibutton> button sets the list to a medium level of
+ other features and a low level set of privacy features. The
+ <guibutton>Advanced</guibutton> button sets the list to a high level of
+ ad blocking and medium level of privacy. See the chart below. The latter
+ three buttons over-ride any changes via with the
+ <guibutton>Edit</guibutton> button. More fine-tuning can be done in the
+ lower sections of this internal page.
+ </para>
+ <para>
+ While the actions file editor allows to enable these settings in all
+ actions files, they are only supposed to be enabled in the first one
+ to make sure you don't unintentionally overrule earlier rules.
+ </para>
+ <para>
+ The default profiles, and their associated actions, as pre-defined in
+ <filename>default.action</filename> are:
+ </para>
+ <para>
<table frame=all><title>Default Configurations</title>
<tgroup cols=4 align=left colsep=1 rowsep=1>
<colspec colname=c1>
<entry>blocks only</entry>
<entry>blocks only</entry>
</row>
-
+
<row>
<entry>Privacy Features</entry>
<entry>low</entry>
<entry>yes</entry>
</row>
-
<row>
<entry>GIF de-animation</entry>
<entry>no</entry>
<entry>yes</entry>
</row>
-
<row>
<entry>Fast redirects</entry>
<entry>no</entry>
<row>
<entry>Image tag reordering</entry>
<entry>no</entry>
- <entry>no</entry>
+ <entry>yes</entry>
<entry>yes</entry>
</row>
</table>
</para>
- </listitem>
- </itemizedlist>
- </para>
+ </listitem>
+ </itemizedlist>
+</para>
<para>
- The list of actions files to be used are defined in the main configuration
+ The list of actions files to be used are defined in the main configuration
file, and are processed in the order they are defined (e.g.
<filename>default.action</filename> is typically processed before
<filename>user.action</filename>). The content of these can all be viewed and
(defined in <filename>default.action</filename>),
followed by any exceptions (typically also in
<filename>default.action</filename>), which are then followed lastly by any
- local preferences (typically in <emphasis>user</emphasis><filename>.action</filename>).
+ local preferences (typically in <emphasis>user</emphasis><filename>.action</filename>).
Generally, <filename>user.action</filename> has the last word.
</para>
<link linkend="aliases">alias section</link> at the top of that file.
Then comes the default set of rules which will apply universally to all
sites and pages (be <emphasis>very careful</emphasis> with using such a
- universal set in <filename>user.action</filename> or any other actions file after
+ universal set in <filename>user.action</filename> or any other actions file after
<filename>default.action</filename>, because it will override the result
from consulting any previous file). And then below that,
exceptions to the defined universal policies. You can regard
personal settings across <application>Privoxy</application> upgrades easier.
</para>
-<para>
+<para>
Actions can be used to block anything you want, including ads, banners, or
just some obnoxious URL whose content you would rather not see. Cookies can be accepted
or rejected, or accepted only during the current browser session (i.e. not
Note that some <link linkend="actions">actions</link>, like cookie suppression
or script disabling, may render some sites unusable that rely on these
techniques to work properly. Finding the right mix of actions is not always easy and
- certainly a matter of personal taste. And, things can always change, requiring
+ certainly a matter of personal taste. And, things can always change, requiring
refinements in the configuration. In general, it can be said that the more
<quote>aggressive</quote> your default settings (in the top section of the
actions file) are, the more exceptions for <quote>trusted</quote> sites you
like <quote>Cautious</quote>, <quote>Medium</quote> or
<quote>Advanced</quote>. Warning: the <quote>Advanced</quote> setting is more
aggressive, and will be more likely to cause problems for some sites.
- Experienced users only!
+ Experienced users only!
</para>
<para>
If you prefer plain text editing to GUIs, you can of course also directly edit the
the actions files with your favorite text editor. Look at
- <filename>default.action</filename> which is richly commented with many
+ <filename>default.action</filename> which is richly commented with many
good examples.
</para>
</sect2>
<para>
If multiple applying sections set the same action differently,
the last match wins. If not, the effects are aggregated.
- E.g. a URL might match a regular section with a heading line of <literal>{
+ E.g. a URL might match a regular section with a heading line of <literal>{
+<link linkend="handle-as-image">handle-as-image</link> }</literal>,
then later another one with just <literal>{
+<link linkend="block">block</link> }</literal>, resulting
- in <emphasis>both</emphasis> actions to apply. And there may well be
- cases where you will want to combine actions together. Such a section then
+ in <emphasis>both</emphasis> actions to apply. And there may well be
+ cases where you will want to combine actions together. Such a section then
might look like:
</para>
<!-- ~~~~~ New section ~~~~~ -->
<sect2 id="af-patterns">
<title>Patterns</title>
-<para>
+<para>
As mentioned, <application>Privoxy</application> uses <quote>patterns</quote>
to determine what <emphasis>actions</emphasis> might apply to which sites and
pages your browser attempts to access. These <quote>patterns</quote> use wild
flexibility. This allows one expression to be expanded and potentially match
against many similar patterns.
</para>
-
+
<para>
Generally, an URL pattern has the form
- <literal><domain>/<path></literal>, where both the
- <literal><domain></literal> and <literal><path></literal> are
- optional. (This is why the special <literal>/</literal> pattern matches all
- URLs). Note that the protocol portion of the URL pattern (e.g.
- <literal>http://</literal>) should <emphasis>not</emphasis> be included in
- the pattern. This is assumed already!
+ <literal><domain><port>/<path></literal>, where the
+ <literal><domain></literal>, the <literal><port></literal>
+ and the <literal><path></literal> are optional. (This is why the special
+ <literal>/</literal> pattern matches all URLs). Note that the protocol
+ portion of the URL pattern (e.g. <literal>http://</literal>) should
+ <emphasis>not</emphasis> be included in the pattern. This is assumed already!
</para>
<para>
The pattern matching syntax is different for the domain and path parts of
- the URL. The domain part uses a simple globbing type matching technique,
- while the path part uses a more flexible
+ the URL. The domain part uses a simple globbing type matching technique,
+ while the path part uses more flexible
<ulink url="http://en.wikipedia.org/wiki/Regular_expressions"><quote>Regular
- Expressions (PCRE)</quote></ulink> based syntax.
+ Expressions</quote></ulink> (POSIX 1003.2).
+</para>
+<para>
+ The port part of a pattern is a decimal port number preceded by a colon
+ (<literal>:</literal>). If the domain part contains a numerical IPv6 address,
+ it has to be put into angle brackets
+ (<literal><</literal>, <literal>></literal>).
</para>
<variablelist>
<para>
is a domain-only pattern and will match any request to <literal>www.example.com</literal>,
regardless of which document on that server is requested. So ALL pages in
- this domain would be covered by the scope of this action. Note that a
+ this domain would be covered by the scope of this action. Note that a
simple <literal>example.com</literal> is different and would NOT match.
</para>
</listitem>
</listitem>
</varlistentry>
<varlistentry>
- <term><literal>www.example.com/index.html$</literal></term>
+ <term><literal>www.example.com/index.html</literal></term>
<listitem>
<para>
matches all the documents on <literal>www.example.com</literal>
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><literal>/</literal></term>
+ <listitem>
+ <para>
+ Matches any URL because there's no requirement for either the
+ domain or the path to match anything.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>:8000/</literal></term>
+ <listitem>
+ <para>
+ Matches any URL pointing to TCP port 8000.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal><2001:db8::1>/</literal></term>
+ <listitem>
+ <para>
+ Matches any URL with the host address <literal>2001:db8::1</literal>.
+ (Note that the real URL uses plain brackets, not angle brackets.)
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><literal>index.html</literal></term>
<listitem>
<para>
matches nothing, since it would be interpreted as a domain name and
- there is no top-level domain called <literal>.html</literal>. So its
+ there is no top-level domain called <literal>.html</literal>. So its
a mistake.
</para>
</listitem>
<para>
The matching of the domain part offers some flexible options: if the
- domain starts or ends with a dot, it becomes unanchored at that end.
+ domain starts or ends with a dot, it becomes unanchored at that end.
For example:
</para>
a domain.) This might be <literal>www.example.com</literal>,
<literal>news.example.de</literal>, or
<literal>www.example.net/cgi/testing.pl</literal> for instance. All these
- cases are matched.
+ cases are matched.
</para>
</listitem>
</varlistentry>
Additionally, there are wild-cards that you can use in the domain names
themselves. These work similarly to shell globbing type wild-cards:
<quote>*</quote> represents zero or more arbitrary characters (this is
- equivalent to the
+ equivalent to the
<ulink url="http://en.wikipedia.org/wiki/Regular_expressions"><quote>Regular
Expression</quote></ulink> based syntax of <quote>.*</quote>),
<quote>?</quote> represents any single character (this is equivalent to the
regular expression syntax of a simple <quote>.</quote>), and you can define
- <quote>character classes</quote> in square brackets which is similar to
+ <quote>character classes</quote> in square brackets which is similar to
the same regular expression technique. All of this can be freely mixed:
</para>
<term><literal>ad*.example.com</literal></term>
<listitem>
<para>
- matches <quote>adserver.example.com</quote>,
+ matches <quote>adserver.example.com</quote>,
<quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>
</para>
</listitem>
<listitem>
<para>
matches <literal>www.ipix.com</literal>,
- <literal>pictures.epix.com</literal>, <literal>a.b.c.d.e.upix.com</literal> etc.
+ <literal>pictures.epix.com</literal>, <literal>a.b.c.d.e.upix.com</literal> etc.
</para>
</listitem>
</varlistentry>
<term><literal>www[1-9a-ez].example.c*</literal></term>
<listitem>
<para>
- matches <literal>www1.example.com</literal>,
- <literal>www4.example.cc</literal>, <literal>wwwd.example.cy</literal>,
- <literal>wwwz.example.com</literal> etc., but <emphasis>not</emphasis>
+ matches <literal>www1.example.com</literal>,
+ <literal>www4.example.cc</literal>, <literal>wwwd.example.cy</literal>,
+ <literal>wwwz.example.com</literal> etc., but <emphasis>not</emphasis>
<literal>wwww.example.com</literal>.
</para>
</listitem>
<sect3><title>The Path Pattern</title>
<para>
- <application>Privoxy</application> uses Perl compatible (PCRE)
+ <application>Privoxy</application> uses <quote>modern</quote> POSIX 1003.2
<ulink url="http://en.wikipedia.org/wiki/Regular_expressions"><quote>Regular
- Expression</quote></ulink> based syntax
- (through the <ulink url="http://www.pcre.org/">PCRE</ulink> library) for
- matching the path portion (after the slash), and is thus more flexible.
+ Expressions</quote></ulink> for matching the path portion (after the slash),
+ and is thus more flexible.
</para>
<para>
There is an <link linkend="regex">Appendix</link> with a brief quick-start into regular
- expressions, and full (very technical) documentation on PCRE regex syntax is available on-line
- at <ulink url="http://www.pcre.org/man.txt">http://www.pcre.org/man.txt</ulink>.
- You might also find the Perl man page on regular expressions (<literal>man perlre</literal>)
- useful, which is available on-line at <ulink
- url="http://perldoc.perl.org/perlre.html">http://perldoc.perl.org/perlre.html</ulink>.
+ expressions, you also might want to have a look at your operating system's documentation
+ on regular expressions (try <literal>man re_format</literal>).
</para>
<para>
Note that the path pattern is automatically left-anchored at the <quote>/</quote>,
- i.e. it matches as if it would start with a <quote>^</quote> (regular expression speak
+ i.e. it matches as if it would start with a <quote>^</quote> (regular expression speak
for the beginning of a line).
</para>
<para>
Please also note that matching in the path is <emphasis>CASE INSENSITIVE</emphasis>
- by default, but you can switch to case sensitive at any point in the pattern by using the
+ by default, but you can switch to case sensitive at any point in the pattern by using the
<quote>(?-i)</quote> switch: <literal>www.example.com/(?-i)PaTtErN.*</literal> will match
only documents whose path starts with <literal>PaTtErN</literal> in
<emphasis>exactly</emphasis> this capitalization.
<term><literal>.example.com/.*</literal></term>
<listitem>
<para>
- Is equivalent to just <quote>.example.com</quote>, since any documents
+ Is equivalent to just <quote>.example.com</quote>, since any documents
within that domain are matched with or without the <quote>.*</quote>
regular expression. This is redundant
</para>
named <quote>index.html</quote>, and that is part of some path. For
example, it matches <quote>www.example.com/testing/index.html</quote> but
NOT <quote>www.example.com/index.html</quote> because the regular
- expression called for at least two <quote>/'s</quote>, thus the path
- requirement. It also would match
- <quote>www.example.com/testing/index_html</quote>, because of the
+ expression called for at least two <quote>/'s</quote>, thus the path
+ requirement. It also would match
+ <quote>www.example.com/testing/index_html</quote>, because of the
special meta-character <quote>.</quote>.
</para>
</listitem>
<term><literal>.example.com/(.*/)?index\.html$</literal></term>
<listitem>
<para>
- This regular expression is conditional so it will match any page
- named <quote>index.html</quote> regardless of path which in this case can
- have one or more <quote>/'s</quote>. And this one must contain exactly
+ This regular expression is conditional so it will match any page
+ named <quote>index.html</quote> regardless of path which in this case can
+ have one or more <quote>/'s</quote>. And this one must contain exactly
<quote>.html</quote> (but does not have to end with that!).
</para>
</listitem>
<listitem>
<para>
This regular expression will match any path of <quote>example.com</quote>
- that contains any of the words <quote>ads</quote>, <quote>banner</quote>,
+ that contains any of the words <quote>ads</quote>, <quote>banner</quote>,
<quote>banners</quote> (because of the <quote>?</quote>) or <quote>junk</quote>.
The path does not have to end in these words, just contain them.
</para>
<term><literal>.example.com/(.*/)(ads|banners?|junk)/.*\.(jpe?g|gif|png)$</literal></term>
<listitem>
<para>
- This is very much the same as above, except now it must end in either
- <quote>.jpg</quote>, <quote>.jpeg</quote>, <quote>.gif</quote> or <quote>.png</quote>. So this
+ This is very much the same as above, except now it must end in either
+ <quote>.jpg</quote>, <quote>.jpeg</quote>, <quote>.gif</quote> or <quote>.png</quote>. So this
one is limited to common image formats.
</para>
</listitem>
</variablelist>
<para>
- There are many, many good examples to be found in <filename>default.action</filename>,
+ There are many, many good examples to be found in <filename>default.action</filename>,
and more tutorials below in <link linkend="regex">Appendix on regular expressions</link>.
</para>
</para>
-<para>
+<para>
Again, actions are invoked by placing them on a line, enclosed in curly braces and
- separated by whitespace, like in
+ separated by whitespace, like in
<literal>{+some-action -some-other-action{some-parameter}}</literal>,
followed by a list of URL patterns, one per line, to which they apply.
Together, the actions line and the following pattern lines make up a section
- of the actions file.
+ of the actions file.
</para>
-<para>
+<para>
Actions fall into three categories:
</para>
<para>
<itemizedlist>
<listitem>
- <para>
+ <para>
Boolean, i.e the action can only be <quote>enabled</quote> or
<quote>disabled</quote>. Syntax:
</para>
+<replaceable class="function">name</replaceable> # enable action <replaceable class="parameter">name</replaceable>
-<replaceable class="function">name</replaceable> # disable action <replaceable class="parameter">name</replaceable></screen>
</para>
- <para>
+ <para>
Example: <literal>+handle-as-image</literal>
</para>
</listitem>
<listitem>
- <para>
+ <para>
Parameterized, where some value is required in order to enable this type of action.
Syntax:
</para>
Note that if the URL matches multiple positive forms of a parameterized action,
the last match wins, i.e. the params from earlier matches are simply ignored.
</para>
- <para>
+ <para>
Example: <literal>+hide-user-agent{Mozilla/5.0 (X11; U; FreeBSD i386; en-US; rv:1.8.1.4) Gecko/20070602 Firefox/2.0.0.4}</literal>
</para>
</listitem>
-
+
<listitem>
- <para>
+ <para>
Multi-value. These look exactly like parameterized actions,
but they behave differently: If the action applies multiple times to the
same URL, but with different parameters, <emphasis>all</emphasis> the parameters
# If it was the last one left, disable the action.
<replaceable class="parameter">-name</replaceable> # disable this action completely and remove all parameters from the list</screen>
</para>
- <para>
+ <para>
Examples: <literal>+add-header{X-Fun-Header: Some text}</literal> and
<literal>+filter{html-annoyances}</literal>
</para>
<para>
Later defined action sections always over-ride earlier ones of the same type.
- So exceptions to any rules you make, should come in the latter part of the file (or
- in a file that is processed later when using multiple actions files such
+ So exceptions to any rules you make, should come in the latter part of the file (or
+ in a file that is processed later when using multiple actions files such
as <filename>user.action</filename>). For multi-valued actions, the actions
are applied in the order they are specified. Actions files are processed in
the order they are defined in <filename>config</filename> (the default
<para>Multi-value.</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Parameter:</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
<para>
- This action may be specified multiple times, in order to define multiple
- headers. This is rarely needed for the typical user. If you don't know what
- <quote>HTTP headers</quote> are, you definitely don't need to worry about this
+ This action may be specified multiple times, in order to define multiple
+ headers. This is rarely needed for the typical user. If you don't know what
+ <quote>HTTP headers</quote> are, you definitely don't need to worry about this
one.
</para>
+ <para>
+ Headers added by this action are not modified by other actions.
+ </para>
</listitem>
</varlistentry>
the <literal><link
linkend="handle-as-image">handle-as-image</link></literal>,
<literal><link
- linkend="set-image-blocker">set-image-blocker</link></literal>, and
+ linkend="set-image-blocker">set-image-blocker</link></literal>, and
<literal><link
linkend="handle-as-empty-document">handle-as-empty-document</link></literal> actions.
-
+
</para>
</listitem>
</varlistentry>
<para>A block reason that should be given to the user.</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
to the blocked content (the latter only if the force feature is available and
enabled).
</para>
-<!--
-This doesn't actually work in all browser configuration and the user probably doesn't care anyway.
<para>
- The <quote>BLOCKED</quote> page adapts to the available
- screen space -- it displays full-blown if space allows, or miniaturized and text-only
- if loaded into a small frame or window. If you are using <application>Privoxy</application>
- right now, you can take a look at the
- <ulink url="http://ads.bannerserver.example.com/nasty-ads/sponsor.html"><quote>BLOCKED</quote>
- page</ulink>.
- </para>
--->
- <para>
- A very important exception occurs if <emphasis>both</emphasis>
+ A very important exception occurs if <emphasis>both</emphasis>
<literal>block</literal> and <literal><link linkend="handle-as-image">handle-as-image</link></literal>,
- apply to the same request: it will then be replaced by an image. If
+ apply to the same request: it will then be replaced by an image. If
<literal><link linkend="set-image-blocker">set-image-blocker</link></literal>
(see below) also applies, the type of image will be determined by its parameter,
if not, the standard checkerboard pattern is sent.
</para>
<para>
- It is important to understand this process, in order
- to understand how <application>Privoxy</application> deals with
- ads and other unwanted content. Blocking is a core feature, and one
+ It is important to understand this process, in order
+ to understand how <application>Privoxy</application> deals with
+ ads and other unwanted content. Blocking is a core feature, and one
upon which various other features depend.
</para>
<para>
# Block and replace with "blocked" page
.nasty-stuff.example.com
-{+block{Doubleclick banners.} +handle-as-image}
+{+block{Doubleclick banners.} +handle-as-image}
# Block and replace with image
.ad.doubleclick.net
.ads.r.us/banners/
-{+block{Layered ads.} +handle-as-empty-document}
+{+block{Layered ads.} +handle-as-empty-document}
# Block and then ignore
adserver.example.net/.*\.js$</screen>
</para>
</sect3>
+<!-- ~~~~~ New section ~~~~~ -->
+<sect3 renderas="sect4" id="change-x-forwarded-for">
+<title>change-x-forwarded-for</title>
+
+<variablelist>
+ <varlistentry>
+ <term>Typical use:</term>
+ <listitem>
+ <para>Improve privacy by not forwarding the source of the request in the HTTP headers.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Effect:</term>
+ <listitem>
+ <para>
+ Deletes the <quote>X-Forwarded-For:</quote> HTTP header from the client request,
+ or adds a new one.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Type:</term>
+ <!-- Boolean, Parameterized, Multi-value -->
+ <listitem>
+ <para>Parameterized.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Parameter:</term>
+ <listitem>
+ <itemizedlist>
+ <listitem>
+ <para><quote>block</quote> to delete the header.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <quote>add</quote> to create the header (or append
+ the client's IP address to an already existing one).
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Notes:</term>
+ <listitem>
+ <para>
+ It is safe and recommended to use <literal>block</literal>.
+ </para>
+ <para>
+ Forwarding the source address of the request may make
+ sense in some multi-user setups but is also a privacy risk.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Example usage:</term>
+ <listitem>
+ <para>
+ <screen>+change-x-forwarded-for{block}</screen>
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+</sect3>
+
<!-- ~~~~~ New section ~~~~~ -->
<sect3 renderas="sect4" id="client-header-filter">
<title>client-header-filter</title>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
and use their output as input.
</para>
<para>
- If the request URL gets changed, &my-app; will detect that and use the new
+ If the request URI gets changed, &my-app; will detect that and use the new
one. This can be used to rewrite the request destination behind the client's
back, for example to specify a Tor exit relay for certain requests.
</para>
{+client-header-filter{hide-tor-exit-notation}}
/
</screen>
- </para>
+ </para>
</listitem>
</varlistentry>
<para>
Client headers to which this action applies are filtered on-the-fly through
the specified regular expression based substitutions, the result is used as
- tag.
+ tag.
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
# Tag every request with the User-Agent header
{+client-header-tagger{user-agent}}
/
+
+# Tagging itself doesn't change the action
+# settings, sections with TAG patterns do:
+#
+# If it's a download agent, use a different forwarding proxy,
+# show the real User-Agent and make sure resume works.
+{+forward-override{forward-socks5 10.0.0.2:2222 .} \
+ -hide-if-modified-since \
+ -overwrite-last-modified \
+ -hide-user-agent \
+ -filter \
+ -deanimate-gifs \
+}
+TAG:^User-Agent: NetBSD-ftp/
+TAG:^User-Agent: Novell ZYPP Installer
+TAG:^User-Agent: RPM APT-HTTP/
+TAG:^User-Agent: fetch libfetch/
+TAG:^User-Agent: Ubuntu APT-HTTP/
+TAG:^User-Agent: MPlayer/
+ </screen>
+ </para>
+ <para>
+ <screen>
+# Tag all requests with the Range header set
+{+client-header-tagger{range-requests}}
+/
+
+# Disable filtering for the tagged requests.
+#
+# With filtering enabled Privoxy would remove the Range headers
+# to be able to filter the whole response. The downside is that
+# it prevents clients from resuming downloads or skipping over
+# parts of multimedia files.
+{-filter -deanimate-gifs}
+TAG:^RANGE-REQUEST$
</screen>
</para>
</listitem>
<term>Parameter:</term>
<listitem>
<para>
- Any string.
- </para>
+ Any string.
+ </para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
browser to decide what to do with the document. The value of this
header can cause the browser to open a download menu instead of
displaying the document by itself, even if the document's format is
- supported by the browser.
+ supported by the browser.
</para>
<para>
The declared content type can also affect which rendering mode
<quote>Content-Type: text/html</quote>, you can use &my-app;
to overwrite it with <quote>application/xml</quote> and validate
the web master's claim inside your XHTML-supporting browser.
- If the syntax is incorrect, the browser will complain loudly.
+ If the syntax is incorrect, the browser will complain loudly.
</para>
<para>
You can also go the opposite direction: if your browser prints
error messages instead of rendering a document falsely declared
as XHTML, you can overwrite the content type with
- <quote>text/html</quote> and have it rendered as broken HTML document.
+ <quote>text/html</quote> and have it rendered as broken HTML document.
</para>
<para>
By default <literal>content-type-overwrite</literal> only replaces
<para>
Of course you can apply <literal>content-type-overwrite</literal>
to a whole site and then make URL based exceptions, but it's a lot
- more work to get the same precision.
+ more work to get the same precision.
</para>
</listitem>
</varlistentry>
<listitem>
<para>
Any string.
- </para>
+ </para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
<term>Example usage (section):</term>
<listitem>
<para>
- <screen># Block the non-existent "Privacy-Violation:" client header
+ <screen># Block the non-existent "Privacy-Violation:" client header
{ +crunch-client-header{Privacy-Violation:} }
/
</screen>
<listitem>
<para>
N/A
- </para>
+ </para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
<para>
It makes <emphasis>no sense at all</emphasis> to use this action in conjunction
with the <literal><link linkend="session-cookies-only">session-cookies-only</link></literal> action,
- since it would prevent the session cookies from being set. See also
+ since it would prevent the session cookies from being set. See also
<literal><link linkend="filter-content-cookies">filter-content-cookies</link></literal>.
</para>
</listitem>
<listitem>
<para>
Any string.
- </para>
+ </para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
<para>
This is a left-over from the time when <application>Privoxy</application>
didn't support important HTTP/1.1 features well. It is left here for the
- unlikely case that you experience HTTP/1.1 related problems with some server
- out there. Not all HTTP/1.1 features and requirements are supported yet,
- so there is a chance you might need this action.
+ unlikely case that you experience HTTP/1.1-related problems with some server
+ out there.
+ </para>
+ <para>
+ Note that enabling this action is only a workaround. It should not
+ be enabled for sites that work without it. While it shouldn't break
+ any pages, it has an (usually negative) performance impact.
+ </para>
+ <para>
+ If you come across a site where enabling this action helps, please report it,
+ so the cause of the problem can be analyzed. If the problem turns out to be
+ caused by a bug in <application>Privoxy</application> it should be
+ fixed so the following release works without the work around.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Notes:</term>
<listitem>
- <para>
+ <para>
Many sites, like yahoo.com, don't just link to other sites. Instead, they
will link to some script on their own servers, giving the destination as a
parameter, which will then redirect you to the final target. URLs
<para>
This feature is currently not very smart and is scheduled for improvement.
If it is enabled by default, you will have to create some exceptions to
- this action. It can lead to failures in several ways:
+ this action. It can lead to failures in several ways:
</para>
<para>
Not every URLs with other URLs as parameters is evil.
<para>
<screen>
{ +fast-redirects{simple-check} }
- one.example.com
+ one.example.com
{ +fast-redirects{check-decoded-url} }
another.example.com/testing</screen>
<varlistentry>
<term>Typical use:</term>
<listitem>
- <para>Get rid of HTML and JavaScript annoyances, banner advertisements (by size),
+ <para>Get rid of HTML and JavaScript annoyances, banner advertisements (by size),
do fun text replacements, add personalized effects, etc.</para>
</listitem>
</varlistentry>
<para>Parameterized.</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Parameter:</term>
<listitem>
<para>
The name of a content filter, as defined in the <link linkend="filter-file">filter file</link>.
- Filters can be defined in one or more files as defined by the
+ Filters can be defined in one or more files as defined by the
<literal><link linkend="filterfile">filterfile</link></literal>
- option in the <link linkend="config">config file</link>.
- <filename>default.filter</filename> is the collection of filters
- supplied by the developers. Locally defined filters should go
+ option in the <link linkend="config">config file</link>.
+ <filename>default.filter</filename> is the collection of filters
+ supplied by the developers. Locally defined filters should go
in their own file, such as <filename>user.filter</filename>.
</para>
<para>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
<para>
- For your convenience, there are a number of pre-defined filters available
+ For your convenience, there are a number of pre-defined filters available
in the distribution filter file that you can use. See the examples below for
a list.
</para>
<para>
Filtering requires buffering the page content, which may appear to
slow down page rendering since nothing is displayed until all content has
- passed the filters. (It does not really take longer, but seems that way
- since the page is not incrementally displayed.) This effect will be more
- noticeable on slower connections.
+ passed the filters. (The total time until the page is completely rendered
+ doesn't change much, but it may be perceived as slower since the page is
+ not incrementally displayed.)
+ This effect will be more noticeable on slower connections.
</para>
<para>
<quote>Rolling your own</quote>
- filters requires a knowledge of
+ filters requires a knowledge of
<ulink url="http://en.wikipedia.org/wiki/Regular_expressions"><quote>Regular
- Expressions</quote></ulink> and
+ Expressions</quote></ulink> and
<ulink url="http://en.wikipedia.org/wiki/Html"><quote>HTML</quote></ulink>.
- This is very powerful feature, and potentially very intrusive.
+ This is very powerful feature, and potentially very intrusive.
Filters should be used with caution, and where an equivalent
<quote>action</quote> is not available.
</para>
<para>
- The amount of data that can be filtered is limited to the
+ The amount of data that can be filtered is limited to the
<literal><link linkend="buffer-limit">buffer-limit</link></literal>
- option in the main <link linkend="config">config file</link>. The
+ option in the main <link linkend="config">config file</link>. The
default is 4096 KB (4 Megs). Once this limit is exceeded, the buffered
- data, and all pending data, is passed through unfiltered.
+ data, and all pending data, is passed through unfiltered.
</para>
<para>
Inappropriate MIME types, such as zipped files, are not filtered at all.
by defining appropriate <literal>-filter</literal> exceptions.
</para>
<para>
- Compressed content can't be filtered either, unless &my-app;
- is compiled with zlib support (requires at least &my-app; 3.0.7),
- in which case &my-app; will decompress the content before filtering
- it.
+ Compressed content can't be filtered either, but if &my-app;
+ is compiled with zlib support and a supported compression algorithm
+ is used (gzip or deflate), &my-app; can first decompress the content
+ and then filter it.
</para>
<para>
If you use a &my-app; version without zlib support, but want filtering to work on
action in conjunction with <literal>filter</literal>.
</para>
<para>
- Content filtering can achieve some of the same effects as the
+ Content filtering can achieve some of the same effects as the
<literal><link linkend="block">block</link></literal>
- action, i.e. it can be used to block ads and banners. But the mechanism
- works quite differently. One effective use, is to block ad banners
- based on their size (see below), since many of these seem to be somewhat
+ action, i.e. it can be used to block ads and banners. But the mechanism
+ works quite differently. One effective use, is to block ad banners
+ based on their size (see below), since many of these seem to be somewhat
standardized.
</para>
<para>
<varlistentry>
<term>Example usage (with filters from the distribution <filename>default.filter</filename> file).
- See <link linkend="PREDEFINED-FILTERS">the Predefined Filters section</link> for
+ See <link linkend="PREDEFINED-FILTERS">the Predefined Filters section</link> for
more explanation on each:</term>
<listitem>
<para>
<anchor id="filter-js-annoyances">
- <screen>+filter{js-annoyances} # Get rid of particularly annoying JavaScript abuse</screen>
+ <screen>+filter{js-annoyances} # Get rid of particularly annoying JavaScript abuse.</screen>
</para>
<para>
<anchor id="filter-js-events">
- <screen>+filter{js-events} # Kill all JS event bindings (Radically destructive! Only for extra nasty sites)</screen>
+ <screen>+filter{js-events} # Kill all JS event bindings and timers (Radically destructive! Only for extra nasty sites).</screen>
</para>
<para>
<anchor id="filter-html-annoyances">
- <screen>+filter{html-annoyances} # Get rid of particularly annoying HTML abuse</screen>
+ <screen>+filter{html-annoyances} # Get rid of particularly annoying HTML abuse.</screen>
</para>
<para>
<anchor id="filter-content-cookies">
- <screen>+filter{content-cookies} # Kill cookies that come in the HTML or JS content</screen>
+ <screen>+filter{content-cookies} # Kill cookies that come in the HTML or JS content.</screen>
</para>
<para>
<anchor id="filter-refresh-tags">
- <screen>+filter{refresh-tags} # Kill automatic refresh tags (for dial-on-demand setups)</screen>
+ <screen>+filter{refresh-tags} # Kill automatic refresh tags (for dial-on-demand setups).</screen>
</para>
<para>
<anchor id="filter-unsolicited-popups">
</para>
<para>
<anchor id="filter-img-reorder">
- <screen>+filter{img-reorder} # Reorder attributes in <img> tags to make the banners-by-* filters more effective</screen>
+ <screen>+filter{img-reorder} # Reorder attributes in <img> tags to make the banners-by-* filters more effective.</screen>
</para>
<para>
<anchor id="filter-banners-by-size">
- <screen>+filter{banners-by-size} # Kill banners by size</screen>
+ <screen>+filter{banners-by-size} # Kill banners by size.</screen>
</para>
<para>
<anchor id="filter-banners-by-link">
- <screen>+filter{banners-by-link} # Kill banners by their links to known clicktrackers</screen>
+ <screen>+filter{banners-by-link} # Kill banners by their links to known clicktrackers.</screen>
</para>
<para>
<anchor id="filter-webbugs">
- <screen>+filter{webbugs} # Squish WebBugs (1x1 invisible GIFs used for user tracking)</screen>
+ <screen>+filter{webbugs} # Squish WebBugs (1x1 invisible GIFs used for user tracking).</screen>
</para>
<para>
<anchor id="filter-tiny-textforms">
- <screen>+filter{tiny-textforms} # Extend those tiny textareas up to 40x80 and kill the hard wrap</screen>
+ <screen>+filter{tiny-textforms} # Extend those tiny textareas up to 40x80 and kill the hard wrap.</screen>
</para>
<para>
<anchor id="filter-jumping-windows">
- <screen>+filter{jumping-windows} # Prevent windows from resizing and moving themselves</screen>
+ <screen>+filter{jumping-windows} # Prevent windows from resizing and moving themselves.</screen>
</para>
<para>
<anchor id="filter-frameset-borders">
- <screen>+filter{frameset-borders} # Give frames a border and make them resizeable</screen>
+ <screen>+filter{frameset-borders} # Give frames a border and make them resizable.</screen>
</para>
<para>
<anchor id="filter-demoronizer">
- <screen>+filter{demoronizer} # Fix MS's non-standard use of standard charsets</screen>
+ <screen>+filter{demoronizer} # Fix MS's non-standard use of standard charsets.</screen>
</para>
<para>
<anchor id="filter-shockwave-flash">
- <screen>+filter{shockwave-flash} # Kill embedded Shockwave Flash objects</screen>
+ <screen>+filter{shockwave-flash} # Kill embedded Shockwave Flash objects.</screen>
</para>
<para>
<anchor id="filter-quicktime-kioskmode">
- <screen>+filter{quicktime-kioskmode} # Make Quicktime movies savable</screen>
+ <screen>+filter{quicktime-kioskmode} # Make Quicktime movies saveable.</screen>
</para>
<para>
<anchor id="filter-fun">
</para>
<para>
<anchor id="filter-crude-parental">
- <screen>+filter{crude-parental} # Crude parental filtering (demo only)</screen>
+ <screen>+filter{crude-parental} # Crude parental filtering. Note that this filter doesn't work reliably.</screen>
</para>
<para>
<anchor id="filter-ie-exploits">
- <screen>+filter{ie-exploits} # Disable a known Internet Explorer bug exploits</screen>
+ <screen>+filter{ie-exploits} # Disable some known Internet Explorer bug exploits.</screen>
</para>
<para>
<anchor id="filter-site-specifics">
- <screen>+filter{site-specifics} # Custom filters for specific site related problems</screen>
+ <screen>+filter{site-specifics} # Cure for site-specific problems. Don't apply generally!</screen>
+ </para>
+ <para>
+ <anchor id="filter-no-ping">
+ <screen>+filter{no-ping} # Removes non-standard ping attributes in <a> and <area> tags.</screen>
</para>
<para>
<anchor id="filter-google">
- <screen>+filter{google} # Removes text ads and other Google specific improvements</screen>
+ <screen>+filter{google} # CSS-based block for Google text ads. Also removes a width limitation and the toolbar advertisement.</screen>
</para>
<para>
<anchor id="filter-yahoo">
- <screen>+filter{yahoo} # Removes text ads and other Yahoo specific improvements</screen>
+ <screen>+filter{yahoo} # CSS-based block for Yahoo text ads. Also removes a width limitation.</screen>
</para>
<para>
<anchor id="filter-msn">
- <screen>+filter{msn} # Removes text ads and other MSN specific improvements</screen>
+ <screen>+filter{msn} # CSS-based block for MSN text ads. Also removes tracking URLs and a width limitation.</screen>
</para>
<para>
<anchor id="filter-blogspot">
- <screen>+filter{blogspot} # Cleans up Blogspot blogs</screen>
- </para>
- <para>
- <anchor id="filter-no-ping">
- <screen>+filter{no-ping} # Removes non-standard ping attributes from anchor and area tags</screen>
+ <screen>+filter{blogspot} # Cleans up some Blogspot blogs. Read the fine print before using this.</screen>
</para>
</listitem>
</varlistentry>
<listitem>
<para>
Declares a document as text, even if the <quote>Content-Type:</quote> isn't detected as such.
- </para>
+ </para>
</listitem>
</varlistentry>
<literal>force-text-mode</literal> declares a document as text,
without looking at the <quote>Content-Type:</quote> first.
</para>
- <warning>
+ <warning>
<para>
Think twice before activating this action. Filtering binary data
with regular expressions can cause file damage.
</warning>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Example usage:</term>
<listitem>
<listitem>
<para>
Overrules the forward directives in the configuration file.
- </para>
+ </para>
</listitem>
</varlistentry>
file, but without the URL pattern. It can be used as replacement, but normally it's only
used in cases where matching based on the request URL isn't sufficient.
</para>
- <warning>
+ <warning>
<para>
Please read the description for the <link linkend="forwarding">forward</link> directives before
using this action. Forwarding to the wrong people will reduce your privacy and increase the
</warning>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Example usage:</term>
<listitem>
<listitem>
<para>
<screen># Block all documents on example.org that end with ".js",
-# but send an empty document instead of the usual HTML message.
+# but send an empty document instead of the usual HTML message.
{+block{Blocked JavaScript} +handle-as-empty-document}
example.org/.*\.js$
</screen>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
<para>
The below generic example section is actually part of <filename>default.action</filename>.
It marks all URLs with well-known image file name extensions as images and should
- be left intact.
+ be left intact.
</para>
<para>
Users will probably only want to use the handle-as-image action in conjunction with
<listitem>
<para>
Keyword: <quote>block</quote>, or any user defined value.
- </para>
+ </para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
to a rare language, you should consider that it helps to
make your requests unique and thus easier to trace.
If you don't plan to change this header frequently,
- you should stick to a common language.
+ you should stick to a common language.
</para>
</listitem>
</varlistentry>
<listitem>
<para>
Keyword: <quote>block</quote>, or any user defined value.
- </para>
+ </para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
<term>Effect:</term>
<listitem>
<para>
- Deletes the <quote>If-Modified-Since:</quote> HTTP client header or modifies its value.
+ Deletes the <quote>If-Modified-Since:</quote> HTTP client header or modifies its value.
</para>
</listitem>
</varlistentry>
<listitem>
<para>
Keyword: <quote>block</quote>, or a user defined value that specifies a range of hours.
- </para>
+ </para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
</sect3>
-<!-- ~~~~~ New section ~~~~~ -->
-<sect3 renderas="sect4" id="hide-forwarded-for-headers">
-<title>hide-forwarded-for-headers</title>
-<variablelist>
- <varlistentry>
- <term>Typical use:</term>
- <listitem>
- <para>Improve privacy by not forwarding the source of the request in the HTTP headers.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Effect:</term>
- <listitem>
- <para>
- Deletes any existing <quote>X-Forwarded-for:</quote> HTTP header from client requests.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Type:</term>
- <!-- Boolean, Parameterized, Multi-value -->
- <listitem>
- <para>Boolean.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Parameter:</term>
- <listitem>
- <para>
- N/A
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- It is safe and recommended to leave this on.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Example usage:</term>
- <listitem>
- <para>
- <screen>+hide-forwarded-for-headers</screen>
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect3>
-
-
<!-- ~~~~~ New section ~~~~~ -->
<sect3 renderas="sect4" id="hide-from-header">
<title>hide-from-header</title>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
<para>
- The keyword <quote>block</quote> will completely remove the header
+ The keyword <quote>block</quote> will completely remove the header
(not to be confused with the <literal><link linkend="block">block</link></literal>
action).
</para>
</itemizedlist>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
will work with referrer checks, as long as content and valid referring page
are on the same host. Most of the time that's the case.
</para>
- <para>
+ <para>
<literal>hide-referer</literal> is an alternate spelling of
<literal>hide-referrer</literal> and the two can be can be freely
substituted with each other. (<quote>referrer</quote> is the
correct English spelling, however the HTTP specification has a bug - it
- requires it to be spelled as <quote>referer</quote>.)
+ requires it to be spelled as <quote>referer</quote>.)
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
- <warning>
+ <warning>
<para>
This can lead to problems on web sites that depend on looking at this header in
order to customize their content for different browsers (which, by the
way, is <emphasis>NOT</emphasis> the right thing to do: good web sites
- work browser-independently).
+ work browser-independently).
</para>
</warning>
<para>
<emphasis>not recommended</emphasis>. In single-user, single-browser
setups, you might use it to delete your OS version information from
the headers, because it is an invitation to exploit known bugs for your
- OS. It is also occasionally useful to forge this in order to access
- sites that won't let you in otherwise (though there may be a good
- reason in some cases). Example of this: some MSN sites will not
- let <application>Mozilla</application> enter, yet forging to a
- <application>Netscape 6.1</application> user-agent works just fine.
- (Must be just a silly MS goof, I'm sure :-).
+ OS. It is also occasionally useful to forge this in order to access
+ sites that won't let you in otherwise (though there may be a good
+ reason in some cases).
</para>
<para>
- More information on known user-agent strings can be found at
+ More information on known user-agent strings can be found at
<ulink url="http://www.user-agents.org/">http://www.user-agents.org/</ulink>
- and
+ and
<ulink url="http://en.wikipedia.org/wiki/User_agent">http://en.wikipedia.org/wiki/User_agent</ulink>.
</para>
</listitem>
<!-- ~~~~~ New section ~~~~~ -->
-<sect3 renderas="sect4" id="inspect-jpegs">
-<title>inspect-jpegs</title>
-<variablelist>
- <varlistentry>
- <term>Typical use:</term>
- <listitem>
- <para>Try to protect against a MS buffer over-run in JPEG processing</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Effect:</term>
- <listitem>
- <para>
- Protect against a known exploit
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Type:</term>
- <!-- Boolean, Parameterized, Multi-value -->
- <listitem>
- <para>Boolean.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Parameter:</term>
- <listitem>
- <para>
- N/A
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- See Microsoft Security Bulletin MS04-028. JPEG images are one of the most
- common image types found across the Internet. The exploit as described can
- allow execution of code on the target system, giving an attacker access
- to the system in question by merely planting an altered JPEG image, which
- would have no obvious indications of what lurks inside. This action
- tries to prevent this exploit if delivered through unencrypted HTTP.
- </para>
- <para>
- Note that the exploit mentioned is several years old
- and it's unlikely that your client is still vulnerable
- against it. This action may be removed in one of the
- next releases.
- </para>
-
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Example usage:</term>
- <listitem>
- <para><screen>+inspect-jpegs</screen></para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect3>
-
-
-<!-- ~~~~~ New section ~~~~~ -->
-<sect3 renderas="sect4" id="kill-popups">
-<title>kill-popups<anchor id="kill-popup"></title>
+<sect3 renderas="sect4" id="limit-connect">
+<title>limit-connect</title>
<variablelist>
<varlistentry>
<term>Typical use:</term>
<listitem>
- <para>Eliminate those annoying pop-up windows (deprecated)</para>
+ <para>Prevent abuse of <application>Privoxy</application> as a TCP proxy relay or disable SSL for untrusted sites</para>
</listitem>
</varlistentry>
<term>Effect:</term>
<listitem>
<para>
- While loading the document, replace JavaScript code that opens
- pop-up windows with (syntactically neutral) dummy code on the fly.
+ Specifies to which ports HTTP CONNECT requests are allowable.
</para>
</listitem>
</varlistentry>
<term>Type:</term>
<!-- Boolean, Parameterized, Multi-value -->
<listitem>
- <para>Boolean.</para>
+ <para>Parameterized.</para>
</listitem>
</varlistentry>
<term>Parameter:</term>
<listitem>
<para>
- N/A
+ A comma-separated list of ports or port ranges (the latter using dashes, with the minimum
+ defaulting to 0 and the maximum to 65K).
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
<para>
- This action is basically a built-in, hardwired special-purpose filter
- action, but there are important differences: For <literal>kill-popups</literal>,
- the document need not be buffered, so it can be incrementally rendered while
- downloading. But <literal>kill-popups</literal> doesn't catch as many pop-ups as
- <literal><link
- linkend="FILTER-ALL-POPUPS">filter{<replaceable>all-popups</replaceable>}</link></literal>
- does and is not as smart as <literal><link
- linkend="FILTER-UNSOLICITED-POPUPS">filter{<replaceable>unsolicited-popups</replaceable>}</link>
- </literal>is.
- </para>
- <para>
- Think of it as a fast and efficient replacement for a filter that you
- can use if you don't want any filtering at all. Note that it doesn't make
- sense to combine it with any <literal><link linkend="filter">filter</link></literal> action,
- since as soon as one <literal><link linkend="filter">filter</link></literal> applies,
- the whole document needs to be buffered anyway, which destroys the advantage of
- the <literal>kill-popups</literal> action over its filter equivalent.
- </para>
- <para>
- Killing all pop-ups unconditionally is problematic. Many shops and banks rely on
- pop-ups to display forms, shopping carts etc, and the <literal><link
- linkend="FILTER-UNSOLICITED-POPUPS">filter{<replaceable>unsolicited-popups</replaceable>}</link>
- </literal> does a better job of catching only the unwanted ones.
- </para>
- <para>
- If the only kind of pop-ups that you want to kill are exit consoles (those
- <emphasis>really nasty</emphasis> windows that appear when you close an other
- one), you might want to use
- <literal><link
- linkend="filter">filter</link>{<replaceable>js-annoyances</replaceable>}</literal>
- instead.
- </para>
- <para>
- This action is most appropriate for browsers that don't have any controls
- for unwanted pop-ups. Not recommended for general usage.
+ By default, i.e. if no <literal>limit-connect</literal> action applies,
+ <application>Privoxy</application> allows HTTP CONNECT requests to all
+ ports. Use <literal>limit-connect</literal> if fine-grained control
+ is desired for some or all destinations.
</para>
<para>
- This action doesn't work very reliable and may be removed in future releases.
- </para>
+ The CONNECT methods exists in HTTP to allow access to secure websites
+ (<quote>https://</quote> URLs) through proxies. It works very simply:
+ the proxy connects to the server on the specified port, and then
+ short-circuits its connections to the client and to the remote server.
+ This means CONNECT-enabled proxies can be used as TCP relays very easily.
+ </para>
+ <para>
+ <application>Privoxy</application> relays HTTPS traffic without seeing
+ the decoded content. Websites can leverage this limitation to circumvent &my-app;'s
+ filters. By specifying an invalid port range you can disable HTTPS entirely.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
- <term>Example usage:</term>
+ <term>Example usages:</term>
<listitem>
- <para><screen>+kill-popups</screen></para>
+ <!-- I had trouble getting the spacing to look right in my browser -->
+ <!-- I probably have the wrong font setup, bollocks. -->
+ <!-- Apparently the emphasis tag uses a proportional font no matter what -->
+ <para>
+ <screen>+limit-connect{443} # Port 443 is OK.
++limit-connect{80,443} # Ports 80 and 443 are OK.
++limit-connect{-3, 7, 20-100, 500-} # Ports less than 3, 7, 20 to 100 and above 500 are OK.
++limit-connect{-} # All ports are OK
++limit-connect{,} # No HTTPS/SSL traffic is allowed</screen>
+ </para>
</listitem>
</varlistentry>
</variablelist>
<!-- ~~~~~ New section ~~~~~ -->
-<sect3 renderas="sect4" id="limit-connect">
-<title>limit-connect</title>
+<sect3 renderas="sect4" id="limit-cookie-lifetime">
+<title>limit-cookie-lifetime</title>
<variablelist>
<varlistentry>
<term>Typical use:</term>
<listitem>
- <para>Prevent abuse of <application>Privoxy</application> as a TCP proxy relay or disable SSL for untrusted sites</para>
+ <para>Limit the lifetime of HTTP cookies to a couple of minutes or hours.</para>
</listitem>
</varlistentry>
<term>Effect:</term>
<listitem>
<para>
- Specifies to which ports HTTP CONNECT requests are allowable.
+ Overwrites the expires field in Set-Cookie server headers if it's above the specified limit.
</para>
</listitem>
</varlistentry>
<term>Parameter:</term>
<listitem>
<para>
- A comma-separated list of ports or port ranges (the latter using dashes, with the minimum
- defaulting to 0 and the maximum to 65K).
+ The lifetime limit in minutes, or 0.
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
<para>
- By default, i.e. if no <literal>limit-connect</literal> action applies,
- <application>Privoxy</application> only allows HTTP CONNECT
- requests to port 443 (the standard, secure HTTPS port). Use
- <literal>limit-connect</literal> if more fine-grained control is desired
- for some or all destinations.
+ This action reduces the lifetime of HTTP cookies coming from the
+ server to the specified number of minutes, starting from the time
+ the cookie passes Privoxy.
</para>
<para>
- The CONNECT methods exists in HTTP to allow access to secure websites
- (<quote>https://</quote> URLs) through proxies. It works very simply:
- the proxy connects to the server on the specified port, and then
- short-circuits its connections to the client and to the remote server.
- This means CONNECT-enabled proxies can be used as TCP relays very easily.
- </para>
- <para>
- <application>Privoxy</application> relays HTTPS traffic without seeing
- the decoded content. Websites can leverage this limitation to circumvent &my-app;'s
- filters. By specifying an invalid port range you can disable HTTPS entirely.
- If you plan to disable SSL by default, consider enabling
- <literal><link linkend="treat-forbidden-connects-like-blocks ">treat-forbidden-connects-like-blocks</link></literal>
- as well, to be able to quickly create exceptions.
- </para>
+ Cookies with a lifetime below the limit are not modified.
+ The lifetime of session cookies is set to the specified limit.
+ </para>
+ <para>
+ The effect of this action depends on the server.
+ </para>
+ <para>
+ In case of servers which refresh their cookies with each response
+ (or at least frequently), the lifetime limit set by this action
+ is updated as well.
+ Thus, a session associated with the cookie continues to work with
+ this action enabled, as long as a new request is made before the
+ last limit set is reached.
+ </para>
+ <para>
+ However, some servers send their cookies once, with a lifetime of several
+ years (the year 2037 is a popular choice), and do not refresh them
+ until a certain event in the future, for example the user logging out.
+ In this case this action may limit the absolute lifetime of the session,
+ even if requests are made frequently.
+ </para>
+ <para>
+ If the parameter is <quote>0</quote>, this action behaves like
+ <literal><link linkend="session-cookies-only">session-cookies-only</link></literal>.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<term>Example usages:</term>
<listitem>
- <!-- I had trouble getting the spacing to look right in my browser -->
- <!-- I probably have the wrong font setup, bollocks. -->
- <!-- Apparently the emphasis tag uses a proportional font no matter what -->
<para>
- <screen>+limit-connect{443} # This is the default and need not be specified.
-+limit-connect{80,443} # Ports 80 and 443 are OK.
-+limit-connect{-3, 7, 20-100, 500-} # Ports less than 3, 7, 20 to 100 and above 500 are OK.
-+limit-connect{-} # All ports are OK
-+limit-connect{,} # No HTTPS/SSL traffic is allowed</screen>
+ <screen>+limit-cookie-lifetime{60}
+ </screen>
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
<para>
More and more websites send their content compressed by default, which
is generally a good idea and saves bandwidth. But the <literal><link
- linkend="filter">filter</link></literal>, <literal><link linkend="deanimate-gifs">deanimate-gifs</link></literal>
- and <literal><link linkend="kill-popups">kill-popups</link></literal> actions need
- access to the uncompressed data.
+ linkend="filter">filter</link></literal> and
+ <literal><link linkend="deanimate-gifs">deanimate-gifs</link></literal>
+ actions need access to the uncompressed data.
</para>
<para>
When compiled with zlib support (available since &my-app; 3.0.7), content that should be
<para>
Most text-based instances compress very well, the size is seldom decreased by less than 50%,
for markup-heavy instances like news feeds saving more than 90% of the original size isn't
- unusual.
+ unusual.
</para>
<para>
Not using compression will therefore slow down the transfer, and you should only
<term>Effect:</term>
<listitem>
<para>
- Deletes the <quote>Last-Modified:</quote> HTTP server header or modifies its value.
+ Deletes the <quote>Last-Modified:</quote> HTTP server header or modifies its value.
</para>
</listitem>
</varlistentry>
<para>
One of the keywords: <quote>block</quote>, <quote>reset-to-request-time</quote>
and <quote>randomize</quote>
- </para>
+ </para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
between the original value and the current time. In theory the server
could send each document with a different <quote>Last-Modified:</quote>
header to track visits without using cookies. <quote>Randomize</quote>
- makes it impossible and the browser can still revalidate cached documents.
+ makes it impossible and the browser can still revalidate cached documents.
</para>
<para>
<quote>reset-to-request-time</quote> overwrites the value of the
<quote>Last-Modified:</quote> header with the current time. You could use
this option together with
- <literal><link linkend="hide-if-modified-since">hided-if-modified-since</link></literal>
+ <literal><link linkend="hide-if-modified-since">hide-if-modified-since</link></literal>
to further customize your random range.
</para>
<para>
of the request, the random range becomes zero and the value stays the same.
Therefore you should later randomize it a second time with
<literal><link linkend="hide-if-modified-since">hided-if-modified-since</link></literal>,
- just to be sure.
+ just to be sure.
</para>
<para>
It is also recommended to use this action together with
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
either provided as parameter, or derived by applying a
single pcrs command to the original URL.
</para>
+ <para>
+ The syntax for pcrs commands is documented in the
+ <link linkend="filter-file">filter file</link> section.
+ </para>
<para>
This action will be ignored if you use it together with
<literal><link linkend="block">block</link></literal>.
and be aware that using your own redirects might make it
possible to fingerprint your requests.
</para>
+ <para>
+ In case of problems with your redirects, or simply to watch
+ them working, enable <link linkend="DEBUG">debug 128</link>.
+ </para>
</listitem>
</varlistentry>
# (Note the $ at the end of the URL pattern to make sure
# the request for the rewritten URL isn't redirected as well)
{+redirect{s@$@&mode=expanded@}}
-undeadly.org/cgi\?action=article&sid=\d*$</screen>
- </para>
- </listitem>
- </varlistentry>
-
-</variablelist>
-</sect3>
-
-
-<!-- ~~~~~ New section ~~~~~ -->
-<sect3 renderas="sect4" id="send-vanilla-wafer">
-<title>send-vanilla-wafer</title>
-
-<variablelist>
- <varlistentry>
- <term>Typical use:</term>
- <listitem>
- <para>
- Feed log analysis scripts with useless data.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Effect:</term>
- <listitem>
- <para>
- Sends a cookie with each request stating that you do not accept any copyright
- on cookies sent to you, and asking the site operator not to track you.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Type:</term>
- <!-- Boolean, Parameterized, Multi-value -->
- <listitem>
- <para>Boolean.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Parameter:</term>
- <listitem>
- <para>
- N/A
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- The vanilla wafer is a (relatively) unique header and could conceivably be used to track you.
- </para>
- <para>
- This action is rarely used and not enabled in the default configuration.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Example usage:</term>
- <listitem>
- <para>
- <screen>+send-vanilla-wafer</screen>
- </para>
- </listitem>
- </varlistentry>
-
-</variablelist>
-</sect3>
-
+undeadly.org/cgi\?action=article&sid=\d*$
-<!-- ~~~~~ New section ~~~~~ -->
-<sect3 renderas="sect4" id="send-wafer">
-<title>send-wafer</title>
+# Redirect Google search requests to MSN
+{+redirect{s@^http://[^/]*/search\?q=([^&]*).*@http://search.msn.com/results.aspx?q=$1@}}
+.google.com/search
-<variablelist>
- <varlistentry>
- <term>Typical use:</term>
- <listitem>
- <para>
- Send custom cookies or feed log analysis scripts with even more useless data.
- </para>
- </listitem>
- </varlistentry>
+# Redirect MSN search requests to Yahoo
+{+redirect{s@^http://[^/]*/results\.aspx\?q=([^&]*).*@http://search.yahoo.com/search?p=$1@}}
+search.msn.com//results\.aspx\?q=
- <varlistentry>
- <term>Effect:</term>
- <listitem>
- <para>
- Sends a custom, user-defined cookie with each request.
+# Redirect remote requests for this manual
+# to the local version delivered by Privoxy
+{+redirect{s@^http://www@http://config@}}
+www.privoxy.org/user-manual/</screen>
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term>Type:</term>
- <!-- Boolean, Parameterized, Multi-value -->
- <listitem>
- <para>Multi-value.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Parameter:</term>
- <listitem>
- <para>
- A string of the form <quote><replaceable class="option">name</replaceable>=<replaceable
- class="parameter">value</replaceable></quote>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- Being multi-valued, multiple instances of this action can apply to the same request,
- resulting in multiple cookies being sent.
- </para>
- <para>
- This action is rarely used and not enabled in the default configuration.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Example usage (section):</term>
- <listitem>
- <para>
- <screen>{+send-wafer{UsingPrivoxy=true}}
-my-internal-testing-server.void</screen>
- </para>
- </listitem>
- </varlistentry>
</variablelist>
</sect3>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
<listitem>
<para>
Allow only temporary <quote>session</quote> cookies (for the current
- browser session <emphasis>only</emphasis>).
+ browser session <emphasis>only</emphasis>).
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>Notes:</term>
<listitem>
<para>
- This is less strict than <literal><link linkend="crunch-incoming-cookies">crunch-incoming-cookies</link></literal> /
+ This is less strict than <literal><link linkend="crunch-incoming-cookies">crunch-incoming-cookies</link></literal> /
<literal><link linkend="crunch-outgoing-cookies">crunch-outgoing-cookies</link></literal> and allows you to browse
websites that insist or rely on setting cookies, without compromising your privacy too badly.
</para>
Most browsers will not permanently store cookies that have been processed by
<literal>session-cookies-only</literal> and will forget about them between sessions.
This makes profiling cookies useless, but won't break sites which require cookies so
- that you can log in for transactions. This is generally turned on for all
+ that you can log in for transactions. This is generally turned on for all
sites, and is the recommended setting.
</para>
<para>
These would have to be removed manually.
</para>
<para>
- <application>Privoxy</application> also uses
- the <link linkend="filter-content-cookies">content-cookies filter</link>
- to block some types of cookies. Content cookies are not effected by
+ <application>Privoxy</application> also uses
+ the <link linkend="filter-content-cookies">content-cookies filter</link>
+ to block some types of cookies. Content cookies are not effected by
<literal>session-cookies-only</literal>.
</para>
</listitem>
<para>
<quote><replaceable class="parameter">target-url</replaceable></quote> to
send a redirect to <replaceable class="parameter">target-url</replaceable>. You can redirect
- to any image anywhere, even in your local filesystem via <quote>file:///</quote> URL.
+ to any image anywhere, even in your local filesystem via <quote>file:///</quote> URL.
(But note that not all browsers support redirecting to a local file system).
</para>
<para>
URLs, which send the built-in images, as <replaceable class="parameter">target-url</replaceable>.
This has the same visual effect as specifying <quote>blank</quote> or <quote>pattern</quote> in
the first place, but enables your browser to cache the replacement image, instead of requesting
- it over and over again.
- </para>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- The URLs for the built-in images are <quote>http://config.privoxy.org/send-banner?type=<replaceable
- class="parameter">type</replaceable></quote>, where <replaceable class="parameter">type</replaceable> is
- either <quote>blank</quote> or <quote>pattern</quote>.
- </para>
- <para>
- There is a third (advanced) type, called <quote>auto</quote>. It is <emphasis>NOT</emphasis> to be
- used in <literal>set-image-blocker</literal>, but meant for use from <link linkend="filter-file">filters</link>.
- Auto will select the type of image that would have applied to the referring page, had it been an image.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Example usage:</term>
- <listitem>
- <para>
- Built-in pattern:
- </para>
- <para>
- <screen>+set-image-blocker{pattern}</screen>
- </para>
- <para>
- Redirect to the BSD daemon:
- </para>
- <para>
- <screen>+set-image-blocker{http://www.freebsd.org/gifs/dae_up3.gif}</screen>
- </para>
- <para>
- Redirect to the built-in pattern for better caching:
- </para>
- <para>
- <screen>+set-image-blocker{http://config.privoxy.org/send-banner?type=pattern}</screen>
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect3>
-
-
-<!-- ~~~~~ New section ~~~~~ -->
-<sect3 renderas="sect4" id="treat-forbidden-connects-like-blocks">
-<title>treat-forbidden-connects-like-blocks</title>
-<!--
-new action
--->
-<variablelist>
- <varlistentry>
- <term>Typical use:</term>
- <listitem>
- <para>Block forbidden connects with an easy to find error message.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Effect:</term>
- <listitem>
- <para>
- If this action is enabled, <application>Privoxy</application> no longer
- makes a difference between forbidden connects and ordinary blocks.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Type:</term>
- <!-- Boolean, Parameterized, Multi-value -->
- <listitem>
- <para>Boolean</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Parameter:</term>
- <listitem>
- <para>N/A</para>
+ it over and over again.
+ </para>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
<term>Notes:</term>
<listitem>
<para>
- By default <application>Privoxy</application> answers
- <link linkend="limit-connect">forbidden <quote>Connect</quote> requests</link>
- with a short error message inside the headers. If the browser doesn't display
- headers (most don't), you just see an empty page.
- </para>
- <para>
- With this action enabled, <application>Privoxy</application> displays
- the message that is used for ordinary blocks instead. If you decide
- to make an exception for the page in question, you can do so by
- following the <quote>See why</quote> link.
+ The URLs for the built-in images are <quote>http://config.privoxy.org/send-banner?type=<replaceable
+ class="parameter">type</replaceable></quote>, where <replaceable class="parameter">type</replaceable> is
+ either <quote>blank</quote> or <quote>pattern</quote>.
</para>
<para>
- For <quote>Connect</quote> requests the clients tell
- <application>Privoxy</application> which host they are interested
- in, but not which document they plan to get later. As a result, the
- <quote>Go there anyway</quote> wouldn't work and is therefore suppressed.
+ There is a third (advanced) type, called <quote>auto</quote>. It is <emphasis>NOT</emphasis> to be
+ used in <literal>set-image-blocker</literal>, but meant for use from <link linkend="filter-file">filters</link>.
+ Auto will select the type of image that would have applied to the referring page, had it been an image.
</para>
</listitem>
</varlistentry>
<term>Example usage:</term>
<listitem>
<para>
- <screen>+treat-forbidden-connects-like-blocks</screen>
+ Built-in pattern:
+ </para>
+ <para>
+ <screen>+set-image-blocker{pattern}</screen>
+ </para>
+ <para>
+ Redirect to the BSD daemon:
+ </para>
+ <para>
+ <screen>+set-image-blocker{http://www.freebsd.org/gifs/dae_up3.gif}</screen>
+ </para>
+ <para>
+ Redirect to the built-in pattern for better caching:
+ </para>
+ <para>
+ <screen>+set-image-blocker{http://config.privoxy.org/send-banner?type=pattern}</screen>
</para>
</listitem>
</varlistentry>
<title>Summary</title>
<para>
Note that many of these actions have the potential to cause a page to
- misbehave, possibly even not to display at all. There are many ways
- a site designer may choose to design his site, and what HTTP header
+ misbehave, possibly even not to display at all. There are many ways
+ a site designer may choose to design his site, and what HTTP header
content, and other criteria, 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
These can in turn be invoked just like the built-in actions.
Currently, an alias name can contain any character except space, tab,
<quote>=</quote>,
- <quote>{</quote> and <quote>}</quote>, but we <emphasis>strongly
+ <quote>{</quote> and <quote>}</quote>, but we <emphasis>strongly
recommend</emphasis> that you only use <quote>a</quote> to <quote>z</quote>,
<quote>0</quote> to <quote>9</quote>, <quote>+</quote>, and <quote>-</quote>.
Alias names are not case sensitive, and are not required to start with a
# These aliases define combinations of actions
# that are useful for certain types of sites:
#
- fragile = -<link linkend="BLOCK">block</link> -<link linkend="FILTER">filter</link> -crunch-all-cookies -<link linkend="FAST-REDIRECTS">fast-redirects</link> -<link linkend="HIDE-REFERER">hide-referrer</link> -<link linkend="KILL-POPUPS">kill-popups</link> -<link linkend="PREVENT-COMPRESSION">prevent-compression</link>
+ fragile = -<link linkend="BLOCK">block</link> -<link linkend="FILTER">filter</link> -crunch-all-cookies -<link linkend="FAST-REDIRECTS">fast-redirects</link> -<link linkend="HIDE-REFERER">hide-referrer</link> -<link linkend="PREVENT-COMPRESSION">prevent-compression</link>
- shop = -crunch-all-cookies -<link linkend="FILTER-ALL-POPUPS">filter{all-popups}</link> -<link linkend="KILL-POPUPS">kill-popups</link>
+ shop = -crunch-all-cookies -<link linkend="FILTER-ALL-POPUPS">filter{all-popups}</link>
# Short names for other aliases, for really lazy people ;-)
#
</para>
<para>
- ...and put them to use. These sections would appear in the lower part of an
+ ...and put them to use. These sections would appear in the lower part of an
actions file and define exceptions to the default actions (as specified further
up for the <quote>/</quote> pattern):
</para>
# Shopping sites:
# Allow cookies (for setting and retrieving your customer data)
- #
+ #
{shop}
.quietpc.com
.worldpay.com # for quietpc.com
# These shops require pop-ups:
#
- {-kill-popups -filter{all-popups} -filter{unsolicited-popups}}
+ {-filter{all-popups} -filter{unsolicited-popups}}
.dabs.com
.overclockers.co.uk</screen>
</para>
<para>
- Aliases like <quote>shop</quote> and <quote>fragile</quote> are typically used for
- <quote>problem</quote> sites that require more than one action to be disabled
+ Aliases like <quote>shop</quote> and <quote>fragile</quote> are typically used for
+ <quote>problem</quote> sites that require more than one action to be disabled
in order to function properly.
</para>
</sect2>
linkend="actions">specified</link> and <link linkend="actions-apply">applied
to URLs</link>, how <link linkend="af-patterns">patterns</link> work, and how to
define and use <link linkend="aliases">aliases</link>. Now, let's look at an
- example <filename>default.action</filename> and <filename>user.action</filename>
- file and see how all these pieces come together:
+ example <filename>match-all.action</filename>, <filename>default.action</filename>
+ and <filename>user.action</filename> file and see how all these pieces come together:
+</para>
+
+<sect3>
+<title>match-all.action</title>
+<para>
+ Remember <emphasis>all actions are disabled when matching starts</emphasis>,
+ so we have to explicitly enable the ones we want.
+</para>
+
+<para>
+ While the <filename>match-all.action</filename> file only contains a
+ single section, it is probably the most important one. It has only one
+ pattern, <quote><literal>/</literal></quote>, but this pattern
+ <link linkend="af-patterns">matches all URLs</link>. Therefore, the set of
+ actions used in this <quote>default</quote> section <emphasis>will
+ be applied to all requests as a start</emphasis>. It can be partly or
+ wholly overridden by other actions files like <filename>default.action</filename>
+ and <filename>user.action</filename>, but it will still be largely responsible
+ for your overall browsing experience.
+</para>
+
+<para>
+ Again, at the start of matching, all actions are disabled, so there is
+ no need to disable any actions here. (Remember: a <quote>+</quote>
+ preceding the action name enables the action, a <quote>-</quote> disables!).
+ Also note how this long line has been made more readable by splitting it into
+ multiple lines with line continuation.
+</para>
+
+<para>
+ <screen>
+{ \
+ +<link linkend="CHANGE-X-FORWARDED-FOR">change-x-forwarded-for{block}</link> \
+ +<link linkend="HIDE-FROM-HEADER">hide-from-header{block}</link> \
+ +<link linkend="SET-IMAGE-BLOCKER">set-image-blocker{pattern}</link> \
+}
+/ # Match all URLs
+ </screen>
+</para>
+
+<para>
+ The default behavior is now set.
</para>
+</sect3>
-<sect3><title>default.action</title>
+<sect3>
+<title>default.action</title>
<para>
-Every config file should start with a short comment stating its purpose:
+ If you aren't a developer, there's no need for you to edit the
+ <filename>default.action</filename> file. It is maintained by
+ the &my-app; developers and if you disagree with some of the
+ sections, you should overrule them in your <filename>user.action</filename>.
</para>
<para>
- <screen># Sample default.action file <ijbswa-developers@lists.sourceforge.net></screen>
+ Understanding the <filename>default.action</filename> file can
+ help you with your <filename>user.action</filename>, though.
</para>
<para>
-Then, since this is the <filename>default.action</filename> file, the
-first section is a special section for internal use that you needn't
-change or worry about:
+ The first section in this file is a special section for internal use
+ that prevents older &my-app; versions from reading the file:
</para>
<para>
##########################################################################
# Settings -- Don't change! For internal Privoxy use ONLY.
##########################################################################
-
{{settings}}
-for-privoxy-version=3.0</screen>
+for-privoxy-version=3.0.11</screen>
</para>
<para>
-After that comes the (optional) alias section. We'll use the example
-section from the above <link linkend="aliases">chapter on aliases</link>,
-that also explains why and how aliases are used:
+ After that comes the (optional) alias section. We'll use the example
+ section from the above <link linkend="aliases">chapter on aliases</link>,
+ that also explains why and how aliases are used:
</para>
<para>
# These aliases define combinations of actions
# that are useful for certain types of sites:
#
- fragile = -<link linkend="BLOCK">block</link> -<link linkend="FILTER">filter</link> -crunch-all-cookies -<link linkend="FAST-REDIRECTS">fast-redirects</link> -<link linkend="HIDE-REFERER">hide-referrer</link> -<link linkend="KILL-POPUPS">kill-popups</link>
- shop = -crunch-all-cookies -<link linkend="FILTER-ALL-POPUPS">filter{all-popups}</link> -<link linkend="KILL-POPUPS">kill-popups</link></screen>
-</para>
-
-<para>
- Now come the regular sections, i.e. sets of actions, accompanied
- by URL patterns to which they apply. Remember <emphasis>all actions
- are disabled when matching starts</emphasis>, so we have to explicitly
- enable the ones we want.
-</para>
-
-<para>
- The first regular section is probably the most important. It has only
- one pattern, <quote><literal>/</literal></quote>, but this pattern
- <link linkend="af-patterns">matches all URLs</link>. Therefore, the
- set of actions used in this <quote>default</quote> section <emphasis>will
- be applied to all requests as a start</emphasis>. It can be partly or
- wholly overridden by later matches further down this file, or in user.action,
- but it will still be largely responsible for your overall browsing
- experience.
-</para>
-
-<para>
- Again, at the start of matching, all actions are disabled, so there is
- no need to disable any actions here. (Remember: a <quote>+</quote>
- preceding the action name enables the action, a <quote>-</quote> disables!).
- Also note how this long line has been made more readable by splitting it into
- multiple lines with line continuation.
-</para>
-
-<para>
- <screen>
-##########################################################################
-# "Defaults" section:
-##########################################################################
- { \
- +<link linkend="DEANIMATE-GIFS">deanimate-gifs</link> \
- +<link linkend="FILTER-HTML-ANNOYANCES">filter{html-annoyances}</link> \
- +<link linkend="FILTER-REFRESH-TAGS">filter{refresh-tags}</link> \
- +<link linkend="FILTER-WEBBUGS">filter{webbugs}</link> \
- +<link linkend="FILTER-IE-EXPLOITS">filter{ie-exploits}</link> \
- +<link linkend="HIDE-FORWARDED-FOR-HEADERS">hide-forwarded-for-headers</link> \
- +<link linkend="HIDE-FROM-HEADER">hide-from-header{block}</link> \
- +<link linkend="HIDE-REFERER">hide-referrer{forge}</link> \
- +<link linkend="PREVENT-COMPRESSION">prevent-compression</link> \
- +<link linkend="SESSION-COOKIES-ONLY">session-cookies-only</link> \
- +<link linkend="SET-IMAGE-BLOCKER">set-image-blocker{pattern}</link> \
- }
- / # forward slash will match *all* potential URL patterns.</screen>
-</para>
-
-<para>
- The default behavior is now set.
- <!--
- This needs rewording, but it can wait for now.
- fk 2007-11-17
-
- Note that some actions, like not hiding
- the user agent, are part of a <quote>general policy</quote> that applies
- universally and won't get any exceptions defined later. Other choices,
- like not blocking (which is <emphasis>understandably</emphasis> the
- default!) need exceptions, i.e. we need to specify explicitly what we
- want to block in later sections.
- -->
+ fragile = -<link linkend="BLOCK">block</link> -<link linkend="FILTER">filter</link> -crunch-all-cookies -<link linkend="FAST-REDIRECTS">fast-redirects</link> -<link linkend="HIDE-REFERER">hide-referrer</link>
+ shop = -crunch-all-cookies -<link linkend="FILTER-ALL-POPUPS">filter{all-popups}</link></screen>
</para>
<para>
require cookies to log in, and pop-up windows for shopping
carts or item details. Again, we'll use a pre-defined alias:
</para>
-
+
<para>
<screen>
# Shopping sites:
#
{ shop }
-.quietpc.com
+.quietpc.com
.worldpay.com # for quietpc.com
.jungle.com
.scan.co.uk</screen>
</para>
-<!-- No longer needed BEGIN OF COMMENTED OUT BLOCK
-
-<para>
- Then, there are sites which rely on pop-up windows (yuck!) to work.
- Since we made pop-up-killing our default above, we need to make exceptions
- now. <ulink url="http://www.mozilla.org/">Mozilla</ulink> users, who
- can turn on smart handling of unwanted pop-ups in their browsers, can
- safely choose
- -<literal><link linkend="FILTER-ALL-POPUPS">filter{popups}</link></literal> (and
- -<literal><link linkend="KILL-POPUPS">kill-popups</link></literal>) above
- and hence don't need this section. Anyway, disabling an already disabled
- action doesn't hurt, so we'll define our exceptions regardless of what was
- chosen in the defaults section:
-</para>
-
-<para>
- <screen>
-# These sites require pop-ups too :(
-#
-{ -<link linkend="KILL-POPUPS">kill-popups</link> -<link linkend="FILTER-ALL-POPUPS">filter{popups}</link> }
-.dabs.com
-.overclockers.co.uk
-.deutsche-bank-24.de</screen>
-</para>
-
- END OF COMMENTED OUT BLOCK -->
-
<para>
The <literal><link linkend="FAST-REDIRECTS">fast-redirects</link></literal>
- action, which we enabled per default above, breaks some sites. So disable
- it for popular sites where we know it misbehaves:
+ action, which may have been enabled in <filename>match-all.action</filename>,
+ breaks some sites. So disable it for popular sites where we know it misbehaves:
</para>
<para>
be blocked, a substitute image can be sent, rather than an HTML page.
Contacting the remote site to find out is not an option, since it
would destroy the loading time advantage of banner blocking, and it
- would feed the advertisers (in terms of money <emphasis>and</emphasis>
- information). We can mark any URL as an image with the <literal><link
+ would feed the advertisers information about you. We can mark any
+ URL as an image with the <literal><link
linkend="handle-as-image">handle-as-image</link></literal> action,
and marking all URLs that end in a known image file extension is a
good start:
# Known ad generators:
#
{ +block-as-image }
-ar.atwola.com
+ar.atwola.com
.ad.doubleclick.net
.ad.*.doubleclick.net
.a.yimg.com/(?:(?!/i/).)*$
{ <link linkend="BLOCK">+block{Banner ads.}</link> }
# Generic patterns:
-#
+#
ad*.
.*ads.
banner?.
</para>
<para>
But being very generic, they necessarily also catch URLs that we don't want
- to block. The pattern <literal>.*ads.</literal> e.g. catches
+ to block. The pattern <literal>.*ads.</literal> e.g. catches
<quote>nasty-<emphasis>ads</emphasis>.nasty-corp.com</quote> as intended,
but also <quote>downlo<emphasis>ads</emphasis>.sourcefroge.net</quote> or
<quote><emphasis>ads</emphasis>l.some-provider.net.</quote> So here come some
##########################################################################
# By domain:
-#
+#
{ -<link linkend="BLOCK">block</link> }
adv[io]*. # (for advogato.org and advice.*)
adsl. # (has nothing to do with ads)
<para>
So far we are painting with a broad brush by setting general policies,
- which would be a reasonable starting point for many people. Now,
+ which would be a reasonable starting point for many people. Now,
you might want to be more specific and have customized rules that
are more suitable to your personal habits and preferences. These would
be for narrowly defined situations like your ISP or your bank, and should
- be placed in <filename>user.action</filename>, which is parsed after all other
+ be placed in <filename>user.action</filename>, which is parsed after all other
actions files and hence has the last word, over-riding any previously
- defined actions. <filename>user.action</filename> is also a
+ defined actions. <filename>user.action</filename> is also a
<emphasis>safe</emphasis> place for your personal settings, since
<filename>default.action</filename> is actively maintained by the
<application>Privoxy</application> developers and you'll probably want
<para>
So let's look at a few examples of things that one might typically do in
- <filename>user.action</filename>:
+ <filename>user.action</filename>:
</para>
# (Re-)define aliases for this file:
#
{{alias}}
-#
-# These aliases just save typing later, and the alias names should
+#
+# These aliases just save typing later, and the alias names should
# be self explanatory.
#
+crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
-crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
allow-all-cookies = -crunch-all-cookies -session-cookies-only
- allow-popups = -filter{all-popups} -kill-popups
+ allow-popups = -filter{all-popups}
+block-as-image = +block{Blocked as image.} +handle-as-image
-block-as-image = -block
# These aliases define combinations of actions that are useful for
# certain types of sites:
#
-fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referrer -kill-popups
+fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referrer
shop = -crunch-all-cookies allow-popups
# Allow ads for selected useful free sites:
you don't want to have to log in manually each time. So you'd like
to allow persistent cookies for these sites. The
<literal>allow-all-cookies</literal> alias defined above does exactly
- that, i.e. it disables crunching of cookies in any direction, and the
+ that, i.e. it disables crunching of cookies in any direction, and the
processing of cookies to make them only temporary.
</para>
Example of a simple <link linkend="BLOCK">block</link> action. Say you've
seen an ad on your favourite page on example.com that you want to get rid of.
You have right-clicked the image, selected <quote>copy image location</quote>
- and pasted the URL below while removing the leading http://, into a
+ and pasted the URL below while removing the leading http://, into a
<literal>{ +block{} }</literal> section. Note that <literal>{ +handle-as-image
}</literal> need not be specified, since all URLs ending in
<literal>.gif</literal> will be tagged as images by the general rules as set
The URLs of dynamically generated banners, especially from large banner
farms, often don't use the well-known image file name extensions, which
makes it impossible for <application>Privoxy</application> to guess
- the file type just by looking at the URL.
+ the file type just by looking at the URL.
You can use the <literal>+block-as-image</literal> alias defined above for
these cases.
Note that objects which match this rule but then turn out NOT to be an
-- <emphasis>whoa!</emphasis> -- it worked. The <literal>fragile</literal>
aliases disables those actions that are most likely to break a site. Also,
good for testing purposes to see if it is <application>Privoxy</application>
- that is causing the problem or not. We later find other regular sites
+ that is causing the problem or not. We later find other regular sites
that misbehave, and add those to our personalized list of troublemakers:
</para>
{ allow-ads }
.sourceforge.net
.slashdot.org
- .osdn.net</screen>
+ .osdn.net</screen>
</para>
<para>
- Note that <literal>allow-ads</literal> has been aliased to
- <literal>-<link linkend="block">block</link></literal>,
- <literal>-<link linkend="filter-banners-by-size">filter{banners-by-size}</link></literal>, and
+ Note that <literal>allow-ads</literal> has been aliased to
+ <literal>-<link linkend="block">block</link></literal>,
+ <literal>-<link linkend="filter-banners-by-size">filter{banners-by-size}</link></literal>, and
<literal>-<link linkend="filter-banners-by-link">filter{banners-by-link}</link></literal> above.
</para>
<para>
Invoke another alias here to force an over-ride of the MIME type <literal>
- application/x-sh</literal> which typically would open a download type
+ application/x-sh</literal> which typically would open a download type
dialog. In my case, I want to look at the shell script, and then I can save
it should I choose to.
</para>
<para>
<screen>
{ handle-as-text }
- /.*\.sh$</screen>
+ /.*\.sh$</screen>
</para>
<para>
<para>
On-the-fly text substitutions need
- to be defined in a <quote>filter file</quote>. Once defined, they
+ to be defined in a <quote>filter file</quote>. Once defined, they
can then be invoked as an <quote>action</quote>.
</para>
<para>
Substitutions are made at the source level, so if you want to <quote>roll
- your own</quote> filters, you should first be familiar with HTML syntax,
+ your own</quote> filters, you should first be familiar with HTML syntax,
and, of course, regular expressions.
</para>
here. Each filter consists of a heading line, that starts with one of the
<emphasis>keywords</emphasis> <literal>FILTER:</literal>,
<literal>CLIENT-HEADER-FILTER:</literal> or <literal>SERVER-HEADER-FILTER:</literal>
- followed by the filter's <emphasis>name</emphasis>, and a short (one line)
+ followed by the filter's <emphasis>name</emphasis>, and a short (one line)
<emphasis>description</emphasis> of what it does. Below that line
come the <emphasis>jobs</emphasis>, i.e. lines that define the actual
text substitutions. By convention, the name of a filter
+<literal><link linkend="filter">filter</link>{<replaceable>name</replaceable>}</literal>
in any <link linkend="actions-file">actions file</link>.
</para>
-
+
<para>
Filter definitions start with a header line that contains the filter
type, the filter name and the filter description.
</para>
<para>
- If you are new to
+ If you are new to
<ulink url="http://en.wikipedia.org/wiki/Regular_expressions"><quote>Regular
Expressions</quote></ulink>, you might want to take a look at
the <link linkend="regex">Appendix on regular expressions</link>, and
see the <ulink url="http://perldoc.perl.org/perlre.html">Perl
manual</ulink> for
- <ulink url="http://perldoc.perl.org/perlop.html">the
+ <ulink url="http://perldoc.perl.org/perlop.html">the
<literal>s///</literal> operator's syntax</ulink> and <ulink
url="http://perldoc.perl.org/perlre.html">Perl-style regular
expressions</ulink> in general.
<para>
Now the pattern is deciphered, but wasn't this about substituting things? So
lets look at the substitute: <literal>$1"Not Your Business!"$2</literal> is
- easy to read: The text remembered as <literal>$1</literal>, followed by
+ easy to read: The text remembered as <literal>$1</literal>, followed by
<literal>"Not Your Business!"</literal> (<emphasis>including</emphasis>
the quotation marks!), followed by the text remembered as <literal>$2</literal>.
This produces an exact copy of the original string, with the middle part
Note that the <literal>i</literal> option makes the pattern matching
case-insensitive. Also note that ungreedy matching alone doesn't always guarantee
a minimal match: In the first parenthesis, we had to use <literal>[^>]*</literal>
- instead of <literal>.*</literal> to prevent the match from exceeding the
+ instead of <literal>.*</literal> to prevent the match from exceeding the
<body> tag if it doesn't contain <quote>OnUnload</quote>, but the page's
content does.
</para>
<para>
Note the <literal>(?!\.com)</literal> part (a so-called negative lookahead)
- in the job's pattern, which means: Don't match, if the string
+ in the job's pattern, which means: Don't match, if the string
<quote>.com</quote> appears directly following <quote>microsoft</quote>
in the page. This prevents links to microsoft.com from being trashed, while
still replacing the word everywhere else.
<para>
The <literal>x</literal> option in this job turns on extended syntax, and allows for
- e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting.
+ e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting.
</para>
<para>
<sect2 id="predefined-filters"><title>The Pre-defined Filters</title>
-<!--
+<!--
Note each filter is also listed in the +filter action section above. Please
keep these listings in sync.
-
+
-->
<para>
</itemizedlist>
</para>
<para>
- Use with caution. This is an aggressive filter, and can break sites that
+ Use with caution. This is an aggressive filter, and can break sites that
rely heavily on JavaScript.
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term><emphasis>js-events</emphasis></term>
<listitem>
This filter will undo many common instances of HTML based abuse.
</para>
<para>
- The <literal>BLINK</literal> and <literal>MARQUEE</literal> tags
+ The <literal>BLINK</literal> and <literal>MARQUEE</literal> tags
are neutralized (yeah baby!), and browser windows will be created as
resizeable (as of course they should be!), and will have location,
scroll and menu bars -- even if specified otherwise.
</para>
<para>
This filter disables most HTML and JavaScript code that reads or sets
- cookies. It cannot detect all clever uses of these types of code, so it
+ cookies. It cannot detect all clever uses of these types of code, so it
should not be relied on as an absolute fix. Use it wherever you would also
- use the cookie crunch actions.
+ use the cookie crunch actions.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis>refresh tags</emphasis></term>
+ <term><emphasis>refresh-tags</emphasis></term>
<listitem>
<para>
- Disable any refresh tags if the interval is greater than nine seconds (so
- that redirections done via refresh tags are not destroyed). This is useful
+ Disable any refresh tags if the interval is greater than nine seconds (so
+ that redirections done via refresh tags are not destroyed). This is useful
for dial-on-demand setups, or for those who find this HTML feature
annoying.
</para>
<term><emphasis>unsolicited-popups</emphasis></term>
<listitem>
<para>
- This filter attempts to prevent only <quote>unsolicited</quote> pop-up
- windows from opening, yet still allow pop-up windows that the user
- has explicitly chosen to open. It was added in version 3.0.1,
+ This filter attempts to prevent only <quote>unsolicited</quote> pop-up
+ windows from opening, yet still allow pop-up windows that the user
+ has explicitly chosen to open. It was added in version 3.0.1,
as an improvement over earlier such filters.
</para>
<para>
</para>
<para>
This is recommended only for browsers that cannot perform this function
- reliably themselves. And be aware that some sites require such windows
+ reliably themselves. And be aware that some sites require such windows
in order to function normally. Use with caution.
</para>
</listitem>
<term><emphasis>banners-by-size</emphasis></term>
<listitem>
<para>
- This filter removes image tags purely based on what size they are. Fortunately
+ This filter removes image tags purely based on what size they are. Fortunately
for us, many ads and banner images tend to conform to certain standardized
sizes, which makes this filter quite effective for ad stripping purposes.
</para>
but just happen to be of one of the standard banner sizes.
</para>
<para>
- Recommended only for those who require extreme ad blocking. The default
+ Recommended only for those who require extreme ad blocking. The default
block rules should catch 95+% of all ads <emphasis>without</emphasis> this filter enabled.
</para>
</listitem>
<term><emphasis>banners-by-link</emphasis></term>
<listitem>
<para>
- This is an experimental filter that attempts to kill any banners if
+ This is an experimental filter that attempts to kill any banners if
their URLs seem to point to known or suspected click trackers. It is currently
not of much value and is not recommended for use by default.
</para>
<term><emphasis>webbugs</emphasis></term>
<listitem>
<para>
- Webbugs are small, invisible images (technically 1X1 GIF images), that
+ Webbugs are small, invisible images (technically 1X1 GIF images), that
are used to track users across websites, and collect information on them.
As an HTML page is loaded by the browser, an embedded image tag causes the
browser to contact a third-party site, disclosing the tracking information
<listitem>
<para>
A rather special-purpose filter that can be used to enlarge textareas (those
- multi-line text boxes in web forms) and turn off hard word wrap in them.
+ multi-line text boxes in web forms) and turn off hard word wrap in them.
It was written for the sourceforge.net tracker system where such boxes are
a nuisance, but it can be handy on other sites, too.
</para>
<para>
Many Microsoft products that generate HTML use non-standard extensions (read:
violations) of the ISO 8859-1 aka Latin-1 character set. This can cause those
- HTML documents to display with errors on standard-compliant platforms.
+ HTML documents to display with errors on standard-compliant platforms.
</para>
<para>
- This filter translates the MS-only characters into Latin-1 equivalents.
- It is not necessary when using MS products, and will cause corruption of
+ This filter translates the MS-only characters into Latin-1 equivalents.
+ It is not necessary when using MS products, and will cause corruption of
all documents that use 8-bit character sets other than Latin-1. It's mostly
worthwhile for Europeans on non-MS platforms, if weird garbage characters
- sometimes appear on some pages, or user agents that don't correct for this on
+ sometimes appear on some pages, or user agents that don't correct for this on
the fly.
<!--
My version of Mozilla (ancient) shows litte square boxes for quote
characters, and apostrophes on moronized pages. So many pages have this, I
can read them fine now. HB 08/27/06
--->
+-->
</para>
</listitem>
</varlistentry>
<listitem>
<para>
A filter for shockwave haters. As the name suggests, this filter strips code
- out of web pages that is used to embed shockwave flash objects.
+ out of web pages that is used to embed shockwave flash objects.
</para>
<para>
</para>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term><emphasis>yahoo</emphasis></term>
<listitem>
<para>
- Another CSS based block, this time for Yahoo text ads. And removes
+ Another CSS based block, this time for Yahoo text ads. And removes
a width limitation as well.
</para>
</listitem>
<term><emphasis>msn</emphasis></term>
<listitem>
<para>
- Another CSS based block, this time for MSN text ads. And removes
+ Another CSS based block, this time for MSN text ads. And removes
tracking URLs, as well as a width limitation.
</para>
</listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term><emphasis>html-to-xml</emphasis></term>
<listitem>
<sect1 id="templates">
<title>Privoxy's Template Files</title>
<para>
- All <application>Privoxy</application> built-in pages, i.e. error pages such as the
+ All <application>Privoxy</application> built-in pages, i.e. error pages such as the
<ulink url="http://show-the-404-error.page"><quote>404 - No Such Domain</quote>
error page</ulink>, the <ulink
url="http://ads.bannerserver.example.com/nasty-ads/sponsor.html"><quote>BLOCKED</quote>
page</ulink>
and all pages of its <ulink url="http://config.privoxy.org/">web-based
- user interface</ulink>, are generated from <emphasis>templates</emphasis>.
+ user interface</ulink>, are generated from <emphasis>templates</emphasis>.
(<application>Privoxy</application> must be running for the above links to work as
intended.)
</para>
or exports), which <application>Privoxy</application> fills at run time. It
is possible to edit the templates with a normal text editor, should you want
to customize them. (<emphasis>Not recommended for the casual
- user</emphasis>). Should you create your own custom templates, you should use
+ user</emphasis>). Should you create your own custom templates, you should use
the <filename>config</filename> setting <link linkend="templdir">templdir</link>
to specify an alternate location, so your templates do not get overwritten
- during upgrades.
+ during upgrades.
</para>
<para>
Note that just like in configuration files, lines starting
expressions</quote> in its <link linkend="actions-file">actions
files</link> and <link linkend="filter-file">filter file</link>,
through the <ulink url="http://www.pcre.org/">PCRE</ulink> and
-<!--
+<!--
dead 08/27/06
<ulink url="http://www.oesterhelt.org/pcrs/">PCRS</ulink> libraries.
-->
<para>
To make a simple analogy, we do something similar when we use wild-card
- characters when listing files with the <command>dir</command> command in DOS.
+ characters when listing files with the <command>dir</command> command in DOS.
<literal>*.*</literal> matches all filenames. The <quote>special</quote>
character here is the asterisk which matches any and all characters. We can be
more specific and use <literal>?</literal> to match just individual
<para>
Regular expressions do essentially the same thing, but are much, much more
- powerful. There are many more <quote>special characters</quote> and ways of
+ powerful. There are many more <quote>special characters</quote> and ways of
building complex patterns however. Let's look at a few of the common ones,
and then some examples:
</para>
<para><simplelist>
<member>
<emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
- the following character should be taken literally. This is used where one of the
+ the following character should be taken literally. This is used where one of the
special characters (e.g. <quote>.</quote>) needs to be taken literally and
- not as a special meta-character. Example: <quote>example\.com</quote>, makes
- sure the period is recognized only as a period (and not expanded to its
+ not as a special meta-character. Example: <quote>example\.com</quote>, makes
+ sure the period is recognized only as a period (and not expanded to its
meta-character meaning of any single character).
</member>
</simplelist></para>
<member>
<emphasis>[ ]</emphasis> - Characters enclosed in brackets will be matched if
any of the enclosed characters are encountered. For instance, <quote>[0-9]</quote>
- matches any numeric digit (zero through nine). As an example, we can combine
+ matches any numeric digit (zero through nine). As an example, we can combine
this with <quote>+</quote> to match any digit one of more times: <quote>[0-9]+</quote>.
</member>
</simplelist></para>
<emphasis>|</emphasis> - The <quote>bar</quote> character works like an
<quote>or</quote> conditional statement. A match is successful if the
sub-expression on either side of <quote>|</quote> matches. As an example:
- <quote>/(this|that) example/</quote> uses grouping and the bar character
+ <quote>/(this|that) example/</quote> uses grouping and the bar character
and would match either <quote>this example</quote> or <quote>that
example</quote>, and nothing else.
</member>
</simplelist></para>
<para>
- These are just some of the ones you are likely to use when matching URLs with
+ These are just some of the ones you are likely to use when matching URLs with
<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>
<emphasis><literal>/.*/banners/.*</literal></emphasis> - A simple example
- that uses the common combination of <quote>.</quote> and <quote>*</quote> to
+ that uses the common combination of <quote>.</quote> and <quote>*</quote> to
denote any character, zero or more times. In other words, any string at all.
- So we start with a literal forward slash, then our regular expression pattern
+ So we start with a literal forward slash, then our regular expression pattern
(<quote>.*</quote>) another literal forward slash, the string
<quote>banners</quote>, another forward slash, and lastly another
- <quote>.*</quote>. We are building
+ <quote>.*</quote>. We are building
a directory path here. This will match any file with the path that has a
directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
any characters, and this could conceivably be more forward slashes, so it
</para>
<para>
- <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
+ <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
We have several literal forward slashes again (<quote>/</quote>), so we are
- building another expression that is a file path statement. We have another
+ building another expression that is a file path statement. We have another
<quote>.*</quote>, so we are matching against any conceivable sub-path, just so
it matches our expression. The only true literal that <emphasis>must
match</emphasis> our pattern is <application>adv</application>, together with
the forward slashes. What comes after the <quote>adv</quote> string is the
- interesting part.
+ interesting part.
</para>
<para>
<quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
individual sub-expressions: <quote>(er)</quote>,
<quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
- means <quote>or</quote>. We have two of those. For instance,
- <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
+ means <quote>or</quote>. We have two of those. For instance,
+ <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
<emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
- attempt at matching as many variations of <quote>advertisement</quote>, and
+ attempt at matching as many variations of <quote>advertisement</quote>, and
similar, as possible. So this would expand to match just <quote>adv</quote>,
or <quote>advert</quote>, or <quote>adverts</quote>, or
<quote>advertising</quote>, or <quote>advertisement</quote>, or
- <quote>advertisements</quote>. You get the idea. But it would not match
+ <quote>advertisements</quote>. You get the idea. But it would not match
<quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
- changing our regular expression to:
+ changing our regular expression to:
<quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
either spelling.
</para>
<para>
- <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
- another path statement with forward slashes. Anything in the square brackets
+ <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
+ another path statement with forward slashes. Anything in the square brackets
<quote>[ ]</quote> can be matched. This is using <quote>0-9</quote> as a
shorthand expression to mean any digit one through nine. It is the same as
saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
- means one or more of the preceding expression must be included. The preceding
- expression here is what is in the square brackets -- in this case, any digit
- one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
+ means one or more of the preceding expression must be included. The preceding
+ expression here is what is in the square brackets -- in this case, any digit
+ one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
This includes a <quote>|</quote>, so this needs to match the expression on
either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
</para>
<para>
- More reading on Perl Compatible Regular expressions:
+ More reading on Perl Compatible Regular expressions:
<ulink url="http://perldoc.perl.org/perlre.html">http://perldoc.perl.org/perlre.html</ulink>
</para>
<title>Privoxy's Internal Pages</title>
<para>
- Since <application>Privoxy</application> proxies each requested
- web page, it is easy for <application>Privoxy</application> to
+ 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
+ <application>Privoxy</application>, and see how it is
+ configured, see how our rules are being applied, change these
rules and other configuration options, and even turn
- <application>Privoxy's</application> filtering off, all with
+ <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
+ The URLs listed below are the special ones that allow direct access
to <application>Privoxy</application>. Of course,
- <application>Privoxy</application> must be running to access these. If
- not, you will get a friendly error message. Internet access is not
+ <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>
<itemizedlist>
<listitem>
- <para>
- Privoxy main page:
+ <para>
+ Privoxy main page:
</para>
<blockquote>
- <para>
+ <para>
<ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
</para>
</blockquote>
</listitem>
<listitem>
- <para>
- Show information about the current configuration, including viewing and
+ <para>
+ Show information about the current configuration, including viewing and
editing of actions files:
</para>
<blockquote>
- <para>
+ <para>
<ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
</para>
</blockquote>
</listitem>
-
+
<listitem>
- <para>
+ <para>
Show the source code version numbers:
</para>
<blockquote>
- <para>
+ <para>
<ulink url="http://config.privoxy.org/show-version">http://config.privoxy.org/show-version</ulink>
</para>
</blockquote>
</listitem>
-
+
<listitem>
- <para>
+ <para>
Show the browser's request headers:
</para>
<blockquote>
- <para>
+ <para>
<ulink url="http://config.privoxy.org/show-request">http://config.privoxy.org/show-request</ulink>
</para>
</blockquote>
</listitem>
-
+
<listitem>
- <para>
+ <para>
Show which actions apply to a URL and why:
</para>
<blockquote>
- <para>
+ <para>
<ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
</para>
</blockquote>
</listitem>
-
+
<listitem>
- <para>
- Toggle Privoxy on or off. This feature can be turned off/on in the main
+ <para>
+ Toggle Privoxy on or off. This feature can be turned off/on in the main
<filename>config</filename> file. When toggled <quote>off</quote>, <quote>Privoxy</quote>
continues to run, but only as a pass-through proxy, with no actions taking
place:
</para>
<blockquote>
- <para>
+ <para>
<ulink url="http://config.privoxy.org/toggle">http://config.privoxy.org/toggle</ulink>
</para>
</blockquote>
<para>
- Short cuts. Turn off, then on:
+ Short cuts. Turn off, then on:
</para>
<blockquote>
- <para>
+ <para>
<ulink url="http://config.privoxy.org/toggle?set=disable">http://config.privoxy.org/toggle?set=disable</ulink>
</para>
</blockquote>
<blockquote>
- <para>
+ <para>
<ulink url="http://config.privoxy.org/toggle?set=enable">http://config.privoxy.org/toggle?set=enable</ulink>
</para>
</blockquote>
</listitem>
-
+
</itemizedlist>
</para>
the bookmark <quote>may not be safe</quote> - just click OK. Then you can run the
Bookmarklet directly from your favorites/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.
+ Toolbar</quote> (Netscape), and run them with a single click.
</para>
<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());">Privoxy - Enable</ulink>
</para>
- </listitem>
+ </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());">Privoxy - Disable</ulink>
</para>
- </listitem>
+ </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());">Privoxy - Toggle Privoxy</ulink> (Toggles between enabled and disabled)
</para>
- </listitem>
+ </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());">Privoxy- View Status</ulink>
</para>
- </listitem>
+ </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/index.php?url='+escape(location.href),'Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Submit Actions File Feedback</ulink>
</para>
- </listitem>
- -->
+ </listitem>
+ -->
<listitem>
<para>
<ulink url="javascript:void(window.open('http://config.privoxy.org/show-url-info?url='+escape(location.href),'Why').focus());">Privoxy - Why?</ulink>
</para>
- </listitem>
+ </listitem>
</itemizedlist>
</para>
<para>
Credit: The site which gave us the general idea for these bookmarklets is
<ulink url="http://www.bookmarklets.com/">www.bookmarklets.com</ulink>. They
- have more information about bookmarklets.
+ have more information about bookmarklets.
</para>
<sect2 id="chain">
<title>Chain of Events</title>
<para>
- Let's take a quick look at how some of <application>Privoxy's</application>
+ Let's take a quick look at how some of <application>Privoxy's</application>
core features are triggered, and the ensuing sequence of events when a web
page is requested by your browser:
</para>
<itemizedlist>
<listitem>
<para>
- First, your web browser requests a web page. The browser knows to send
- the request to <application>Privoxy</application>, which will in turn,
- relay the request to the remote web server after passing the following
- tests:
+ First, your web browser requests a web page. The browser knows to send
+ the request to <application>Privoxy</application>, which will in turn,
+ relay the request to the remote web server after passing the following
+ tests:
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- <application>Privoxy</application> traps any request for its own internal CGI
+ <application>Privoxy</application> traps any request for its own internal CGI
pages (e.g <ulink url="http://p.p/">http://p.p/</ulink>) and sends the CGI page back to the browser.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- Next, <application>Privoxy</application> checks to see if the URL
+ Next, <application>Privoxy</application> checks to see if the URL
matches any <link
linkend="BLOCK"><quote>+block</quote></link> patterns. If
so, the URL is then blocked, and the remote web server will not be contacted.
- <link linkend="HANDLE-AS-IMAGE"><quote>+handle-as-image</quote></link>
- and
+ <link linkend="HANDLE-AS-IMAGE"><quote>+handle-as-image</quote></link>
+ and
<link linkend="HANDLE-AS-EMPTY-DOCUMENT"><quote>+handle-as-empty-document</quote></link>
- are then checked, and if there is no match, an
+ are then checked, and if there is no match, an
HTML <quote>BLOCKED</quote> page is sent back to the browser. Otherwise, if
it does match, an image is returned for the former, and an empty text
document for the latter. The type of image would depend on the setting of
<link linkend="SET-IMAGE-BLOCKER"><quote>+set-image-blocker</quote></link>
(blank, checkerboard pattern, or an HTTP redirect to an image elsewhere).
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Untrusted URLs are blocked. If URLs are being added to the
<filename>trust</filename> file, then that is done.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
If the URL pattern matches the <link
linkend="FAST-REDIRECTS"><quote>+fast-redirects</quote></link> action,
it is then processed. Unwanted parts of the requested URL are stripped.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Now the rest of the client browser's request headers are processed. If any
etc.), headers are suppressed or forged as determined by these actions and
their parameters.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Now the web server starts sending its response back (i.e. typically a web
page).
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
First, the server headers are read and processed to determine, among other
things, the MIME type (document type) and encoding. The headers are then
- filtered as determined by the
+ filtered as determined by the
<link linkend="CRUNCH-INCOMING-COOKIES"><quote>+crunch-incoming-cookies</quote></link>,
<link linkend="SESSION-COOKIES-ONLY"><quote>+session-cookies-only</quote></link>,
and <link linkend="DOWNGRADE-HTTP-VERSION"><quote>+downgrade-http-version</quote></link>
actions.
</para>
- </listitem>
- <listitem>
- <para>
- If the <link linkend="KILL-POPUPS"><quote>+kill-popups</quote></link>
- action applies, and it is an HTML or JavaScript document, the popup-code in the
- response is filtered on-the-fly as it is received.
- </para>
- </listitem>
+ </listitem>
<listitem>
<para>
If any <link linkend="FILTER"><quote>+filter</quote></link> action
they are specified in one of the filter files. Animated GIFs, if present,
are reduced to either the first or last frame, depending on the action
setting.The entire page, which is now filtered, is then sent by
- <application>Privoxy</application> back to your browser.
+ <application>Privoxy</application> back to your browser.
</para>
<para>
If neither a <link linkend="FILTER"><quote>+filter</quote></link> action
or <link
linkend="DEANIMATE-GIFS"><quote>+deanimate-gifs</quote></link>
- matches, then <application>Privoxy</application> passes the raw data through
+ matches, then <application>Privoxy</application> passes the raw data through
to the client browser as it becomes available.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- As the browser receives the now (possibly filtered) page content, it
+ As the browser receives the now (possibly filtered) page content, it
reads and then requests any URLs that may be embedded within the page
source, e.g. ad images, stylesheets, JavaScript, other HTML documents (e.g.
frames), sounds, etc. For each of these objects, the browser issues a
separate request (this is easily viewable in <application>Privoxy's</application>
logs). And each such request is in turn processed just as above. Note that a
- complex web page will have many, many such embedded URLs. If these
- secondary requests are to a different server, then quite possibly a very
+ complex web page will have many, many such embedded URLs. If these
+ secondary requests are to a different server, then quite possibly a very
differing set of actions is triggered.
</para>
- </listitem>
-
+ </listitem>
+
</itemizedlist>
</para>
<para>
NOTE: This is somewhat of a simplistic overview of what happens with each URL
- request. For the sake of brevity and simplicity, we have focused on
+ request. For the sake of brevity and simplicity, we have focused on
<application>Privoxy's</application> core features only.
</para>
<title>Troubleshooting: Anatomy of an Action</title>
<para>
- The way <application>Privoxy</application> applies
+ The way <application>Privoxy</application> applies
<link linkend="ACTIONS">actions</link> and <link linkend="FILTER">filters</link>
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
is causing us a problem inadvertently. It can be a little daunting to look at
the actions and filters files themselves, since they tend to be filled with
<link linkend="regex">regular expressions</link> whose consequences are not
- always so obvious.
+ always so obvious.
</para>
<para>
- One quick test to see if <application>Privoxy</application> is causing a problem
- or not, is to disable it temporarily. This should be the first troubleshooting
- step. See <link linkend="bookmarklets">the Bookmarklets</link> section on a quick
- and easy way to do this (be sure to flush caches afterward!). Looking at the
- logs is a good idea too. (Note that both the toggle feature and logging are
- enabled via <filename>config</filename> file settings, and may need to be
+ One quick test to see if <application>Privoxy</application> is causing a problem
+ or not, is to disable it temporarily. This should be the first troubleshooting
+ step. See <link linkend="bookmarklets">the Bookmarklets</link> section on a quick
+ and easy way to do this (be sure to flush caches afterward!). Looking at the
+ logs is a good idea too. (Note that both the toggle feature and logging are
+ enabled via <filename>config</filename> file settings, and may need to be
turned <quote>on</quote>.)
</para>
<para>
</para>
<para>
- <application>Privoxy</application> also provides the
+ <application>Privoxy</application> also 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>
First, enter one URL (or partial URL) at the prompt, and then
- <application>Privoxy</application> will tell us
+ <application>Privoxy</application> will tell us
how the current configuration will handle it. This will not
help with filtering effects (i.e. the <link
linkend="FILTER"><quote>+filter</quote></link> action) from
</para>
<para>
- Let's try an example, <ulink url="http://google.com">google.com</ulink>,
- and look at it one section at a time in a sample configuration (your real
+ Let's try an example, <ulink url="http://google.com">google.com</ulink>,
+ and look at it one section at a time in a sample configuration (your real
configuration may vary):
</para>
In file: default.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
- {+deanimate-gifs {last}
+ {+change-x-forwarded-for{block}
+ +deanimate-gifs {last}
+fast-redirects {check-decoded-url}
+filter {refresh-tags}
+filter {img-reorder}
+filter {webbugs}
+filter {jumping-windows}
+filter {ie-exploits}
- +hide-forwarded-for-headers
+hide-from-header {block}
+hide-referrer {forge}
+session-cookies-only
+set-image-blocker {pattern}
/
-
+
{ -session-cookies-only }
.google.com
.google.com
In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
-(no matches in this file)
+(no matches in this file)
</screen>
</para>
<para>
- This is telling us how we have defined our
+ This is telling us how we have defined our
<link linkend="ACTIONS"><quote>actions</quote></link>, and
- which ones match for our test case, <quote>google.com</quote>.
+ which ones match for our test case, <quote>google.com</quote>.
Displayed is all the actions that are available to us. Remember,
the <literal>+</literal> sign denotes <quote>on</quote>. <literal>-</literal>
- denotes <quote>off</quote>. So some are <quote>on</quote> here, but many
+ denotes <quote>off</quote>. So some are <quote>on</quote> here, but many
are <quote>off</quote>. Each example we try may provide a slightly different
end result, depending on our configuration directives.
</para>
action, allowing this to take place unmolested. Note that there is a leading
dot here -- <quote>.google.com</quote>. This will match any hosts and
sub-domains, in the google.com domain also, such as
- <quote>www.google.com</quote> or <quote>mail.google.com</quote>. But it would not
+ <quote>www.google.com</quote> or <quote>mail.google.com</quote>. But it would not
match <quote>www.google.de</quote>! So, apparently, we have these two actions
defined as exceptions to the general rules at the top somewhere in the lower
part of our <filename>default.action</filename> file, and
<para>
Then, for our <filename>user.action</filename> file, we again have no hits.
So there is nothing google-specific that we might have added to our own, local
- configuration. If there was, those actions would over-rule any actions from
+ configuration. If there was, those actions would over-rule any actions from
previously processed files, such as <filename>default.action</filename>.
<filename>user.action</filename> typically has the last word. This is the
best place to put hard and fast exceptions,
<para>
And finally we pull it all together in the bottom section and summarize how
- <application>Privoxy</application> is applying all its <quote>actions</quote>
+ <application>Privoxy</application> is applying all its <quote>actions</quote>
to <quote>google.com</quote>:
</para>
<screen>
Final results:
-
+
-add-header
-block
+ +change-x-forwarded-for{block}
-client-header-filter{hide-tor-exit-notation}
-content-type-overwrite
-crunch-client-header
-handle-as-image
-hide-accept-language
-hide-content-disposition
- +hide-forwarded-for-headers
+hide-from-header {block}
-hide-if-modified-since
+hide-referrer {forge}
-hide-user-agent
- -inspect-jpegs
- -kill-popups
-limit-connect
-overwrite-last-modified
-prevent-compression
-redirect
- -send-vanilla-wafer
- -send-wafer
-server-header-filter{xml-to-html}
- -server-header-filter{html-to-xml}
+ -server-header-filter{html-to-xml}
-session-cookies-only
- +set-image-blocker {pattern}
- -treat-forbidden-connects-like-blocks </screen>
+ +set-image-blocker {pattern} </screen>
</para>
<para>
- Notice the only difference here to the previous listing, is to
+ Notice the only difference here to the previous listing, is to
<quote>fast-redirects</quote> and <quote>session-cookies-only</quote>,
- which are activated specifically for this site in our configuration,
+ which are activated specifically for this site in our configuration,
and thus show in the <quote>Final Results</quote>.
</para>
</para>
<para>
- We'll just show the interesting part here - the explicit matches. It is
- matched three different times. Two <quote>+block{}</quote> sections,
+ We'll just show the interesting part here - the explicit matches. It is
+ matched three different times. Two <quote>+block{}</quote> sections,
and a <quote>+block{} +handle-as-image</quote>,
- which is the expanded form of one of our aliases that had been defined as:
+ which is the expanded form of one of our aliases that had been defined as:
<quote>+block-as-image</quote>. (<link
linkend="ALIASES"><quote>Aliases</quote></link> are defined in
- the first section of the actions file and typically used to combine more
+ the first section of the actions file and typically used to combine more
than one action.)
</para>
<para>
- Any one of these would have done the trick and blocked this as an unwanted
- image. This is unnecessarily redundant since the last case effectively
- would also cover the first. No point in taking chances with these guys
- though ;-) Note that if you want an ad or obnoxious
+ Any one of these would have done the trick and blocked this as an unwanted
+ image. This is unnecessarily redundant since the last case effectively
+ would also cover the first. No point in taking chances with these guys
+ though ;-) Note that if you want an ad or obnoxious
URL to be invisible, it should be defined as <quote>ad.doubleclick.net</quote>
is done here -- as both a <link
linkend="BLOCK"><quote>+block{}</quote></link>
- <emphasis>and</emphasis> an
+ <emphasis>and</emphasis> an
<link linkend="HANDLE-AS-IMAGE"><quote>+handle-as-image</quote></link>.
The custom alias <quote><literal>+block-as-image</literal></quote> just
simplifies the process and make it more readable.
In file: default.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
- {-add-header
+ {-add-header
-block
+ +change-x-forwarded-for{block}
-client-header-filter{hide-tor-exit-notation}
-content-type-overwrite
-crunch-client-header
-crunch-incoming-cookies
-crunch-outgoing-cookies
-crunch-server-header
- +deanimate-gifs
- -downgrade-http-version
+ +deanimate-gifs
+ -downgrade-http-version
+fast-redirects {check-decoded-url}
-filter {js-events}
-filter {content-cookies}
-filter {no-ping}
-force-text-mode
-handle-as-empty-document
- -handle-as-image
+ -handle-as-image
-hide-accept-language
- -hide-content-disposition
- +hide-forwarded-for-headers
- +hide-from-header{block}
- +hide-referer{forge}
- -hide-user-agent
- -inspect-jpegs
- -kill-popups
+ -hide-content-disposition
+ +hide-from-header{block}
+ +hide-referer{forge}
+ -hide-user-agent
-overwrite-last-modified
- +prevent-compression
+ +prevent-compression
-redirect
- -send-vanilla-wafer
- -send-wafer
-server-header-filter{xml-to-html}
- -server-header-filter{html-to-xml}
- +session-cookies-only
- +set-image-blocker{blank}
- -treat-forbidden-connects-like-blocks }
+ -server-header-filter{html-to-xml}
+ +session-cookies-only
+ +set-image-blocker{blank} }
/
{ +block{Path contains "ads".} +handle-as-image }
</para>
<para>
- Ooops, the <quote>/adsl/</quote> is matching <quote>/ads</quote> in our
+ Ooops, the <quote>/adsl/</quote> is matching <quote>/ads</quote> in our
configuration! But we did not want this at all! Now we see why we get the
- blank page. It is actually triggering two different actions here, and
- the effects are aggregated so that the URL is blocked, and &my-app; is told
+ blank page. It is actually triggering two different actions here, and
+ the effects are aggregated so that the URL is blocked, and &my-app; is told
to treat the block as if it were an image. But this is, of course, all wrong.
We could now add a new action below this (or better in our own
<filename>user.action</filename> file) that explicitly
</para>
<para>
- Now the page displays ;-)
+ Now the page displays ;-)
Remember to flush your browser's caches when making these kinds of changes to
your configuration to insure that you get a freshly delivered page! Or, try
using <literal>Shift+Reload</literal>.
</para>
<para>
- But now what about a situation where we get no explicit matches like
+ But now what about a situation where we get no explicit matches like
we did with:
</para>
<para>
That actually was very helpful 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
+ was. If you don't get this kind of match, then it means one of the default
rules in the first section of <filename>default.action</filename> 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
</para>
<para>
- <quote><literal>{ shop }</literal></quote> is an <quote>alias</quote> that expands to
+ <quote><literal>{ shop }</literal></quote> is an <quote>alias</quote> that expands to
<quote><literal>{ -filter -session-cookies-only }</literal></quote>.
Or you could do your own exception to negate filtering:
This would turn off all filtering for these sites. This is best
put in <filename>user.action</filename>, for local site
exceptions. Note that when a simple domain pattern is used by itself (without
- the subsequent path portion), all sub-pages within that domain are included
+ the subsequent path portion), all sub-pages within that domain are included
automatically in the scope of the action.
</para>
<para>
- Images that are inexplicably being blocked, may well be hitting the
+ Images that are inexplicably being blocked, may well be hitting the
<link linkend="FILTER-BANNERS-BY-SIZE"><quote>+filter{banners-by-size}</quote></link>
- rule, which assumes
- that images of certain sizes are ad banners (works well
+ rule, which assumes
+ that images of certain sizes are ad banners (works well
<emphasis>most of the time</emphasis> since these tend to be standardized).
</para>
<para>
<quote><literal>{ fragile }</literal></quote> is an alias that disables most
actions that are the most likely to cause trouble. This can be used as a
- last resort for problem sites.
-</para>
+ last resort for problem sites.
+</para>
<para>
<screen>
mail.google.
mybank.example.com</screen>
</para>
-
+
<para>
- <emphasis>Remember to flush caches!</emphasis> Note that the
- <literal>mail.google</literal> reference lacks the TLD portion (e.g.
- <quote>.com</quote>). This will effectively match any TLD with
- <literal>google</literal> in it, such as <literal>mail.google.de.</literal>,
+ <emphasis>Remember to flush caches!</emphasis> Note that the
+ <literal>mail.google</literal> reference lacks the TLD portion (e.g.
+ <quote>.com</quote>). This will effectively match any TLD with
+ <literal>google</literal> in it, such as <literal>mail.google.de.</literal>,
just as an example.
</para>
-<para>
+<para>
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>
<!--
- This program is free software; you can redistribute it
+ This program 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
The GNU General Public License should be included with
this file. If not, you can view it at
http://www.gnu.org/copyleft/gpl.html
- or write to the Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+ or write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
USA
$Log: user-manual.sgml,v $
+ Revision 2.153 2012/11/09 10:49:59 fabiankeil
+ Document --config-test option
+
+ Revision 2.152 2012/10/29 12:02:55 fabiankeil
+ Clarify that the destination-change detection works for intercepted requests as well
+
+ For some values of "clarify".
+
+ Revision 2.151 2012/10/21 12:31:59 fabiankeil
+ In the redirect{} section, refer pcrs newbies to the 'filter file' section
+
+ Revision 2.150 2012/09/26 15:20:54 fabiankeil
+ Spell 'refresh-tags' correctly
+
+ Reported by Don in #3571927.
+
+ Revision 2.149 2012/04/22 12:15:53 fabiankeil
+ Use another client-header-tagger{} example: disable filtering for range requests
+
+ Revision 2.148 2012/03/18 15:41:49 fabiankeil
+ Bump entities to 3.0.20 UNRELEASED
+
+ Revision 2.147 2012/03/11 19:03:42 diem
+ Updated user manual to refer to both packaged and source install options for OS X
+
+ Revision 2.146 2011/12/26 17:05:40 fabiankeil
+ Bump entities for 3.0.19
+
+ Revision 2.145 2011/12/26 17:04:19 fabiankeil
+ Import ChangeLog entries for 3.0.19, keeping the ones for 3.0.18 for now
+
+ Revision 2.144 2011/12/26 17:01:29 fabiankeil
+ Try to be less misleading in the downgrade-http-version description
+
+ Revision 2.143 2011/11/20 17:16:36 fabiankeil
+ Last minute ChangeLog changes that didn't make it into the tarball
+
+ Revision 2.142 2011/11/20 12:43:38 fabiankeil
+ Update ChangeLog. Once more, with feeling.
+
+ Revision 2.141 2011/11/20 12:41:22 fabiankeil
+ Document the +fast-redirects{} HTTP response splitting fix
+
+ Revision 2.140 2011/11/19 15:18:02 fabiankeil
+ Update ChangeLog
+
+ Revision 2.139 2011/11/18 16:49:29 fabiankeil
+ Update ChangeLog
+
+ Revision 2.138 2011/11/13 17:03:54 fabiankeil
+ Bump entities for 3.0.18 stable
+
+ Revision 2.137 2011/11/13 17:02:59 fabiankeil
+ Import the first ChangeLog draft for 3.0.18 stable
+
+ Revision 2.136 2011/10/14 16:53:10 fabiankeil
+ Clarify the effect of compiling Privoxy with zlib support
+
+ Suggested by dg1727 in #3423782.
+
+ zlib support has been available for years now,
+ so drop the reference to Privoxy 3.0.7
+
+ Revision 2.135 2011/09/04 11:10:12 fabiankeil
+ Ditch trailing whitespace
+
+ Revision 2.134 2011/08/18 11:45:02 fabiankeil
+ Don't use unspecified MSN sites as examples for User-Agent-based descrimination
+
+ Without knowing the URLs, nobody can easily verify it and it could
+ be mistaken as FUD. I also assume that it's no longer an issue anyway.
+
+ Revision 2.133 2011/08/18 11:42:50 fabiankeil
+ Bump some more documentation copyright ranges.
+
+ Revision 2.132 2011/08/17 10:40:07 fabiankeil
+ Update the entities.
+
+ This commit is chronological out of order.
+
+ Revision 2.131 2011/04/19 13:14:10 fabiankeil
+ Fix spelling errors in the documentation. Found with codespell.
+
+ Revision 2.130 2010/12/01 19:28:28 fabiankeil
+ Hopefully unbreak the dok target when using some kind of jade.
+
+ Reported by Lee.
+
+ Revision 2.129 2010/11/13 20:17:11 fabiankeil
+ Merge ChangeLog updates
+
+ Revision 2.128 2010/11/10 22:00:13 fabiankeil
+ Update the first paragraph of the 'What's New' section.
+
+ Revision 2.127 2010/11/10 21:48:54 fabiankeil
+ Update the "What's New" section.
+
+ Revision 2.126 2010/11/06 12:55:48 fabiankeil
+ Set p-version to 3.0.17
+
+ Revision 2.125 2010/09/03 17:39:37 fabiankeil
+ Slightly improve the explanation of why filtering may appear slower than it is.
+
+ Revision 2.124 2010/05/01 18:21:30 fabiankeil
+ Explicitly mention how to match any URL.
+
+ Revision 2.123 2010/02/19 16:00:38 fabiankeil
+ Even more fixes.
+
+ Revision 2.122 2010/02/19 15:22:47 fabiankeil
+ Add missing word.
+
+ Revision 2.121 2010/02/15 15:30:13 fabiankeil
+ Mention the use of the no-such-domain template for DNS problems with FEATURE_IPV6_SUPPORT enabled.
+
+ Revision 2.120 2010/02/13 17:38:39 fabiankeil
+ Update entities for 3.0.16 stable.
+
+ Revision 2.119 2010/02/13 16:37:37 fabiankeil
+ Update 'What's new?' section.
+
+ Revision 2.118 2010/02/11 13:59:48 fabiankeil
+ Mention that the headers added by the add-header action aren't modified by other actions.
+
+ Revision 2.117 2010/01/11 12:56:04 fabiankeil
+ Bump copyright range as p-config.sgml's copyright line is only used in the config file.
+
+ Revision 2.116 2009/11/15 14:24:12 fabiankeil
+ Prepare to generate docs for 3.0.16 UNRELEASED.
+
+ Revision 2.115 2009/10/10 06:19:34 fabiankeil
+ Ditch a duplicated 'since'.
+
+ Revision 2.114 2009/10/10 05:51:48 fabiankeil
+ Update "What's new" section.
+
+ Revision 2.113 2009/10/10 05:48:55 fabiankeil
+ Prepare for 3.0.15 beta.
+
+ Revision 2.112 2009/07/24 12:20:30 fabiankeil
+ Remove duplicated period.
+
+ Revision 2.111 2009/07/18 18:11:11 fabiankeil
+ Don't claim that NTLM should work when there are multiple reports that it doesn't.
+
+ Revision 2.110 2009/07/18 16:25:17 fabiankeil
+ Fix trailing whitespace.
+
+ Revision 2.109 2009/07/18 16:24:39 fabiankeil
+ Bump entities for 3.0.14 beta.
+
+ Revision 2.108 2009/07/18 15:49:23 fabiankeil
+ Add most of the changes in 3.0.14 to the "What's New" section.
+
+ Revision 2.107 2009/06/12 14:30:58 fabiankeil
+ Update entities for 3.0.13 beta.
+
+ Revision 2.106 2009/06/12 11:04:13 fabiankeil
+ Import ChangeLog for 3.0.13 beta.
+
+ Revision 2.105 2009/04/17 11:32:57 fabiankeil
+ Grammar and spelling fixes.
+
+ Revision 2.104 2009/04/17 11:27:49 fabiankeil
+ Petr Pisar's privoxy-3.0.12-ipv6-3.diff.
+
+ Revision 2.103 2009/03/21 10:49:05 fabiankeil
+ Merge updated ChangeLog.
+
+ Revision 2.102 2009/03/15 19:31:36 fabiankeil
+ Update "What's New in this Release" section.
+
+ Revision 2.101 2009/02/25 19:01:56 fabiankeil
+ Fix typo.
+
+ Revision 2.100 2009/02/19 17:14:11 fabiankeil
+ - Copy the release cycle description from announce.txt into
+ the "What's New" section.
+ - Stop referring to the ChangeLog for a "complete list of changes".
+ The "What's New" section already contains the complete list.
+
+ Revision 2.99 2009/02/19 02:20:22 hal9
+ Make some links in seealso conditional. Man page is now privoxy only links.
+
+ Revision 2.98 2009/02/16 17:10:33 fabiankeil
+ Fix entry about shortened log messages. Noticed by Lee.
+
+ Revision 2.97 2009/02/14 18:01:00 fabiankeil
+ Import ChangeLog.
+
+ Revision 2.96 2009/02/14 13:14:03 fabiankeil
+ Unbreak syntax.
+
+ Revision 2.95 2009/02/14 12:51:26 fabiankeil
+ Mention match-all.action in the "Actions Files Tutorial" section.
+
+ Revision 2.94 2009/02/14 11:50:31 fabiankeil
+ Some indentation fixes.
+
+ Revision 2.93 2009/02/14 10:14:42 fabiankeil
+ Mention match-all.action in the action file descriptions.
+
+ Revision 2.92 2009/02/12 16:08:26 fabiankeil
+ Declare the code stable.
+
+ Revision 2.91 2009/01/13 16:50:35 fabiankeil
+ The standard.action file is gone.
+
+ Revision 2.90 2008/09/26 16:53:09 fabiankeil
+ Update "What's new" section.
+
+ Revision 2.89 2008/09/21 15:38:56 fabiankeil
+ Fix Portage tree sync instructions in Gentoo section.
+ Anonymously reported at ijbswa-developers@.
+
+ Revision 2.88 2008/09/21 14:42:52 fabiankeil
+ Add documentation for change-x-forwarded-for{},
+ remove documentation for hide-forwarded-for-headers.
+
+ Revision 2.87 2008/08/30 15:37:35 fabiankeil
+ Update entities.
+
+ Revision 2.86 2008/08/16 10:12:23 fabiankeil
+ Merge two sentences and move the URL to the end of the item.
+
+ Revision 2.85 2008/08/16 10:04:59 fabiankeil
+ Some more syntax fixes. This version actually builds.
+
+ Revision 2.84 2008/08/16 09:42:45 fabiankeil
+ Turns out building docs works better if the syntax is valid.
+
+ Revision 2.83 2008/08/16 09:32:02 fabiankeil
+ Mention changes since 3.0.9 beta.
+
+ Revision 2.82 2008/08/16 09:00:52 fabiankeil
+ Fix example URL pattern (once more with feeling).
+
+ Revision 2.81 2008/08/16 08:51:28 fabiankeil
+ Update version-related entities.
+
+ Revision 2.80 2008/07/18 16:54:30 fabiankeil
+ Remove erroneous whitespace in documentation link.
+ Reported by John Chronister in #2021611.
+
+ Revision 2.79 2008/06/27 18:00:53 markm68k
+ remove outdated startup information for mac os x
+
+ Revision 2.78 2008/06/21 17:03:03 fabiankeil
+ Fix typo.
+
+ Revision 2.77 2008/06/14 13:45:22 fabiankeil
+ Re-add a colon I unintentionally removed a few revisions ago.
+
+ Revision 2.76 2008/06/14 13:21:28 fabiankeil
+ Prepare for the upcoming 3.0.9 beta release.
+
+ Revision 2.75 2008/06/13 16:06:48 fabiankeil
+ Update the "What's New in this Release" section with
+ the ChangeLog entries changelog2doc.pl could handle.
+
+ Revision 2.74 2008/05/26 15:55:46 fabiankeil
+ - Update "default profiles" table.
+ - Add some more pcrs redirect examples and note that
+ enabling debug 128 helps to get redirects working.
+
+ Revision 2.73 2008/05/23 14:43:18 fabiankeil
+ Remove previously out-commented block that caused syntax problems.
+
+ Revision 2.72 2008/05/12 10:26:14 fabiankeil
+ Synchronize content filter descriptions with the ones in default.filter.
+
+ Revision 2.71 2008/04/10 17:37:16 fabiankeil
+ Actually we use "modern" POSIX 1003.2 regular
+ expressions in path patterns, not PCRE.
+
+ Revision 2.70 2008/04/10 15:59:12 fabiankeil
+ Add another section to the client-header-tagger example that shows
+ how to actually change the action settings once the tag is created.
+
+ Revision 2.69 2008/03/29 12:14:25 fabiankeil
+ Remove send-wafer and send-vanilla-wafer actions.
+
+ Revision 2.68 2008/03/28 15:13:43 fabiankeil
+ Remove inspect-jpegs action.
+
+ Revision 2.67 2008/03/27 18:31:21 fabiankeil
+ Remove kill-popups action.
+
+ Revision 2.66 2008/03/06 16:33:47 fabiankeil
+ If limit-connect isn't used, don't limit CONNECT requests to port 443.
+
+ Revision 2.65 2008/03/04 18:30:40 fabiankeil
+ Remove the treat-forbidden-connects-like-blocks action. We now
+ use the "blocked" page for forbidden CONNECT requests by default.
+
+ Revision 2.64 2008/03/01 14:10:28 fabiankeil
+ Use new block syntax. Still needs some polishing.
+
Revision 2.63 2008/02/22 05:50:37 markm68k
fix merge problem
clarification.
Revision 1.111 2002/05/14 23:01:36 oes
- Fixing the fixes
+ Fixing the fixes
Revision 1.110 2002/05/14 19:10:45 oes
Restored alphabetical order of actions
projects / privoxy.git / blobdiff