X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=6b7a29646da8482122abb8daec134955c929eab7;hp=b10f1e9bde14b5ffe358c25cfad437924aefa725;hb=86c44446839fd2f9c1b0a28c2bac147ab51fb2a5;hpb=32398a73006575190e5b75062bb79c690fe736da
diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index b10f1e9b..6b7a2964 100644
--- a/doc/source/user-manual.sgml
+++ b/doc/source/user-manual.sgml
@@ -1,5 +1,5 @@
+
@@ -8,7 +8,8 @@
-
+
+
@@ -17,6 +18,7 @@
+
]>
+
+ Privoxy Developers
+
+
+
+$Id: user-manual.sgml,v 1.109 2002/05/14 17:23:11 oes Exp $
+
+
-
-
-
- By: Privoxy Developers
-
-
-
+
@@ -71,7 +95,7 @@
The user manual gives users information on how to install, configure and use
Privoxy Contact section on how to
contact the developers.
-
+
@@ -92,14 +116,6 @@
-
-Introduction
This documentation is included with the current &p-status; version of
@@ -123,15 +139,13 @@
]]>
-
-New Features
+Features
In addition to Internet Junkbuster's traditional
features of ad and banner blocking and cookie management,
Privoxy provides new features:
-
&newfeatures;
@@ -149,53 +163,52 @@
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 .
-
-
-
- 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.
+ Privoxy Project
+ Page .
-
- &supported;
-
-
-
-Binary Packages
-
Note: If you have a previous Junkbuster or
Privoxy installation on your system, you
- will either need to remove it, or that might be done by the setup
- procedure. (See below for your platform).
-
-
-
+ will need to remove it. Some platforms do this for you as part
+ of their installation procedure. (See below for your platform).
In any case be sure to backup your old configuration
- if it is valuable to you. In that case, also see the
-
+
+Binary Packages
- How to install the binary packages depends on your operating system:
+How to install the binary packages depends on your operating system:
Red Hat and SuSE RPMs
- RPMs can be installed with rpm -Uvh <name-of-rpm.rpm> ,
+ RPMs can be installed with rpm -Uvh privoxy-&p-version;-1.rpm ,
and will use /etc/privoxy for the location
of configuration files.
- Note that if you have a Junkbuster RPM installed
+ 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. Note that SuSE will
+automatically start Privoxy in the boot process.
+
+
+
+ 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.
+
+
+
+ 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 .
@@ -214,7 +227,9 @@
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. We do not
+ use the registry of Windows.
Junkbuster and / or
Privoxy are left on your
- system.
+ system. You can do this by
@@ -254,14 +269,34 @@
Max OSX
- FIXME.
+ 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 bring-up via
+ /System/Library/StartupItems/Privoxy .
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.
+
+
+ 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).
Building from Source
+
+ The most convenient way to obtain the Privoxy sources
+ is to download the source tarball from our 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.
+
+
&buildsource;
+
Quickstart to Using <application>Privoxy</application>
-
-
-
+
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).
+ There are very significant changes from earlier
+ Junkbuster versions to the current
+ Privoxy . The number, names, syntax, and
+ purposes of configuration files have substantially changed.
+ Junkbuster 2.0.x configuration
+ files will not migrate, Junkbuster 2.9.x
+ and Privoxy configurations will need to be
+ ported. The functionalities of the old blockfile ,
+ cookiefile and imagelist
+ are now combined into the actions
+ files
default.action , is the main actions file. Local
+ exceptions should best be put into user.action .
- 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.
+ A filter file
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 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
+ to the new actions files, 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.
@@ -345,9 +394,10 @@
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.
+ configuration is in the actions
+ files . It is strongly recommended to become familiar with the new
+ actions concept below, before modifying these files. Locally defined rules
+ should go into user.action .
@@ -361,18 +411,92 @@
+
-
+
+Quickstart to Using <application>Privoxy</application>
+
+
+
+
+
+ If upgrading, please back up any configuration files. See
+ the
+
+
+
+ Install Privoxy . See the
+
+
+
+
+ Start Privoxy , if the installation program has
+ not done this already. See the section Privoxy .
+
+
+
+
+
+ Set your browser to use Privoxy as HTTP and HTTPS
+ proxy by setting the proxy configuration for address of
+ 127.0.0.1 and port 8118 .
+ (Junkbuster and earlier versions of
+ Privoxy used port 8000.) See the section Privoxy .
+
+
+
+
+
+ Flush your browser's caches, to remove any cached ad images.
+
+
+
+
+
+ Enjoy surfing with enhanced comfort and privacy. You may want to customize the
+ user.action file to
+ personalize your new browsing experience. See the
+
+
+
+
+ If you experience problems with sites that misbehave
, see
+ the
+
+
+
+
+ Please see the section
+
+
+
+
+
+
+
Starting <application>Privoxy</application>
- 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 required
- configuration that must be done!
+ 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
+ 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!
@@ -382,7 +506,7 @@
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.
+ 127.0.0.1, Port: 8118). Include if HTTPS proxy support too.
@@ -392,74 +516,124 @@
Privoxy !
-
Privoxy is typically started by specifying the
- main configuration file to be used on the command line. Example Unix startup
- command:
+ 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 .
+
+RedHat and Debian
+
+We use a script. Note that RedHat does not start Privoxy upon booting per
+default. It will use the file /etc/privoxy/config as its
+main configuration file. FIXME: Debian??
+
-
- # /usr/sbin/privoxy /etc/privoxy/config
-
-
+ # /etc/rc.d/init.d/privoxy start
+
+
+
+
+
+SuSE
+
+We use a script. It will use the file /etc/privoxy/config
+as its main configuration file. Note that SuSE starts Privoxy upon booting
+your PC.
+
+
+ # rcprivoxy start
+
+
+
+
+
+Windows
+
+Click on the Privoxy 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 Privoxy upon booting you PC.
+
+
+
+Solaris, NetBSD, FreeBSD, HP-UX and others
- See
+
+
+ # /usr/sbin/privoxy /etc/privoxy/config
+
+
+
+
+OS/2
- An init script is provided for SuSE and Red Hat.
+FIXME.
+
+
+MAX OSX
- For for SuSE: rcprivoxy start
+FIXME.
+
+
+
+AmigaOS
- For Red Hat: /etc/rc.d/init.d/privoxy start
+FIXME.
+
+
@@ -612,7 +786,6 @@
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.
-
@@ -629,26 +802,36 @@
-
-
-
-Please choose from the following options:
+
+
+
+ Privoxy Menu
- * 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
+
+
+ ▪ 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
+
+
+
+
-
-
- 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
+ This should be self-explanatory. Note the first item leads to an editor for the
+ 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.
@@ -659,7 +842,8 @@ Please choose from the following options:
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
+ 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 Privoxy with one click from
your browser.
@@ -674,7 +858,7 @@ Please choose from the following options:
-
+
Configuration Files Overview
For Unix, *BSD and Linux, all configuration files are located in
@@ -686,9 +870,9 @@ Please choose from the following options:
- 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):
+ 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:
@@ -696,31 +880,48 @@ Please choose from the following options:
- The main configuration file is named config
+ The config
on Linux, Unix, BSD, OS/2, and AmigaOS and config.txt
- on Windows.
+ on Windows. This is a required file.
- 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 .)
+ default.action (the main 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 propably want
+ to define sooner or later) are probably best applied in
+ user.action , where you can preserve them across
+ upgrades. standard.action is 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.
- 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.
+ default.filter (the
@@ -738,7 +939,7 @@ Please choose from the following options:
- default.action and default.filter
+ The actions files and default.filter
can use Perl style
@@ -761,13 +962,17 @@ Please choose from the following options:
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.
@@ -780,8 +985,7 @@ Please choose from the following options:
- confdir /etc/privoxy
-
+ confdir /etc/privoxy
@@ -807,18 +1011,23 @@ Please choose from the following options:
-
+
Configuration and Log File Locations
Privoxy can (and normally does) use a number of
- other files for additional configuration and logging.
+ other files for additional configuration, help and logging.
This section of the configuration file tells Privoxy
where to find those other files.
+
+ The user running Privoxy, must have read permission for all
+ configuration files, and write permission to any files that would
+ be modified, such as log files.
+
-confdir
+confdir
@@ -861,10 +1070,10 @@ Please choose from the following options:
-
-logdir
+logdir
@@ -903,36 +1112,51 @@ Please choose from the following options:
-actionsfile
+
+
+actionsfile
+
+
+
+
+
Specifies:
- The actions file to use
+ The
Type of value:
- File name, relative to confdir
+ File name, relative to confdir , without the .action suffix
Default value:
- default.action (Unix) or default.action.txt (Windows)
+
+
+ standard # Internal purposes, no editing recommended
+
+ default # Main actions file
+
+ user # User customizations
+
Effect if unset:
- No action is taken at all. Simple neutral proxying.
+ No actions are taken at all. Simple neutral proxying.
@@ -940,25 +1164,33 @@ Please choose from the following options:
Notes:
- There is no point in using Privoxy without
- an actions file. There are three different actions files included in the
- distribution, with varying degrees of aggressiveness:
- default.action , intermediate.action and
- advanced.action .
+ Multiple actionsfile lines are permitted, and are in fact recommended!
+
+
+ The default values include standard.action, which is used for internal
+ purposes and should be loaded, default.action, which is the
+ main
actions file maintained by the developers, and
+ user.action , where you can make your personal additions.
+
+
+ Actions files are where all the per site and per URL configuration is done for
+ ad blocking, cookie management, privacy considerations, etc.
+ There is no point in using Privoxy without at
+ least one actions file.
- filterfile
+
+filterfile
+
Specifies:
- The filter file to use
+ The
@@ -980,7 +1212,7 @@ Please choose from the following options:
No textual content filtering takes place, i.e. all
+filter{name }
- actions in the actions file are turned off
+ actions in the actions files are turned neutral.
@@ -998,9 +1230,9 @@ Please choose from the following options:
- logfile
+logfile
@@ -1056,12 +1288,16 @@ Please choose from the following options:
the effect that cron.daily will automatically archive, gzip, and empty the
log, when it exceeds 1M size.
+
+ Any log files must be writable by whatever user Privoxy
+ is being run as (default on UNIX, user id is privoxy
).
+
-jarfile
+jarfile
@@ -1101,10 +1337,9 @@ Please choose from the following options:
-trustfile
+
+trustfile
Specifies:
@@ -1156,9 +1391,8 @@ Please choose from the following options:
-
@@ -1166,7 +1400,7 @@ Please choose from the following options:
-
+
Local Set-up Documentation
@@ -1175,7 +1409,73 @@ Please choose from the following options:
you, what you block and why you do that, your policies etc.
-trust-info-url
+user-manual
+
+
+ Specifies:
+
+
+ Location of the Privoxy User Manual.
+
+
+
+
+ Type of value:
+
+ A fully qualified URI
+
+
+
+ Default value:
+
+ Unset
+
+
+ Effect if unset:
+
+
+ http://www.privoxy.org/version /user-manual/
+ will be used, where version is the Privoxy version.
+
+
+
+
+ Notes:
+
+
+ The User Manual URI is used for help links from some of the internal CGI pages.
+ The manual itself is normally packaged with the binary distributions, so you propably want
+ to set this to a locally installed copy. For multi-user setups, you could provide a copy on
+ a local webserver for all your users and use the corresponding URL here.
+
+
+ Examples:
+
+
+ Unix, in local filesystem:
+
+
+ user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/
+
+
+ Any platform, on local webserver (called local-webserver
):
+
+
+ user-manual http://local-webserver/privoxy-user-manual/
+
+
+
+ If set, this option should be the first option in the config file , because
+ it is used while the config file is being read.
+
+
+
+
+
+trust-info-url
@@ -1225,9 +1525,9 @@ Please choose from the following options:
-
-admin-address
+admin-address
@@ -1269,9 +1569,9 @@ Please choose from the following options:
-proxy-info-url
+proxy-info-url
@@ -1317,14 +1617,14 @@ Please choose from the following options:
-
-
+
Debugging
@@ -1334,7 +1634,7 @@ Please choose from the following options:
command line option when debugging.
-debug
+debug
@@ -1386,7 +1686,7 @@ Please choose from the following options:
debug 1024 # debug kill pop-ups
debug 4096 # Startup banner and warnings.
debug 8192 # Non-fatal errors
-
+
To select multiple debug levels, you can either add them or use
@@ -1411,9 +1711,9 @@ Please choose from the following options:
-
-single-threaded
+single-threaded
@@ -1455,13 +1755,13 @@ Please choose from the following options:
-
+
+
+
Access Control and Security
@@ -1469,7 +1769,7 @@ Please choose from the following options:
of Privoxy 's configuration.
-listen-address
+listen-address
@@ -1487,17 +1787,18 @@ Please choose from the following options:
[IP-Address ]:Port
+
Default value:
- localhost:8118
+ 127.0.0.1:8118
Effect if unset:
- Bind to localhost (127.0.0.1), port 8118. This is suitable and recommended for
+ Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
home users who run Privoxy on the same machine as
their browser.
@@ -1517,7 +1818,7 @@ Please choose from the following options:
If you leave out the IP address, Privoxy will
bind to all interfaces (addresses) on your machine and may become reachable
- from the Internet. In that case, consider using access control lists (acl's)
+ from the Internet. In that case, consider using access control lists (ACL's)
(see ACLs
below), or a firewall.
@@ -1534,14 +1835,14 @@ Please choose from the following options:
listen-address 192.168.0.1:8118
-
+
-
-toggle
+toggle
@@ -1581,7 +1882,7 @@ Please choose from the following options:
proxy. See enable-remote-toggle
below. This is not really useful anymore, since toggling is much easier
via the web
- interface then via editing the conf file.
+ interface than via editing the conf file.
The windows version will only display the toggle icon in the system tray
@@ -1590,10 +1891,10 @@ Please choose from the following options:
-enable-remote-toggle
+enable-remote-toggle
Specifies:
@@ -1647,16 +1948,16 @@ Please choose from the following options:
-enable-edit-actions
+enable-edit-actions
Specifies:
- Whether or not the web-based actions
+ Whether or not the web-based actions
file editor may be used
@@ -1699,9 +2000,13 @@ Please choose from the following options:
-
+ACLs: permit-access and deny-access
+
+
-ACLs: permit-access and deny-access
Specifies:
@@ -1749,8 +2054,9 @@ Please choose from the following options:
Access controls are included at the request of ISPs and systems
administrators, and are not usually needed by individual users .
For a typical home user, it will normally suffice to ensure that
- Privoxy only listens on the localhost or internal (home)
- network address by means of the listen-address option.
+ Privoxy only listens on the localhost
+ (127.0.0.1) or internal (home) network address by means of the
+ listen-address option.
Please see the warnings in the FAQ that this proxy is not intended to be a substitute
@@ -1796,7 +2102,7 @@ Please choose from the following options:
permit-access localhost
-
+
Allow any host on the same class C subnet as www.privoxy.org access to
@@ -1805,7 +2111,7 @@ Please choose from the following options:
permit-access www.privoxy.org/24 www.example.com/32
-
+
Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
@@ -1815,14 +2121,14 @@ Please choose from the following options:
permit-access 192.168.45.64/26
deny-access 192.168.45.73 www.dirty-stuff.example.com
-
+
- buffer-limit
+buffer-limit
@@ -1875,16 +2181,16 @@ Please choose from the following options:
-
+
Forwarding
@@ -1904,7 +2210,7 @@ Please choose from the following options:
supports the SOCKS 4 and SOCKS 4A protocols.
-forward
+forward
Specifies:
@@ -1923,7 +2229,7 @@ Please choose from the following options:
Where target_domain is a domain name pattern (see the
- chapter on domain matching in the actions file),
+ chapter on domain matching in the default.action file),
http_parent is the address of the parent HTTP proxy
as an IP addresses in dotted decimal notation or as a valid DNS name (or .
to denote
no forwarding
, and the optional
@@ -1968,7 +2274,7 @@ Please choose from the following options:
forward .* anon-proxy.example.org:8080
forward :443 .
-
+
Everything goes to our example ISP's caching proxy, except for requests
@@ -1978,14 +2284,18 @@ Please choose from the following options:
forward .*. caching-proxy.example-isp.net:8000
forward .example-isp.net .
-
+
-
+
+
+forward-socks4 and forward-socks4a
+
+
-forward-socks4 and forward-socks4a
Specifies:
@@ -2005,7 +2315,7 @@ Please choose from the following options:
Where target_domain is a domain name pattern (see the
- chapter on domain matching in the actions file),
+ chapter on domain matching in the default.action file),
http_parent and socks_proxy
are IP addresses in dotted decimal notation or valid DNS names (http_parent
may be .
to denote no HTTP forwarding
), and the optional
@@ -2058,7 +2368,7 @@ Please choose from the following options:
forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080
forward .example.com .
-
+
A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
@@ -2066,14 +2376,14 @@ Please choose from the following options:
forward-socks4 .*. socks-gw.example.com:1080 .
-
+
- Advanced Forwarding Examples
+Advanced Forwarding Examples
If you have links to multiple ISPs that provide various special content
@@ -2096,7 +2406,7 @@ Please choose from the following options:
forward .*. .
forward .isp-b.net host-b:8118
-
+
@@ -2107,7 +2417,7 @@ Please choose from the following options:
forward .*. .
forward .isp-a.net host-a:8118
-
+
@@ -2139,8 +2449,7 @@ Please choose from the following options:
always_direct allow ftp
# Forward all the rest to Privoxy
- never_direct allow all
-
+ never_direct allow all
@@ -2148,22 +2457,23 @@ Please choose from the following options:
Squid normally uses port 3128. If unsure consult http_port in squid.conf .
-
+
Windows GUI Options
Privoxy has a number of options specific to the
Windows GUI interface:
+
If activity-animation
is set to 1, the
Privoxy icon will animate when
@@ -2180,6 +2490,7 @@ Please choose from the following options:
+
If log-messages
is set to 1,
Privoxy will log messages to the console
@@ -2196,6 +2507,7 @@ Please choose from the following options:
+
If log-buffer-size
is set to 1, the size of the log buffer,
i.e. the amount of memory used for the log messages displayed in the
@@ -2217,6 +2529,7 @@ Please choose from the following options:
+
log-max-lines is the maximum number of lines held
in the log buffer. See above.
@@ -2232,6 +2545,7 @@ Please choose from the following options:
+
If log-highlight-messages
is set to 1,
Privoxy will highlight portions of the log
@@ -2248,6 +2562,7 @@ Please choose from the following options:
+
The font used in the console window:
@@ -2262,6 +2577,7 @@ Please choose from the following options:
+
Font size used in the console window:
@@ -2276,6 +2592,7 @@ Please choose from the following options:
+
show-on-task-bar
controls whether or not
Privoxy will appear as a button on the Task bar
@@ -2292,6 +2609,7 @@ Please choose from the following options:
+
If close-button-minimizes
is set to 1, the Windows close
button will minimize Privoxy instead of closing
@@ -2308,6 +2626,7 @@ Please choose from the following options:
+
The hide-console
option is specific to the MS-Win console
version of Privoxy . If this option is used,
@@ -2319,92 +2638,147 @@ Please choose from the following options:
- #hide-console
+ #hide-console
-
+
-The Actions File
+
+
+
+Actions Files
- The actions file (default.action , formerly:
- actionsfile or ijb.action ) is 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 on which sites (or even parts
- thereof).
-
+ The actions files are used to define what actions
+ Privoxy takes for which URLs, and thus determine
+ 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 three such files included with Privoxy (as of
+ version 2.9.15), with differing purposes:
+
+
+
+
+
+
+ standard.action - is used by the web based editor,
+ to set various pre-defined sets of rules for the default actions section
+ in default.action . These have increasing levels of
+ aggressiveness and have no influence on your browsing unless
+ you select them explicitly in the editor . It is not recommend
+ to edit this file.
+
+
+
+
+ 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 for users everywhere.
+ This is the file that the developers are keeping updated, and making
+ available to users.
+
+
+
+
+ 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.
+
+
+
+
-
- Anything you want can blocked, including ads, banners, or just some obnoxious
- URL that you would rather not see. Cookies can be accepted or rejected, or
- accepted only during the current browser session (i.e. not written to disk),
- content can be modified, JavaScripts tamed, user-tracking fooled, and much more.
- See below for a complete list of available actions.
+
+ The list of actions files to be used are defined in the main configuration
+ file, and are processed in the order they are defined. The content of these
+ can all be viewed and edited from http://config.privoxy.org/show-status .
- An actions file typically has sections. At the top, aliases
are
- defined (discussed below), then the default set of rules which will apply
- universally to all sites and pages. And then below that is generally a lengthy
- set of exceptions to the defined universal policies.
+ An actions file typically has multiple sections. If you want to use
+ aliases
in an actions file, you have to place the (optional)
+ very careful with using such a
+ universal set in user.action or any other actions file after
+ default.action , because it will override the result
+ from consulting any previous file). And then below that,
+ exceptions to the defined universal policies. You can regard
+ user.action as an appendix to default.action ,
+ with the advantage that is a separate file, which makes preserving your
+ personal settings across Privoxy upgrades easier.
+
+
+
+ Actions can be used to block anything you want, including ads, banners, or
+ just some obnoxious URL that you would rather not see. Cookies can be accepted
+ or rejected, or accepted only during the current browser session (i.e. not
+ written to disk), content can be modified, JavaScripts tamed, user-tracking
+ fooled, and much more. See below for a
-
+
Finding the Right Mix
- Note that some actions like cookie suppression or script disabling may
- render some sites unusable, which rely on these techniques to work properly.
- Finding the right mix of actions is not easy and certainly a matter of personal
- taste. In general, it can be said that the more aggressive
- your default settings (in the top section of the actions file) are,
- the more exceptions for trusted
sites you will have to
- make later. If, for example, you want to kill popup windows per default, you'll
- have to make exceptions from that rule for sites that you regularly use
- and that require popups for actually useful content, like maybe your bank,
- favorite shop, or newspaper.
+ Note that some aggressive
your default settings (in the top section of the
+ actions file) are, the more exceptions for trusted
sites you
+ will have to make later. If, for example, you want to kill popup windows per
+ default, you'll have to make exceptions from that rule for sites that you
+ regularly use and that require popups for actually useful content, like maybe
+ your bank, favorite shop, or newspaper.
We have tried to provide you with reasonable rules to start from in the
- distribution actions file. But there is no general rule of thumb on these
+ distribution actions files. But there is no general rule of thumb on these
things. There just are too many variables, and sites are constantly changing.
- Sooner or later you will want to change the rules (and read this chapter).
+ Sooner or later you will want to change the rules (and read this chapter again :).
-
+
-
+
How to Edit
- The easiest way to edit the actions
file is with a browser by
- using our browser-based editor, which is available at http://config.privoxy.org/edit-actions .
+ The easiest way to edit the actions files is with a browser by
+ using our browser-based editor, which can be reached from http://config.privoxy.org/show-status .
+ The editor allows both fine-grained control over every single feature on a
+ per-URL basis, and easy choosing from wholesale sets of defaults like
+ Cautious
, Medium
or Advanced
.
If you prefer plain text editing to GUIs, you can of course also directly edit the
- default.action file.
+ the actions files. Look at default.action which is richly
+ commented.
-
+
-
+
How Actions are Applied to URLs
- The actions file is divided into sections. There are special sections,
- like the alias sections which will be discussed later. For now let's
- concentrate on regular sections: They have a heading line (often split
+ Actions files are divided into sections. There are special sections,
+ like the
sections which will be discussed later. For now
+ let's concentrate on regular sections: They have a heading line (often split
up to multiple lines for readability) which consist of a list of actions,
separated by whitespace and enclosed in curly braces. Below that, there
is a list of URL patterns, each on a separate line.
@@ -2412,14 +2786,18 @@ Please choose from the following options:
To determine which actions apply to a request, the URL of the request is
- compared to all patterns in this file. Every time it matches, the list of
+ compared to all patterns in each action file file. Every time it matches, the list of
applicable actions for the URL is incrementally updated, using the heading
of the section in which the pattern is located. If multiple matches for
- the same URL set the same action differently, the last match wins.
+ the same URL set the same action differently, the last match wins. If not,
+ the effects are aggregated (e.g. a URL might match both the
+ +handle-as-image
+block
- You can trace this process by visiting http://config.privoxy.org/show-url-info .
@@ -2427,10 +2805,10 @@ Please choose from the following options:
More detail on this is provided in the Appendix,
-
+
-
+
Patterns
Generally, a pattern has the form <domain>/<path> ,
@@ -2486,7 +2864,9 @@ Please choose from the following options:
-The Domain Pattern
+
+
+The Domain Pattern
The matching of the domain part offers some flexible options: if the
@@ -2572,9 +2952,13 @@ Please choose from the following options:
-
+
+
+
-The Path Pattern
+
+The Path Pattern
Privoxy uses Perl compatible regular expressions
@@ -2593,7 +2977,8 @@ Please choose from the following options:
Note that the path pattern is automatically left-anchored at the /
,
- i.e. it matches as if it would start with a ^
.
+ i.e. it matches as if it would start with a ^
(regular expression speak
+ for the beginning of a line).
@@ -2605,81 +2990,99 @@ Please choose from the following options:
documents whose path starts with PaTtErN in
exactly this capitalization.
-
+
Actions
- Actions are enabled if preceded with a +
, and disabled if
- preceded with a -
. Actions are invoked by enclosing the
- action name in curly braces (e.g. {+some_action}), followed by a list of
- URLs (or patterns that match URLs) to which the action applies. There are
- three classes of actions:
+ All actions are disabled by default, until they are explicitly enabled
+ somewhere in an actions file. Actions are turned on if preceded with a
+ +
, and turned off if preceded with a -
. So a
+ +action means do that action
, e.g.
+ +block means please block URLs that match the
+ following patterns
, and -block means don't
+ block URLs that match the following patterns, even if +block
+ previously applied.
+
+
+
+
+ Again, actions are invoked by placing them on a line, enclosed in curly braces and
+ separated by whitespace, like in
+ {+some-action -some-other-action{some-parameter}} ,
+ followed by a list of URL patterns, one per line, to which they apply.
+ Together, the actions line and the following pattern lines make up a section
+ of the actions file.
+
+
+
+ There are three classes of actions:
-
- Boolean, i.e the action can only be on
or
- off
. Examples:
-
+ Boolean, i.e the action can only be enabled
or
+ disabled
. Syntax:
+
-
-
-
- {+name} # enable this action
- {-name} # disable this action
-
-
-
+
+ +name # enable action name
+ -name # disable action name
+
+
+ Example: +block
- Parameterized, e.g. +/-hide-user-agent{ Mozilla 1.0 }
,
- where some value is required in order to enable this type of action.
- Examples:
+ Parameterized, where some value is required in order to enable this type of action.
+ Syntax:
-
-
-
- {+name{param}} # enable action and set parameter to param
- {-name} # disable action (parameter
) can be omitted
-
-
-
+
+ +name {param } # enable action and set parameter to param ,
+ # overwriting parameter from previous match if necessary
+ -name # disable action. The parameter can be omitted
+
+
+ Note that if the URL matches multiple positive forms of a parameterized action,
+ the last match wins, i.e. the params from earlier matches are simply ignored.
+
+
+ Example: +hide-user-agent{ Mozilla 1.0 }
-
- Multi-value, e.g. {+/-add-header{Name: value}}
ot
- {+/-wafer{name=value}}
), where some value needs to be defined
- in addition to simply enabling the actino. Examples:
+ Multi-value. These look exactly like parameterized actions,
+ but they behave differently: If the action applies multiple times to the
+ same URL, but with different parameters, all the parameters
+ from all matches are remembered. This is used for actions
+ that can be executed for the same request repeatedly, like adding multiple
+ headers, or filtering through multiple filters. Syntax:
-
-
-
- {+name{param=value}} # enable action and set param
to value
- {-name{param=value}} # remove the parameter param
completely
- {-name} # disable this action totally and remove param too
-
-
-
+
+ +name {param } # enable action and add param to the list of parameters
+ -name {param } # remove the parameter param from the list of parameters
+ # If it was the last one left, disable the action.
+ -name # disable this action completely and remove all parameters from the list
+
+
+ Examples: +add-header{X-Fun-Header: Some text} and
+ +filter{html-annoyances}
@@ -2687,24 +3090,27 @@ Please choose from the following options:
- If nothing is specified in this file, no actions
are taken.
- So in this case Privoxy would just be a
- normal, non-blocking, non-anonymizing proxy. You must specifically
- enable the privacy and blocking features you need (although the
- provided default default.action file will
- give a good starting point).
+ If nothing is specified in any actions file, no actions
are
+ taken. So in this case Privoxy would just be a
+ normal, non-blocking, non-anonymizing proxy. You must specifically enable the
+ privacy and blocking features you need (although the provided default actions
+ files will give a good starting point).
Later defined actions always over-ride earlier ones. So exceptions
- to any rules you make, should come in the latter part of the file. For
- multi-valued actions, the actions are applied in the order they are
- specified.
+ to any rules you make, should come in the latter part of the file (or
+ in a file that is processed later when using multiple actions files). For
+ multi-valued actions, the actions are applied in the order they are specified.
+ Actions files are processed in the order they are defined in
+ config (the default installation has three actions
+ files). It also quite possible for any given URL pattern to match more than
+ one pattern and thus more than one set of actions!
- The list of valid Privoxy actions
are:
+ The list of valid Privoxy actions are:
@@ -2717,46 +3123,45 @@ Please choose from the following options:
-
+
-
-<emphasis>+block</emphasis>
+
+<emphasis>block</emphasis>
- Type:
-
+ Typical use:
- Boolean.
+ Block ads or other obnoxious content
- Typical uses:
+ Effect:
- Used to block a URL from reaching your browser. The URL may be
- anything, but is typically used to block ads or other obnoxious
- content.
+ Requests for URLs to which this action applies are blocked, i.e. the requests are not
+ forwarded to the remote server, but answered locally with a substitute page or image,
+ as determined by the
- Possible values:
+ Type:
+
- N/A
+ Boolean.
-
+
- Example usage:
+ Parameter:
-
- {+block}
- .example.com
- .ads.r.us
-
+ N/A
-
+
Notes:
- Privoxy will display its
- special BLOCKED
page if a URL matches one of the
- blocked patterns. If there is sufficient space, a large red
- banner will appear with a friendly message about why the page
- was blocked, and a way to go there anyway. If there is insufficient
- space a smaller blocked page will appear without the red banner.
- One exception is if the URL matches both +block
- and +image
, then it can be handled by
- +image-blocker
(see below).
+ Privoxy sends a special BLOCKED
page
+ for requests to blocked pages. This page contains links to find out why the request
+ was blocked, and a click-through to the blocked content (the latter only if compiled with the
+ force feature enabled). The BLOCKED
page adapts to the available
+ screen space -- it displays full-blown if space allows, or minaturized and text-only
+ if loaded into a small frame or window. If you are using Privoxy
+ right now, you can take a look at the
+ BLOCKED
+ page
+
+ A very important exception occurs if both
+ block and
+
+ It is important to understand this process, in order
+ to understand how Privoxy deals with
+ ads and other unwanted content.
+
+
+ The blocking
+ banner images and other content through rewriting the relevant URLs in the
+ document's HTML source, so they don't get requested in the first place.
+ Note that this is a totally different technique, and it's easy to confuse the two.
-
-
+
+ Example usage (section):
+
+
+ {+block} # Block and replace with "blocked" page
+.nasty-stuff.example.com
+
+{+block +handle-as-image} # Block and replace with image
+.ad.doubleclick.net
+.ads.r.us
+
+
+
+
+
+
-
-<emphasis>+deanimate-gifs</emphasis>
+
+<emphasis>crunch-incoming-cookies</emphasis>
- Type:
-
+ Typical use:
- Parameterized.
+
+ Prevent the web server from setting any cookies on your system
+
- Typical uses:
+ Effect:
- To stop those annoying, distracting animated GIF images.
+ Deletes any Set-Cookie:
HTTP headers from server replies.
- Possible values:
+ Type:
+
+
+ Boolean.
+
+
+
+
+ Parameter:
- last
or first
+ N/A
- Example usage:
+ Notes:
-
- {+deanimate-gifs{last}}
- .example.com
-
+
+ This action is only concerned with incoming cookies. For
+ outgoing cookies, use
+ both to disable cookies completely.
+
+
+ It makes no sense at all to use this action in conjunction
+ with the
- Notes:
+ Example usage:
- De-animate all animated GIF images, i.e. reduce them to their last frame.
- This will also shrink the images considerably (in bytes, not pixels!). If
- the option first
is given, the first frame of the animation
- is used as the replacement. If last
is given, the last
- frame of the animation is used instead, which probably makes more sense for
- most banner animations, but also has the risk of not showing the entire
- last frame (if it is only a delta to an earlier frame).
+ +crunch-incoming-cookies
-
-
+
+
-
-<emphasis>+downgrade</emphasis>
+
+<emphasis>crunch-outgoing-cookies</emphasis>
- Type:
-
+ Typical use:
- Boolean.
+
+ Prevent the web server from reading any cookies from your system
+
- Typical uses:
+ Effect:
- +downgrade
will downgrade HTTP/1.1 client requests to
- HTTP/1.0 and downgrade the responses as well.
+ Deletes any Cookie:
HTTP headers from client requests.
- Possible values:
+ Type:
+
+
+ Boolean.
+
+
+
+
+ Parameter:
N/A
@@ -2927,686 +3390,794 @@ Please choose from the following options:
- Example usage:
+ Notes:
-
- {+downgrade}
- .example.com
-
+
+ This action is only concerned with outgoing cookies. For
+ incoming cookies, use
+ both to disable cookies completely.
+
+
+ It makes no sense at all to use this action in conjunction
+ with the
- Notes:
+ Example usage:
- Use this action for servers that use HTTP/1.1 protocol features that
- Privoxy doesn't handle well yet. HTTP/1.1 is
- only partially implemented. Default is not to downgrade requests. This is
- an infrequently needed action, and is used to help with problem sites only.
+ +crunch-outgoing-cookies
-
+
+
-
-<emphasis>+fast-redirects</emphasis>
+
+<emphasis>deanimate-gifs</emphasis>
- Type:
-
+ Typical use:
- Boolean.
+ Stop those annoying, distracting animated GIF images.
- Typical uses:
+ Effect:
- The +fast-redirects
action enables interception of
- redirect
requests from one server to another, which
- are used to track users.Privoxy can cut off
- all but the last valid URL in redirect request and send a local redirect
- back to your browser without contacting the intermediate site(s).
+ De-animate GIF animations, i.e. reduce them to their first or last image.
- Possible values:
+ Type:
+
-
- N/A
-
+ Parameterized.
-
+
- Example usage:
+ Parameter:
-
- {+fast-redirects}
- .example.com
-
+
+ last
or first
+
-
+
Notes:
-
- Many sites, like yahoo.com, don't just link to other sites. Instead, they
- will link to some script on their own server, giving the destination as a
- parameter, which will then redirect you to the final target. URLs
- resulting from this scheme typically look like:
- http://some.place/some_script?http://some.where-else .
-
- Sometimes, there are even multiple consecutive redirects encoded in the
- URL. These redirections via scripts make your web browsing more traceable,
- since the server from which you follow such a link can see where you go
- to. Apart from that, valuable bandwidth and time is wasted, while your
- browser ask the server for one redirect after the other. Plus, it feeds
- the advertisers.
+ This will also shrink the images considerably (in bytes, not pixels!). If
+ the option first
is given, the first frame of the animation
+ is used as the replacement. If last
is given, the last
+ frame of the animation is used instead, which probably makes more sense for
+ most banner animations, but also has the risk of not showing the entire
+ last frame (if it is only a delta to an earlier frame).
- This is a normally on feature, and often requires exceptions for sites that
- are sensitive to defeating this mechanism.
+ You can safely use this action with patterns that will also match non-GIF
+ objects, because no attempt will be made at anything that doesn't look like
+ a GIF.
+
+ Example usage:
+
+
+ +deanimate-gifs{last}
+
+
+
-
-
+
-
-<emphasis>+filter</emphasis>
+
+<emphasis>downgrade-http-version</emphasis>
- Type:
-
+ Typical use:
- Parameterized.
+ Work around (very rare) problems with HTTP/1.1
- Typical uses:
+ Effect:
- Apply page filtering as defined by named sections of the
- default.filter file to the specified site(s).
- Filtering
can be any modification of the raw
- page content, including re-writing or deletion.
+ Downgrades HTTP/1.1 client requests and server replies to HTTP/1.0.
- Possible values:
+ Type:
+
+
+ Boolean.
+
+
+
+
+ Parameter:
- +filter
must include the name of one of the section identifiers
- from default.filter (or whatever
- filterfile is specified in config ).
+ N/A
-
- Example usage (from the current default.filter ):
+
+ Notes:
-
-
- +filter{html-annoyances} : Get rid of particularly annoying HTML abuse.
-
-
-
-
- +filter{js-annoyances} : Get rid of particularly annoying JavaScript abuse
-
-
-
-
- +filter{content-cookies} : Kill cookies that come in the HTML or JS content
-
-
-
-
- +filter{popups} : Kill all popups in JS and HTML
-
-
-
-
- +filter{frameset-borders} : Give frames a border and make them resizable
-
-
-
-
- +filter{webbugs} : Squish WebBugs (1x1 invisible GIFs used for user tracking)
-
-
-
-
- +filter{refresh-tags} : Kill automatic refresh tags (for dial-on-demand setups)
-
-
-
-
- +filter{fun} : Text replacements for subversive browsing fun!
-
-
-
-
- +filter{nimda} : Remove Nimda (virus) code.
-
-
-
-
- +filter{banners-by-size} : Kill banners by size (very efficient!)
-
-
-
-
- +filter{shockwave-flash} : Kill embedded Shockwave Flash objects
-
-
-
-
- +filter{crude-parental} : Kill all web pages that contain the words "sex" or "warez"
-
-
+
+ This is a left-over from the time when Privoxy
+ didn't support important HTTP/1.1 features well. It is left here for the
+ unlikely case that you experience HTTP/1.1 related problems with some server
+ out there. Not all (optional) HTTP/1.1 features are supported yet, so there
+ is a chance you might need this action.
+
- Notes:
+ Example usage (section):
-
- This is potentially a very powerful feature! And requires a knowledge
- of regular expressions if you want to roll your own
.
-
-
- Filtering requires buffering the page content, which may appear to
- slow down page rendering since nothing is displayed until all content has
- passed the filters. (It does not really take longer, but seems that way
- since the page is not incrementally displayed.) This effect will be more
- noticeable on slower connections.
-
+
+ {+downgrade-http-version}
+problem-host.example.com
+
-
-
+
-
-<emphasis>+hide-forwarded</emphasis>
+
+<emphasis>fast-redirects</emphasis>
- Type:
-
+ Typical use:
- Boolean.
+ Fool some click-tracking scripts and speed up indirect links
- Typical uses:
+ Effect:
- Block any existing X-Forwarded-for HTTP header, and do not add a new one.
+ Cut off all but the last valid URL from requests.
- Possible values:
+ Type:
+
-
- N/A
-
+ Boolean.
-
+
- Example usage:
+ Parameter:
-
- {+hide-forwarded}
- .example.com
-
+
+ N/A
+
Notes:
+
+ Many sites, like yahoo.com, don't just link to other sites. Instead, they
+ will link to some script on their own servers, giving the destination as a
+ parameter, which will then redirect you to the final target. URLs
+ resulting from this scheme typically look like:
+ http://some.place/click-tracker.cgi?target=http://some.where.else .
+
- It is fairly safe to leave this on. It does not seem to break many sites.
+ Sometimes, there are even multiple consecutive redirects encoded in the
+ URL. These redirections via scripts make your web browsing more traceable,
+ since the server from which you follow such a link can see where you go
+ to. Apart from that, valuable bandwidth and time is wasted, while your
+ browser ask the server for one redirect after the other. Plus, it feeds
+ the advertisers.
+
+
+ This feature is currently not very smart and is scheduled for improvement.
+ It is likely to break some sites. There is a bunch of exceptions to this action in
+ default.action , should you decide to turn it on by default.
+
+ Example usage:
+
+
+ {+fast-redirects}
+
+
+
+
-
+
-
-<emphasis>+hide-from</emphasis>
+
+<emphasis>filter</emphasis>
- Type:
-
+ Typical use:
- Parameterized.
+ Get rid of HTML and JavaScript annoyances, banner advertisements (by size), do fun text replacements, etc.
- Typical uses:
+ Effect:
- To block the browser from sending your email address in a From:
- header.
+ Text documents, including HTML and JavaScript, to which this action applies, are filterd on-the-fly
+ through the specified regular expression based substitutions.
- Possible values:
+ Type:
+
+
+ Parameterized.
+
+
+
+
+ Parameter:
- Keyword: block
, or any user defined value.
+ The name of a filter, as defined in the default.filter , set by the
+
- Example usage:
+ Notes:
-
- {+hide-from{block}}
- .example.com
-
+
+ For your convenience, there are a bunch of pre-defined filters available
+ in the distribution filter file that you can use. See the example below for
+ a list.
+
+
+ This is potentially a very powerful feature! But rolling your own
+ filters requires a knowledge of regular expressions and HTML.
+
+
+ Filtering requires buffering the page content, which may appear to
+ slow down page rendering since nothing is displayed until all content has
+ passed the filters. (It does not really take longer, but seems that way
+ since the page is not incrementally displayed.) This effect will be more
+ noticeable on slower connections.
+
+
+ At this time, Privoxy cannot (yet!) uncompress compressed
+ documents. If you want filtering to work on all documents, even those that
+ would normally be sent compressed, use the
+ filter .
+
+
+ Filtering can achieve some of the effects as the
+
+
+
- Notes:
+ Example usage (with filters from the distribution default.filter file):
- The keyword block
will completely remove the header.
- Alternately, you can specify any value you prefer to send to the web
- server.
+
+ +filter{html-annoyances} # Get rid of particularly annoying HTML abuse.
+
+
+
+ +filter{js-annoyances} # Get rid of particularly annoying JavaScript abuse
+
+
+
+ +filter{banners-by-size} # Kill banners by size (very efficient!)
+
+
+
+ +filter{content-cookies} # Kill cookies that come sneaking in the HTML or JS content
+
+
+
+
+
+ +filter{webbugs} # Squish WebBugs (1x1 invisible GIFs used for user tracking)
+
+
+
+ +filter{fun} # Text replacements for subversive browsing fun!
+
+
+
+ +filter{frameset-borders} # Give frames a border and make them resizable
+
+
+
+ +filter{refresh-tags} # Kill automatic refresh tags (for dial-on-demand setups)
+
+
+
+ +filter{nimda} # Remove Nimda (virus) code.
+
+
+
+ +filter{shockwave-flash} # Kill embedded Shockwave Flash objects
+
+
+
+ +filter{crude-parental} # Kill all web pages that contain the words "sex" or "warez"
-
-
+
-
-<emphasis>+hide-referer</emphasis>
-
+
+<emphasis>handle-as-image</emphasis>
- Type:
-
+ Typical use:
- Parameterized.
+ Mark URLs as belonging to images (so they'll be replaced by images if they get blocked )
- Typical uses:
+ Effect:
- Don't send the Referer:
(sic) HTTP header to the web site.
- Or, alternately send a forged header instead.
+ This action alone doesn't do anything noticeable. It just marks URLs as images.
+ If the also applies ,
+ the presence or absence of this mark decides whether an HTML blocked
+ page, or a replacement image (as determined by the
- Possible values:
+ Type:
+
+
+ Boolean.
+
+
+
+
+ Parameter:
- Prevent the header from being sent with the keyword, block
.
- Or, forge
a URL to one from the same server as the request.
- Or, set to user defined value of your choice.
+ N/A
- Example usage:
+ Notes:
-
- {+hide-referer{forge}}
- .example.com
-
+
+ The below generic example section is actually part of default.action .
+ It marks all URLs with well-known image file name extensions as images and should
+ be left intact.
+
+
+ Users will probably only want to use the handle-as-image action in conjunction with
+
+
+ Note that you cannot treat HTML pages as images in most cases. For instance, (inline) ad
+ frames require an HTML page to be sent, or they won't display properly.
+ Forcing handle-as-image in this situation will not replace the
+ ad frame with an image, but lead to error messages.
+
- Notes:
+ Example usage (sections):
- forge
is the preferred option here, since some servers will
- not send images back otherwise.
+ # Generic image extensions:
+#
+{+handle-as-image}
+/.*\.(gif|jpg|jpeg|png|bmp|ico)$
+
+# These don't look like images, but they're banners and should be
+# blocked as images:
+#
+{+block +handle-as-image}
+some.nasty-banner-server.com/junk.cgi?output=trash
+
+# Banner source! Who cares if they also have non-image content?
+ad.doubleclick.net
+
-
- +hide-referrer
is an alternate spelling of
- +hide-referer
. It has the exact same parameters, and can be freely
- mixed with, +hide-referer
. (referrer
is the
- correct English spelling, however the HTTP specification has a bug - it
- requires it to be spelled as referer
.)
-
-
-
+
-
-<emphasis>+hide-user-agent</emphasis>
+
+
+
-
-<emphasis>+image</emphasis>
+
+
-
-<emphasis>+image-blocker</emphasis>
-
+
+<emphasis>hide-referrer</emphasis>
+
- Type:
-
+ Typical use:
- Parameterized.
+ Conceal which link you followed to get to a particular site
- Typical uses:
+ Effect:
- Decide what to do with URLs that end up tagged with both {+block}
- and {+image}
, e.g an advertisement.
+ Deletes the Referer:
(sic) HTTP header from the client request,
+ or replaces it with a forged one.
- Possible values:
+ Type:
+
-
- There are four available options: -image-blocker
will send a HTML
- blocked
page, usually resulting in a broken
- image
icon. +image-blocker{blank}
will send a 1x1
- transparent GIF image. +image-blocker{pattern}
will send a
- checkerboard type pattern (the default). And finally,
- +image-blocker{http://xyz.com}
will send a HTTP temporary
- redirect to the specified image. This has the advantage of the icon being
- being cached by the browser, which will speed up the display.
-
+ Parameterized.
-
+
- Example usage:
+ Parameter:
-
- {+image-blocker{blank}}
- .example.com
-
+
+
+ block
to delete the header completely.
+
+ forge
to pretend to be coming from the homepage of the server we are talking to.
+
+ Any other string to set a user defined referrer.
+
+
-
+
Notes:
- If you want invisible ads, they need to be both
- defined as images and blocked .
- And then, image-blocker
should be set to
- blank
for invisibility. Note you cannot treat HTML pages as
- images in most cases. For instance, frames require an HTML page to display.
- So a frame that is an ad, cannot be treated as an image. Forcing an
- image
in this situation just will not work.
+ forge
is the preferred option here, since some servers will
+ not send images back otherwise, in an attempt to prevent their valuable
+ content from being embedded elsewhere (and hence, without being surrounded
+ by their banners.
+
+ hide-referer is an alternate spelling of
+ hide-referrer and the two can be can be freely
+ substituted with each other. (referrer
is the
+ correct English spelling, however the HTTP specification has a bug - it
+ requires it to be spelled as referer
.)
+
+
+ Example usage:
+
+
+ +hide-referrer{forge} or
+ +hide-referrer{http://www.yahoo.com/}
+
+
+
-
+
+
-
-<emphasis>+limit-connect</emphasis>
+
+<emphasis>hide-user-agent</emphasis>
- Type:
-
+ Typical use:
- Parameterized.
+ Conceal your type of browser and client operating system
- Typical uses:
+ Effect:
- By default, Privoxy only allows HTTP CONNECT
- requests to port 443 (the standard, secure HTTPS port). Use
- +limit-connect
to disable this altogether, or to allow
- more ports.
+ Replaces the value of the User-Agent:
HTTP header
+ in client requests with the specified value.
- Possible values:
+ Type:
+
+
+ Parameterized.
+
+
+
+
+ Parameter:
- Any valid port number, or port number range.
+ Any user-defined string.
- Example usages:
+ Notes:
-
-
-
- +limit-connect{443} # This is the default and need not be specified.
- +limit-connect{80,443} # Ports 80 and 443 are OK.
- +limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100 and above 500 are OK.
-
-
+
+ Warning! This breaks many web sites that depend on this in order
+ to customize their content for the different browser types by looking
+ at this header (which, btw, is NOT a smart way to
+ do that!).
+
+
+ Using this action in multi-user setups or wherever diffrerent types of
+ browsers will access the same Privoxy is
+ not recommended . In single-user, single-browser
+ setups, you might use it to delete your OS version information from
+ the headers, because it is an invitation to exploit known bugs for your
+ OS.
+
+
+ This action is scheduled for improvement.
+
+
- Notes:
+ Example usage:
- The CONNECT methods exists in HTTP to allow access to secure websites
- (https:// URLs) through proxies. It works very simply: the proxy connects
- to the server on the specified port, and then short-circuits its
- connections to the client and to the remote proxy.
- This can be a big security hole, since CONNECT-enabled proxies can be
- abused as TCP relays very easily.
-
-
- If you want to allow CONNECT for more ports than this, or want to forbid
- CONNECT altogether, you can specify a comma separated list of ports and
- port ranges (the latter using dashes, with the minimum defaulting to 0 and
- max to 65K).
-
-
- If you don't know what any of this means, there probably is no reason to
- change this one.
-
+ +hide-user-agent{Netscape 6.1 (X11; I; Linux 2.4.18 i686)}
+
-
-
+
+
-
-<emphasis>+no-compression</emphasis>
+
+
+
-
-<emphasis>+no-cookies-keep</emphasis>
+
+<emphasis>limit-connect</emphasis>
- Type:
-
+ Typical use:
- Boolean.
+ Prevent abuse of Privoxy as a TCP relay
- Typical uses:
+ Effect:
- Allow cookies for the current browser session only.
+ Specifies to which ports HTTP CONNECT requests are allowable.
- Possible values:
+ Type:
+
+
+ Parameterized.
+
+
+
+
+ Parameter:
- N/A
+ A comma-separated list of ports or port ranges (the latter using dashes, with the minimum
+ defaulting to 0 and the maximum to 65K).
- Example usage:
+ Notes:
-
- {+no-cookies-keep}
- .example.com
-
+
+ By default, i.e. if no limit-connect action applies,
+ Privoxy only allows HTTP CONNECT
+ requests to port 443 (the standard, secure HTTPS port). Use
+ limit-connect if more fine-grained control is desired
+ for some or all destinations.
+
+
+ The CONNECT methods exists in HTTP to allow access to secure websites
+ (https://
URLs) through proxies. It works very simply:
+ the proxy connects to the server on the specified port, and then
+ short-circuits its connections to the client and to the remote server.
+ This can be a big security hole, since CONNECT-enabled proxies can be
+ abused as TCP relays very easily.
+
+
+ If you don't know what any of this means, there probably is no reason to
+ change this one, since the default is already very restrictive.
+
- Notes:
+ Example usages:
-
- If websites set cookies, no-cookies-keep
will make sure
- they are erased when you exit and restart your web browser. This makes
- profiling cookies useless, but won't break sites which require cookies so
- that you can log in for transactions. This is generally turned on for all
- sites. Sometimes referred to as session cookies
.
+
+
+
+
+ +limit-connect{443} # This is the default and need not be specified.
++limit-connect{80,443} # Ports 80 and 443 are OK.
++limit-connect{-3, 7, 20-100, 500-} # Ports less than 3, 7, 20 to 100 and above 500 are OK.
++limit-connect{-} # All ports are OK (gaping security hole!)
-
-
-
+
-
-<emphasis>+no-cookies-read</emphasis>
+
+<emphasis>prevent-compression</emphasis>
- Type:
-
+ Typical use:
- Boolean.
+
+ Ensure that servers send the content uncompressed, so it can be
+ passed through
- Typical uses:
+ Effect:
- Explicitly prevent the web server from reading any cookies on your
- system.
+ Adds a header to the request that asks for uncompressed transfer.
- Possible values:
+ Type:
+
+
+ Boolean.
+
+
+
+
+ Parameter:
N/A
@@ -3731,54 +4355,87 @@ Please choose from the following options:
- Example usage:
+ Notes:
-
- {+no-cookies-read}
- .example.com
-
+
+ More and more websites send their content compressed by default, which
+ is generally a good idea and saves bandwidth. But for the Privoxy needs access to the uncompressed data.
+ Unfortunately, Privoxy can't yet(!) uncompress, filter, and
+ re-compress the content on the fly. So if you want to ensure that all websites, including
+ those that normally compress, can be filtered, you need to use this action.
+
+
+ This will slow down transfers from those websites, though. If you use any of the above-mentioned
+ actions, you will typically want to use prevent-compression in conjunction
+ with them.
+
+
+ Note that some (rare) ill-configured sites don't handle requests for uncompressed
+ documents correctly (they send an empty document body). If you use prevent-compression
+ per default, you'll have to add exceptions for those sites. See the example for how to do that.
+
- Notes:
+ Example usage (sections):
- Often used in conjunction with +no-cookies-set
to
- disable persistant cookies completely.
+ # Set default:
+#
+{+prevent-compression}
+/ # Match all sites
+
+# Make exceptions for ill sites:
+#
+{-prevent-compression}
+www.debianhelp.org
+www.pclinuxonline.com
-
+
-
-<emphasis>+no-cookies-set</emphasis>
+
+<emphasis>send-vanilla-wafer</emphasis>
- Type:
-
+ Typical use:
- Boolean.
+
+ Feed log analysis scripts with useless data.
+
- Typical uses:
+ Effect:
- Explicitly block the web server from sending cookies to your
- system.
+ Sends a cookie with each request stating that you do not accept any copyright
+ on cookies sent to you, and asking the site operator not to track you.
- Possible values:
+ Type:
+
+
+ Boolean.
+
+
+
+
+ Parameter:
N/A
@@ -3787,114 +4444,130 @@ Please choose from the following options:
- Example usage:
+ Notes:
-
- {+no-cookies-set}
- .example.com
-
+
+ The vanilla wafer is a (relatively) unique header and could conceivably be used to track you.
+
+
+ This action is rarely used and not enabled in the default configuration.
+
- Notes:
+ Example usage:
- Often used in conjunction with +no-cookies-read
to
- disable persistant cookies completely.
+ +send-vanilla-wafer
-
+
-
+
-
-<emphasis>+vanilla-wafer</emphasis>
+
+<emphasis>session-cookies-only</emphasis>
- Type:
-
+ Typical use:
- Boolean.
+
+ Allow only temporary session
cookies (for the current browser session only ).
+
- Typical uses:
+ Effect:
- Sends a cookie for every site stating that you do not accept any copyright
- on cookies sent to you, and asking them not to track you.
+ Deletes the expires
field from Set-Cookie:
server headers.
+ Most browsers will not store such cookies permanently and forget them in between sessions.
+
+ Type:
+
+
+ Boolean.
+
+
+
- Possible values:
+ Parameter:
N/A
@@ -3903,68 +4576,112 @@ Please choose from the following options:
- Example usage:
+ Notes:
-
- {+vanilla-wafer}
- .example.com
-
+
+ This is less strict than
+
+ Most browsers will not permanently store cookies that have been processed by
+ session-cookies-only and will forget about them between sessions.
+ This makes profiling cookies useless, but won't break sites which require cookies so
+ that you can log in for transactions. This is generally turned on for all
+ sites, and is the recommended setting.
+
+
+ It makes no sense at all to use session-cookies-only
+ together with
+
+ Note that it is up to the browser how it handles such cookies without an expires
+ field. If you use an exotic browser, you might want to try it out to be sure.
+
- Notes:
+ Example usage:
- This action only applies if you are using a jarfile
- for saving cookies. Of course, this is a (relatively) unique header and
- could be used to track you.
+ +session-cookies-only
-
-
+
-
-<emphasis>+wafer</emphasis>
+
+<emphasis>set-image-blocker</emphasis>
- Type:
-
+ Typical use:
- Multi-value.
+ Choose the replacement for blocked images
- Typical uses:
+ Effect:
- This allows you to send an arbitrary, user definable cookie.
+ This action alone doesn't do anything noticeable. If both
+ and also
+ apply, i.e. if the request is to be blocked as an image,
+ then the parameter of this action decides what will be
+ sent as a replacement.
- Possible values:
+ Type:
+
-
- User specified cookie name and corresponding value.
-
+ Parameterized.
-
+
- Example usage:
-
-
- {+wafer{name=value}}
- .example.com
-
+ Parameter:
+
+
+
+
+ pattern
to send a built-in checkerboard pattern image. The image is visually
+ decent, scales very well, and makes it obvious where banners were busted.
+
+
+
+
+ blank
to send a built-in transparent image. This makes banners disappear
+ completely, but makes it hard to detect where Privoxy has blocked
+ images on a given page and complicates troubleshooting if Privoxy
+ has blocked innocent images, like navigation icons.
+
+
+
+
+ target-url
to
+ send a redirect to target-url . You can redirect
+ to any image anywhere, even in your local filesystem (via file:///
URL).
+
+
+ A good application of redirects is to use special Privoxy -built-in
+ URLs, which send the built-in images, as target-url .
+ This has the same visual effect as specifying blank
or pattern
in
+ the first place, but enables your browser to cache the replacement image, instead of requesting
+ it over and over again.
+
+
+
@@ -3972,281 +4689,473 @@ Please choose from the following options:
Notes:
- This can be specified multiple times in order to add as many cookies as you
- like.
+ The URLs for the built-in images are http://config.privoxy.org/send-banner?type=type
, where type is
+ either blank
or pattern
.
+
+
+ There is a third (advanced) type, called auto
. It is NOT to be
+ used in set-image-blocker , but meant for use from
+
+ Example usage:
+
+
+ Built-in pattern:
+
+
+ +set-image-blocker{pattern}
+
+
+ Redirect to the BSD devil:
+
+
+ +set-image-blocker{http://www.freebsd.org/gifs/dae_up3.gif}
+
+
+ Redirect to the built-in pattern for better caching:
+
+
+ +set-image-blocker{http://config.privoxy.org/send-banner?type=pattern}
+
+
+
-
+
-
-Actions Examples
+
+Summary
- Note that the meaning of any of the above examples is reversed by preceding
- the action with a -
, in place of the +
. Also,
- that some actions are turned on in the default section of the actions file,
- and require little to no additional configuration. These are just on
.
- Some actions that are turned on the default section do typically require
- exceptions to be listed in the lower sections of actions file.
+ Note that many of these actions have the potential to cause a page to
+ misbehave, possibly even not to display at all. There are many ways
+ a site designer may choose to design his site, and what HTTP header
+ content, and other criteria, he may depend on. There is no way to have hard
+ and fast rules for all sites. See the
+
+
+
+
+Aliases
+
+ Custom actions
, known to Privoxy
+ as aliases
, can be defined by combining other actions.
+ These can in turn be invoked just like the built-in actions.
+ Currently, an alias name can contain any character except space, tab,
+ =
,
+ {
and }
, but we strongly
+ recommend that you only use a
to z
,
+ 0
to 9
, +
, and -
.
+ Alias names are not case sensitive, and are not required to start with a
+ +
or -
sign, since they are merely textually
+ expanded.
+
+
+ Aliases can be used throughout the actions file, but they must be
+ defined in a special section at the top of the file!
+ And there can only be one such section per actions file. Each actions file may
+ have its own alias section, and the aliases defined in it are only visible
+ within that file.
+
+
+ There are two main reasons to use aliases: One is to save typing for frequently
+ used combinations of actions, the other one is a gain in flexibility: If you
+ decide once how you want to handle shops by defining an alias called
+ shop
, you can later chenge your policy on shops in
+ one place, and your changes will take effect everywhere
+ in the actions file where the shop
alias is used. Calling aliases
+ by their purpose also makes your actions files more readable.
+
- Some examples:
+ Currently, there is one big drawback to using aliases, though:
+ Privoxy 's built-in web-based action file
+ editor honors aliases when reading the actions files, but it expands
+ them before writing. So the effects of your aliases are of course preserved,
+ but the aliases themselves are lost when you edit the files this way.
+ This is likely to change in future versions of Privoxy .
- Turn off cookies by default, then allow a few through for specified sites:
+ Now let's define some aliases...
-
+
-
-
-
- # Turn off all persistent cookies
- { +no-cookies-read }
- { +no-cookies-set }
-
- # Allow cookies for this browser session ONLY
- { +no-cookies-keep }
-
- # Exceptions to the above, sites that benefit from persistent cookies
- # that saved from one browser session to the next.
- { -no-cookies-read }
- { -no-cookies-set }
- { -no-cookies-keep }
- .javasoft.com
- .sun.com
- .yahoo.com
- .msdn.microsoft.com
- .redhat.com
+
+ # Useful custom aliases we can use later.
+ #
+ # Note the (required!) section header line and that this section
+ # must be at the top of the actions file!
+ #
+ {{alias}}
- # Alternative way of saying the same thing
- {-no-cookies-set -no-cookies-read -no-cookies-keep}
- .sourceforge.net
- .sf.net
-
-
-
+ # These aliases just save typing later:
+ #
+ +crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
+ -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
+ +imageblock = +block +handle-as-image
+
+ # These aliases define combinations of actions
+ # that are useful for certain types of sites:
+ #
+ fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referer -kill-popups
+ shop = -crunch-all-cookies -fast-redirects
+
+ # Aliases defined from other aliases, for really lazy people ;-)
+ #
+ c0 = +crunch-all-cookies
+ c1 = -crunch-all-cookies
+
+
+
+ ...and put them to use. These sections would appear in the lower part of an
+ actions file and define exceptions to the default actions (as specified further
+ up for the /
pattern):
+
+
+
+
+ # These sites are either very complex or very keen on
+ # user data and require minimal interference to work:
+ #
+ {fragile}
+ .office.microsoft.com
+ .windowsupdate.microsoft.com
+ .nytimes.com
+
+ # Shopping sites:
+ # Allow cookies (for setting and retrieving your customer data)
+ #
+ {shop}
+ .quietpc.com
+ .worldpay.com # for quietpc.com
+ .scan.co.uk
+
+ # These shops require pop-ups:
+ #
+ {shop -kill-popups -filter{popups}}
+ .dabs.com
+ .overclockers.co.uk
- Now turn off fast redirects
, and then we allow two exceptions:
+ Aliases like shop
and fragile
are often used for
+ problem
sites that require some actions to be disabled
+ in order to function properly.
+
+
+
+Sample Actions Files
-
-
-
- # Turn them off!
- {+fast-redirects}
-
- # Reverse it for these two sites, which don't work right without it.
- {-fast-redirects}
- www.ukc.ac.uk/cgi-bin/wac\.cgi\?
- login.yahoo.com
-
-
-
+ Remember that the meaning of any of the above references is reversed by preceding
+ the action with a -
, in place of the +
. Also,
+ that some actions are turned on in the default section of the actions file,
+ and require little to no additional configuration. These are just on
.
- Turn on page filtering according to rules in the defined sections
- of default.filter , and make one exception for
- Sourceforge:
-
-
-
-
-
-
- # Run everything through the filter file, using only the
- # specified sections:
- +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}\
- +filter{webbugs} +filter{nimda} +filter{banners-by-size}
-
- # Then disable filtering of code from sourceforge!
- {-filter}
- .cvs.sourceforge.net
-
-
-
+ But, other actions that are turned on in the default section do
+ typically require exceptions to be listed in the latter sections of
+ one of our actions file. For instance, by default no URLs are
+ blocked
(i.e. in the default definitions of
+ default.action ). We need exceptions to this in order to
+ enable ad blocking in the lower sections. But we need to
+ be very selective about what we do block. Thus, the default is off
+ for blocking.
- Now some URLs that we want blocked
(normally generates
- the blocked
banner). Many of these use
-
+ Below is a liberally commented sample default.action file
+ to demonstrate how all the pieces come together. And to show how exceptions
+ to the default policies can be handled. This is followed by a brief
+ user.action with similar examples.
+
- # Blocklist:
- {+block}
- /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
- /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/])
- /.*/(ng)?adclient\.cgi
- /.*/(plain|live|rotate)[-_.]?ads?/
- /.*/(sponsor)s?[0-9]?/
- /.*/_?(plain|live)?ads?(-banners)?/
- /.*/abanners/
- /.*/ad(sdna_image|gifs?)/
- /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
- /.*/adbanners/
- /.*/adserver
- /.*/adstream\.cgi
- /.*/adv((er)?ts?|ertis(ing|ements?))?/
- /.*/banner_?ads/
- /.*/banners?/
- /.*/banners?\.cgi/
- /.*/cgi-bin/centralad/getimage
- /.*/images/addver\.gif
- /.*/images/marketing/.*\.(gif|jpe?g)
- /.*/popupads/
- /.*/siteads/
- /.*/sponsor.*\.gif
- /.*/sponsors?[0-9]?/
- /.*/advert[0-9]+\.jpg
- /Media/Images/Adds/
- /ad_images/
- /adimages/
- /.*/ads/
- /bannerfarm/
- /grafikk/annonse/
- /graphics/defaultAd/
- /image\.ng/AdType
- /image\.ng/transactionID
- /images/.*/.*_anim\.gif # alvin brattli
- /ip_img/.*\.(gif|jpe?g)
- /rotateads/
- /rotations/
- /worldnet/ad\.cgi
- /cgi-bin/nph-adclick.exe/
- /.*/Image/BannerAdvertising/
- /.*/ad-bin/
- /.*/adlib/server\.cgi
- /autoads/
-
-
-
-
+# Sample default.action file <developers@privoxy.org>
+
+# Settings -- Don't change! For internal Privoxy use ONLY.
+{{settings}}
+for-privoxy-version=3.0
+
+
+##########################################################################
+# Aliases must be defined *before* they are used. These are
+# easier to remember, and can combine several actions into one. Once
+# defined they can be used just like any built-in action -- but within
+# this file only! Aliases do not require a + or - sign.
+##########################################################################
+
+# Some useful aliases.
+# Alias to turn off cookie handling, ie allow all cookies unmolested.
+ -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies \
+ -session-cookies-only
+
+# Alias to both block and treat as if an image for ad blocking
+# purposes.
+ +imageblock = +block +handle-as-image
+
+# Fragile sites should have the minimum changes:
+ fragile = -block -deanimate-gifs -fast-redirects -filter -hide-referer \
+ -crunch-all-cookies -kill-popups
+
+# Shops should be allowed to set persistent cookies
+ shop = -filter -crunch-all-cookies -session-cookies-only
+
+
+##########################################################################
+# Begin default action settings. Anything in this section will match
+# all URLs -- UNLESS we have exceptions that also match, defined below this
+# section. We will show all potential actions here whether they are on
+# or off. We could omit any disabled action if we wanted, since all
+# actions are 'off' by default anyway. Shown for completeness only.
+# Actions are enabled if preceded by a '+', otherwise they are disabled
+# (unless an alias has been defined without this).
+##########################################################################
+ { \
+ -add-header \
+ -block \
+ -deanimate-gifs \
+ -downgrade-http-version \
+ +fast-redirects \
+ +filter{html-annoyances} \
+ +filter{js-annoyances} \
+ -filter{content-cookies} \
+ -filter{popups} \
+ +filter{webbugs} \
+ -filter{refresh-tags} \
+ -filter{fun} \
+ +filter{nimda} \
+ +filter{banners-by-size} \
+ -filter{shockwave-flash} \
+ -filter{crude-prental} \
+ +hide-forwarded-for-headers \
+ +hide-from-header{block} \
+ -hide-referrer \
+ -hide-user-agent \
+ -handle-as-image \
+ +set-image-blocker{pattern} \
+ -limit-connect \
+ +prevent-compression \
+ -session-cookies-only \
+ -crunch-outgoing-cookies \
+ -crunch-incoming-cookies \
+ -kill-popups \
+ -send-vanilla-wafer \
+ -send-wafer \
+ }
+ / # forward slash will match *all* potential URL patterns.
+
+##########################################################################
+# Default behavior is now set. Now we will define some exceptions to our
+# default action policies.
+##########################################################################
+
+# These sites are very complex and require very minimal interference.
+# We'll disable most actions with our 'fragile' alias:
+ { fragile }
+ .office.microsoft.com # surprise, surprise!
+ .windowsupdate.microsoft.com
-
- Note that many of these actions have the potential to cause a page to
- misbehave, possibly even not to display at all. There are many ways
- a site designer may choose to design his site, and what HTTP header
- content he may depend on. There is no way to have hard and fast rules
- for all sites. See the
-
-
+# Shopping sites - not as fragile but require some special
+# handling. We still want to block ads, and we will allow
+# persistant cookies via the 'shop' alias:
+ { shop }
+ .quietpc.com
+ .worldpay.com # for quietpc.com
+ .jungle.com
+ .scan.co.uk
-
+# These sites require pop-ups too :( We'll combine our 'shop'
+# alias with two other actions into one rule to allow all popups.
+ { shop -kill-popups -filter{popups} }
+ .dabs.com
+ .overclockers.co.uk
-
-
-Aliases
-
- Custom actions
, known to Privoxy
- as aliases
, can be defined by combining other actions
.
- These can in turn be invoked just like the built-in actions
.
- Currently, an alias can contain any character except space, tab, =
,
- {
or }
. But please use only a
-
- z
, 0
-9
, +
, and
- -
. Alias names are not case sensitive, and
- must be defined before anything else in the
- default.action file! And there can only be one set of
- aliases
defined.
-
-
- Now let's define a few aliases:
-
+# The 'Fast-redirects' action breaks some sites. Disable this action
+# for these known sensitive sites:
+ { -fast-redirects }
+ login.yahoo.com
+ edit.europe.yahoo.com
+ .google.com
+ .altavista.com/.*(like|url|link):http
+ .altavista.com/trans.*urltext=http
+ .nytimes.com
-
-
-
-
- # Useful custom aliases we can use later. These must come first!
- {{alias}}
- +no-cookies = +no-cookies-set +no-cookies-read
- -no-cookies = -no-cookies-set -no-cookies-read
- fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups
- shop = -no-cookies -filter -fast-redirects
- +imageblock = +block +image
-
- #For people who don't like to type too much: ;-)
- c0 = +no-cookies
- c1 = -no-cookies
- c2 = -no-cookies-set +no-cookies-read
- c3 = +no-cookies-set -no-cookies-read
- #... etc. Customize to your heart's content.
+
+# Define which file types will be treated as images. Important
+# for ad blocking.
+ { +handle-as-image }
+ /.*\.(gif|jpe?g|png|bmp|ico)
+
+
+# Now lets list some domains that are known ad generators. And
+# our alias that we use here will block these as well as force
+# them to be treated as images. This combination of actions is
+# important for ad blocking. What the browser will show instead is
+# determined by the setting of +set-image-blocker
+block }
+ ad*.
+ .*ads.
+ banner?.
+ count*.
+ /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
+ /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|annonse|maino(kset|nta|s)?)/
+ .hitbox.com
+
+
+# The above block section will probably inadvertantly catch some
+# sites we DO NOT want blocked via the wildcards and regular expressions.
+# Now let's set exceptions to the exceptions so the good guys get better
+# treatment. Disable block action:
+ { -block }
+ advogato.org
+ adsl.
+ ad[ud]*.
+ advice.
+# Let's just trust all .edu top level domains.
+ .edu
+ www.ugu.com/sui/ugu/adv
+# We'll need to access to path names containing 'download'
+ .*downloads.
+ /downloads/
+# 'adv' is for globalintersec and means advanced, not advertisement
+ www.globalintersec.com/adv
+
+
+# Don't filter *anything* from our friends at sourceforge.
+# Notice we don't have to name the individual filter
+# identifiers -- we just turn them all off in one fell swoop.
+# Disable all filters for this one site:
+ { -filter }
+ .sourceforge.net
- Some examples using our shop
and fragile
- aliases from above:
+ So far we are painting with a broad brush by setting general policies.
+ The above would be a reasonable starting point for many situations. Now,
+ we want to be more specific and have customized rules that are more suitable
+ to our personal habits and preferences. These would be for narrowly defined
+ situations like your ISP or your bank, and should be placed in
+ user.action , which is parsed after all other
+ actions files and should not be clobbered by upgrades. So any settings here,
+ will have the last word and over-ride any previously defined actions.
+
+
+
+ Now a few examples of some things that one might do with a
+ user.action file.
+
+
- # These sites are very complex and require
- # minimal interference.
- {fragile}
- .office.microsoft.com
- .windowsupdate.microsoft.com
- .nytimes.com
+# Sample user.action file.
+
+# Any aliases you want to use need to be re-defined here.
+# Alias to turn off cookie handling, ie allow all cookies unmolested.
+ -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies \
+ -session-cookies-only
+
+# Fragile sites should have the minimum changes:
+ fragile = -block -deanimate-gifs -fast-redirects -filter -hide-referer \
+ -crunch-all-cookies -kill-popups
+
+# Allow persistent cookies for a few regular sites that we
+# trust via our above alias. These will be saved from one browser session
+# to the next. We are explicity turning off any and all cookie handling,
+# even though the cunch-*-cookies settings were disabled in our above
+# default.action anyway. So cookies from these domains will come through
+# unmolested.
+ { -crunch-all-cookies }
+ .sun.com
+ .yahoo.com
+ .msdn.microsoft.com
+ .redhat.com
- # Shopping sites - but we still want to block ads.
- {shop}
- .quietpc.com
- .worldpay.com # for quietpc.com
- .jungle.com
- .scan.co.uk
- # These shops require pop-ups also
- {shop -no-popups}
- .dabs.com
- .overclockers.co.uk
+# My ISP uses obnoxious self promoting images on many pages.
+# Nuke them :) Note that +handle-as-image
+block }
+ www.my-isp-example.com/logo[0-9].gif
+
+
+# Say the site where you do your homebanking needs to open
+# popup windows, but you have chosen to kill popups by
+# default. This will allow it for your-example-bank.com:
+#
+ { -filter{popups} -kill-popups }
+ .my-example-bank.com
+
+
+# This site is delicate, and requires kid-glove
+# treatment.
+ { fragile }
+ .forbes.com
+
-
- The shop
and fragile
aliases are often used for
- problem
sites that require most actions to be disabled
- in order to function properly.
+
-
-
-
+
+
-
-
+
+
+
+
The Filter File
Any web page can be dynamically modified with the filter file. This
modification can be removal, or re-writing, of any web page content,
including tags and non-visible content. The default filter file is
- default.filter , located in the config directory.
+ oddly enough default.filter , located in the config
+ directory.
@@ -4339,32 +5248,58 @@ Please choose from the following options:
+
+
+
+The <emphasis>+filter</emphasis> Action
+
+ Filters are enabled with the +filter
+filter
requires one parameter, which
+ should match one of the section identifiers in the filter file itself. Example:
+
+
+
+ +filter{html-annoyances}
+
+
+
+ This would activate that particular filter. Similarly, +filter
+ can be turned off for selected sites as:
+ -filter{html-annoyances}
. Remember too, all actions are off by
+ default, unless they are explicity enabled in one of the actions files.
+
+
+
+
-
+
Templates
When Privoxy displays one of its internal
- pages, such as a 404 Not Found error page, it uses the appropriate template.
- On Linux, BSD, and Unix, these are located in
- /etc/privoxy/templates by default. These may be
- customized, if desired. cgi-style.css is
- used to control the HTML attributes (fonts, etc).
-
-
- The default Blocked
banner page with the bright red top
+ pages, such as a 404 Not Found error page
+ (Privoxy must be running for link to work as
+ intended), it uses the appropriate template. On Linux, BSD, and Unix, these
+ are located in /etc/privoxy/templates by default. These
+ may be customized, if desired. cgi-style.css is used to
+ control the HTML attributes (fonts, etc).
+
+
+ The default
+Blocked
+(Privoxy needs to be running for page to display)
+ banner page with the bright red top
banner, is called just blocked
. This
may be customized or replaced with something else if desired.
-
-
@@ -4380,49 +5315,24 @@ Requests
&contacting;
-
-
-
-Submitting Ads and <quote>Action</quote> Problems
-
- Ads and banners that are not stopped by Privoxy
- can be submitted to the developers by accessing a special page and filling
- out the brief, required form. Conversely, you can also report pages, images,
- etc. that Privoxy is blocking, but should not.
- The form itself does require Internet access.
-
-
- To do this, point your browser to Privoxy
- at http://config.privoxy.org/
- (shortcut: http://p.p/ ), and then select
- Actions file feedback system ,
- near the bottom of the page. Paste in the URL that is the cause of the
- unwanted behavior, and follow the prompts. The developers will
- try to incorporate a fix for the problem you reported into future versions.
-
-
-
- New default.actions files will occasionally be made
- available based on your feedback. These
- will be announced on the
- ijbswa-announce
- list.
-
-
-
+
+
-Copyright and History
+<application>Privoxy</application> Copyright, License and History
-Copyright
©right;
-License
+
+ &license;
+
+
+
+
+
See Also
@@ -4531,7 +5444,7 @@ Requests
special characters (e.g. .
) needs to be taken literally and
not as a special meta-character. Example: example\.com
, makes
sure the period is recognized only as a period (and not expanded to its
- metacharacter meaning of any single character).
+ meta-character meaning of any single character).
@@ -4733,7 +5646,8 @@ Requests
- Show information about the current configuration:
+ Show information about the current configuration, including viewing and
+ editing of actions files:
@@ -4755,7 +5669,7 @@ Requests
- Show the client's request headers:
+ Show the browser's request headers:
@@ -4799,17 +5713,6 @@ Requests
-
-
-
- Edit the actions list file:
-
-
-
- http://config.privoxy.org/edit-actions
-
-
-
@@ -4843,31 +5746,35 @@ 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
- Actions file feedback system
+ Privoxy - Submit Filter Feedback
@@ -4888,13 +5795,138 @@ Requests
+
+
+Chain of Events
+
+ Let's take a quick look at the basic sequence of events when a web page is
+ requested by your browser and Privoxy is on duty:
+
+
+
+
+
+
+ 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
+handle-as-image
BLOCKED
page is sent back. Otherwise, if it does match,
+ an image is returned. The type of image depends on the setting of +set-image-blocker
+
+
+
+ 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
+
+
+
+ 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
+
+
+
+ Now the web server starts sending its response back (i.e. typically a web page and related
+ data).
+
+
+
+
+ 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 deterimed by the
+ +crunch-incoming-cookies
+session-cookies-only
+downgrade-http-version
+
+
+
+ If the +kill-popups
+
+
+
+ If a +filter
+deanimate-gifs
default.filter ) are processed against the buffered
+ content. Filters are applied in the order they are specified in the
+ default.filter file. 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 +filter
+deanimate-gifs
Privoxy passes the raw data through
+ to the client browser as it becomes available.
+
+
+
+
+ As the browser receives the now (probably 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 new
+ request. And each such request is in turn processed as above. Note that a
+ complex web page may have many such embedded URLs.
+
+
+
+
+
+
+
+
+
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
filters
see just what Privoxy is
doing. Especially, if something Privoxy is doing
@@ -4908,7 +5940,7 @@ Requests
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
@@ -4922,92 +5954,94 @@ 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
default.filter file 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:
- 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 }
-
-
-
-
-
- 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:
-
+ Matches for http://google.com:
-
-
+--- File standard ---
+(no matches in this file)
- Matches for http://google.com:
+--- File default ---
- { -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 }
- /
+{ -add-header -block +deanimate-gifs{last} -downgrade-http-version +fast-redirects
+ -filter{popups} -filter{fun} -filter{shockwave-flash} -filter{crude-parental}
+ +filter{html-annoyances} +filter{js-annoyances} +filter{content-cookies}
+ +filter{webbugs} +filter{refresh-tags} +filter{nimda} +filter{banners-by-size}
+ +hide-forwarded-for-headers +hide-from-header{block} +hide-referer{forge}
+ -hide-user-agent -handle-as-image +set-image-blocker{pattern} -limit-connect
+ +prevent-compression +session-cookies-only -crunch-outgoing-cookies
+ -crunch-incoming-cookies -kill-popups -send-vanilla-wafer -send-wafer }
+/
- { -no-cookies-keep -no-cookies-read -no-cookies-set }
- .google.com
+ { -session-cookies-only }
+ .google.com
{ -fast-redirects }
- .google.com
+ .google.com
-
+--- File user ---
+(no matches in this file)
+
- 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 -- /
.
-
+ This tells us how we have defined our
+ actions
google.com
. The first listing
+ is any matches for the standard.action file. No hits at
+ all here on standard
. Then next is default
, or
+ 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
+ -- /
.
- 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.
+ But we can define additional actions that would be exceptions to these general
+ rules, and then 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
off any
+ +fast-redirects
.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 two actions
+ defined somewhere in the lower part of our default.action
+ file, and google.com
is referenced somewhere in these latter
+ sections.
+
+
+ Then, for our user.action file, we again have no hits.
- 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
:
@@ -5017,16 +6051,20 @@ Requests
Final results:
+ -add-header -block +deanimate-gifs{last} -downgrade-http-version -fast-redirects
+ -filter{popups} -filter{fun} -filter{shockwave-flash} -filter{crude-parental}
+ +filter{html-annoyances} +filter{js-annoyances} +filter{content-cookies}
+ +filter{webbugs} +filter{refresh-tags} +filter{nimda} +filter{banners-by-size}
+ +hide-forwarded-for-headers +hide-from-header{block} +hide-referer{forge}
+ -hide-user-agent -handle-as-image +set-image-blocker{pattern} -limit-connect
+ +prevent-compression -session-cookies-only -crunch-outgoing-cookies
+ -crunch-incoming-cookies -kill-popups -send-vanilla-wafer -send-wafer
+
+
- -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
-
-
+
+ Notice the only difference here to the previous listing, is to
+ fast-redirects
and session-cookies-only
.
@@ -5036,24 +6074,24 @@ Requests
- { +block +image }
+ { +block +handle-as-image }
.ad.doubleclick.net
- { +block +image }
+ { +block +handle-as-image }
ad*.
- { +block +image }
+ { +block +handle-as-image }
.doubleclick.net
-
-
+
We'll just show the interesting part here, the explicit matches. It is
- matched three different times. Each as an +block +image
,
+ matched three different times. Each as an +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
+ +imageblock
. (Aliases
@@ -5063,9 +6101,13 @@ 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 +block
and an
- +image
. The custom alias +imageblock
does this
- for us.
+ is done here -- as both a +block
and an
+ +handle-as-image
+imageblock
just simplifies the process and make
+ it more readable.
@@ -5078,27 +6120,26 @@ Requests
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}
+ { -add-header -block +deanimate-gifs -downgrade-http-version +fast-redirects
+ +filter{html-annoyances} +filter{js-annoyances} +filter{kill-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 }
+ +filter{fun} +hide-forwarded-for-headers +hide-from-header{block}
+ +hide-referer{forge} -hide-user-agent -handle-as-image +set-image-blocker{blank}
+ +prevent-compression +session-cookies-only -crunch-incoming-cookies
+ -crunch-outgoing-cookies +kill-popups -send-vanilla-wafer -send-wafer }
/
- { +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:
+ block ({-block}
) paths with adsl
. There are
+ various ways to handle such exceptions. Example:
@@ -5106,8 +6147,7 @@ Requests
{ -block }
/adsl
-
-
+
@@ -5123,10 +6163,9 @@ Requests
- { -block }
- /adsl
-
-
+ { +block +handle-as-image }
+ /ads
+
@@ -5147,14 +6186,13 @@ Requests
.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:
+ { -filter -session-cookies-only }
.
+ Or you could do your own exception to negate filtering:
@@ -5163,8 +6201,12 @@ Requests
{-filter}
.forbes.com
-
-
+
+
+
+
+ This would probably be most appropriately put in user.action ,
+ for local site exceptions.
@@ -5199,6 +6241,86 @@ Requests
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
+ 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.
+
Revision 1.85 2002/04/18 21:23:23 hal9
Fix ugly typo (mine).