X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=427cf0f03211356688379d559871778b133480cd;hb=c54228f0ef0172341cfe4f9acb7e955fa1e269b7;hp=09fd525f1d141d5a72dfc773b1073907a14e2f22;hpb=86843fe49327d314678892f9114b061b0615c481;p=privoxy.git
diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index 09fd525f..427cf0f0 100644
--- a/doc/source/user-manual.sgml
+++ b/doc/source/user-manual.sgml
@@ -1,5 +1,5 @@
+
@@ -8,15 +8,23 @@
-
-
-
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+Privoxy">
]>
+
+ Copyright &my-copy; 2001 - 2008 by
+ Privoxy Developers
+
+
+
+$Id: user-manual.sgml,v 2.54 2008/01/19 17:52:39 hal9 Exp $
+
+
-
-
-
- By: Privoxy Developers
-
-
-
+
@@ -68,21 +87,21 @@
]]>
- The user manual gives users information on how to install, configure and use
- Privoxy.
-
+ The Privoxy User Manual gives users information on how to
+ install, configure and use Privoxy.
+
&p-intro;
- You can find the latest version of the user manual at Privoxy User Manual at http://www.privoxy.org/user-manual/.
- Please see the Contact section on how to
+ Please see the Contact section on how to
contact the developers.
-
+
@@ -92,24 +111,15 @@
-
-
-
-
-
-
-
-
Introduction
This documentation is included with the current &p-status; version of
Privoxy, v.&p-version;soon ;-)]]>.
+ configuration files. Development of a new version is currently nearing
+ completion, and includes significant changes and enhancements over
+ earlier versions. ]]>.
@@ -123,15 +133,15 @@
]]>
-
-New Features
+Features
- In addition to Internet Junkbuster's traditional
- features of ad and banner blocking and cookie management,
- Privoxy provides new features:
+ In addition to the core
+ features of ad blocking and
+ cookie management,
+ Privoxy provides many supplemental
+ features,
+ that give the end-user more control, more privacy and more freedom:
-
&newfeatures;
@@ -149,63 +159,62 @@
Privoxy is available both in convenient pre-compiled
packages for a wide range of operating systems, and as raw source code.
For most users, we recommend using the packages, which can be downloaded from our
- Privoxy Project Page.
+ Privoxy Project
+ Page.
- 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 the
- CVS repository or simply download the nightly CVS
- tarball.
+ Note:
+ On some platforms, the installer may remove previously installed versions, if
+ found. (See below for your platform). In any case be sure to backup
+ your old configuration if it is valuable to you. See the note to upgraders section below.
-
- &supported;
-
-
-
+
Binary Packages
-
- Note: If you have a previous Junkbuster or
- Privoxy installation on your system, you
- will need to remove it. Some platforms do this for you as part
- of their installation procedure. (See below for your platform).
+How to install the binary packages depends on your operating system:
+
+
+
+Red Hat and Fedora RPMs
+
- In any case be sure to backup your old configuration
- if it is valuable to you. See the
- note to upgraders.
+ RPMs can be installed with rpm -Uvh privoxy-&p-version;-1.rpm,
+ and will use /etc/privoxy for the location
+ of configuration files.
- How to install the binary packages depends on your operating system:
+ Note that on Red Hat, Privoxy will
+ not be automatically started on system boot. You will
+ need to enable that using chkconfig,
+ ntsysv, or similar methods.
-
-Red Hat and SuSE RPMs
-
- RPMs can be installed with rpm -Uvh <name-of-rpm.rpm>,
- and will use /etc/privoxy for the location
- of configuration files.
+ If you have problems with failed dependencies, try rebuilding the SRC RPM:
+ rpm --rebuild privoxy-&p-version;-1.src.rpm. This
+ will use your locally installed libraries and RPM version.
- Note that if you have a Junkbuster RPM installed
+ Also note that if you have a Junkbuster RPM installed
on your system, you need to remove it first, because the packages conflict.
Otherwise, RPM will try to remove Junkbuster
- automatically, before installing Privoxy.
+ automatically if found, before installing Privoxy.
-Debian
+Debian and Ubuntu
- FIXME.
+ DEBs can be installed with apt-get install privoxy,
+ and will use /etc/privoxy for the location of
+ configuration files.
@@ -214,17 +223,51 @@
Just double-click the installer, which will guide you through
- the installation process.
+ the installation process. You will find the configuration files
+ in the same directory as you installed Privoxy in.
+
+
+ Version 3.0.5 beta introduced full Windows service
+ functionality. On Windows only, the Privoxy
+ program has two new command line arguments to install and uninstall
+ Privoxy as a service.
+
+
+
+ Arguments:
+
+
+ --install[:service_name]
+
+
+ --uninstall[:service_name]
+
+
+
+
+
+ After invoking Privoxy with
+ --install, you will need to bring up the
+ Windows service console to assign the user you
+ want Privoxy to run under, and whether or not you
+ want it to run whenever the system starts. You can start the
+ Windows services console with the following
+ command: services.msc. If you do not take the manual step
+ of modifying Privoxy's 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
+ write to its log and configuration files.
+
-Solaris, NetBSD, FreeBSD, HP-UX
+Solaris
Create a new directory, cd to it, then unzip and
untar the archive. For the most part, you'll have to figure out where
- things go. FIXME.
+ things go.
@@ -235,8 +278,10 @@
First, make sure that no previous installations of
Junkbuster and / or
Privoxy are left on your
- system.
- You can do this by
+ system. Check that no Junkbuster
+ or Privoxy objects are in
+ your startup folder.
+
@@ -253,290 +298,311 @@
-Max OSX
-
- Unzip the downloaded package (you can either double-click on the file
- in the finder, or on the desktop if you downloaded it there). Then,
- double-click on the package installer icon and follow the installation
- process.
- Privoxy will be installed in the subdirectory
- /Applications/Privoxy.app.
- Privoxy will set itself up to start
- automatically on system bringup via
- /System/Library/StartupItems/Privoxy.
+Mac OSX
+
+ Unzip the downloaded file (you can either double-click on the file
+ from the finder, or from the desktop if you downloaded it there).
+ Then, double-click on the package installer icon named
+ Privoxy.pkg
+ and follow the installation process.
+ Privoxy will be installed in the folder
+ /Library/Privoxy.
+ It will start automatically whenever you start up. To prevent it from
+ starting automatically, remove or rename the folder
+ /Library/StartupItems/Privoxy.
+
+
+ To start Privoxy by hand, double-click on
+ StartPrivoxy.command in the
+ /Library/Privoxy folder.
+ Or, type this command in the Terminal:
+
+
+
+ /Library/Privoxy/StartPrivoxy.command
+
+
+
+ You will be prompted for the administrator password.
AmigaOS
- Unpack the .lha archive, then FIXME.
+ Copy and then unpack the lha archive to a suitable location.
+ All necessary files will be installed into Privoxy
+ directory, including all configuration and log files. To uninstall, just
+ remove this directory.
-
-
-
-Building from Source
-
-
-&buildsource;
-
-
-
-
-
-
-
+FreeBSD
-Quickstart to Using Privoxy
-
-
-
-
-Note to Upgraders
- There are very significant changes from older versions of
- Junkbuster to the current
- Privoxy. Configuration is substantially
- changed. Junkbuster 2.0.x and earlier
- configuration files will not migrate. The functionality of the old
- blockfile, cookiefile and
- imagelist, are now combined into the
- actions file (default.action
- for most installations).
+ Privoxy is part of FreeBSD's Ports Collection, you can build and install
+ it with cd /usr/ports/www/privoxy; make install clean.
- A filter file (typically default.filter)
- is new as of Privoxy 2.9.x, and provides some
- of the new sophistication (explained below). config is
- much the same as before.
+ If you don't use the ports, you can fetch and install
+ the package with pkg_add -r privoxy.
- If upgrading from a 2.0.x version, you will have to use the new config
- files, and possibly adapt any personal rules from your older files.
- When porting personal rules over from the old blockfile
- to the new actions file, please note that even the pattern syntax has
- changed. If upgrading from 2.9.x development versions, it is still
- recommended to use the new configuration files.
+ The port skeleton and the package can also be downloaded from the
+ File Release
+ Page, but there's no reason to use them unless you're interested in the
+ beta releases which are only available there.
+
+
+
+Gentoo
- A quick list of things to be aware of before upgrading:
+ Gentoo source packages (Ebuilds) for Privoxy 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
+ Privoxy Version is added to the Portage Tree).
-
-
-
-
-
- The default listening port is now 8118 due to a conflict with another
- service (NAS).
-
-
-
-
- Some installers may remove earlier versions completely. Save any
- important configuration files!
-
-
-
-
- Privoxy is controllable with a web browser
- at the special URL: http://config.privoxy.org/
- (Shortcut: http://p.p/). Many
- aspects of configuration can be done here, including temporarily disabling
- Privoxy.
-
-
-
-
- The primary configuration file for cookie management, ad and banner
- blocking, and many other aspects of Privoxy
- configuration is default.action. It is strongly
- recommended to become familiar with the new actions concept below,
- before modifying this file.
-
-
-
-
-
-
- Some installers may not automatically start
- Privoxy after installation.
-
-
-
-
+ Before installing Privoxy under Gentoo just do
+ first emerge rsync to get the latest changes from the
+ Portage tree. With emerge privoxy you install the latest
+ version.
+
+
+ Configuration files are in /etc/privoxy, the
+ documentation is in /usr/share/doc/privoxy-&p-version;
+ and the Log directory is in /var/log/privoxy.
+
-
-Starting Privoxy
-
- Before launching Privoxy for the first time, you
- will want to configure your browser(s) to use Privoxy
- as a HTTP and HTTPS proxy. The default is localhost for the proxy address,
- and port 8118 (earlier versions used port 8000). This is the one
- configuration step that must be done!
-
-
-
- With Netscape (and
- Mozilla), this can be set under Edit
- -> Preferences -> Advanced -> Proxies -> HTTP Proxy.
- For Internet Explorer: Tools ->
- Internet Properties -> Connections -> LAN Setting. Then,
- check Use Proxy and fill in the appropriate info (Address:
- localhost, Port: 8118). Include if HTTPS proxy support too.
-
+Building from Source
- 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. You
- are now ready to start enjoying the benefits of using
- Privoxy!
+ The most convenient way to obtain the Privoxy sources
+ is to download the source tarball from our
+ project download
+ page.
-
- Privoxy is typically started by specifying the
- main configuration file to be used on the command line. Example Unix startup
- command:
+ 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 the
+ CVS repository.
+
-
-
-
- # /usr/sbin/privoxy /etc/privoxy/config
-
-
-
+
+&buildsource;
+
+
+
+Keeping your Installation Up-to-Date
- See below for other command line options.
+ As user feedback comes in and development continues, we will make updated versions
+ of both the main actions file (as a separate
+ package) and the software itself (including the actions file) available for
+ download.
- An init script is provided for SuSE and Red Hat.
+ If you wish to receive an email notification whenever we release updates of
+ Privoxy or the actions file, subscribe
+ to our announce mailing list, ijbswa-announce@lists.sourceforge.net.
- For for SuSE: rcprivoxy start
+ In order not to lose your personal changes and adjustments when updating
+ to the latest default.action file we strongly
+ recommend that you use user.action and
+ user.filter for your local
+ customizations of Privoxy. See the Chapter on actions files for details.
-
- For Red Hat: /etc/rc.d/init.d/privoxy start
-
+
-
- If no configuration file is specified on the command line,
- Privoxy will look for a file named
- config in the current directory. Except on Win32 where
- it will try config.txt. If no file is specified on the
- command line and no default configuration file can be found,
- Privoxy will fail to start.
-
+
+
+
+
+What's New in this Release
- The included default configuration files should give a reasonable starting
- point. Most of the per site configuration is done in the
- actions files. These are where various cookie actions are
- defined, ad and banner blocking, and other aspects of
- Privoxy configuration. There are several such
- files included, with varying levels of aggressiveness.
+ There are many improvements and new features since Privoxy 3.0.6, the last stable release:
- You will probably want to keep an eye out for sites that require persistent
- cookies, and add these to default.action as needed. By
- default, most of these will be accepted only during the current browser
- session (aka session cookies), until you add them to the
- configuration. If you want the browser to handle this instead, you will need
- to edit default.action and disable this feature. If you
- use more than one browser, it would make more sense to let
- Privoxy handle this. In which case, the
- browser(s) should be set to accept all cookies.
-
+
+
+
+ Two new actions server-header-tagger
+ and client-header-tagger
+ that can be used to create arbitrary tags
+ based on client and server headers.
+ These tags can then subsequently be used
+ to control the other actions used for the current request,
+ greatly increasing &my-app;'s flexibility and selectivity. See tag patterns for more information on tags.
+
+
+
+
+
+ Header filtering is done with dedicated header filters now. As a result
+ the actions filter-client-headers and filter-server-headers
+ that were introduced with Privoxy 3.0.5 to apply
+ content filters to the headers have been removed.
+ See the new actions server-header-filter
+ and client-header-filter for details.
+
+
+
+
+ There are four new options for the main config file:
+
+
+
+
+
+ allow-cgi-request-crunching
+ which allows requests for Privoxy's internal CGI pages to be
+ blocked, redirected or (un)trusted like ordinary requests.
+
+
+
+
+ split-large-forms
+ 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.
+
+
+
+
+ accept-intercepted-requests
+ 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.
+
+
+
+
+ templdir
+ to designate an alternate location for &my-app;'s
+ locally customized CGI templates so that
+ these are not overwritten during upgrades.
+
+
+
+
+
+
+
+ A new command line option --pre-chroot-nslookup hostname 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)
+
+
+
+
+
+ The forward-override 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 User-Agent, or the request origin.
+
+
-
- Another feature where you will probably want to define exceptions for trusted
- sites is the popup-killing (through the +popup and
- +filter{popups} actions), because your favorite shopping,
- banking, or leisure site may need popups.
-
+
+
+ The redirect action can now use regular
+ expression substitutions against the original URL.
+
+
-
- Privoxy is HTTP/1.1 compliant, but not all of
- the optional 1.1 features are as yet supported. In the unlikely event that
- you experience inexplicable problems with browsers that use HTTP/1.1 per default
- (like Mozilla or recent versions of I.E.), you might
- try to force HTTP/1.0 compatibility. For Mozilla, look under Edit ->
- Preferences -> Debug -> Networking.
- Alternatively, set the +downgrade config option in
- default.action which will downgrade your browser's HTTP
- requests from HTTP/1.1 to HTTP/1.0 before processing them.
-
+
+
+ zlib support is now available as a compile
+ time option to filter compressed content. Patch provided by Wil Mahan.
+
+
+
+
+ Improve various filters, and add new ones.
+
+
-
- After running Privoxy 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. Actions (as specified in default.action)
- can be adjusted by pointing your browser to
- http://config.privoxy.org/
- (shortcut: http://p.p/),
- and then follow the link to edit the actions list.
- (This is an internal page and does not require Internet access.)
-
-
- In fact, various aspects of Privoxy
- configuration can be viewed from this page, including
- current configuration parameters, source code version numbers,
- the browser's request headers, and actions that apply
- to a given URL. In addition to the default.action file
- editor mentioned above, Privoxy can also
- be turned on and off (toggled) from this page.
-
+
+
+ Include support for RFC 3253 so that Subversion works
+ with &my-app;. Patch provided by Petr Kadlec.
+
+
-
- If you encounter problems, try loading the page without
- Privoxy. If that helps, enter the URL where
- you have the problems into the browser
- based rule tracing utility. See which rules apply and why, and
- then try turning them off for that site one after the other, until the problem
- is gone. When you have found the culprit, you might want to turn the rest on
- again.
-
+
+
+ Logging can be completely turned off by not specifying a logfile directive.
+
+
-
- If the above paragraph sounds gibberish to you, you might want to read more about the actions concept
- or even dive deep into the Appendix
- on actions.
-
+
+
+ A number of improvements to Privoxy's internal CGI pages, including the
+ use of favicons for error and control pages.
+
+
+
+
+
+ Many bugfixes, memory leaks addressed, code improvements, and logging
+ improvements.
+
+
+
+
+
- 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
- chapter "Contacting the Developers, .." below.
+ For a more detailed list of changes please have a look at the ChangeLog.
-
+
+
+Note to Upgraders
-
-
-Command Line Options
- Privoxy may be invoked with the following
- command-line options:
+ A quick list of things to be aware of before upgrading from earlier
+ versions of Privoxy:
@@ -544,160 +610,451 @@
- --version
+ 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
+ diff and maybe patch.
- Print version info and exit. Unix only.
+ There are a number of new features in each &my-app; release and
+ most of them have to be explicitly enabled in the configuration
+ files. Old configuration files obviously don't do that and due
+ to syntax changes using old configuration files with a new
+ &my-app; isn't always possible anyway.
-
+
-
- --help
-
-
- Print short usage info and exit. Unix only.
+
+ Note that some installers remove earlier versions completely,
+ including configuration files, therefore you should really save
+ any important configuration files!
-
+
-
- --no-daemon
+
+ On the other hand, other installers don't overwrite existing configuration
+ files, thinking you will want to do that yourself.
-
- Don't become a daemon, i.e. don't fork and become process group
- leader, and don't detach from controlling tty. Unix only.
+
+
+
+ standard.action now only includes the enabled actions.
+ Not all actions as before.
-
+
- --pidfile FILE
-
+ In the default configuration only fatal errors are logged now.
+ You can change that in the debug section
+ of the configuration file. You may also want to enable more verbose
+ logging until you verified that the new &my-app; version is working
+ as expected.
-
- On startup, write the process ID to FILE. Delete the
- FILE on exit. Failure to create or delete the
- FILE is non-fatal. If no FILE
- option is given, no PID file will be used. Unix only.
+
+
+
+
+ Three other config file settings are now off by default:
+ enable-remote-toggle,
+ enable-remote-http-toggle,
+ and enable-edit-actions.
+ If you use or want these, you will need to explicitly enable them, and
+ be aware of the security issues involved.
+
+
+
+
+
+ The filter-client-headers and
+ filter-server-headers actions that were introduced with
+ Privoxy 3.0.5 to apply content filters to
+ the headers have been removed and replaced with new actions.
+ See the What's New section above.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Quickstart to Using Privoxy
+
+
+
- --user USER[.GROUP]
-
+ Install Privoxy. See the Installation Section below for platform specific
+ information.
+
+
+
+
+
+ Advanced users and those who want to offer Privoxy
+ service to more than just their local machine should check the main config file, especially the security-relevant options. These are
+ off by default.
+
+
+
- After (optionally) writing the PID file, assume the user ID of
- USER, and if included the GID of GROUP. Exit if the
- privileges are not sufficient to do so. Unix only.
+ Start Privoxy, if the installation program has
+ not done this already (may vary according to platform). See the section
+ Starting Privoxy.
-
+
+
- configfile
+ Set your browser to use Privoxy as HTTP and
+ HTTPS (SSL) proxy
+ by setting the proxy configuration for address of
+ 127.0.0.1 and port 8118.
+ DO NOT activate proxying for FTP or
+ any protocols besides HTTP and HTTPS (SSL) unless you intend to prevent your
+ browser from using these protocols.
+
+
+
- If no configfile is included on the command line,
- Privoxy will look for a file named
- config in the current directory (except on Win32
- where it will look for config.txt instead). Specify
- full path to avoid confusion. If no config file is found,
- Privoxy will fail to start.
+ Flush your browser's disk and memory caches, to remove any cached ad images.
+ If using Privoxy to manage
+ cookies,
+ you should remove any currently stored cookies too.
-
+
+
+ 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
+ to no initial configuration is required in most cases, you may want
+ to enable the
+ web-based action editor though.
+ Be sure to read the warnings first.
+
+
+ See the Configuration section for more
+ configuration options, and how to customize your installation.
+ You might also want to look at the next section for a quick
+ introduction to how Privoxy blocks ads and
+ banners.
+
-
-
-
+
+
+ If you experience ads that slip through, innocent images that are
+ blocked, or otherwise feel the need to fine-tune
+ Privoxy's behavior, take a look at the actions files. As a quick start, you might
+ find the richly commented examples
+ helpful. You can also view and edit the actions files through the web-based user interface. The
+ Appendix Troubleshooting: Anatomy of an
+ Action has hints on how to understand and debug actions that
+ misbehave.
+
+
-
+
+
+
+ Please see the section Contacting the
+ Developers on how to report bugs, problems with websites or to get
+ help.
+
+
-
-Privoxy Configuration
-
- All Privoxy configuration is stored
- in text files. These files can be edited with a text editor.
- Many important aspects of Privoxy can
- also be controlled easily with a web browser.
+
+
+ Now enjoy surfing with enhanced control, comfort and privacy!
+
+
-
+
+
-
-Controlling Privoxy with Your Web Browser
+
+Quickstart to Ad Blocking
+
- Privoxy's user interface can be reached through the special
- URL http://config.privoxy.org/
- (shortcut: http://p.p/),
- which is a built-in page and works without Internet access.
- You will see the following section:
-
+ Ad blocking is but one of Privoxy's
+ 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.
+
+
+ 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.
+
+
+ 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
+ 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
+ problem sites, and to spend more time adjusting the
+ configuration to solve these unintended consequences. In short, there is
+ not an easy way to eliminate all ads. Either take
+ the easy way and settle for most ads blocked with the
+ default configuration, or jump in and tweak it for your personal surfing
+ habits and preferences.
+
+
+ Secondly, a brief explanation of Privoxy's
+ actions. Actions in this context, are
+ the directives we use to tell Privoxy to perform
+ some task relating to HTTP transactions (i.e. web browsing). We tell
+ Privoxy to take some action. Each
+ action has a unique name and function. While there are many potential
+ actions in Privoxy's
+ arsenal, only a few are used for ad blocking. Actions, and action
+ configuration files, are explained in depth below.
+
+
+ Actions are specified in Privoxy's configuration,
+ followed by one or more URLs to which the action should apply. URLs
+ can actually be URL type patterns 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.
+
+
+ When you connect to a website, the full URL will either match one or more
+ of the sections as defined in Privoxy's configuration,
+ or not. If so, then Privoxy will perform the
+ respective actions. If not, then nothing special happens. Furthermore, web
+ pages may contain embedded, secondary URLs that your web browser will
+ use to load additional components of the page, as it parses the
+ original page's HTML content. An ad image for instance, is just an URL
+ embedded in the page somewhere. The image itself may be on the same server,
+ or a server somewhere else on the Internet. Complex web pages will have many
+ such embedded URLs. &my-app; can deal with each URL individually, so, for
+ instance, the main page text is not touched, but images from such-and-such
+ server are blocked.
+
+
+
+ The most important actions for basic ad blocking are: block, handle-as-image,
+ handle-as-empty-document,and
+ set-image-blocker:
-
+
+
+
+
+ block - 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,
+ but also anything that is determined to be unwanted. By itself, it simply
+ stops any communication with the remote server and sends
+ Privoxy's own built-in BLOCKED page instead to
+ let you now what has happened (with some exceptions, see below).
+
+
-Please choose from the following options:
+
+
+ handle-as-image -
+ tells Privoxy to treat this URL as an image.
+ Privoxy'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
+ Privoxy BLOCKED page (which would only result in
+ a broken image 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.
+
+
- * Privoxy main page
- * Show information about the current configuration
- * Show the source code version numbers
- * Show the request headers.
- * Show which actions apply to a URL and why
- * Toggle Privoxy on or off
- * Edit the actions list
+
+
+ handle-as-empty-document -
+ sends an empty document instead of Privoxy's
+ normal BLOCKED HTML page. This is useful for file types that are neither
+ HTML nor images, such as blocking JavaScript files.
+
+
-
+
+
+ set-image-blocker - tells
+ Privoxy what to display in place of an ad image that
+ has hit a block rule. For this to come into play, the URL must match a
+ block action somewhere in the
+ configuration, and, it must also match an
+ handle-as-image action.
+
+
+ The configuration options on what to display instead of the ad are:
+
+
+
+ pattern - a checkerboard pattern, so that an ad
+ replacement is obvious. This is the default.
+
+
+
+
+ blank - A very small empty GIF image is displayed.
+ This is the so-called invisible configuration option.
+
+
+
+
+ http://<URL> - A redirect to any image anywhere
+ of the user's choosing (advanced usage).
+
+
+
+
+
- This should be self-explanatory. Note the last item is an editor for the
- actions list, which is where much of the ad, banner, cookie,
- and URL blocking magic is configured as well as other advanced features of
- Privoxy. This is an easy way to adjust various
- aspects of Privoxy configuration. The actions
- file, and other configuration files, are explained in detail below.
+ Advanced users will eventually want to explore &my-app;
+ filters as well. Filters
+ are very different from blocks.
+ A block blocks a site, page, or unwanted contented. Filters
+ are a way of filtering or modifying what is actually on the page. An example
+ filter usage: a text replacement of no-no for
+ nasty-word. That is a very simple example. This process can be
+ used for ad blocking, but it is more in the realm of advanced usage and has
+ some pitfalls to be wary off.
- Toggle Privoxy On or Off 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 Privoxy
- causing the problem or not. Privoxy continues
- to run as a proxy in this case, but all filtering is disabled. There
- is even a toggle Bookmarklet offered, so
- that you can toggle Privoxy with one click from
- your browser.
+ The quickest way to adjust any of these settings is with your browser through
+ the special Privoxy editor at http://config.privoxy.org/show-status
+ (shortcut: http://p.p/show-status). This
+ is an internal page, and does not require Internet access.
-
-
-
-
-
-
-
-
+
+ Note that as of Privoxy 3.0.7 beta the
+ action editor is disabled by default. Check the
+ enable-edit-actions
+ section in the configuration file to learn why and in which
+ cases it's safe to enable again.
+
-
-Configuration Files Overview
- For Unix, *BSD and Linux, all configuration files are located in
- /etc/privoxy/ by default. For MS Windows, OS/2, and
- AmigaOS these are all in the same directory as the
- Privoxy executable.
+ If you decided to enable the action editor, select the appropriate
+ actions file, and click
+ Edit. It is best to put personal or
+ local preferences in user.action since this is not
+ meant to be overwritten during upgrades, and will over-ride the settings in
+ other files. Here you can insert new actions, and URLs for ad
+ blocking or other purposes, and make other adjustments to the configuration.
+ Privoxy will detect these changes automatically.
- The installed defaults provide a reasonable starting point, though possibly
- aggressive by some standards. For the time being, there are only three
- default configuration files (this may change in time):
+ A quick and simple step by step example:
@@ -705,3674 +1062,6729 @@ Please choose from the following options:
- The main configuration file is named config
- on Linux, Unix, BSD, OS/2, and AmigaOS and config.txt
- on Windows.
+ Right click on the ad image to be blocked, then select
+ Copy Link Location from the
+ pop-up menu.
-
- default.action (the actions file) is used to define
- which of a set of various actions relating to images, banners,
- pop-ups, access restrictions, banners and cookies are to be applied, and where.
- There is a web based editor for this file that can be accessed at http://config.privoxy.org/edit-actions/
- (Shortcut: http://p.p/edit-actions/).
- (Other actions files are included as well with differing levels of filtering
- and blocking, e.g. basic.action.)
+ Set your browser to
+ http://config.privoxy.org/show-status
-
- default.filter (the filter file) can be used to re-write the raw
- page content, including viewable text as well as embedded HTML and JavaScript,
- and whatever else lurks on any given web page. The filtering jobs are only
- pre-defined here; whether to apply them or not is up to the actions file.
+ Find user.action in the top section, and click
+ on Edit:
-
+
+
+
+
+
+
+
+
+ You should have a section with only
+ block listed under
+ Actions:.
+ If not, click a Insert new section below
+ button, and in the new section that just appeared, click the
+ Edit button right under the word Actions:.
+ This will bring up a list of all actions. Find
+ block near the top, and click
+ in the Enabled column, then Submit
+ just below the list.
+
+
+
+
+ Now, in the block actions section,
+ click the Add button, and paste the URL the
+ browser got from Copy Link Location.
+ Remove the http:// at the beginning of the URL. Then, click
+ Submit (or
+ OK if in a pop-up window).
+
+
+
+
+ Now go back to the original page, and press SHIFT-Reload
+ (or flush all browser caches). The image should be gone now.
+
+
+
- All files use the # character to denote a
- comment (the rest of the line will be ignored) and understand line continuation
- through placing a backslash ("\") as the very last character
- in a line. If the # is preceded by a backslash, it looses
- its special function. Placing a # in front of an otherwise
- valid configuration line to prevent it from being interpreted is called "commenting
- out" that line.
+ 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 patterns, and
+ the entire actions concept, see the Actions
+ section.
- default.action and default.filter
- can use Perl style regular expressions for
- maximum flexibility.
+ For advanced users who want to hand edit their config files, you might want
+ to now go to the Actions Files Tutorial.
+ The ideas explained therein also apply to the web-based editor.
-
- After making any changes, there is no need to restart
- Privoxy in order for the changes to take
- effect. Privoxy 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 Privoxy, these wake up requests
- must obviously be sent to the old listening address.
+ There are also various
+ filters that can be used for ad blocking
+ (filters are a special subset of actions). These
+ fall into the advanced usage category, and are explained in
+ depth in later sections.
-
- 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 default setting, may change, so
- please check all your configuration files on important issues.
-
-]]>
+
-
+
-
-The Main Configuration File
-
- Again, the main configuration file is named config on
- Linux/Unix/BSD and OS/2, and config.txt on Windows.
- Configuration lines consist of an initial keyword followed by a list of
- values, all separated by whitespace (any number of spaces or tabs). For
- example:
-
+
+
+Starting Privoxy
-
-
-
- confdir /etc/privoxy
-
-
-
+ Before launching Privoxy for the first time, you
+ will want to configure your browser(s) to use
+ Privoxy as a HTTP and HTTPS (SSL)
+ proxy. 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 that must be done
+!
-
- Assigns the value /etc/privoxy to the option
- confdir and thus indicates that the configuration
- directory is named /etc/privoxy/.
+ Please note that Privoxy can only proxy HTTP and
+ HTTPS traffic. It will not work with FTP or other protocols.
-
- All options in the config file except for confdir and
- logdir are optional. Watch out in the below description
- for what happens if you leave them unset.
-
+
+
+
+
+
-
- The main config file controls all aspects of Privoxy's
- operation that are not location dependent (i.e. they apply universally, no matter
- where you may be surfing).
+
+ With Firefox, this is typically set under:
+
+
+ Tools -> Options -> Advanced -> Network ->Connection -> Settings
+
+
+
+
+ Or optionally on some platforms:
+
+
+
+ Edit -> Preferences -> General -> Connection Settings -> Manual Proxy Configuration
+
+
+
+
+
+ With Netscape (and
+ Mozilla), this can be set under:
+
+
+
+
+
+
+ Edit -> Preferences -> Advanced -> Proxies -> HTTP Proxy
+
+
+
+
+ For Internet Explorer v.5-7:
+
+
+
+ Tools -> Internet Options -> Connections -> LAN Settings
+
+
+
+ Then, check Use Proxy and fill in the appropriate info
+ (Address: 127.0.0.1, Port: 8118). Include HTTPS (SSL), if you want HTTPS
+ proxy support too (sometimes labeled Secure). Make sure any
+ checkboxes like Use the same proxy server for all protocols is
+ UNCHECKED. You want only HTTP and HTTPS (SSL)!
+
+
+
+
+
+
+
+
+
+ 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
+ any cookies,
+ if you want Privoxy to manage that. You are now
+ ready to start enjoying the benefits of using
+ Privoxy!
+
+
+
+ Privoxy itself is typically started by specifying the
+ main configuration file to be used on the command line. If no configuration
+ file is specified on the command line, Privoxy
+ will look for a file named config in the current
+ directory. Except on Win32 where it will try config.txt.
+
+
+
+Red Hat and Fedora
+
+ A default Red Hat installation may not start &my-app; upon boot. It will use
+ the file /etc/privoxy/config as its main configuration
+ file.
+
+
+
+ # /etc/rc.d/init.d/privoxy start
+
+
+
+ Or ...
+
+
+
+ # service privoxy start
+
+
+
+
+
+Debian
+
+ We use a script. Note that Debian typically starts &my-app; upon booting per
+ default. It will use the file
+ /etc/privoxy/config as its main configuration
+ file.
+
+
+
+ # /etc/init.d/privoxy start
+
+
+
+
+
+Windows
+
+Click on the &my-app; Icon to start Privoxy. If no configuration file is
+ specified on the command line, Privoxy will look
+ for a file named config.txt. Note that Windows will
+ automatically start &my-app; when the system starts if you chose that option
+ when installing.
+
+
+ Privoxy 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
+ Windows Installation
+ instructions for details.
+
+
+
+
+Solaris, NetBSD, FreeBSD, HP-UX and others
+
+Example Unix startup command:
+
+
+
+ # /usr/sbin/privoxy /etc/privoxy/config
+
+
+
+
+
+OS/2
+
+ During installation, Privoxy is configured to
+ start automatically when the system restarts. You can start it manually by
+ double-clicking on the Privoxy icon in the
+ Privoxy folder.
+
+
+
+
+Mac OSX
+
+ During installation, Privoxy is configured to
+ start automatically when the system restarts. To start &my-app; manually,
+ double-click on the StartPrivoxy.command icon in the
+ /Library/Privoxy folder. Or, type this command
+ in the Terminal:
+
+
+
+ /Library/Privoxy/StartPrivoxy.command
+
+
+
+ You will be prompted for the administrator password.
+
+
+
+
+
+AmigaOS
+
+ Start Privoxy (with RUN <>NIL:) in your
+ startnet script (AmiTCP), in
+ s:user-startup (RoadShow), as startup program in your
+ startup script (Genesis), or as startup action (Miami and MiamiDx).
+ Privoxy will automatically quit when you quit your
+ TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that
+ Privoxy is still running).
+
+
+
+
+Gentoo
+
+ A script is again used. It will use the file /etc/privoxy/config
+ as its main configuration file.
+
+
+
+ /etc/init.d/privoxy start
+
+
+
+ Note that Privoxy is not automatically started at
+ boot time by default. You can change this with the rc-update
+ command.
+
+
+
+ rc-update add privoxy default
+
+
+
+
+
+
+
+
+Command Line Options
+
+ Privoxy may be invoked with the following
+ command-line options:
+
+
+
+
+
+
+
+ --version
+
+
+ Print version info and exit. Unix only.
+
+
+
+
+ --help
+
+
+ Print short usage info and exit. Unix only.
+
+
+
+
+ --no-daemon
+
+
+ Don't become a daemon, i.e. don't fork and become process group
+ leader, and don't detach from controlling tty. Unix only.
+
+
+
+
+ --pidfile FILE
+
+
+ On startup, write the process ID to FILE. Delete the
+ FILE on exit. Failure to create or delete the
+ FILE is non-fatal. If no FILE
+ option is given, no PID file will be used. Unix only.
+
+
+
+
+ --user USER[.GROUP]
+
+
+ After (optionally) writing the PID file, assume the user ID of
+ USER, and if included the GID of GROUP. Exit if the
+ privileges are not sufficient to do so. Unix only.
+
+
+
+
+ --chroot
+
+
+ Before changing to the user ID given in the --user 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
+ the impact of possible vulnerabilities in &my-app; to the files contained in that hierarchy.
+ Unix only.
+
+
+
+
+ --pre-chroot-nslookup hostname
+
+
+ Specifies a hostname to look up before doing a chroot. On some systems, initializing the
+ resolver library involves reading config files from /etc and/or loading additional shared
+ libraries from /lib. On these systems, doing a hostname lookup before the chroot reduces
+ the number of files that must be copied into the chroot tree.
+
+
+ For fastest startup speed, a good value is a hostname that is not in /etc/hosts but that
+ your local name server (listed in /etc/resolv.conf) can resolve without recursion
+ (that is, without having to ask any other name servers). The hostname need not exist,
+ but if it doesn't, an error message (which can be ignored) will be output.
+
+
+
+
+
+ configfile
+
+
+ If no configfile is included on the command line,
+ Privoxy will look for a file named
+ config in the current directory (except on Win32
+ where it will look for config.txt instead). Specify
+ full path to avoid confusion. If no config file is found,
+ Privoxy will fail to start.
+
+
+
+
+
+
+
+ On MS Windows only there are two additional
+ command-line options to allow Privoxy to install and
+ run as a service. See the
+Window Installation section
+for details.
+
+
+
+
+
+
+
+
+
+
+Privoxy Configuration
+
+ All Privoxy configuration is stored
+ in text files. These files can be edited with a text editor.
+ Many important aspects of Privoxy can
+ also be controlled easily with a web browser.
+
+
+
+
+
+
+Controlling Privoxy with Your Web Browser
+
+ Privoxy's user interface can be reached through the special
+ URL http://config.privoxy.org/
+ (shortcut: http://p.p/),
+ which is a built-in page and works without Internet access.
+ You will see the following section:
+
+
+
+
+
+
+ Privoxy Menu
+
+
+
+ ▪ View & change the current configuration
+
+
+ ▪ View the source code version numbers
+
+
+ ▪ View the request headers.
+
+
+ ▪ Look up which actions apply to a URL and why
+
+
+ ▪ Toggle Privoxy on or off
+
+
+ ▪ Documentation
+
+
+
+
+
+
+
+ This should be self-explanatory. Note the first item leads to an editor for the
+ actions files, which is where the ad, banner,
+ cookie, and URL blocking magic is configured as well as other advanced features of
+ Privoxy. This is an easy way to adjust various
+ aspects of Privoxy configuration. The actions
+ file, and other configuration files, are explained in detail below.
+
+
+
+ Toggle Privoxy On or Off 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 Privoxy
+ causing the problem or not. Privoxy continues
+ to run as a proxy in this case, but all manipulation is disabled, i.e.
+ Privoxy acts like a normal forwarding proxy. There
+ is even a toggle Bookmarklet offered, so
+ that you can toggle Privoxy with one click from
+ your browser.
+
+
+
+ Note that several of the features described above are disabled by default
+ in Privoxy 3.0.7 beta and later.
+ Check the
+ configuration file to learn why
+ and in which cases it's safe to enable them again.
+
+
+
+
+
+
+
+
+
+
+
+
+Configuration Files Overview
+
+ For Unix, *BSD and Linux, all configuration files are located in
+ /etc/privoxy/ by default. For MS Windows, OS/2, and
+ AmigaOS these are all in the same directory as the
+ Privoxy executable.
+
+
+
+ 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:
+
+
+
+
+
+
+
+ The main configuration file is named config
+ on Linux, Unix, BSD, OS/2, and AmigaOS and config.txt
+ on Windows. This is a required file.
+
+
+
+
+
+ default.action (the main actions file)
+ is used to define which actions 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
+ Privoxy to selectively eliminate the junk, and only the junk, on
+ as many websites as possible.
+
+
+ Multiple actions files may be defined in config. These
+ are processed in the order they are defined. Local customizations and locally
+ preferred exceptions to the default policies as defined in
+ default.action (which you will most probably want
+ to define sooner or later) are probably best applied in
+ user.action, where you can preserve them across
+ upgrades. standard.action is only for
+ Privoxy's internal use.
+
+
+ There is also a web based editor that can be accessed from
+ http://config.privoxy.org/show-status
+ (Shortcut: http://p.p/show-status) for the
+ various actions files.
+
+
+
+
+
+ Filter files (the filter
+ file) can be used to re-write the raw page content, including
+ viewable text as well as embedded HTML and JavaScript, and whatever else
+ lurks on any given web page. The filtering jobs are only pre-defined here;
+ whether to apply them or not is up to the actions files.
+ default.filter 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 config as you can with
+ actions files. We suggest user.filter for any
+ locally defined filters or customizations.
+
+
+
+
+
+
+
+ The syntax of the configuration and filter files may change between different
+ Privoxy versions, unfortunately some enhancements cost backwards compatibility.
+
+
+
+
+ All files use the # character to denote a
+ comment (the rest of the line will be ignored) and understand line continuation
+ through placing a backslash ("\") as the very last character
+ in a line. If the # is preceded by a backslash, it looses
+ its special function. Placing a # in front of an otherwise
+ valid configuration line to prevent it from being interpreted is called "commenting
+ out" that line. Blank lines are ignored.
+
+
+
+ The actions files and filter files
+ can use Perl style regular expressions for
+ maximum flexibility.
+
+
+
+ After making any changes, there is no need to restart
+ Privoxy in order for the changes to take
+ effect. Privoxy 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 Privoxy, these wake up requests
+ must obviously be sent to the old listening address.
+
+
+
+ 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 default setting, may change, so
+ please check all your configuration files on important issues.
+
+]]>
+
+
+
+
+
+
+
+
+
+
+
+ &config;
+
+
+
+
+
+
+
+
+
+Actions Files
+
+
+ The actions files are used to define what actions
+ Privoxy 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).
+ 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
+ their effects are aggregated when applied against a given set of URLs.
+
+
+ There
+ are three action files included with Privoxy with
+ differing purposes:
+
+
+
+
+
+
+ default.action - is the primary action file
+ that sets the initial values for all actions. It is intended to
+ provide a base level of functionality for
+ Privoxy's 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 making available to users.
+ The user's preferences as set in standard.action,
+ e.g. either Cautious (the default),
+ Medium, or Advanced (see
+ below).
+
+
+
+
+ user.action - 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.
+
+
+
+
+ standard.action - is used only by the web based editor
+ at
+ http://config.privoxy.org/edit-actions-list?f=default,
+ to set various pre-defined sets of rules for the default actions section
+ in default.action.
+
+
+ EditSet to CautiousSet to MediumSet to Advanced
+
+
+ These have increasing levels of aggressiveness and have no
+ influence on your browsing unless you select them explicitly in the
+ editor. A default installation should be pre-set to
+ Cautious (versions prior to 3.0.5 were set to
+ Medium). 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.
+
+
+ The Edit button allows you to turn each
+ action on/off individually for fine-tuning. The Cautious
+ 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
+ Medium button sets the list to a medium level of
+ other features and a low level set of privacy features. The
+ Advanced 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
+ Edit button. More fine-tuning can be done in the
+ lower sections of this internal page.
+
+
+ It is not recommend to edit the standard.action file
+ itself.
+
+
+ The default profiles, and their associated actions, as pre-defined in
+ standard.action are:
+
+
+
Default Configurations
+
+
+
+
+
+
+
+ Feature
+ Cautious
+ Medium
+ Advanced
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Ad-blocking Aggressiveness
+ medium
+ high
+ high
+
+
+
+ Ad-filtering by size
+ no
+ yes
+ yes
+
+
+
+ Ad-filtering by link
+ no
+ no
+ yes
+
+
+ Pop-up killing
+ blocks only
+ blocks only
+ blocks only
+
+
+
+ Privacy Features
+ low
+ medium
+ medium/high
+
+
+
+ Cookie handling
+ none
+ session-only
+ kill
+
+
+
+ Referer forging
+ no
+ yes
+ yes
+
+
+
+
+ GIF de-animation
+ no
+ yes
+ yes
+
+
+
+
+ Fast redirects
+ no
+ no
+ yes
+
+
+
+ HTML taming
+ no
+ no
+ yes
+
+
+
+ JavaScript taming
+ no
+ no
+ yes
+
+
+
+ Web-bug killing
+ no
+ yes
+ yes
+
+
+
+ Image tag reordering
+ no
+ no
+ yes
+
+
+
+
+
@@ -4764,7 +8152,7 @@ Requests
- Show the client's request headers:
+ Show the browser's request headers:
@@ -4786,8 +8174,10 @@ Requests
- Toggle Privoxy on or off. In this case, Privoxy continues
- to run, but only as a pass-through proxy, with no actions taking place:
+ Toggle Privoxy on or off. This feature can be turned off/on in the main
+ config file. When toggled off, Privoxy
+ continues to run, but only as a pass-through proxy, with no actions taking
+ place:
@@ -4852,42 +8231,49 @@ Requests
- Enable Privoxy
+ Privoxy - Enable
- Disable Privoxy
+ Privoxy - Disable
- Toggle Privoxy (Toggles between enabled and disabled)
+ Privoxy - Toggle Privoxy (Toggles between enabled and disabled)
- View Privoxy Status
+ Privoxy- View Status
-
+
+
+
+ Privoxy - Why?
-
-
-
- Credit: The site which gave me the general idea for these bookmarklets is
- www.bookmarklets.com. They
+ Credit: The site which gave us the general idea for these bookmarklets is
+ www.bookmarklets.com. They
have more information about bookmarklets.
@@ -4897,27 +8283,173 @@ Requests
+
+
+Chain of Events
+
+ Let's take a quick look at how some of Privoxy's
+ core features are triggered, and the ensuing sequence of events when a web
+ page is requested by your browser:
+
+
+
+
+
+
+ First, your web browser requests a web page. The browser knows to send
+ the request to Privoxy, which will in turn,
+ relay the request to the remote web server after passing the following
+ tests:
+
+
+
+
+ Privoxy traps any request for its own internal CGI
+ pages (e.g http://p.p/) and sends the CGI page back to the browser.
+
+
+
+
+ Next, Privoxy checks to see if the URL
+ matches any +block patterns. If
+ so, the URL is then blocked, and the remote web server will not be contacted.
+ +handle-as-image
+ and
+ +handle-as-empty-document
+ are then checked, and if there is no match, an
+ HTML BLOCKED 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
+ +set-image-blocker
+ (blank, checkerboard pattern, or an HTTP redirect to an image elsewhere).
+
+
+
+
+ Untrusted URLs are blocked. If URLs are being added to the
+ trust file, then that is done.
+
+
+
+
+ If the URL pattern matches the +fast-redirects action,
+ it is then processed. Unwanted parts of the requested URL are stripped.
+
+
+
+
+ Now the rest of the client browser's request headers are processed. If any
+ of these match any of the relevant actions (e.g. +hide-user-agent,
+ etc.), headers are suppressed or forged as determined by these actions and
+ their parameters.
+
+
+
+
+ Now the web server starts sending its response back (i.e. typically a web
+ page).
+
+
+
+
+ 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
+ +crunch-incoming-cookies,
+ +session-cookies-only,
+ and +downgrade-http-version
+ actions.
+
+
+
+
+ If the +kill-popups
+ 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.
+
+
+
+
+ If any +filter action
+ or +deanimate-gifs
+ action applies (and the document type fits the action), the rest of the page is
+ read into memory (up to a configurable limit). Then the filter rules (from
+ default.filter and any other filter files) are
+ processed against the buffered content. Filters are applied in the order
+ 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
+ Privoxy back to your browser.
+
+
+ If neither a +filter action
+ or +deanimate-gifs
+ matches, then Privoxy passes the raw data through
+ to the client browser as it becomes available.
+
+
+
+
+ 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 Privoxy's
+ 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
+ differing set of actions is triggered.
+
+
+
+
+
+
+ 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
+ Privoxy's core features only.
+
+
+
+
+
-Anatomy of an Action
+Troubleshooting: Anatomy of an Action
- The way Privoxy applies actions
- and filters to any given URL can be complex, and not always so
+ The way Privoxy applies
+ actions and filters
+ 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
see just what Privoxy is
doing. Especially, if something Privoxy is doing
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
- regular expressions whose consequences are not always
- so obvious.
+ regular expressions whose consequences are not
+ always so obvious.
One quick test to see if Privoxy is causing a problem
or not, is to disable it temporarily. This should be the first troubleshooting
step. See the Bookmarklets section on a quick
- and easy way to do this.
+ 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 config file settings, and may need to be
+ turned on.)
+
+
+ Another easy troubleshooting step to try is if you have done any
+ customization of your installation, revert back to the installed
+ defaults and see if that helps. There are times the developers get complaints
+ about one thing or another, and the problem is more related to a customized
+ configuration issue.
@@ -4931,92 +8463,109 @@ Requests
First, enter one URL (or partial URL) at the prompt, and then
Privoxy will tell us
how the current configuration will handle it. This will not
- help with filtering effects from the default.filter file! It
- also will not tell you about any other URLs that may be embedded within the
- URL you are testing (i.e. a web page). For instance, images such as ads are expressed as URLs
- within the raw page source of HTML pages. So you will only get info for the
- actual URL that is pasted into the prompt area -- not any sub-URLs. If you
- want to know about embedded URLs like ads, you will have to dig those out of
- the HTML source. Use your browser's View Page Source option
- for this. Or right click on the ad, and grab the URL.
+ help with filtering effects (i.e. the +filter action) from
+ one of the filter files since this is handled very
+ differently and not so easy to trap! It also will not tell you about any other
+ URLs that may be embedded within the URL you are testing. For instance, images
+ such as ads are expressed as URLs within the raw page source of HTML pages. So
+ you will only get info for the actual URL that is pasted into the prompt area
+ -- not any sub-URLs. If you want to know about embedded URLs like ads, you
+ will have to dig those out of the HTML source. Use your browser's View
+ Page Source option for this. Or right click on the ad, and grab the
+ URL.
- Let's look at an example, google.com,
- one section at a time:
+ Let's try an example, google.com,
+ and look at it one section at a time in a sample configuration (your real
+ configuration may vary):
- System default actions:
-
- { -add-header -block -deanimate-gifs -downgrade -fast-redirects -filter
- -hide-forwarded -hide-from -hide-referer -hide-user-agent -image
- -image-blocker -limit-connect -no-compression -no-cookies-keep
- -no-cookies-read -no-cookies-set -no-popups -vanilla-wafer -wafer }
+ Matches for http://www.google.com:
+
+ In file: default.action [ View ][ Edit ]
+
+ {+deanimate-gifs {last}
+ +fast-redirects {check-decoded-url}
+ +filter {refresh-tags}
+ +filter {img-reorder}
+ +filter {banners-by-size}
+ +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
+
+ { -fast-redirects }
+ .google.com
+
+In file: user.action [ View ][ Edit ]
+(no matches in this file)
+
- This is the top section, and only tells us of the compiled in defaults. This
- is basically what Privoxy would do if there
- were not any actions defined, i.e. it does nothing. Every action
- is disabled. This is not particularly informative for our purposes here. OK,
- next section:
+ This is telling us how we have defined our
+ actions, and
+ which ones match for our test case, google.com.
+ Displayed is all the actions that are available to us. Remember,
+ the + sign denotes on. -
+ denotes off. So some are on here, but many
+ are off. Each example we try may provide a slightly different
+ end result, depending on our configuration directives.
-
-
-
- Matches for http://google.com:
-
- { -add-header -block +deanimate-gifs -downgrade +fast-redirects
- +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
- +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
- +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
- -hide-user-agent -image +image-blocker{blank} +no-compression
- +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups
- -vanilla-wafer -wafer }
- /
-
- { -no-cookies-keep -no-cookies-read -no-cookies-set }
- .google.com
-
- { -fast-redirects }
- .google.com
-
-
+ The first listing
+ is for our default.action file. The large, multi-line
+ listing, is how the actions are set to match for all URLs, i.e. our default
+ settings. If you look at your actions file, this would be the
+ section just below the aliases section near the top. This
+ will apply to all URLs as signified by the single forward slash at the end
+ of the listing -- / .
- This is much more informative, and tells us how we have defined our
- actions, and which ones match for our example,
- google.com. The first grouping shows our default
- settings, which would apply to all URLs. If you look at your actions
- file, this would be the section just below the aliases section
- near the top. This applies to all URLs as signified by the single forward
- slash -- /.
-
+ But we have defined additional actions that would be exceptions to these general
+ rules, and then we list specific URLs (or patterns) that these exceptions
+ would apply to. Last match wins. Just below this then are two explicit
+ matches for .google.com. The first is negating our previous
+ cookie setting, which was for +session-cookies-only
+ (i.e. not persistent). So we will allow persistent cookies for google, at
+ least that is how it is in this example. The second turns
+ off any +fast-redirects
+ action, allowing this to take place unmolested. Note that there is a leading
+ dot here -- .google.com. This will match any hosts and
+ sub-domains, in the google.com domain also, such as
+ www.google.com or mail.google.com. But it would not
+ match www.google.de! So, apparently, we have these two actions
+ defined as exceptions to the general rules at the top somewhere in the lower
+ part of our default.action file, and
+ google.com is referenced somewhere in these latter sections.
- These are the default actions we have enabled. But we can define additional
- actions that would be exceptions to these general rules, and then list
- specific URLs that these exceptions would apply to. Last match wins.
- Just below this then are two explicit matches for .google.com.
- The first is negating our various cookie blocking actions (i.e. we will allow
- cookies here). The second is allowing fast-redirects. Note
- that there is a leading dot here -- .google.com. This will
- match any hosts and sub-domains, in the google.com domain also, such as
- www.google.com. So, apparently, we have these actions defined
- somewhere in the lower part of our actions file, and
- google.com is referenced in these sections.
-
+ Then, for our user.action 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
+ previously processed files, such as default.action.
+ user.action typically has the last word. This is the
+ best place to put hard and fast exceptions,
- And now we pull it altogether in the bottom section and summarize how
+ And finally we pull it all together in the bottom section and summarize how
Privoxy is applying all its actions
to google.com:
@@ -5026,16 +8575,75 @@ Requests
Final results:
-
- -add-header -block -deanimate-gifs -downgrade -fast-redirects
- +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
- +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
- +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
- -hide-user-agent -image +image-blocker{blank} -limit-connect +no-compression
- -no-cookies-keep -no-cookies-read -no-cookies-set +no-popups -vanilla-wafer
- -wafer
-
-
+
+ -add-header
+ -block
+ -client-header-filter{hide-tor-exit-notation}
+ -content-type-overwrite
+ -crunch-client-header
+ -crunch-if-none-match
+ -crunch-incoming-cookies
+ -crunch-outgoing-cookies
+ -crunch-server-header
+ +deanimate-gifs {last}
+ -downgrade-http-version
+ -fast-redirects
+ -filter {js-events}
+ -filter {content-cookies}
+ -filter {all-popups}
+ -filter {banners-by-link}
+ -filter {tiny-textforms}
+ -filter {frameset-borders}
+ -filter {demoronizer}
+ -filter {shockwave-flash}
+ -filter {quicktime-kioskmode}
+ -filter {fun}
+ -filter {crude-parental}
+ -filter {site-specifics}
+ -filter {js-annoyances}
+ -filter {html-annoyances}
+ +filter {refresh-tags}
+ -filter {unsolicited-popups}
+ +filter {img-reorder}
+ +filter {banners-by-size}
+ +filter {webbugs}
+ +filter {jumping-windows}
+ +filter {ie-exploits}
+ -filter {google}
+ -filter {yahoo}
+ -filter {msn}
+ -filter {blogspot}
+ -filter {no-ping}
+ -force-text-mode
+ -handle-as-empty-document
+ -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}
+ -session-cookies-only
+ +set-image-blocker {pattern}
+ -treat-forbidden-connects-like-blocks
+
+
+
+ Notice the only difference here to the previous listing, is to
+ fast-redirects and session-cookies-only,
+ which are activated specifically for this site in our configuration,
+ and thus show in the Final Results.
@@ -5045,24 +8653,25 @@ Requests
- { +block +image }
- .ad.doubleclick.net
-
- { +block +image }
+ { +block }
ad*.
- { +block +image }
- .doubleclick.net
+ { +block }
+ .ad.
-
+ { +block +handle-as-image }
+ .[a-vx-z]*.doubleclick.net
+
- We'll just show the interesting part here, the explicit matches. It is
- matched three different times. Each as an +block +image,
+ We'll just show the interesting part here - the explicit matches. It is
+ matched three different times. Two +block sections,
+ and a +block +handle-as-image,
which is the expanded form of one of our aliases that had been defined as:
- +imageblock. (Aliases are defined in the
- first section of the actions file and typically used to combine more
+ +block-as-image. (Aliases are defined in
+ the first section of the actions file and typically used to combine more
than one action.)
@@ -5072,42 +8681,104 @@ Requests
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 ad.doubleclick.net
- is done here -- as both a +blockand an
- +image. The custom alias +imageblock does this
- for us.
+ is done here -- as both a +block
+ and an
+ +handle-as-image.
+ The custom alias +block-as-image just
+ simplifies the process and make it more readable.
- One last example. Let's try http://www.rhapsodyk.net/adsl/HOWTO/.
- This one is giving us problems. We are getting a blank page. Hmmm...
+ One last example. Let's try http://www.example.net/adsl/HOWTO/.
+ This one is giving us problems. We are getting a blank page. Hmmm ...
- Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
-
- { -add-header -block +deanimate-gifs -downgrade +fast-redirects
- +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
- +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
- +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
- -hide-user-agent -image +image-blocker{blank} +no-compression
- +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups
- -vanilla-wafer -wafer }
+ Matches for http://www.example.net/adsl/HOWTO/:
+
+ In file: default.action [ View ][ Edit ]
+
+ {-add-header
+ -block
+ -client-header-filter{hide-tor-exit-notation}
+ -content-type-overwrite
+ -crunch-client-header
+ -crunch-if-none-match
+ -crunch-incoming-cookies
+ -crunch-outgoing-cookies
+ -crunch-server-header
+ +deanimate-gifs
+ -downgrade-http-version
+ +fast-redirects {check-decoded-url}
+ -filter {js-events}
+ -filter {content-cookies}
+ -filter {all-popups}
+ -filter {banners-by-link}
+ -filter {tiny-textforms}
+ -filter {frameset-borders}
+ -filter {demoronizer}
+ -filter {shockwave-flash}
+ -filter {quicktime-kioskmode}
+ -filter {fun}
+ -filter {crude-parental}
+ -filter {site-specifics}
+ -filter {js-annoyances}
+ -filter {html-annoyances}
+ +filter {refresh-tags}
+ -filter {unsolicited-popups}
+ +filter {img-reorder}
+ +filter {banners-by-size}
+ +filter {webbugs}
+ +filter {jumping-windows}
+ +filter {ie-exploits}
+ -filter {google}
+ -filter {yahoo}
+ -filter {msn}
+ -filter {blogspot}
+ -filter {no-ping}
+ -force-text-mode
+ -handle-as-empty-document
+ -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
+ -overwrite-last-modified
+ +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 }
/
- { +block +image }
+ { +block +handle-as-image }
/ads
-
-
+
- Ooops, the /adsl/ is matching /ads! But
- we did not want this at all! Now we see why we get the blank page. We could
- now add a new action below this that explicitly does not
- block (-block) pages with adsl. There are various ways to
- handle such exceptions. Example:
+ Ooops, the /adsl/ is matching /ads 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
+ 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
+ user.action file) that explicitly
+ un blocks (
+ {-block}) paths with
+ adsl in them (remember, last match in the configuration
+ wins). There are various ways to handle such exceptions. Example:
@@ -5115,13 +8786,14 @@ Requests
{ -block }
/adsl
-
-
+
- Now the page displays ;-) Be sure to flush your browser's caches when
- making such changes. Or, try using Shift+Reload.
+ 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 Shift+Reload.
@@ -5132,55 +8804,94 @@ Requests
- { -block }
- /adsl
-
-
+ { +block +handle-as-image }
+ /ads
+
- That actually was very telling and pointed us quickly to where the problem
+ 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
- rules in the first section is causing the problem. This would require some
- guesswork, and maybe a little trial and error to isolate the offending rule.
- One likely cause would be one of the {+filter} actions. Try
- adding the URL for the site to one of aliases that turn off +filter:
+ rules in the first section of default.action 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
+ +filter actions.
+ These tend to be harder to troubleshoot.
+ Try adding the URL for the site to one of aliases that turn off
+ +filter:
- {shop}
+ { shop }
.quietpc.com
.worldpay.com # for quietpc.com
.jungle.com
.scan.co.uk
.forbes.com
-
-
+
- {shop} is an alias that expands to
- { -filter -no-cookies -no-cookies-keep }. Or you could do
- your own exception to negate filtering:
+ { shop } is an alias that expands to
+ { -filter -session-cookies-only }.
+ Or you could do your own exception to negate filtering:
- {-filter}
+ { -filter }
+ # Disable ALL filter actions for sites in this section
.forbes.com
-
-
+ developer.ibm.com
+ localhost
+
+
+
+
+ This would turn off all filtering for these sites. This is best
+ put in user.action, 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
+ automatically in the scope of the action.
+
+
+
+ Images that are inexplicably being blocked, may well be hitting the
++filter{banners-by-size}
+ rule, which assumes
+ that images of certain sizes are ad banners (works well
+ most of the time since these tend to be standardized).
+
+
+
+ { fragile } 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.
+
+
+
+
+ { fragile }
+ # Handle with care: easy to break
+ mail.google.
+ mybank.example.com
+
- {fragile} is an alias that disables most actions. This can be
- used as a last resort for problem sites. Remember to flush caches! If this
- still does not work, you will have to go through the remaining actions one by
- one to find which one(s) is causing the problem.
+ Remember to flush caches! Note that the
+ mail.google reference lacks the TLD portion (e.g.
+ .com). This will effectively match any TLD with
+ google in it, such as mail.google.de.,
+ just as an example.
+
+
+ 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.
@@ -5204,10 +8915,458 @@ Requests
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., 59
- Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ 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.54 2008/01/19 17:52:39 hal9
+ Re-commit to fix various minor issues for new release.
+
+ Revision 2.53 2008/01/19 15:03:05 hal9
+ Doc sources tagged for 3.0.8 release.
+
+ Revision 2.52 2008/01/17 01:49:51 hal9
+ Change copyright notice for docs s/2007/2008/. All these will be rebuilt soon
+ enough.
+
+ Revision 2.51 2007/12/23 16:48:24 fabiankeil
+ Use more precise example descriptions for the mysterious domain patterns.
+
+ Revision 2.50 2007/12/08 12:44:36 fabiankeil
+ - Remove already commented out pre-3.0.7 changes.
+ - Update the "new log defaults" paragraph.
+
+ Revision 2.49 2007/12/06 18:21:55 fabiankeil
+ Update hide-forwarded-for-headers description.
+
+ Revision 2.48 2007/11/24 19:07:17 fabiankeil
+ - Mention request rewriting.
+ - Enable the conditional-forge paragraph.
+ - Minor rewordings.
+
+ Revision 2.47 2007/11/18 14:59:47 fabiankeil
+ A few "Note to Upgraders" updates.
+
+ Revision 2.46 2007/11/17 17:24:44 fabiankeil
+ - Use new action defaults.
+ - Minor fixes and rewordings.
+
+ Revision 2.45 2007/11/16 11:48:46 hal9
+ Fix one typo, and add a couple of small refinements.
+
+ Revision 2.44 2007/11/15 03:30:20 hal9
+ Results of spell check.
+
+ Revision 2.43 2007/11/14 18:45:39 fabiankeil
+ - Mention some more contributors in the "New in this Release" list.
+ - Minor rewordings.
+
+ Revision 2.42 2007/11/12 03:32:40 hal9
+ Updates for "What's New" and "Notes to Upgraders". Various other changes in
+ preparation for new release. User Manual is almost ready.
+
+ Revision 2.41 2007/11/11 16:32:11 hal9
+ This is primarily syncing What's New and Note to Upgraders sections with the many
+ new features and changes (gleaned from memory but mostly from ChangeLog).
+
+ Revision 2.40 2007/11/10 17:10:59 fabiankeil
+ In the first third of the file, mention several times that
+ the action editor is disabled by default in 3.0.7 beta and later.
+
+ Revision 2.39 2007/11/05 02:34:49 hal9
+ Various changes in preparation for the upcoming release. Much yet to be done.
+
+ Revision 2.38 2007/09/22 16:01:42 fabiankeil
+ Update embedded show-url-info output.
+
+ Revision 2.37 2007/08/27 16:09:55 fabiankeil
+ Fix pre-chroot-nslookup description which I failed to
+ copy and paste properly. Reported by Stephen Gildea.
+
+ Revision 2.36 2007/08/26 16:47:14 fabiankeil
+ Add Stephen Gildea's pre-chroot-nslookup patch [#1276666],
+ extensive comments moved to user manual.
+
+ Revision 2.35 2007/08/26 14:59:49 fabiankeil
+ Minor rewordings and fixes.
+
+ Revision 2.34 2007/08/05 15:19:50 fabiankeil
+ - Don't claim HTTP/1.1 compliance.
+ - Use $ in some of the path pattern examples.
+ - Use a hide-user-agent example argument without
+ leading and trailing space.
+ - Make it clear that the cookie actions work with
+ HTTP cookies only.
+ - Rephrase the inspect-jpegs text to underline
+ that it's only meant to protect against a single
+ exploit.
+
+ Revision 2.33 2007/07/27 10:57:35 hal9
+ Add references for user-agent strings for hide-user-agenet
+
+ Revision 2.32 2007/06/07 12:36:22 fabiankeil
+ Apply Roland's 29_usermanual.dpatch to fix a bunch
+ of syntax errors I collected over the last months.
+
+ Revision 2.31 2007/06/02 14:01:37 fabiankeil
+ Start to document forward-override{}.
+
+ Revision 2.30 2007/04/25 15:10:36 fabiankeil
+ - Describe installation for FreeBSD.
+ - Start to document taggers and tag patterns.
+ - Don't confuse devils and daemons.
+
+ Revision 2.29 2007/04/05 11:47:51 fabiankeil
+ Some updates regarding header filtering,
+ handling of compressed content and redirect's
+ support for pcrs commands.
+
+ Revision 2.28 2006/12/10 23:42:48 hal9
+ Fix various typos reported by Adam P. Thanks.
+
+ Revision 2.27 2006/11/14 01:57:47 hal9
+ Dump all docs prior to 3.0.6 release. Various minor changes to faq and user
+ manual.
+
+ Revision 2.26 2006/10/24 11:16:44 hal9
+ Add new filters.
+
+ Revision 2.25 2006/10/18 10:50:33 hal9
+ Add note that since filters are off in Cautious, compression is ON. Turn off
+ compression to make filters work on all sites.
+
+ Revision 2.24 2006/10/03 11:13:54 hal9
+ More references to the new filters. Include html this time around.
+
+ Revision 2.23 2006/10/02 22:43:53 hal9
+ Contains new filter definitions from Fabian, and few other miscellaneous
+ touch-ups.
+
+ Revision 2.22 2006/09/22 01:27:55 hal9
+ Final commit of probably various minor changes here and there. Unless
+ something changes this should be ready for pending release.
+
+ Revision 2.21 2006/09/20 03:21:36 david__schmidt
+ Just the tiniest tweak. Wafer thin!
+
+ Revision 2.20 2006/09/10 14:53:54 hal9
+ Results of spell check. User manual has some updates to standard.actions file
+ info.
+
+ Revision 2.19 2006/09/08 12:19:02 fabiankeil
+ Adjust hide-if-modified-since example values
+ to reflect the recent changes.
+
+ Revision 2.18 2006/09/08 02:38:57 hal9
+ Various changes:
+ -Fix a number of broken links.
+ -Migrate the new Windows service command line options, and reference as
+ needed.
+ -Rebuild so that can be used with the new "user-manual" config capabilities.
+ -Etc.
+
+ Revision 2.17 2006/09/05 13:25:12 david__schmidt
+ Add Windows service invocation stuff (duplicated) in FAQ and in user manual under Windows startup. One probably ought to reference the other.
+
+ Revision 2.16 2006/09/02 12:49:37 hal9
+ Various small updates for new actions, filterfiles, etc.
+
+ Revision 2.15 2006/08/30 11:15:22 hal9
+ More work on the new actions, especially filter-*-headers, and What's New
+ section. User Manual is close to final form for 3.0.4 release. Some tinkering
+ and proof reading left to do.
+
+ Revision 2.14 2006/08/29 10:59:36 hal9
+ Add a "Whats New in this release" Section. Further work on multiple filter
+ files, and assorted other minor changes.
+
+ Revision 2.13 2006/08/22 11:04:59 hal9
+ Silence warnings and errors. This should build now. New filters were only
+ stubbed in. More to be done.
+
+ Revision 2.12 2006/08/14 08:40:39 fabiankeil
+ Documented new actions that were part of
+ the "minor Privoxy improvements".
+
+ Revision 2.11 2006/07/18 14:48:51 david__schmidt
+ Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
+ with what was really the latest development (the v_3_0_branch branch)
+
+ Revision 1.123.2.43 2005/05/23 09:59:10 hal9
+ Fix typo 'loose'
+
+ Revision 1.123.2.42 2004/12/04 14:39:57 hal9
+ Fix two minor typos per bug SF report.
+
+ Revision 1.123.2.41 2004/03/23 12:58:42 oes
+ Fixed an inaccuracy
+
+ Revision 1.123.2.40 2004/02/27 12:48:49 hal9
+ Add comment re: redirecting to local file system for set-image-blocker may
+ is dependent on browser.
+
+ Revision 1.123.2.39 2004/01/30 22:31:40 oes
+ Added a hint re bookmarklets to Quickstart section
+
+ Revision 1.123.2.38 2004/01/30 16:47:51 oes
+ Some minor clarifications
+
+ Revision 1.123.2.37 2004/01/29 22:36:11 hal9
+ Updates for no longer filtering text/plain, and demoronizer default settings,
+ and copyright notice dates.
+
+ Revision 1.123.2.36 2003/12/10 02:26:26 hal9
+ Changed the demoronizer filter description.
+
+ Revision 1.123.2.35 2003/11/06 13:36:37 oes
+ Updated link to nightly CVS tarball
+
+ Revision 1.123.2.34 2003/06/26 23:50:16 hal9
+ Add a small bit on filtering and problems re: source code being corrupted.
+
+ Revision 1.123.2.33 2003/05/08 18:17:33 roro
+ Use apt-get instead of dpkg to install Debian package, which is more
+ solid, uses the correct and most recent Debian version automatically.
+
+ Revision 1.123.2.32 2003/04/11 03:13:57 hal9
+ Add small note about only one filterfile (as opposed to multiple actions
+ files).
+
+ Revision 1.123.2.31 2003/03/26 02:03:43 oes
+ Updated hard-coded copyright dates
+
+ Revision 1.123.2.30 2003/03/24 12:58:56 hal9
+ Add new section on Predefined Filters.
+
+ Revision 1.123.2.29 2003/03/20 02:45:29 hal9
+ More problems with \-\-chroot causing markup problems :(
+
+ Revision 1.123.2.28 2003/03/19 00:35:24 hal9
+ Manual edit of revision log because 'chroot' (even inside a comment) was
+ causing Docbook to hang here (due to double hyphen and the processor thinking
+ it was a comment).
+
+ Revision 1.123.2.27 2003/03/18 19:37:14 oes
+ s/Advanced|Radical/Adventuresome/g to avoid complaints re fun filter
+
+ Revision 1.123.2.26 2003/03/17 16:50:53 oes
+ Added documentation for new chroot option
+
+ Revision 1.123.2.25 2003/03/15 18:36:55 oes
+ Adapted to the new filters
+
+ Revision 1.123.2.24 2002/11/17 06:41:06 hal9
+ Move default profiles table from FAQ to U-M, and other minor related changes.
+ Add faq on cookies.
+
+ Revision 1.123.2.23 2002/10/21 02:32:01 hal9
+ Updates to the user.action examples section. A few new ones.
+
+ Revision 1.123.2.22 2002/10/12 00:51:53 hal9
+ Add demoronizer to filter section.
+
+ Revision 1.123.2.21 2002/10/10 04:09:35 hal9
+ s/Advanced/Radical/ and added very brief note.
+
+ Revision 1.123.2.20 2002/10/10 03:49:21 hal9
+ Add notes to session-cookies-only and Quickstart about pre-existing
+ cookies. Also, note content-cookies work differently.
+
+ Revision 1.123.2.19 2002/09/26 01:25:36 hal9
+ More explanation on Privoxy patterns, more on content-cookies and SSL.
+
+ Revision 1.123.2.18 2002/08/22 23:47:58 hal9
+ Add 'Documentation' to Privoxy Menu shot in Configuration section to match
+ CGIs.
+
+ Revision 1.123.2.17 2002/08/18 01:13:05 hal9
+ Spell checked (only one typo this time!).
+
+ Revision 1.123.2.16 2002/08/09 19:20:54 david__schmidt
+ Update to Mac OSX startup script name
+
+ Revision 1.123.2.15 2002/08/07 17:32:11 oes
+ Converted some internal links from ulink to link for PDF creation; no content changed
+
+ Revision 1.123.2.14 2002/08/06 09:16:13 oes
+ Nits re: actions file download
+
+ Revision 1.123.2.13 2002/08/02 18:23:19 g_sauthoff
+ Just 2 small corrections to the Gentoo sections
+
+ Revision 1.123.2.12 2002/08/02 18:17:21 g_sauthoff
+ Added 2 Gentoo sections
+
+ Revision 1.123.2.11 2002/07/26 15:20:31 oes
+ - Added version info to title
+ - Added info on new filters
+ - Revised parts of the filter file tutorial
+ - Added info on where to get updated actions files
+
+ Revision 1.123.2.10 2002/07/25 21:42:29 hal9
+ Add brief notes on not proxying non-HTTP protocols.
+
+ Revision 1.123.2.9 2002/07/11 03:40:28 david__schmidt
+
+ Updated Mac OSX sections due to installation location change
+
+ Revision 1.123.2.8 2002/06/09 16:36:32 hal9
+ Clarifications on filtering and MIME. Hardcode 'latest release' in index.html.
+
+ Revision 1.123.2.7 2002/06/09 00:29:34 hal9
+ Touch ups on filtering, in actions section and Anatomy.
+
+ Revision 1.123.2.6 2002/06/06 23:11:03 hal9
+ Fix broken link. Linkchecked all docs.
+
+ Revision 1.123.2.5 2002/05/29 02:01:02 hal9
+ This is break out of the entire config section from u-m, so it can
+ eventually be used to generate the comments, etc in the main config file
+ so that these are in sync with each other.
+
+ Revision 1.123.2.4 2002/05/27 03:28:45 hal9
+ Ooops missed something from David.
+
+ Revision 1.123.2.3 2002/05/27 03:23:17 hal9
+ Fix FIXMEs for OS2 and OSX startup. Fix Redhat typos (should be Red Hat).
+ That's a wrap, I think.
+
+ Revision 1.123.2.2 2002/05/26 19:02:09 hal9
+ Move Amiga stuff around to take of FIXME in start up section.
+
+ Revision 1.123.2.1 2002/05/26 17:04:25 hal9
+ -Spellcheck, very minor edits, and sync across branches
+
+ Revision 1.123 2002/05/24 23:19:23 hal9
+ Include new image (Proxy setup). More fun with guibutton.
+ Minor corrections/clarifications here and there.
+
+ Revision 1.122 2002/05/24 13:24:08 oes
+ Added Bookmarklet for one-click pre-filled access to show-url-info
+
+ Revision 1.121 2002/05/23 23:20:17 oes
+ - Changed more (all?) references to actions to the
+ style.
+ - Small fixes in the actions chapter
+ - Small clarifications in the quickstart to ad blocking
+ - Removed from s since the new doc CSS
+ renders them red (bad in TOC).
+
+ Revision 1.120 2002/05/23 19:16:43 roro
+ Correct Debian specials (installation and startup).
+
+ Revision 1.119 2002/05/22 17:17:05 oes
+ Added Security hint
+
+ Revision 1.118 2002/05/21 04:54:55 hal9
+ -New Section: Quickstart to Ad Blocking
+ -Reformat Actions Anatomy to match new CGI layout
+
+ Revision 1.117 2002/05/17 13:56:16 oes
+ - Reworked & extended Templates chapter
+ - Small changes to Regex appendix
+ - #included authors.sgml into (C) and hist chapter
+
+ Revision 1.116 2002/05/17 03:23:46 hal9
+ Fixing merge conflict in Quickstart section.
+
+ Revision 1.115 2002/05/16 16:25:00 oes
+ Extended the Filter File chapter & minor fixes
+
+ Revision 1.114 2002/05/16 09:42:50 oes
+ More ulink->link, added some hints to Quickstart section
+
+ Revision 1.113 2002/05/15 21:07:25 oes
+ Extended and further commented the example actions files
+
+ Revision 1.112 2002/05/15 03:57:14 hal9
+ Spell check. A few minor edits here and there for better syntax and
+ clarification.
+
+ Revision 1.111 2002/05/14 23:01:36 oes
+ Fixing the fixes
+
+ Revision 1.110 2002/05/14 19:10:45 oes
+ Restored alphabetical order of actions
+
+ Revision 1.109 2002/05/14 17:23:11 oes
+ Renamed the prevent-*-cookies actions, extended aliases section and moved it before the example AFs
+
+ Revision 1.108 2002/05/14 15:29:12 oes
+ Completed proofreading the actions chapter
+
+ Revision 1.107 2002/05/12 03:20:41 hal9
+ Small clarifications for 127.0.0.1 vs localhost for listen-address since this
+ apparently an important distinction for some OS's.
+
+ Revision 1.106 2002/05/10 01:48:20 hal9
+ This is mostly proposed copyright/licensing additions and changes. Docs
+ are still GPL, but licensing and copyright are more visible. Also, copyright
+ changed in doc header comments (eliminate references to JB except FAQ).
+
+ Revision 1.105 2002/05/05 20:26:02 hal9
+ Sorting out license vs copyright in these docs.
+
+ Revision 1.104 2002/05/04 08:44:45 swa
+ bumped version
+
+ Revision 1.103 2002/05/04 00:40:53 hal9
+ -Remove the TOC first page kludge. It's fixed proper now in ldp.dsl.in.
+ -Some minor additions to Quickstart.
+
+ Revision 1.102 2002/05/03 17:46:00 oes
+ Further proofread & reactivated short build instructions
+
+ Revision 1.101 2002/05/03 03:58:30 hal9
+ Move the user-manual config directive to top of section. Add note about
+ Privoxy needing read permissions for configs, and write for logs.
+
+ Revision 1.100 2002/04/29 03:05:55 hal9
+ Add clarification on differences of new actions files.
+
+ Revision 1.99 2002/04/28 16:59:05 swa
+ more structure in starting section
+
+ Revision 1.98 2002/04/28 05:43:59 hal9
+ This is the break up of configuration.html into multiple files. This
+ will probably break links elsewhere :(
+
+ Revision 1.97 2002/04/27 21:04:42 hal9
+ -Rewrite of Actions File example.
+ -Add section for user-manual directive in config.
+
+ Revision 1.96 2002/04/27 05:32:00 hal9
+ -Add short section to Filter Files to tie in with +filter action.
+ -Start rewrite of examples in Actions Examples (not finished).
+
+ Revision 1.95 2002/04/26 17:23:29 swa
+ bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot
+
+ Revision 1.94 2002/04/26 05:24:36 hal9
+ -Add most of Andreas suggestions to Chain of Events section.
+ -A few other minor corrections and touch up.
+
+ Revision 1.92 2002/04/25 18:55:13 hal9
+ More catchups on new actions files, and new actions names.
+ Other assorted cleanups, and minor modifications.
+
+ Revision 1.91 2002/04/24 02:39:31 hal9
+ Add 'Chain of Events' section.
+
+ Revision 1.90 2002/04/23 21:41:25 hal9
+ Linuxconf is deprecated on RH, substitute chkconfig.
+
+ Revision 1.89 2002/04/23 21:05:28 oes
+ Added hint for startup on Red Hat
+
+ Revision 1.88 2002/04/23 05:37:54 hal9
+ Add AmigaOS install stuff.
+
+ Revision 1.87 2002/04/23 02:53:15 david__schmidt
+ Updated OSX installation section
+ Added a few English tweaks here an there
+
Revision 1.86 2002/04/21 01:46:32 hal9
Re-write actions section.