X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=02acfda11b684412bbe31fd0cb87e9857e39ff46;hp=8af6da9eb534069e99848acb9d5ffc38d5b07803;hb=15e948c1a62d809d13c3f66376d9eea6254ea14e;hpb=bb59003c7c0561d06a81589622165b0b36ca2b28 diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 8af6da9e..02acfda1 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -1,5 +1,5 @@ + @@ -9,9 +9,11 @@ + - + + @@ -24,6 +26,7 @@ + Privoxy"> ]> - Copyright &my-copy; 2001-2009 by + Copyright &my-copy; 2001-2013 by Privoxy Developers -$Id: user-manual.sgml,v 2.96 2009/02/14 13:14:03 fabiankeil Exp $ +$Id: user-manual.sgml,v 2.173 2013/03/01 17:44:24 fabiankeil Exp $ Since this is a &p-status; version, not all new features are well tested. This - documentation may be slightly out of sync as a result (especially with + documentation may be slightly out of sync as a result (especially with CVS sources). And there may be bugs, though hopefully - not many! + not many! ]]> Features - In addition to the core - features of ad blocking and + In addition to the core + features of ad blocking and cookie management, Privoxy provides many supplemental - features, + features, that give the end-user more control, more privacy and more freedom: @@ -164,14 +167,14 @@ Hal. - Note: - On some platforms, the installer may remove previously installed versions, if + Note: + On some platforms, the installer may remove previously installed versions, if found. (See below for your platform). In any case be sure to backup your old configuration if it is valuable to you. See the note to upgraders section below. - + Binary Packages How to install the binary packages depends on your operating system: @@ -179,41 +182,11 @@ How to install the binary packages depends on your operating system: - -Red Hat and Fedora RPMs - - - 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 on Red Hat, Privoxy will - not be automatically started on system boot. You will - need to enable that using chkconfig, - ntsysv, or similar methods. - - - - 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 if found, before installing Privoxy. - - - Debian and Ubuntu DEBs can be installed with apt-get install privoxy, - and will use /etc/privoxy for the location of + and will use /etc/privoxy for the location of configuration files. @@ -224,7 +197,7 @@ How to install the binary packages depends on your operating system: Just double-click the installer, which will guide you through the installation process. You will find the configuration files - in the same directory as you installed Privoxy in. + in the same directory as you installed Privoxy in. Version 3.0.5 beta introduced full Windows service @@ -255,28 +228,18 @@ How to install the binary packages depends on your operating system: command: services.msc. If you do not take the manual step of modifying Privoxy's service settings, it will not start. Note too that you will need to give Privoxy a user account that - actually exists, or it will not be permitted to + actually exists, or it will not be permitted to write to its log and configuration files. - -Solaris <!--, NetBSD, HP-UX--> - - - Create a new directory, cd to it, then unzip and - untar the archive. For the most part, you'll have to figure out where - things go. - - - OS/2 First, make sure that no previous installations of - Junkbuster and / or + Junkbuster and / or Privoxy are left on your system. Check that no Junkbuster or Privoxy objects are in @@ -300,72 +263,83 @@ How to install the binary packages depends on your operating system: Mac OS X - Unzip the downloaded file (you can either double-click on the zip file - icon from the Finder, or from the desktop if you downloaded it there). - Then, double-click on the package installer icon and follow the - installation process. + Installation instructions for the OS X platform depend upon whether + you downloaded a ready-built installation package (.pkg or .mpkg) or have + downloaded the source code. + + +Installation from ready-built package - The privoxy service will automatically start after a successful - installation (in addition to every time your computer starts up). To - prevent the privoxy service from automatically starting when your - computer starts up, remove or rename the folder named - /Library/StartupItems/Privoxy. + The downloaded file will either be a .pkg (for OS X 10.5 upwards) or a bzipped + .mpkg file (for OS X 10.4). The former can be double-clicked as is and the + installation will start; double-clicking the latter will unzip the .mpkg file + which can then be double-clicked to commence the installation. - To manually start or stop the privoxy service, use the Privoxy Utility - for Mac OS X. This application controls the privoxy service (e.g. - starting and stopping the service as well as uninstalling the software). + The privoxy service will automatically start after a successful installation + (and thereafter every time your computer starts up) however you will need to + configure your web browser(s) to use it. To do so, configure them to use a + proxy for HTTP and HTTPS at the address 127.0.0.1:8118. + + + To prevent the privoxy service from automatically starting when your computer + starts up, remove or rename the file /Library/LaunchDaemons/org.ijbswa.privoxy.plist + (on OS X 10.5 and higher) or the folder named + /Library/StartupItems/Privoxy (on OS X 10.4 'Tiger'). + + + To manually start or stop the privoxy service, use the scripts startPrivoxy.sh + and stopPrivoxy.sh supplied in /Applications/Privoxy. They must be run from an + administrator account, using sudo. - - - -AmigaOS - 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. + To uninstall, run /Applications/Privoxy/uninstall.command as sudo from an + administrator account. - - -FreeBSD - + +Installation from source - Privoxy is part of FreeBSD's Ports Collection, you can build and install - it with cd /usr/ports/www/privoxy; make install clean. + To build and install the Privoxy source code on OS X you will need to obtain + the macsetup module from the Privoxy Sourceforge CVS repository (refer to + Sourceforge help for details of how to set up a CVS client to have read-only + access to the repository). This module contains scripts that leverage the usual + open-source tools (available as part of Apple's free of charge Xcode + distribution or via the usual open-source software package managers for OS X + (MacPorts, Homebrew, Fink etc.) to build and then install the privoxy binary + and associated files. The macsetup module's README file contains complete + instructions for its use. - If you don't use the ports, you can fetch and install - the package with pkg_add -r privoxy. + The privoxy service will automatically start after a successful installation + (and thereafter every time your computer starts up) however you will need to + configure your web browser(s) to use it. To do so, configure them to use a + proxy for HTTP and HTTPS at the address 127.0.0.1:8118. - The port skeleton and the package can also be downloaded from the - File Release - Page, but there's no reason to use them unless you're interested in the - beta releases which are only available there. + To prevent the privoxy service from automatically starting when your computer + starts up, remove or rename the file /Library/LaunchDaemons/org.ijbswa.privoxy.plist + (on OS X 10.5 and higher) or the folder named + /Library/StartupItems/Privoxy (on OS X 10.4 'Tiger'). - - - -Gentoo - Gentoo source packages (Ebuilds) for Privoxy are - contained in the Gentoo Portage Tree (they are not on the download page, - but there is a Gentoo section, where you can see when a new - Privoxy Version is added to the Portage Tree). + To manually start or stop the privoxy service, use the Privoxy Utility + for Mac OS X (also part of the macsetup module). This application can start + and stop the privoxy service and display its log and configuration files. - Before installing Privoxy under Gentoo just do - first emerge --sync to get the latest changes from the - Portage tree. With emerge privoxy you install the latest - version. + To uninstall, run the macsetup module's uninstall.sh as sudo from an + administrator account. + + + +FreeBSD + - Configuration files are in /etc/privoxy, the - documentation is in /usr/share/doc/privoxy-&p-version; - and the Log directory is in /var/log/privoxy. + Privoxy is part of FreeBSD's Ports Collection, you can build and install + it with cd /usr/ports/www/privoxy; make install clean. @@ -376,7 +350,7 @@ How to install the binary packages depends on your operating system: The most convenient way to obtain the Privoxy sources - is to download the source tarball from our + is to download the source tarball from our project download page. @@ -385,8 +359,8 @@ How to install the binary packages depends on your operating system: 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. - - + Keeping your Installation Up-to-Date - - As user feedback comes in and development continues, we will make updated versions - of both the main actions file (as a separate - package) and the software itself (including the actions file) available for - download. - If you wish to receive an email notification whenever we release updates of @@ -419,7 +386,7 @@ How to install the binary packages depends on your operating system: In order not to lose your personal changes and adjustments when updating to the latest default.action file we strongly - recommend that you use user.action and + recommend that you use user.action and user.filter for your local customizations of Privoxy. See the Chapter on actions files for details. @@ -435,144 +402,8 @@ How to install the binary packages depends on your operating system: What's New in this Release - - There are only a few improvements and new features since - Privoxy 3.0.10, the last stable release: - - - - - - - On most platforms, outgoing connections can be kept alive and - reused if the server supports it. Whether or not this improves - things depends on the connection. - - - - - When dropping privileges, membership in supplementary groups - is given up as well. Not doing that can lead to Privoxy running - with more rights than necessary and violates the principle of - least privilege. Users of the --user option are advised to update. - Thanks to Matthias Drochner for reporting the problem, - providing the initial patch and testing the final version. - - - - - Passing invalid users or groups with the --user option - didn't lead to program exit. Regression introduced in 3.0.7. - - - - - The match all section has been moved from default.action - to a new file called match-all.action. As a result the - default.action no longer needs to be touched by the user - and can be safely overwritten by updates. - - - - - The standard.action file has been removed. Its content - is now part of the default.action file. - - - - - In some situations the logged content length was slightly too low. - - - - - Crunched requests are logged with their own log level. - If you used "debug 1" in the past, you'll probably want - to additionally enable "debug 1024", otherwise only passed - requests will be logged. If you only care about crunched - requests, simply replace "debug 1" with "debug 1024". - - - - - The crunch reason has been moved to the beginning of the - crunch message. For HTTP URLs, the protocol is logged as well. - - - - - Log messages are shortened by not printing the thread id - on its own (as opposed to putting it inside "Privoxy()". - - - - - The config option socket-timeout has been added to control - the time Privoxy waits for data to arrive on a socket. - - - - - Support for remote toggling is controlled by the configure - option --disable-toggle only. In previous versions it also - depended on the action editor and thus configuring with the - --disable-editor option would disable remote toggling support - as well. - - - - - Requests with invalid HTTP versions are rejected. - - - - - The template symbol @date@ can be used to include a date(1)-like - time string. Initial patch submitted by Endre Szabo. - - - - - Responses from shoutcast servers are accepted again. - Problem reported and fix suggested by Stefan. - - - - - The hide-forwarded-for-headers action has been replaced with - the change-x-forwarded-for{} action which can also be used to - add X-Forwarded-For headers. The latter functionality already - existed in Privoxy versions prior to 3.0.7 but has been removed - as it was often used unintentionally (by not using the - hide-forwarded-for-headers action). - - - - - A "clear log" view option was added to the mingw32 version - to clear out all of the lines in the Privoxy log window. - Based on a patch submitted by T Ford. - - - - - The mingw32 version uses "critical sections" now, which prevents - log message corruption under load. As a side effect, the - "no thread-safe PRNG" warning could be removed as well. - - - - - The mingw32 version's task bar icon is crossed out and - the color changed to gray if Privoxy is toggled off. - - - - - - For a more detailed list of changes please have a look at the ChangeLog. - +&changelog; @@ -580,7 +411,7 @@ How to install the binary packages depends on your operating system: Note to Upgraders - A quick list of things to be aware of before upgrading from earlier + A quick list of things to be aware of before upgrading from earlier versions of Privoxy: @@ -589,7 +420,7 @@ How to install the binary packages depends on your operating system: - The recommended way to upgrade &my-app; is to backup your old + The recommended way to upgrade &my-app; is to backup your old configuration files, install the new ones, verify that &my-app; is working correctly and finally merge back your changes using diff and maybe patch. @@ -603,24 +434,18 @@ How to install the binary packages depends on your operating system: - + Note that some installers remove earlier versions completely, including configuration files, therefore you should really save any important configuration files! - - On the other hand, other installers don't overwrite existing configuration + + On the other hand, other installers don't overwrite existing configuration files, thinking you will want to do that yourself. - - - standard.action has been merged into - the default.action file. - - In the default configuration only fatal errors are logged now. @@ -633,21 +458,21 @@ How to install the binary packages depends on your operating system: - Three other config file settings are now off by default: + Three other config file settings are now off by default: enable-remote-toggle, enable-remote-http-toggle, - and enable-edit-actions. + and enable-edit-actions. If you use or want these, you will need to explicitly enable them, and - be aware of the security issues involved. + be aware of the security issues involved. @@ -721,19 +546,19 @@ How to install the binary packages depends on your operating system: Install Privoxy. See the Installation Section below for platform specific - information. + information. - + Advanced users and those who want to offer Privoxy service to more than just their local machine should check the main config file, especially the security-relevant options. These are + linkend="access-control">security-relevant options. These are off by default. - + @@ -749,26 +574,26 @@ How to install the binary packages depends on your operating system: HTTPS (SSL) proxy by setting the proxy configuration for address of 127.0.0.1 and port 8118. - DO NOT activate proxying for FTP or + DO NOT activate proxying for FTP or any protocols besides HTTP and HTTPS (SSL) unless you intend to prevent your browser from using these protocols. - + Flush your browser's disk and memory caches, to remove any cached ad images. - If using Privoxy to manage + If using Privoxy to manage cookies, you should remove any currently stored cookies too. - + - A default installation should provide a reasonable starting point for + A default installation should provide a reasonable starting point for most. There will undoubtedly be occasions where you will want to adjust the - configuration, but that can be dealt with as the need arises. Little + configuration, but that can be dealt with as the need arises. Little to no initial configuration is required in most cases, you may want to enable the web-based action editor though. @@ -782,7 +607,7 @@ How to install the binary packages depends on your operating system: introduction to how Privoxy blocks ads and banners. - + @@ -797,7 +622,7 @@ How to install the binary packages depends on your operating system: Action has hints on how to understand and debug actions that misbehave. - + Please see the section Contacting the Developers on how to report bugs, problems with websites or to get - help. + help. - + Now enjoy surfing with enhanced control, comfort and privacy! - + @@ -834,35 +659,35 @@ How to install the binary packages depends on your operating system: Quickstart to Ad Blocking Ad blocking is but one of Privoxy's - array of features. Many of these features are for the technically minded advanced + array of features. Many of these features are for the technically minded advanced user. But, ad and banner blocking is surely common ground for everybody. - - This section will provide a quick summary of ad blocking so + + This section will provide a quick summary of ad blocking so you can get up to speed quickly without having to read the more extensive information provided below, though this is highly recommended. First a bit of a warning ... blocking ads is much like blocking SPAM: the - more aggressive you are about it, the more likely you are to block - things that were not intended. And the more likely that some things + more aggressive you are about it, the more likely you are to block + things that were not intended. And the more likely that some things may not work as intended. So there is a trade off here. If you want extreme ad free browsing, be prepared to deal with more problem sites, and to spend more time adjusting the - configuration to solve these unintended consequences. In short, there is - not an easy way to eliminate all ads. Either take + configuration to solve these unintended consequences. In short, there is + not an easy way to eliminate all ads. Either take the easy way and settle for most ads blocked with the default configuration, or jump in and tweak it for your personal surfing habits and preferences. Secondly, a brief explanation of Privoxy's - actions. Actions in this context, are + actions. Actions in this context, are the directives we use to tell Privoxy to perform some task relating to HTTP transactions (i.e. web browsing). We tell Privoxy to take some action. Each @@ -874,7 +699,7 @@ How to install the binary packages depends on your operating system: Actions are specified in Privoxy's configuration, - followed by one or more URLs to which the action should apply. URLs + followed by one or more URLs to which the action should apply. URLs can actually be URL type patterns that use wildcards so they can apply potentially to a range of similar URLs. The actions, together with the URL patterns are called a section. @@ -897,7 +722,7 @@ How to install the binary packages depends on your operating system: The most important actions for basic ad blocking are: block, handle-as-image, + linkend="handle-as-image">handle-as-image, handle-as-empty-document,and set-image-blocker: @@ -905,10 +730,10 @@ How to install the binary packages depends on your operating system: - + - block - this is perhaps + block - this is perhaps the single most used action, and is particularly important for ad blocking. This action stops any contact between your browser and any URL patterns that match this action's configuration. It can be used for blocking ads, @@ -917,32 +742,32 @@ How to install the binary packages depends on your operating system: Privoxy's own built-in BLOCKED page instead to let you now what has happened (with some exceptions, see below). - + - handle-as-image - + handle-as-image - tells Privoxy to treat this URL as an image. Privoxy's default configuration already does this for all common image types (e.g. GIF), but there are many situations where this is not so easy to determine. So we'll force it in these cases. This is particularly important for ad blocking, since only if we know that it's an image of - some kind, can we replace it with an image of our choosing, instead of the + some kind, can we replace it with an image of our choosing, instead of the Privoxy BLOCKED page (which would only result in a broken image icon). There are some limitations to this though. For instance, you can't just brute-force an image substitution for an entire HTML page in most situations. - + - handle-as-empty-document - - sends an empty document instead of Privoxy's - normal BLOCKED HTML page. This is useful for file types that are neither + handle-as-empty-document - + sends an empty document instead of Privoxy's + normal BLOCKED HTML page. This is useful for file types that are neither HTML nor images, such as blocking JavaScript files. - + @@ -959,7 +784,7 @@ How to install the binary packages depends on your operating system: -    pattern - a checkerboard pattern, so that an ad +    pattern - a checkerboard pattern, so that an ad replacement is obvious. This is the default. @@ -975,14 +800,14 @@ How to install the binary packages depends on your operating system: of the user's choosing (advanced usage). - + Advanced users will eventually want to explore &my-app; - filters as well. Filters + filters as well. Filters are very different from blocks. A block blocks a site, page, or unwanted contented. Filters @@ -997,7 +822,7 @@ How to install the binary packages depends on your operating system: The quickest way to adjust any of these settings is with your browser through the special Privoxy editor at http://config.privoxy.org/show-status - (shortcut: http://p.p/show-status). This + (shortcut: http://p.p/show-status). This is an internal page, and does not require Internet access. @@ -1029,21 +854,21 @@ How to install the binary packages depends on your operating system: - Right click on the ad image to be blocked, then select + Right click on the ad image to be blocked, then select Copy Link Location from the - pop-up menu. + pop-up menu. - + - Set your browser to + Set your browser to http://config.privoxy.org/show-status - + - Find user.action in the top section, and click + Find user.action in the top section, and click on Edit: @@ -1053,29 +878,29 @@ How to install the binary packages depends on your operating system: - + [ Screenshot of Actions Files in Use ] - - + + You should have a section with only - block listed under + block listed under Actions:. If not, click a Insert new section below - button, and in the new section that just appeared, click the + button, and in the new section that just appeared, click the Edit button right under the word Actions:. This will bring up a list of all actions. Find block near the top, and click in the Enabled column, then Submit just below the list. - + Now, in the block actions section, @@ -1085,21 +910,21 @@ How to install the binary packages depends on your operating system: Submit (or OK if in a pop-up window). - + Now go back to the original page, and press SHIFT-Reload (or flush all browser caches). The image should be gone now. - - + + - This is a very crude and simple example. There might be good reasons to use a + This is a very crude and simple example. There might be good reasons to use a wildcard pattern match to include potentially similar images from the same - site. For a more extensive explanation of patterns, and + site. For a more extensive explanation of patterns, and the entire actions concept, see the Actions section. @@ -1110,11 +935,11 @@ How to install the binary packages depends on your operating system: The ideas explained therein also apply to the web-based editor. - There are also various - filters that can be used for ad blocking - (filters are a special subset of actions). These + There are also various + filters that can be used for ad blocking + (filters are a special subset of actions). These fall into the advanced usage category, and are explained in - depth in later sections. + depth in later sections. @@ -1130,14 +955,14 @@ How to install the binary packages depends on your operating system: Before launching Privoxy for the first time, you will want to configure your browser(s) to use - Privoxy as a HTTP and HTTPS (SSL) + Privoxy as a HTTP and HTTPS (SSL) proxy. The default is 127.0.0.1 (or localhost) for the proxy address, and port 8118 (earlier versions used port 8000). This is the one configuration step that must be done ! - Please note that Privoxy can only proxy HTTP and + Please note that Privoxy can only proxy HTTP and HTTPS traffic. It will not work with FTP or other protocols. @@ -1148,35 +973,35 @@ How to install the binary packages depends on your operating system: - + [ Screenshot of Mozilla Proxy Configuration ] - - + + With Firefox, this is typically set under: - + Tools -> Options -> Advanced -> Network ->Connection -> Settings - + Or optionally on some platforms: - + Edit -> Preferences -> General -> Connection Settings -> Manual Proxy Configuration - + With Netscape (and Mozilla), this can be set under: @@ -1190,7 +1015,7 @@ How to install the binary packages depends on your operating system: - For Internet Explorer v.5-7: + For Internet Explorer v.5-7: @@ -1212,7 +1037,7 @@ How to install the binary packages depends on your operating system: - + [ Screenshot of IE Proxy Configuration ] @@ -1223,7 +1048,7 @@ How to install the binary packages depends on your operating system: After doing this, flush your browser's disk and memory caches to force a - re-reading of all pages and to get rid of any ads that may be cached. Remove + re-reading of all pages and to get rid of any ads that may be cached. Remove any cookies, if you want Privoxy to manage that. You are now ready to start enjoying the benefits of using @@ -1238,28 +1063,6 @@ How to install the binary packages depends on your operating system: directory. Except on Win32 where it will try config.txt. - -Red Hat and Fedora - - A default Red Hat installation may not start &my-app; upon boot. It will use - the file /etc/privoxy/config as its main configuration - file. - - - - # /etc/rc.d/init.d/privoxy start - - - - Or ... - - - - # service privoxy start - - - - Debian @@ -1287,7 +1090,7 @@ Click on the &my-app; Icon to start Privoxy. If no co Privoxy can run with full Windows service functionality. On Windows only, the &my-app; program has two new command line arguments - to install and uninstall &my-app; as a service. See the + to install and uninstall &my-app; as a service. See the Windows Installation instructions for details. @@ -1348,42 +1151,6 @@ Example Unix startup command: - -AmigaOS - - Start Privoxy (with RUN <>NIL:) in your - startnet script (AmiTCP), in - s:user-startup (RoadShow), as startup program in your - startup script (Genesis), or as startup action (Miami and MiamiDx). - Privoxy will automatically quit when you quit your - TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that - Privoxy is still running). - - - - -Gentoo - - A script is again used. It will use the file /etc/privoxy/config - as its main configuration file. - - - - /etc/init.d/privoxy start - - - - Note that Privoxy is not automatically started at - boot time by default. You can change this with the rc-update - command. - - - - rc-update add privoxy default - - - - @@ -1493,6 +1260,27 @@ must find a better place for this paragraph + + + --config-test + + + Exit after loading the configuration files before binding to + the listen address. The exit code signals whether or not the + configuration files have been successfully loaded. + + + If the exit code is 1, at least one of the configuration files + is invalid, if it is 0, all the configuration files have been + successfully loaded (but may still contain errors that can + currently only be detected at run time). + + + This option doesn't affect the log setting, combination with + --no-daemon is recommended if a configured + log file shouldn't be used. + + --version @@ -1500,7 +1288,7 @@ must find a better place for this paragraph Print version info and exit. Unix only. - + --help @@ -1508,7 +1296,7 @@ must find a better place for this paragraph Print short usage info and exit. Unix only. - + --no-daemon @@ -1517,7 +1305,7 @@ must find a better place for this paragraph Don't become a daemon, i.e. don't fork and become process group leader, and don't detach from controlling tty. Unix only. - + --pidfile FILE @@ -1528,7 +1316,7 @@ must find a better place for this paragraph FILE is non-fatal. If no FILE option is given, no PID file will be used. Unix only. - + --user USER[.GROUP] @@ -1544,9 +1332,9 @@ must find a better place for this paragraph --chroot - Before changing to the user ID given in the --user option, + Before changing to the user ID given in the --user option, chroot to that user's home directory, i.e. make the kernel pretend to the &my-app; - process that the directory tree starts there. If set up carefully, this can limit + process that the directory tree starts there. If set up carefully, this can limit the impact of possible vulnerabilities in &my-app; to the files contained in that hierarchy. Unix only. @@ -1574,23 +1362,23 @@ must find a better place for this paragraph configfile - If no configfile is included on the command line, - Privoxy will look for a file named - config in the current directory (except on Win32 - where it will look for config.txt instead). Specify - full path to avoid confusion. If no config file is found, + If no configfile is included on the command line, + Privoxy will look for a file named + config in the current directory (except on Win32 + where it will look for config.txt instead). Specify + full path to avoid confusion. If no config file is found, Privoxy will fail to start. - + - On MS Windows only there are two additional - command-line options to allow Privoxy to install and - run as a service. See the -Window Installation section + On MS Windows only there are two additional + command-line options to allow Privoxy to install and + run as a service. See the +Window Installation section for details. @@ -1604,9 +1392,9 @@ for details. Privoxy Configuration - All Privoxy configuration is stored + All Privoxy configuration is stored in text files. These files can be edited with a text editor. - Many important aspects of Privoxy can + Many important aspects of Privoxy can also be controlled easily with a web browser. @@ -1616,9 +1404,9 @@ for details. Controlling Privoxy with Your Web Browser - Privoxy's user interface can be reached through the special + Privoxy's user interface can be reached through the special URL http://config.privoxy.org/ - (shortcut: http://p.p/), + (shortcut: http://p.p/), which is a built-in page and works without Internet access. You will see the following section: @@ -1660,14 +1448,14 @@ for details. cookie, and URL blocking magic is configured as well as other advanced features of Privoxy. This is an easy way to adjust various aspects of Privoxy configuration. The actions - file, and other configuration files, are explained in detail below. + file, and other configuration files, are explained in detail below. - Toggle Privoxy On or Off is handy for sites that might + Toggle Privoxy On or Off is handy for sites that might have problems with your current actions and filters. You can in fact use - it as a test to see whether it is Privoxy - causing the problem or not. Privoxy continues + it as a test to see whether it is Privoxy + causing the problem or not. Privoxy continues to run as a proxy in this case, but all manipulation is disabled, i.e. Privoxy acts like a normal forwarding proxy. There is even a toggle Bookmarklet offered, so @@ -1697,14 +1485,14 @@ for details. For Unix, *BSD and Linux, all configuration files are located in /etc/privoxy/ by default. For MS Windows, OS/2, and - AmigaOS these are all in the same directory as the + AmigaOS these are all in the same directory as the Privoxy executable. - The installed defaults provide a reasonable starting point, though + The installed defaults provide a reasonable starting point, though some settings may be aggressive by some standards. For the time being, the principle configuration files are: @@ -1718,7 +1506,7 @@ for details. on Linux, Unix, BSD, OS/2, and AmigaOS and config.txt on Windows. This is a required file. - + @@ -1732,23 +1520,23 @@ for details. It should be the second actions file loaded and shouldn't be edited by the user. - Multiple actions files may be defined in config. These - are processed in the order they are defined. Local customizations and locally + 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 match-all.action (which you will most probably want to define sooner or later) are best applied in user.action, where you can preserve them across upgrades. The file isn't installed by all installers, but you can easily create it yourself with a text editor. - + 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. + various actions files. - + @@ -1756,15 +1544,15 @@ for details. file) can be used to re-write the raw page content, including viewable text as well as embedded HTML and JavaScript, and whatever else lurks on any given web page. The filtering jobs are only pre-defined here; - whether to apply them or not is up to the actions files. - default.filter includes various filters made - available for use by the developers. Some are much more intrusive than - others, and all should be used with caution. You may define additional - filter files in config as you can with - actions files. We suggest user.filter for any + whether to apply them or not is up to the actions files. + default.filter includes various filters made + available for use by the developers. Some are much more intrusive than + others, and all should be used with caution. You may define additional + filter files in config as you can with + actions files. We suggest user.filter for any locally defined filters or customizations. - + @@ -1786,15 +1574,15 @@ for details. - The actions files and filter files + The actions files and filter files can use Perl style regular expressions for - maximum flexibility. + maximum flexibility. After making any changes, there is no need to restart Privoxy in order for the changes to take - effect. Privoxy detects such changes + effect. Privoxy detects such changes automatically. Note, however, that it may take one or two additional requests for the change to take effect. When changing the listening address of Privoxy, these wake up requests @@ -1803,9 +1591,9 @@ for details. - While under development, the configuration content is subject to change. - The below documentation may not be accurate by the time you read this. - Also, what constitutes a default setting, may change, so + While under development, the configuration content is subject to change. + The below documentation may not be accurate by the time you read this. + Also, what constitutes a default setting, may change, so please check all your configuration files on important issues. ]]> @@ -1841,15 +1629,15 @@ for details. The actions files are used to define what actions Privoxy takes for which URLs, and thus determines how ad images, cookies and various other aspects of HTTP content and - transactions are handled, and on which sites (or even parts thereof). + transactions are handled, and on which sites (or even parts thereof). There are a number of such actions, with a wide range of functionality. Each action does something a little different. - These actions give us a veritable arsenal of tools with which to exert - our control, preferences and independence. Actions can be combined so that + These actions give us a veritable arsenal of tools with which to exert + our control, preferences and independence. Actions can be combined so that their effects are aggregated when applied against a given set of URLs. - + - There + There are three action files included with Privoxy with differing purposes: @@ -1862,7 +1650,7 @@ for details. content modification, cookie handling etc should be applied by default. It should be the first actions file loaded - + default.action - defines many exceptions (both @@ -1871,15 +1659,15 @@ for details. work reasonably well as-is for most users. This file is only supposed to be edited by the developers. It should be the second actions file loaded. - + - user.action - is intended to be for local site + 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 + has specific requirements, and need special handling, this kind of thing should go here. This file will not be upgraded. - + Edit Set to Cautious Set to Medium Set to Advanced @@ -1887,16 +1675,16 @@ for details. These have increasing levels of aggressiveness and have no influence on your browsing unless you select them explicitly in the - editor. A default installation should be pre-set to + editor. A default installation should be pre-set to Cautious. New users should try this for a while before - adjusting the settings to more aggressive levels. The more aggressive - the settings, then the more likelihood there is of problems such as sites + adjusting the settings to more aggressive levels. The more aggressive + the settings, then the more likelihood there is of problems such as sites not working as they should. - The Edit button allows you to turn each + The Edit button allows you to turn each action on/off individually for fine-tuning. The Cautious - button changes the actions list to low/safe settings which will activate + button changes the actions list to low/safe settings which will activate ad blocking and a minimal set of &my-app;'s features, and subsequently there will be less of a chance for accidental problems. The Medium button sets the list to a medium level of @@ -1967,7 +1755,7 @@ for details. blocks only blocks only - + Privacy Features low @@ -2036,12 +1824,12 @@ for details. - + - + - The list of actions files to be used are defined in the main configuration + The list of actions files to be used are defined in the main configuration file, and are processed in the order they are defined (e.g. default.action is typically processed before user.action). The content of these can all be viewed and @@ -2052,7 +1840,7 @@ for details. (defined in default.action), followed by any exceptions (typically also in default.action), which are then followed lastly by any - local preferences (typically in user.action). + local preferences (typically in user.action). Generally, user.action has the last word. @@ -2062,7 +1850,7 @@ for details. alias section at the top of that file. Then comes the default set of rules which will apply universally to all sites and pages (be very careful with using such a - universal set in user.action or any other actions file after + 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 @@ -2071,7 +1859,7 @@ for details. personal settings across Privoxy upgrades easier. - + Actions can be used to block anything you want, including ads, banners, or just some obnoxious URL whose content you would rather not see. Cookies can be accepted or rejected, or accepted only during the current browser session (i.e. not @@ -2087,7 +1875,7 @@ for details. Note that some actions, like cookie suppression or script disabling, may render some sites unusable that rely on these techniques to work properly. Finding the right mix of actions is not always easy and - certainly a matter of personal taste. And, things can always change, requiring + certainly a matter of personal taste. And, things can always change, requiring refinements in the configuration. In general, it can be said that the more aggressive your default settings (in the top section of the actions file) are, the more exceptions for trusted sites you @@ -2119,13 +1907,13 @@ for details. like Cautious, Medium or Advanced. Warning: the Advanced setting is more aggressive, and will be more likely to cause problems for some sites. - Experienced users only! + Experienced users only! If you prefer plain text editing to GUIs, you can of course also directly edit the the actions files with your favorite text editor. Look at - default.action which is richly commented with many + default.action which is richly commented with many good examples. @@ -2153,12 +1941,12 @@ for details. If multiple applying sections set the same action differently, the last match wins. If not, the effects are aggregated. - E.g. a URL might match a regular section with a heading line of { + E.g. a URL might match a regular section with a heading line of { +handle-as-image }, then later another one with just { +block }, resulting - in both actions to apply. And there may well be - cases where you will want to combine actions together. Such a section then + in both actions to apply. And there may well be + cases where you will want to combine actions together. Such a section then might look like: @@ -2185,7 +1973,7 @@ for details. Patterns - + As mentioned, Privoxy uses patterns to determine what actions might apply to which sites and pages your browser attempts to access. These patterns use wild @@ -2193,23 +1981,29 @@ for details. flexibility. This allows one expression to be expanded and potentially match against many similar patterns. - + Generally, an URL pattern has the form - <domain>/<path>, where both the - <domain> and <path> are - optional. (This is why the special / pattern matches all - URLs). Note that the protocol portion of the URL pattern (e.g. - http://) should not be included in - the pattern. This is assumed already! + <domain><port>/<path>, where the + <domain>, the <port> + and the <path> are optional. (This is why the special + / pattern matches all URLs). Note that the protocol + portion of the URL pattern (e.g. http://) should + not be included in the pattern. This is assumed already! The pattern matching syntax is different for the domain and path parts of - the URL. The domain part uses a simple globbing type matching technique, - while the path part uses more flexible + the URL. The domain part uses a simple globbing type matching technique, + while the path part uses more flexible Regular Expressions (POSIX 1003.2). + + The port part of a pattern is a decimal port number preceded by a colon + (:). If the domain part contains a numerical IPv6 address, + it has to be put into angle brackets + (<, >). + @@ -2218,7 +2012,7 @@ for details. is a domain-only pattern and will match any request to www.example.com, regardless of which document on that server is requested. So ALL pages in - this domain would be covered by the scope of this action. Note that a + this domain would be covered by the scope of this action. Note that a simple example.com is different and would NOT match. @@ -2259,12 +2053,38 @@ for details. + + / + + + Matches any URL because there's no requirement for either the + domain or the path to match anything. + + + + + :8000/ + + + Matches any URL pointing to TCP port 8000. + + + + + <2001:db8::1>/ + + + Matches any URL with the host address 2001:db8::1. + (Note that the real URL uses plain brackets, not angle brackets.) + + + index.html matches nothing, since it would be interpreted as a domain name and - there is no top-level domain called .html. So its + there is no top-level domain called .html. So its a mistake. @@ -2277,7 +2097,7 @@ for details. The matching of the domain part offers some flexible options: if the - domain starts or ends with a dot, it becomes unanchored at that end. + domain starts or ends with a dot, it becomes unanchored at that end. For example: @@ -2315,7 +2135,7 @@ for details. a domain.) This might be www.example.com, news.example.de, or www.example.net/cgi/testing.pl for instance. All these - cases are matched. + cases are matched. @@ -2325,12 +2145,12 @@ for details. Additionally, there are wild-cards that you can use in the domain names themselves. These work similarly to shell globbing type wild-cards: * represents zero or more arbitrary characters (this is - equivalent to the + equivalent to the Regular Expression based syntax of .*), ? represents any single character (this is equivalent to the regular expression syntax of a simple .), and you can define - character classes in square brackets which is similar to + character classes in square brackets which is similar to the same regular expression technique. All of this can be freely mixed: @@ -2339,7 +2159,7 @@ for details. ad*.example.com - matches adserver.example.com, + matches adserver.example.com, ads.example.com, etc but not sfads.example.com @@ -2357,7 +2177,7 @@ for details. matches www.ipix.com, - pictures.epix.com, a.b.c.d.e.upix.com etc. + pictures.epix.com, a.b.c.d.e.upix.com etc. @@ -2365,9 +2185,9 @@ for details. www[1-9a-ez].example.c* - matches www1.example.com, - www4.example.cc, wwwd.example.cy, - wwwz.example.com etc., but not + matches www1.example.com, + www4.example.cc, wwwd.example.cy, + wwwz.example.com etc., but not wwww.example.com. @@ -2401,13 +2221,13 @@ for details. Note that the path pattern is automatically left-anchored at the /, - i.e. it matches as if it would start with a ^ (regular expression speak + i.e. it matches as if it would start with a ^ (regular expression speak for the beginning of a line). Please also note that matching in the path is CASE INSENSITIVE - by default, but you can switch to case sensitive at any point in the pattern by using the + by default, but you can switch to case sensitive at any point in the pattern by using the (?-i) switch: www.example.com/(?-i)PaTtErN.* will match only documents whose path starts with PaTtErN in exactly this capitalization. @@ -2418,7 +2238,7 @@ for details. .example.com/.* - Is equivalent to just .example.com, since any documents + Is equivalent to just .example.com, since any documents within that domain are matched with or without the .* regular expression. This is redundant @@ -2432,9 +2252,9 @@ for details. named index.html, and that is part of some path. For example, it matches www.example.com/testing/index.html but NOT www.example.com/index.html because the regular - expression called for at least two /'s, thus the path - requirement. It also would match - www.example.com/testing/index_html, because of the + expression called for at least two /'s, thus the path + requirement. It also would match + www.example.com/testing/index_html, because of the special meta-character .. @@ -2443,9 +2263,9 @@ for details. .example.com/(.*/)?index\.html$ - This regular expression is conditional so it will match any page - named index.html regardless of path which in this case can - have one or more /'s. And this one must contain exactly + This regular expression is conditional so it will match any page + named index.html regardless of path which in this case can + have one or more /'s. And this one must contain exactly .html (but does not have to end with that!). @@ -2455,7 +2275,7 @@ for details. This regular expression will match any path of example.com - that contains any of the words ads, banner, + that contains any of the words ads, banner, banners (because of the ?) or junk. The path does not have to end in these words, just contain them. @@ -2465,8 +2285,8 @@ for details. .example.com/(.*/)(ads|banners?|junk)/.*\.(jpe?g|gif|png)$ - This is very much the same as above, except now it must end in either - .jpg, .jpeg, .gif or .png. So this + This is very much the same as above, except now it must end in either + .jpg, .jpeg, .gif or .png. So this one is limited to common image formats. @@ -2474,7 +2294,7 @@ for details. - There are many, many good examples to be found in default.action, + There are many, many good examples to be found in default.action, and more tutorials below in Appendix on regular expressions. @@ -2564,23 +2384,23 @@ for details. - + Again, actions are invoked by placing them on a line, enclosed in curly braces and - separated by whitespace, like in + separated by whitespace, like in {+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. + of the actions file. - + Actions fall into three categories: - + Boolean, i.e the action can only be enabled or disabled. Syntax: @@ -2589,14 +2409,14 @@ for details. +name # enable action name -name # disable action name - + Example: +handle-as-image - + Parameterized, where some value is required in order to enable this type of action. Syntax: @@ -2610,13 +2430,13 @@ for details. 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/5.0 (X11; U; FreeBSD i386; en-US; rv:1.8.1.4) Gecko/20070602 Firefox/2.0.0.4} - + - + 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 @@ -2631,7 +2451,7 @@ for details. # 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} @@ -2650,8 +2470,8 @@ for details. Later defined action sections always over-ride earlier ones of the same type. - So exceptions to any rules you make, should come in the latter part of the file (or - in a file that is processed later when using multiple actions files such + So exceptions to any rules you make, should come in the latter part of the file (or + in a file that is processed later when using multiple actions files such as user.action). 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 @@ -2703,7 +2523,7 @@ for details. Multi-value. - + Parameter: @@ -2714,16 +2534,19 @@ for details. - + Notes: - This action may be specified multiple times, in order to define multiple - headers. This is rarely needed for the typical user. If you don't know what - HTTP headers are, you definitely don't need to worry about this + This action may be specified multiple times, in order to define multiple + headers. This is rarely needed for the typical user. If you don't know what + HTTP headers are, you definitely don't need to worry about this one. + + Headers added by this action are not modified by other actions. + @@ -2761,10 +2584,10 @@ for details. the handle-as-image, set-image-blocker, and + linkend="set-image-blocker">set-image-blocker, and handle-as-empty-document actions. - + @@ -2783,7 +2606,7 @@ for details. A block reason that should be given to the user. - + Notes: @@ -2794,18 +2617,18 @@ for details. to the blocked content (the latter only if the force feature is available and enabled). - - A very important exception occurs if both + + A very important exception occurs if both block and handle-as-image, - apply to the same request: it will then be replaced by an image. If + apply to the same request: it will then be replaced by an image. If set-image-blocker (see below) also applies, the type of image will be determined by its parameter, if not, the standard checkerboard pattern is sent. - It is important to understand this process, in order - to understand how Privoxy deals with - ads and other unwanted content. Blocking is a core feature, and one + It is important to understand this process, in order + to understand how Privoxy deals with + ads and other unwanted content. Blocking is a core feature, and one upon which various other features depend. @@ -2826,12 +2649,12 @@ for details. # Block and replace with "blocked" page .nasty-stuff.example.com -{+block{Doubleclick banners.} +handle-as-image} +{+block{Doubleclick banners.} +handle-as-image} # Block and replace with image .ad.doubleclick.net .ads.r.us/banners/ -{+block{Layered ads.} +handle-as-empty-document} +{+block{Layered ads.} +handle-as-empty-document} # Block and then ignore adserver.example.net/.*\.js$ @@ -2889,7 +2712,7 @@ for details. - + Notes: @@ -2954,7 +2777,7 @@ for details. - + Notes: @@ -2969,7 +2792,7 @@ for details. and use their output as input. - If the request URL gets changed, &my-app; will detect that and use the new + If the request URI gets changed, &my-app; will detect that and use the new one. This can be used to rewrite the request destination behind the client's back, for example to specify a Tor exit relay for certain requests. @@ -2991,7 +2814,7 @@ for details. {+client-header-filter{hide-tor-exit-notation}} / - + @@ -3019,7 +2842,7 @@ for details. Client headers to which this action applies are filtered on-the-fly through the specified regular expression based substitutions, the result is used as - tag. + tag. @@ -3041,7 +2864,7 @@ for details. - + Notes: @@ -3085,6 +2908,22 @@ TAG:^User-Agent: fetch libfetch/ TAG:^User-Agent: Ubuntu APT-HTTP/ TAG:^User-Agent: MPlayer/ + + + +# Tag all requests with the Range header set +{+client-header-tagger{range-requests}} +/ + +# Disable filtering for the tagged requests. +# +# With filtering enabled Privoxy would remove the Range headers +# to be able to filter the whole response. The downside is that +# it prevents clients from resuming downloads or skipping over +# parts of multimedia files. +{-filter -deanimate-gifs} +TAG:^RANGE-REQUEST$ + @@ -3126,11 +2965,11 @@ TAG:^User-Agent: MPlayer/ Parameter: - Any string. - + Any string. + - + Notes: @@ -3139,7 +2978,7 @@ TAG:^User-Agent: MPlayer/ browser to decide what to do with the document. The value of this header can cause the browser to open a download menu instead of displaying the document by itself, even if the document's format is - supported by the browser. + supported by the browser. The declared content type can also affect which rendering mode @@ -3153,13 +2992,13 @@ TAG:^User-Agent: MPlayer/ Content-Type: text/html, you can use &my-app; to overwrite it with application/xml and validate the web master's claim inside your XHTML-supporting browser. - If the syntax is incorrect, the browser will complain loudly. + If the syntax is incorrect, the browser will complain loudly. You can also go the opposite direction: if your browser prints error messages instead of rendering a document falsely declared as XHTML, you can overwrite the content type with - text/html and have it rendered as broken HTML document. + text/html and have it rendered as broken HTML document. By default content-type-overwrite only replaces @@ -3177,7 +3016,7 @@ TAG:^User-Agent: MPlayer/ Of course you can apply content-type-overwrite to a whole site and then make URL based exceptions, but it's a lot - more work to get the same precision. + more work to get the same precision. @@ -3239,10 +3078,10 @@ new action Any string. - + - + Notes: @@ -3275,7 +3114,7 @@ new action Example usage (section): - # Block the non-existent "Privacy-Violation:" client header + # Block the non-existent "Privacy-Violation:" client header { +crunch-client-header{Privacy-Violation:} } / @@ -3322,10 +3161,10 @@ new action N/A - + - + Notes: @@ -3409,7 +3248,7 @@ new action - + Notes: @@ -3422,7 +3261,7 @@ new action It makes no sense at all to use this action in conjunction with the session-cookies-only action, - since it would prevent the session cookies from being set. See also + since it would prevent the session cookies from being set. See also filter-content-cookies. @@ -3476,10 +3315,10 @@ new action Any string. - + - + Notes: @@ -3560,7 +3399,7 @@ new action - + Notes: @@ -3628,7 +3467,7 @@ new action - + Notes: @@ -3696,16 +3535,26 @@ new action - + Notes: 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 HTTP/1.1 features and requirements are supported yet, - so there is a chance you might need this action. + unlikely case that you experience HTTP/1.1-related problems with some server + out there. + + + Note that enabling this action is only a workaround. It should not + be enabled for sites that work without it. While it shouldn't break + any pages, it has an (usually negative) performance impact. + + + If you come across a site where enabling this action helps, please report it, + so the cause of the problem can be analyzed. If the problem turns out to be + caused by a bug in Privoxy it should be + fixed so the following release works without the work around. @@ -3776,7 +3625,7 @@ problem-host.example.com 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 @@ -3794,7 +3643,7 @@ problem-host.example.com This feature is currently not very smart and is scheduled for improvement. If it is enabled by default, you will have to create some exceptions to - this action. It can lead to failures in several ways: + this action. It can lead to failures in several ways: Not every URLs with other URLs as parameters is evil. @@ -3835,7 +3684,7 @@ problem-host.example.com { +fast-redirects{simple-check} } - one.example.com + one.example.com { +fast-redirects{check-decoded-url} } another.example.com/testing @@ -3855,7 +3704,7 @@ problem-host.example.com Typical use: - Get rid of HTML and JavaScript annoyances, banner advertisements (by size), + Get rid of HTML and JavaScript annoyances, banner advertisements (by size), do fun text replacements, add personalized effects, etc. @@ -3880,17 +3729,17 @@ problem-host.example.com Parameterized. - + Parameter: The name of a content filter, as defined in the filter file. - Filters can be defined in one or more files as defined by the + Filters can be defined in one or more files as defined by the filterfile - option in the config file. - default.filter is the collection of filters - supplied by the developers. Locally defined filters should go + option in the config file. + default.filter is the collection of filters + supplied by the developers. Locally defined filters should go in their own file, such as user.filter. @@ -3899,38 +3748,39 @@ problem-host.example.com - + Notes: - For your convenience, there are a number of pre-defined filters available + For your convenience, there are a number of pre-defined filters available in the distribution filter file that you can use. See the examples below for a list. Filtering requires buffering the page content, which may appear to slow down page rendering since nothing is displayed until all content has - passed the filters. (It does not really take longer, but seems that way - since the page is not incrementally displayed.) This effect will be more - noticeable on slower connections. + passed the filters. (The total time until the page is completely rendered + doesn't change much, but it may be perceived as slower since the page is + not incrementally displayed.) + This effect will be more noticeable on slower connections. Rolling your own - filters requires a knowledge of + filters requires a knowledge of Regular - Expressions and + Expressions and HTML. - This is very powerful feature, and potentially very intrusive. + This is very powerful feature, and potentially very intrusive. Filters should be used with caution, and where an equivalent action is not available. - The amount of data that can be filtered is limited to the + The amount of data that can be filtered is limited to the buffer-limit - option in the main config file. The + option in the main config file. The default is 4096 KB (4 Megs). Once this limit is exceeded, the buffered - data, and all pending data, is passed through unfiltered. + data, and all pending data, is passed through unfiltered. Inappropriate MIME types, such as zipped files, are not filtered at all. @@ -3941,10 +3791,10 @@ problem-host.example.com by defining appropriate -filter exceptions. - Compressed content can't be filtered either, unless &my-app; - is compiled with zlib support (requires at least &my-app; 3.0.7), - in which case &my-app; will decompress the content before filtering - it. + Compressed content can't be filtered either, but if &my-app; + is compiled with zlib support and a supported compression algorithm + is used (gzip or deflate), &my-app; can first decompress the content + and then filter it. If you use a &my-app; version without zlib support, but want filtering to work on @@ -3953,11 +3803,11 @@ problem-host.example.com action in conjunction with filter. - Content filtering can achieve some of the same effects as the + Content filtering can achieve some of the same effects as the block - action, i.e. it can be used to block ads and banners. But the mechanism - works quite differently. One effective use, is to block ad banners - based on their size (see below), since many of these seem to be somewhat + action, i.e. it can be used to block ads and banners. But the mechanism + works quite differently. One effective use, is to block ad banners + based on their size (see below), since many of these seem to be somewhat standardized. @@ -3975,7 +3825,7 @@ problem-host.example.com Example usage (with filters from the distribution default.filter file). - See the Predefined Filters section for + See the Predefined Filters section for more explanation on each: @@ -3984,7 +3834,7 @@ problem-host.example.com - +filter{js-events} # Kill all JS event bindings and timers (Radically destructive! Only for extra nasty sites). + +filter{js-events} # Kill JavaScript event bindings and timers (Radically destructive! Only for extra nasty sites). @@ -3996,15 +3846,15 @@ problem-host.example.com - +filter{refresh-tags} # Kill automatic refresh tags (for dial-on-demand setups). + +filter{refresh-tags} # Kill automatic refresh tags if refresh time is larger than 9 seconds. - +filter{unsolicited-popups} # Disable only unsolicited pop-up windows. Useful if your browser lacks this ability. + +filter{unsolicited-popups} # Disable only unsolicited pop-up windows. - +filter{all-popups} # Kill all popups in JavaScript and HTML. Useful if your browser lacks this ability. + +filter{all-popups} # Kill all popups in JavaScript and HTML. @@ -4034,6 +3884,10 @@ problem-host.example.com +filter{frameset-borders} # Give frames a border and make them resizable. + + + +filter{iframes} # Removes all detected iframes. Should only be enabled for individual sites. + +filter{demoronizer} # Fix MS's non-standard use of standard charsets. @@ -4107,7 +3961,7 @@ new action Declares a document as text, even if the Content-Type: isn't detected as such. - + @@ -4139,7 +3993,7 @@ new action force-text-mode declares a document as text, without looking at the Content-Type: first. - + Think twice before activating this action. Filtering binary data with regular expressions can cause file damage. @@ -4147,7 +4001,7 @@ new action - + Example usage: @@ -4181,7 +4035,7 @@ new action Overrules the forward directives in the configuration file. - + @@ -4235,7 +4089,7 @@ new action file, but without the URL pattern. It can be used as replacement, but normally it's only used in cases where matching based on the request URL isn't sufficient. - + Please read the description for the forward directives before using this action. Forwarding to the wrong people will reduce your privacy and increase the @@ -4253,7 +4107,7 @@ new action - + Example usage: @@ -4347,7 +4201,7 @@ new action # Block all documents on example.org that end with ".js", -# but send an empty document instead of the usual HTML message. +# but send an empty document instead of the usual HTML message. {+block{Blocked JavaScript} +handle-as-empty-document} example.org/.*\.js$ @@ -4400,14 +4254,14 @@ example.org/.*\.js$ - + Notes: 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. + be left intact. Users will probably only want to use the handle-as-image action in conjunction with @@ -4481,10 +4335,10 @@ new action Keyword: block, or any user defined value. - + - + Notes: @@ -4510,7 +4364,7 @@ new action to a rare language, you should consider that it helps to make your requests unique and thus easier to trace. If you don't plan to change this header frequently, - you should stick to a common language. + you should stick to a common language. @@ -4567,10 +4421,10 @@ new action Keyword: block, or any user defined value. - + - + Notes: @@ -4639,7 +4493,7 @@ new action Effect: - Deletes the If-Modified-Since: HTTP client header or modifies its value. + Deletes the If-Modified-Since: HTTP client header or modifies its value. @@ -4657,10 +4511,10 @@ new action Keyword: block, or a user defined value that specifies a range of hours. - + - + Notes: @@ -4748,12 +4602,12 @@ new action - + Notes: - The keyword block will completely remove the header + The keyword block will completely remove the header (not to be confused with the block action). @@ -4834,7 +4688,7 @@ new action - + Notes: @@ -4863,12 +4717,12 @@ new action will work with referrer checks, as long as content and valid referring page are on the same host. Most of the time that's the case. - + 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.) + requires it to be spelled as referer.) @@ -4924,16 +4778,16 @@ new action - + Notes: - + This can lead to problems on web sites that depend on looking at this header in order to customize their content for different browsers (which, by the way, is NOT the right thing to do: good web sites - work browser-independently). + work browser-independently). @@ -4942,17 +4796,14 @@ new action 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. It is also occasionally useful to forge this in order to access - sites that won't let you in otherwise (though there may be a good - reason in some cases). Example of this: some MSN sites will not - let Mozilla enter, yet forging to a - Netscape 6.1 user-agent works just fine. - (Must be just a silly MS goof, I'm sure :-). + OS. It is also occasionally useful to forge this in order to access + sites that won't let you in otherwise (though there may be a good + reason in some cases). - More information on known user-agent strings can be found at + More information on known user-agent strings can be found at http://www.user-agents.org/ - and + and http://en.wikipedia.org/wiki/User_agent. @@ -5008,7 +4859,7 @@ new action - + Notes: @@ -5051,6 +4902,94 @@ new action + + + +limit-cookie-lifetime + + + + Typical use: + + Limit the lifetime of HTTP cookies to a couple of minutes or hours. + + + + + Effect: + + + Overwrites the expires field in Set-Cookie server headers if it's above the specified limit. + + + + + + Type: + + + Parameterized. + + + + + Parameter: + + + The lifetime limit in minutes, or 0. + + + + + + Notes: + + + This action reduces the lifetime of HTTP cookies coming from the + server to the specified number of minutes, starting from the time + the cookie passes Privoxy. + + + Cookies with a lifetime below the limit are not modified. + The lifetime of session cookies is set to the specified limit. + + + The effect of this action depends on the server. + + + In case of servers which refresh their cookies with each response + (or at least frequently), the lifetime limit set by this action + is updated as well. + Thus, a session associated with the cookie continues to work with + this action enabled, as long as a new request is made before the + last limit set is reached. + + + However, some servers send their cookies once, with a lifetime of several + years (the year 2037 is a popular choice), and do not refresh them + until a certain event in the future, for example the user logging out. + In this case this action may limit the absolute lifetime of the session, + even if requests are made frequently. + + + If the parameter is 0, this action behaves like + session-cookies-only. + + + + + + Example usages: + + + +limit-cookie-lifetime{60} + + + + + + + prevent-compression @@ -5091,7 +5030,7 @@ new action - + Notes: @@ -5111,7 +5050,7 @@ new action Most text-based instances compress very well, the size is seldom decreased by less than 50%, for markup-heavy instances like news feeds saving more than 90% of the original size isn't - unusual. + unusual. Not using compression will therefore slow down the transfer, and you should only @@ -5176,7 +5115,7 @@ new action Effect: - Deletes the Last-Modified: HTTP server header or modifies its value. + Deletes the Last-Modified: HTTP server header or modifies its value. @@ -5195,10 +5134,10 @@ new action One of the keywords: block, reset-to-request-time and randomize - + - + Notes: @@ -5214,13 +5153,13 @@ new action between the original value and the current time. In theory the server could send each document with a different Last-Modified: header to track visits without using cookies. Randomize - makes it impossible and the browser can still revalidate cached documents. + makes it impossible and the browser can still revalidate cached documents. reset-to-request-time overwrites the value of the Last-Modified: header with the current time. You could use this option together with - hided-if-modified-since + hide-if-modified-since to further customize your random range. @@ -5230,7 +5169,7 @@ new action of the request, the random range becomes zero and the value stays the same. Therefore you should later randomize it a second time with hided-if-modified-since, - just to be sure. + just to be sure. It is also recommended to use this action together with @@ -5297,7 +5236,7 @@ new action - + Notes: @@ -5307,6 +5246,10 @@ new action either provided as parameter, or derived by applying a single pcrs command to the original URL. + + The syntax for pcrs commands is documented in the + filter file section. + This action will be ignored if you use it together with block. @@ -5406,7 +5349,7 @@ www.privoxy.org/user-manual/ - + Notes: @@ -5489,7 +5432,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not - + Notes: @@ -5540,7 +5483,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not Allow only temporary session cookies (for the current - browser session only). + browser session only). @@ -5572,12 +5515,12 @@ example.org/instance-that-is-delivered-as-xml-but-is-not - + Notes: - This is less strict than crunch-incoming-cookies / + This is less strict than crunch-incoming-cookies / crunch-outgoing-cookies and allows you to browse websites that insist or rely on setting cookies, without compromising your privacy too badly. @@ -5585,7 +5528,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not 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 + that you can log in for transactions. This is generally turned on for all sites, and is the recommended setting. @@ -5604,9 +5547,9 @@ example.org/instance-that-is-delivered-as-xml-but-is-not These would have to be removed manually. - Privoxy also uses - the content-cookies filter - to block some types of cookies. Content cookies are not effected by + Privoxy also uses + the content-cookies filter + to block some types of cookies. Content cookies are not effected by session-cookies-only. @@ -5680,7 +5623,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not target-url to send a redirect to target-url. You can redirect - to any image anywhere, even in your local filesystem via file:/// URL. + to any image anywhere, even in your local filesystem via file:/// URL. (But note that not all browsers support redirecting to a local file system). @@ -5743,8 +5686,8 @@ example.org/instance-that-is-delivered-as-xml-but-is-not Summary Note that many of these actions have the potential to cause a page to - misbehave, possibly even not to display at all. There are many ways - a site designer may choose to design his site, and what HTTP header + misbehave, possibly even not to display at all. There are many ways + a site designer may choose to design his site, and what HTTP header content, and other criteria, he may depend on. There is no way to have hard and fast rules for all sites. See the Appendix for a brief example on troubleshooting @@ -5762,7 +5705,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not 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 + { 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 @@ -5829,7 +5772,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not - ...and put them to use. These sections would appear in the lower part of an + ...and put them to use. These sections would appear in the lower part of an actions file and define exceptions to the default actions (as specified further up for the / pattern): @@ -5847,7 +5790,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not # Shopping sites: # Allow cookies (for setting and retrieving your customer data) - # + # {shop} .quietpc.com .worldpay.com # for quietpc.com @@ -5861,8 +5804,8 @@ example.org/instance-that-is-delivered-as-xml-but-is-not - Aliases like shop and fragile are typically used for - problem sites that require more than one action to be disabled + Aliases like shop and fragile are typically used for + problem sites that require more than one action to be disabled in order to function properly. @@ -5907,7 +5850,7 @@ hal stop here preceding the action name enables the action, a - disables!). Also note how this long line has been made more readable by splitting it into multiple lines with line continuation. - + @@ -6010,13 +5953,13 @@ mail.google.com require cookies to log in, and pop-up windows for shopping carts or item details. Again, we'll use a pre-defined alias: - + # Shopping sites: # { shop } -.quietpc.com +.quietpc.com .worldpay.com # for quietpc.com .jungle.com .scan.co.uk @@ -6085,7 +6028,7 @@ edit.*.yahoo.com # Known ad generators: # { +block-as-image } -ar.atwola.com +ar.atwola.com .ad.doubleclick.net .ad.*.doubleclick.net .a.yimg.com/(?:(?!/i/).)*$ @@ -6120,7 +6063,7 @@ bs*.gsanet.com { +block{Banner ads.} } # Generic patterns: -# +# ad*. .*ads. banner?. @@ -6141,7 +6084,7 @@ count*. But being very generic, they necessarily also catch URLs that we don't want - to block. The pattern .*ads. e.g. catches + to block. The pattern .*ads. e.g. catches nasty-ads.nasty-corp.com as intended, but also downloads.sourcefroge.net or adsl.some-provider.net. So here come some @@ -6168,7 +6111,7 @@ count*. ########################################################################## # By domain: -# +# { -block } adv[io]*. # (for advogato.org and advice.*) adsl. # (has nothing to do with ads) @@ -6218,13 +6161,13 @@ wiki. So far we are painting with a broad brush by setting general policies, - which would be a reasonable starting point for many people. Now, + which would be a reasonable starting point for many people. Now, you might want to be more specific and have customized rules that are more suitable to your personal habits and preferences. These would be for narrowly defined situations like your ISP or your bank, and should - be placed in user.action, which is parsed after all other + be placed in user.action, which is parsed after all other actions files and hence has the last word, over-riding any previously - defined actions. user.action is also a + defined actions. user.action is also a safe place for your personal settings, since default.action is actively maintained by the Privoxy developers and you'll probably want @@ -6233,7 +6176,7 @@ wiki. So let's look at a few examples of things that one might typically do in - user.action: + user.action: @@ -6256,8 +6199,8 @@ wiki. # (Re-)define aliases for this file: # {{alias}} -# -# These aliases just save typing later, and the alias names should +# +# These aliases just save typing later, and the alias names should # be self explanatory. # +crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies @@ -6288,7 +6231,7 @@ handle-as-text = -filter +-block action. Say you've seen an ad on your favourite page on example.com that you want to get rid of. You have right-clicked the image, selected copy image location - and pasted the URL below while removing the leading http://, into a + and pasted the URL below while removing the leading http://, into a { +block{} } section. Note that { +handle-as-image } need not be specified, since all URLs ending in .gif will be tagged as images by the general rules as set @@ -6351,7 +6294,7 @@ stupid-server.example.com/ The URLs of dynamically generated banners, especially from large banner farms, often don't use the well-known image file name extensions, which makes it impossible for Privoxy to guess - the file type just by looking at the URL. + the file type just by looking at the URL. You can use the +block-as-image alias defined above for these cases. Note that objects which match this rule but then turn out NOT to be an @@ -6376,7 +6319,7 @@ stupid-server.example.com/ -- whoa! -- it worked. The fragile aliases disables those actions that are most likely to break a site. Also, good for testing purposes to see if it is Privoxy - that is causing the problem or not. We later find other regular sites + that is causing the problem or not. We later find other regular sites that misbehave, and add those to our personalized list of troublemakers: @@ -6421,19 +6364,19 @@ stupid-server.example.com/ { allow-ads } .sourceforge.net .slashdot.org - .osdn.net + .osdn.net - Note that allow-ads has been aliased to - -block, - -filter{banners-by-size}, and + Note that allow-ads has been aliased to + -block, + -filter{banners-by-size}, and -filter{banners-by-link} above. Invoke another alias here to force an over-ride of the MIME type - application/x-sh which typically would open a download type + application/x-sh which typically would open a download type dialog. In my case, I want to look at the shell script, and then I can save it should I choose to. @@ -6441,7 +6384,7 @@ stupid-server.example.com/ { handle-as-text } - /.*\.sh$ + /.*\.sh$ @@ -6476,7 +6419,7 @@ stupid-server.example.com/ On-the-fly text substitutions need - to be defined in a filter file. Once defined, they + to be defined in a filter file. Once defined, they can then be invoked as an action. @@ -6530,7 +6473,7 @@ stupid-server.example.com/ Substitutions are made at the source level, so if you want to roll - your own filters, you should first be familiar with HTML syntax, + your own filters, you should first be familiar with HTML syntax, and, of course, regular expressions. @@ -6540,7 +6483,7 @@ stupid-server.example.com/ here. Each filter consists of a heading line, that starts with one of the keywords FILTER:, CLIENT-HEADER-FILTER: or SERVER-HEADER-FILTER: - followed by the filter's name, and a short (one line) + followed by the filter's name, and a short (one line) description of what it does. Below that line come the jobs, i.e. lines that define the actual text substitutions. By convention, the name of a filter @@ -6555,7 +6498,7 @@ stupid-server.example.com/ +filter{name} in any actions file. - + Filter definitions start with a header line that contains the filter type, the filter name and the filter description. @@ -6579,13 +6522,13 @@ stupid-server.example.com/ - If you are new to + If you are new to Regular Expressions, you might want to take a look at the Appendix on regular expressions, and see the Perl manual for - the + the s/// operator's syntax and Perl-style regular expressions in general. @@ -6700,7 +6643,7 @@ s|(<script.*)document\.referrer(.*</script>)|$1"Not Your Business!"$2|U Now the pattern is deciphered, but wasn't this about substituting things? So lets look at the substitute: $1"Not Your Business!"$2 is - easy to read: The text remembered as $1, followed by + easy to read: The text remembered as $1, followed by "Not Your Business!" (including the quotation marks!), followed by the text remembered as $2. This produces an exact copy of the original string, with the middle part @@ -6767,7 +6710,7 @@ s/(<body [^>]*)onunload(.*>)/$1never$2/iU Note that the i option makes the pattern matching case-insensitive. Also note that ungreedy matching alone doesn't always guarantee a minimal match: In the first parenthesis, we had to use [^>]* - instead of .* to prevent the match from exceeding the + instead of .* to prevent the match from exceeding the <body> tag if it doesn't contain OnUnload, but the page's content does. @@ -6787,7 +6730,7 @@ s/microsoft(?!\.com)/MicroSuck/ig Note the (?!\.com) part (a so-called negative lookahead) - in the job's pattern, which means: Don't match, if the string + in the job's pattern, which means: Don't match, if the string .com appears directly following microsoft in the page. This prevents links to microsoft.com from being trashed, while still replacing the word everywhere else. @@ -6813,7 +6756,7 @@ s* industry[ -]leading \ The x option in this job turns on extended syntax, and allows for - e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting. + e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting. @@ -6825,11 +6768,11 @@ s* industry[ -]leading \ The Pre-defined Filters - @@ -6869,12 +6812,12 @@ pre-defined filters for your convenience: - Use with caution. This is an aggressive filter, and can break sites that + Use with caution. This is an aggressive filter, and can break sites that rely heavily on JavaScript. - + js-events @@ -6898,7 +6841,7 @@ pre-defined filters for your convenience: This filter will undo many common instances of HTML based abuse. - The BLINK and MARQUEE tags + The BLINK and MARQUEE tags are neutralized (yeah baby!), and browser windows will be created as resizeable (as of course they should be!), and will have location, scroll and menu bars -- even if specified otherwise. @@ -6919,19 +6862,19 @@ pre-defined filters for your convenience: This filter disables most HTML and JavaScript code that reads or sets - cookies. It cannot detect all clever uses of these types of code, so it + cookies. It cannot detect all clever uses of these types of code, so it should not be relied on as an absolute fix. Use it wherever you would also - use the cookie crunch actions. + use the cookie crunch actions. - refresh tags + refresh-tags - Disable any refresh tags if the interval is greater than nine seconds (so - that redirections done via refresh tags are not destroyed). This is useful + Disable any refresh tags if the interval is greater than nine seconds (so + that redirections done via refresh tags are not destroyed). This is useful for dial-on-demand setups, or for those who find this HTML feature annoying. @@ -6942,9 +6885,9 @@ pre-defined filters for your convenience: unsolicited-popups - This filter attempts to prevent only unsolicited pop-up - windows from opening, yet still allow pop-up windows that the user - has explicitly chosen to open. It was added in version 3.0.1, + This filter attempts to prevent only unsolicited pop-up + windows from opening, yet still allow pop-up windows that the user + has explicitly chosen to open. It was added in version 3.0.1, as an improvement over earlier such filters. @@ -6955,7 +6898,7 @@ pre-defined filters for your convenience: This is recommended only for browsers that cannot perform this function - reliably themselves. And be aware that some sites require such windows + reliably themselves. And be aware that some sites require such windows in order to function normally. Use with caution. @@ -6988,7 +6931,7 @@ pre-defined filters for your convenience: banners-by-size - This filter removes image tags purely based on what size they are. Fortunately + This filter removes image tags purely based on what size they are. Fortunately for us, many ads and banner images tend to conform to certain standardized sizes, which makes this filter quite effective for ad stripping purposes. @@ -6997,7 +6940,7 @@ pre-defined filters for your convenience: but just happen to be of one of the standard banner sizes. - Recommended only for those who require extreme ad blocking. The default + Recommended only for those who require extreme ad blocking. The default block rules should catch 95+% of all ads without this filter enabled. @@ -7007,7 +6950,7 @@ pre-defined filters for your convenience: banners-by-link - This is an experimental filter that attempts to kill any banners if + This is an experimental filter that attempts to kill any banners if their URLs seem to point to known or suspected click trackers. It is currently not of much value and is not recommended for use by default. @@ -7018,7 +6961,7 @@ pre-defined filters for your convenience: webbugs - Webbugs are small, invisible images (technically 1X1 GIF images), that + Webbugs are small, invisible images (technically 1X1 GIF images), that are used to track users across websites, and collect information on them. As an HTML page is loaded by the browser, an embedded image tag causes the browser to contact a third-party site, disclosing the tracking information @@ -7037,7 +6980,7 @@ pre-defined filters for your convenience: A rather special-purpose filter that can be used to enlarge textareas (those - multi-line text boxes in web forms) and turn off hard word wrap in them. + multi-line text boxes in web forms) and turn off hard word wrap in them. It was written for the sourceforge.net tracker system where such boxes are a nuisance, but it can be handy on other sites, too. @@ -7081,20 +7024,20 @@ pre-defined filters for your convenience: Many Microsoft products that generate HTML use non-standard extensions (read: violations) of the ISO 8859-1 aka Latin-1 character set. This can cause those - HTML documents to display with errors on standard-compliant platforms. + HTML documents to display with errors on standard-compliant platforms. - This filter translates the MS-only characters into Latin-1 equivalents. - It is not necessary when using MS products, and will cause corruption of + This filter translates the MS-only characters into Latin-1 equivalents. + It is not necessary when using MS products, and will cause corruption of all documents that use 8-bit character sets other than Latin-1. It's mostly worthwhile for Europeans on non-MS platforms, if weird garbage characters - sometimes appear on some pages, or user agents that don't correct for this on + sometimes appear on some pages, or user agents that don't correct for this on the fly. +--> @@ -7104,7 +7047,7 @@ pre-defined filters for your convenience: A filter for shockwave haters. As the name suggests, this filter strips code - out of web pages that is used to embed shockwave flash objects. + out of web pages that is used to embed shockwave flash objects. @@ -7180,12 +7123,12 @@ pre-defined filters for your convenience: - + yahoo - Another CSS based block, this time for Yahoo text ads. And removes + Another CSS based block, this time for Yahoo text ads. And removes a width limitation as well. @@ -7195,7 +7138,7 @@ pre-defined filters for your convenience: msn - Another CSS based block, this time for MSN text ads. And removes + Another CSS based block, this time for MSN text ads. And removes tracking URLs, as well as a width limitation. @@ -7224,7 +7167,7 @@ pre-defined filters for your convenience: - + html-to-xml @@ -7303,13 +7246,13 @@ pre-defined filters for your convenience: Privoxy's Template Files - All Privoxy built-in pages, i.e. error pages such as the + All Privoxy built-in pages, i.e. error pages such as the 404 - No Such Domain error page, the BLOCKED page and all pages of its web-based - user interface, are generated from templates. + user interface, are generated from templates. (Privoxy must be running for the above links to work as intended.) @@ -7326,10 +7269,10 @@ pre-defined filters for your convenience: or exports), which Privoxy fills at run time. It is possible to edit the templates with a normal text editor, should you want to customize them. (Not recommended for the casual - user). Should you create your own custom templates, you should use + user). Should you create your own custom templates, you should use the config setting templdir to specify an alternate location, so your templates do not get overwritten - during upgrades. + during upgrades. Note that just like in configuration files, lines starting @@ -7412,11 +7355,20 @@ Requests ©right; + + Privoxy is free software; you can + redistribute it and/or modify it under the terms of the + GNU General Public License, version 2, + as published by the Free Software Foundation and included in + the next section. + + -License - - &license; - +License + + + + @@ -7461,7 +7413,7 @@ Requests expressions in its actions files and filter file, through the PCRE and - @@ -7488,7 +7440,7 @@ Requests To make a simple analogy, we do something similar when we use wild-card - characters when listing files with the dir command in DOS. + characters when listing files with the dir command in DOS. *.* matches all filenames. The special character here is the asterisk which matches any and all characters. We can be more specific and use ? to match just individual @@ -7499,7 +7451,7 @@ Requests Regular expressions do essentially the same thing, but are much, much more - powerful. There are many more special characters and ways of + powerful. There are many more special characters and ways of building complex patterns however. Let's look at a few of the common ones, and then some examples: @@ -7535,10 +7487,10 @@ Requests \ - The escape character denotes that - the following character should be taken literally. This is used where one of the + the following character should be taken literally. This is used where one of the special characters (e.g. .) 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 + not as a special meta-character. Example: example\.com, makes + sure the period is recognized only as a period (and not expanded to its meta-character meaning of any single character). @@ -7547,7 +7499,7 @@ Requests [ ] - Characters enclosed in brackets will be matched if any of the enclosed characters are encountered. For instance, [0-9] - matches any numeric digit (zero through nine). As an example, we can combine + matches any numeric digit (zero through nine). As an example, we can combine this with + to match any digit one of more times: [0-9]+. @@ -7564,14 +7516,14 @@ Requests | - The bar character works like an or conditional statement. A match is successful if the sub-expression on either side of | matches. As an example: - /(this|that) example/ uses grouping and the bar character + /(this|that) example/ uses grouping and the bar character and would match either this example or that example, and nothing else. - These are just some of the ones you are likely to use when matching URLs with + These are just some of the ones you are likely to use when matching URLs with Privoxy, and is a long way from a definitive list. This is enough to get us started with a few simple examples which may be more illuminating: @@ -7579,12 +7531,12 @@ Requests /.*/banners/.* - A simple example - that uses the common combination of . and * to + that uses the common combination of . and * to denote any character, zero or more times. In other words, any string at all. - So we start with a literal forward slash, then our regular expression pattern + So we start with a literal forward slash, then our regular expression pattern (.*) another literal forward slash, the string banners, another forward slash, and lastly another - .*. We are building + .*. We are building a directory path here. This will match any file with the path that has a directory named banners in it. The .* matches any characters, and this could conceivably be more forward slashes, so it @@ -7600,14 +7552,14 @@ Requests - /.*/adv((er)?ts?|ertis(ing|ements?))?/ - + /.*/adv((er)?ts?|ertis(ing|ements?))?/ - We have several literal forward slashes again (/), so we are - building another expression that is a file path statement. We have another + building another expression that is a file path statement. We have another .*, so we are matching against any conceivable sub-path, just so it matches our expression. The only true literal that must match our pattern is adv, together with the forward slashes. What comes after the adv string is the - interesting part. + interesting part. @@ -7617,29 +7569,29 @@ Requests ((er)?ts?|ertis(ing|ements?)) is optional, as are the individual sub-expressions: (er), (ing|ements?), and the s. The | - means or. We have two of those. For instance, - (ing|ements?), can expand to match either ing + means or. We have two of those. For instance, + (ing|ements?), can expand to match either ing OR ements?. What is being done here, is an - attempt at matching as many variations of advertisement, and + attempt at matching as many variations of advertisement, and similar, as possible. So this would expand to match just adv, or advert, or adverts, or advertising, or advertisement, or - advertisements. You get the idea. But it would not match + advertisements. You get the idea. But it would not match advertizements (with a z). We could fix that by - changing our regular expression to: + changing our regular expression to: /.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/, which would then match either spelling. - /.*/advert[0-9]+\.(gif|jpe?g) - Again - another path statement with forward slashes. Anything in the square brackets + /.*/advert[0-9]+\.(gif|jpe?g) - Again + another path statement with forward slashes. Anything in the square brackets [ ] can be matched. This is using 0-9 as a shorthand expression to mean any digit one through nine. It is the same as saying 0123456789. So any digit matches. The + - means one or more of the preceding expression must be included. The preceding - expression here is what is in the square brackets -- in this case, any digit - one through nine. Then, at the end, we have a grouping: (gif|jpe?g). + means one or more of the preceding expression must be included. The preceding + expression here is what is in the square brackets -- in this case, any digit + one through nine. Then, at the end, we have a grouping: (gif|jpe?g). This includes a |, so this needs to match the expression on either side of that bar character also. A simple gif on one side, and the other side will in turn match either jpeg or jpg, @@ -7669,7 +7621,7 @@ Requests - More reading on Perl Compatible Regular expressions: + More reading on Perl Compatible Regular expressions: http://perldoc.perl.org/perlre.html @@ -7688,22 +7640,22 @@ Requests Privoxy's Internal Pages - Since Privoxy proxies each requested - web page, it is easy for Privoxy to + Since Privoxy proxies each requested + web page, it is easy for Privoxy to trap certain special URLs. In this way, we can talk directly to - Privoxy, and see how it is - configured, see how our rules are being applied, change these + Privoxy, and see how it is + configured, see how our rules are being applied, change these rules and other configuration options, and even turn - Privoxy's filtering off, all with + Privoxy's filtering off, all with a web browser. - The URLs listed below are the special ones that allow direct access + The URLs listed below are the special ones that allow direct access to Privoxy. Of course, - Privoxy must be running to access these. If - not, you will get a friendly error message. Internet access is not + Privoxy must be running to access these. If + not, you will get a friendly error message. Internet access is not necessary either. @@ -7711,11 +7663,11 @@ Requests - - Privoxy main page: + + Privoxy main page:
- + http://config.privoxy.org/
@@ -7727,77 +7679,77 @@ Requests
- - Show information about the current configuration, including viewing and + + Show information about the current configuration, including viewing and editing of actions files:
- + http://config.privoxy.org/show-status
- + - + Show the source code version numbers:
- + http://config.privoxy.org/show-version
- + - + Show the browser's request headers:
- + http://config.privoxy.org/show-request
- + - + Show which actions apply to a URL and why:
- + http://config.privoxy.org/show-url-info
- + - - Toggle Privoxy on or off. This feature can be turned off/on in the main + + Toggle Privoxy on or off. This feature can be turned off/on in the main config file. When toggled off, Privoxy continues to run, but only as a pass-through proxy, with no actions taking place:
- + http://config.privoxy.org/toggle
- Short cuts. Turn off, then on: + Short cuts. Turn off, then on:
- + http://config.privoxy.org/toggle?set=disable
- + http://config.privoxy.org/toggle?set=enable
- +
@@ -7822,7 +7774,7 @@ Requests the bookmark may not be safe - just click OK. Then you can run the Bookmarklet directly from your favorites/bookmarks. For even faster access, you can put them on the Links bar (IE) or the Personal - Toolbar (Netscape), and run them with a single click. + Toolbar (Netscape), and run them with a single click. @@ -7833,47 +7785,47 @@ Requests Privoxy - Enable -
+ Privoxy - Disable - + Privoxy - Toggle Privoxy (Toggles between enabled and disabled) - + Privoxy- View Status - + + + --> Privoxy - Why? - + Credit: The site which gave us the general idea for these bookmarklets is www.bookmarklets.com. They - have more information about bookmarklets. + have more information about bookmarklets. @@ -7886,7 +7838,7 @@ Requests Chain of Events - Let's take a quick look at how some of Privoxy's + Let's take a quick look at how some of Privoxy's core features are triggered, and the ensuing sequence of events when a web page is requested by your browser: @@ -7895,48 +7847,48 @@ Requests - 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: + 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 + 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 + Next, Privoxy checks to see if the URL matches any +block patterns. If so, the URL is then blocked, and the remote web server will not be contacted. - +handle-as-image - and + +handle-as-image + and +handle-as-empty-document - are then checked, and if there is no match, an + are then checked, and if there is no match, an HTML BLOCKED page is sent back to the browser. Otherwise, if it does match, an image is returned for the former, and an empty text document for the latter. The type of image would depend on the setting of +set-image-blocker (blank, checkerboard pattern, or an HTTP redirect to an image elsewhere). - + Untrusted URLs are blocked. If URLs are being added to the trust file, then that is done. - + If the URL pattern matches the +fast-redirects action, it is then processed. Unwanted parts of the requested URL are stripped. - + Now the rest of the client browser's request headers are processed. If any @@ -7945,24 +7897,24 @@ Requests etc.), headers are suppressed or forged as determined by these actions and their parameters. - + Now the web server starts sending its response back (i.e. typically a web page). - + First, the server headers are read and processed to determine, among other things, the MIME type (document type) and encoding. The headers are then - filtered as determined by the + filtered as determined by the +crunch-incoming-cookies, +session-cookies-only, and +downgrade-http-version actions. - + If any +filter action @@ -7975,35 +7927,35 @@ Requests they are specified in one of the filter files. Animated GIFs, if present, are reduced to either the first or last frame, depending on the action setting.The entire page, which is now filtered, is then sent by - Privoxy back to your browser. + Privoxy back to your browser. If neither a +filter action or +deanimate-gifs - matches, then Privoxy passes the raw data through + matches, then Privoxy passes the raw data through to the client browser as it becomes available. - + - As the browser receives the now (possibly filtered) page content, it + As the browser receives the now (possibly filtered) page content, it reads and then requests any URLs that may be embedded within the page source, e.g. ad images, stylesheets, JavaScript, other HTML documents (e.g. frames), sounds, etc. For each of these objects, the browser issues a separate request (this is easily viewable in Privoxy's logs). And each such request is in turn processed just as above. Note that a - complex web page will have many, many such embedded URLs. If these - secondary requests are to a different server, then quite possibly a very + complex web page will have many, many such embedded URLs. If these + secondary requests are to a different server, then quite possibly a very differing set of actions is triggered. - - + + NOTE: This is somewhat of a simplistic overview of what happens with each URL - request. For the sake of brevity and simplicity, we have focused on + request. For the sake of brevity and simplicity, we have focused on Privoxy's core features only. @@ -8015,7 +7967,7 @@ Requests Troubleshooting: Anatomy of an Action - The way Privoxy applies + The way Privoxy applies actions and filters to any given URL can be complex, and not always so easy to understand what is happening. And sometimes we need to be able to @@ -8024,16 +7976,16 @@ Requests is causing us a problem inadvertently. It can be a little daunting to look at the actions and filters files themselves, since they tend to be filled with regular expressions whose consequences are not - always so obvious. + always so obvious. - One quick test to see if Privoxy is causing a problem - or not, is to disable it temporarily. This should be the first troubleshooting - step. See the Bookmarklets section on a quick - and easy way to do this (be sure to flush caches afterward!). Looking at the - logs is a good idea too. (Note that both the toggle feature and logging are - enabled via config file settings, and may need to be + One quick test to see if Privoxy is causing a problem + or not, is to disable it temporarily. This should be the first troubleshooting + step. See the Bookmarklets section on a quick + and easy way to do this (be sure to flush caches afterward!). Looking at the + logs is a good idea too. (Note that both the toggle feature and logging are + enabled via config file settings, and may need to be turned on.) @@ -8045,7 +7997,7 @@ Requests - Privoxy also provides the + Privoxy also provides the http://config.privoxy.org/show-url-info page that can show us very specifically how actions are being applied to any given URL. This is a big help for troubleshooting. @@ -8053,7 +8005,7 @@ Requests First, enter one URL (or partial URL) at the prompt, and then - Privoxy will tell us + Privoxy will tell us how the current configuration will handle it. This will not help with filtering effects (i.e. the +filter action) from @@ -8069,8 +8021,8 @@ Requests - Let's try an example, google.com, - and look at it one section at a time in a sample configuration (your real + Let's try an example, google.com, + and look at it one section at a time in a sample configuration (your real configuration may vary): @@ -8094,7 +8046,7 @@ Requests +session-cookies-only +set-image-blocker {pattern} / - + { -session-cookies-only } .google.com @@ -8102,17 +8054,17 @@ Requests .google.com In file: user.action [ View ] [ Edit ] -(no matches in this file) +(no matches in this file) - This is telling us how we have defined our + This is telling us how we have defined our actions, and - which ones match for our test case, google.com. + which ones match for our test case, google.com. Displayed is all the actions that are available to us. Remember, the + sign denotes on. - - denotes off. So some are on here, but many + denotes off. So some are on here, but many are off. Each example we try may provide a slightly different end result, depending on our configuration directives. @@ -8140,7 +8092,7 @@ In file: user.action [ View ] [ Edit ].google.com. This will match any hosts and sub-domains, in the google.com domain also, such as - www.google.com or mail.google.com. But it would not + www.google.com or mail.google.com. But it would not match www.google.de! So, apparently, we have these two actions defined as exceptions to the general rules at the top somewhere in the lower part of our default.action file, and @@ -8150,7 +8102,7 @@ In file: user.action [ View ] [ Edit ] Then, for our user.action file, we again have no hits. So there is nothing google-specific that we might have added to our own, local - configuration. If there was, those actions would over-rule any actions from + configuration. If there was, those actions would over-rule any actions from previously processed files, such as default.action. user.action typically has the last word. This is the best place to put hard and fast exceptions, @@ -8158,7 +8110,7 @@ In file: user.action [ View ] [ Edit ] And finally we pull it all together in the bottom section and summarize how - Privoxy is applying all its actions + Privoxy is applying all its actions to google.com: @@ -8167,10 +8119,10 @@ In file: user.action [ View ] [ Edit ] Final results: - + -add-header -block - +change-x-forwarded-for{block} + +change-x-forwarded-for{block} -client-header-filter{hide-tor-exit-notation} -content-type-overwrite -crunch-client-header @@ -8221,15 +8173,15 @@ In file: user.action [ View ] [ Edit ] - Notice the only difference here to the previous listing, is to + Notice the only difference here to the previous listing, is to fast-redirects and session-cookies-only, - which are activated specifically for this site in our configuration, + which are activated specifically for this site in our configuration, and thus show in the Final Results. @@ -8252,25 +8204,25 @@ In file: user.action [ View ] [ Edit ] - We'll just show the interesting part here - the explicit matches. It is - matched three different times. Two +block{} sections, + We'll just show the interesting part here - the explicit matches. It is + matched three different times. Two +block{} sections, and a +block{} +handle-as-image, - which is the expanded form of one of our aliases that had been defined as: + which is the expanded form of one of our aliases that had been defined as: +block-as-image. (Aliases are defined in - the first section of the actions file and typically used to combine more + the first section of the actions file and typically used to combine more than one action.) - Any one of these would have done the trick and blocked this as an unwanted - image. This is unnecessarily redundant since the last case effectively - would also cover the first. No point in taking chances with these guys - though ;-) Note that if you want an ad or obnoxious + Any one of these would have done the trick and blocked this as an unwanted + image. This is unnecessarily redundant since the last case effectively + would also cover the first. No point in taking chances with these guys + though ;-) Note that if you want an ad or obnoxious URL to be invisible, it should be defined as ad.doubleclick.net is done here -- as both a +block{} - and an + and an +handle-as-image. The custom alias +block-as-image just simplifies the process and make it more readable. @@ -8288,9 +8240,9 @@ In file: user.action [ View ] [ Edit ][ View ] [ Edit ] - {-add-header + {-add-header -block - +change-x-forwarded-for{block} + +change-x-forwarded-for{block} -client-header-filter{hide-tor-exit-notation} -content-type-overwrite -crunch-client-header @@ -8298,8 +8250,8 @@ In file: user.action [ View ] [ Edit ][ View ] [ Edit ][ View ] [ Edit ] - Ooops, the /adsl/ is matching /ads in our + Ooops, the /adsl/ is matching /ads in our configuration! But we did not want this at all! Now we see why we get the - blank page. It is actually triggering two different actions here, and - the effects are aggregated so that the URL is blocked, and &my-app; is told + blank page. It is actually triggering two different actions here, and + the effects are aggregated so that the URL is blocked, and &my-app; is told to treat the block as if it were an image. But this is, of course, all wrong. We could now add a new action below this (or better in our own user.action file) that explicitly @@ -8372,14 +8324,14 @@ In file: user.action [ View ] [ Edit ] - Now the page displays ;-) + Now the page displays ;-) Remember to flush your browser's caches when making these kinds of changes to your configuration to insure that you get a freshly delivered page! Or, try using Shift+Reload. - But now what about a situation where we get no explicit matches like + But now what about a situation where we get no explicit matches like we did with: @@ -8393,7 +8345,7 @@ In file: user.action [ View ] [ Edit ] That actually was very helpful and pointed us quickly to where the problem - was. If you don't get this kind of match, then it means one of the default + was. If you don't get this kind of match, then it means one of the default rules in the first section of default.action is causing the problem. This would require some guesswork, and maybe a little trial and error to isolate the offending rule. One likely cause would be one of the @@ -8416,7 +8368,7 @@ In file: user.action [ View ] [ Edit ] - { shop } is an alias that expands to + { shop } is an alias that expands to { -filter -session-cookies-only }. Or you could do your own exception to negate filtering: @@ -8437,23 +8389,23 @@ In file: user.action [ View ] [ Edit ]user.action, for local site exceptions. Note that when a simple domain pattern is used by itself (without - the subsequent path portion), all sub-pages within that domain are included + the subsequent path portion), all sub-pages within that domain are included automatically in the scope of the action. - Images that are inexplicably being blocked, may well be hitting the + Images that are inexplicably being blocked, may well be hitting the +filter{banners-by-size} - rule, which assumes - that images of certain sizes are ad banners (works well + rule, which assumes + that images of certain sizes are ad banners (works well most of the time since these tend to be standardized). { fragile } is an alias that disables most actions that are the most likely to cause trouble. This can be used as a - last resort for problem sites. - + last resort for problem sites. + @@ -8462,16 +8414,16 @@ In file: user.action [ View ] [ Edit ] - + - Remember to flush caches! Note that the - mail.google reference lacks the TLD portion (e.g. - .com). This will effectively match any TLD with - google in it, such as mail.google.de., + Remember to flush caches! Note that the + mail.google reference lacks the TLD portion (e.g. + .com). This will effectively match any TLD with + google in it, such as mail.google.de., just as an example. - + If this still does not work, you will have to go through the remaining actions one by one to find which one(s) is causing the problem. @@ -8482,7 +8434,7 @@ In file: user.action [ View ] [ Edit ][ View ] [ Edit ] style. - - Small fixes in the actions chapter - - Small clarifications in the quickstart to ad blocking - - Removed from s since the new doc CSS - renders them red (bad in TOC). - - Revision 1.120 2002/05/23 19:16:43 roro - Correct Debian specials (installation and startup). - - Revision 1.119 2002/05/22 17:17:05 oes - Added Security hint - - Revision 1.118 2002/05/21 04:54:55 hal9 - -New Section: Quickstart to Ad Blocking - -Reformat Actions Anatomy to match new CGI layout - - Revision 1.117 2002/05/17 13:56:16 oes - - Reworked & extended Templates chapter - - Small changes to Regex appendix - - #included authors.sgml into (C) and hist chapter - - Revision 1.116 2002/05/17 03:23:46 hal9 - Fixing merge conflict in Quickstart section. - - Revision 1.115 2002/05/16 16:25:00 oes - Extended the Filter File chapter & minor fixes - - Revision 1.114 2002/05/16 09:42:50 oes - More ulink->link, added some hints to Quickstart section - - Revision 1.113 2002/05/15 21:07:25 oes - Extended and further commented the example actions files - - Revision 1.112 2002/05/15 03:57:14 hal9 - Spell check. A few minor edits here and there for better syntax and - clarification. - - Revision 1.111 2002/05/14 23:01:36 oes - Fixing the fixes - - Revision 1.110 2002/05/14 19:10:45 oes - Restored alphabetical order of actions - - Revision 1.109 2002/05/14 17:23:11 oes - Renamed the prevent-*-cookies actions, extended aliases section and moved it before the example AFs - - Revision 1.108 2002/05/14 15:29:12 oes - Completed proofreading the actions chapter - - Revision 1.107 2002/05/12 03:20:41 hal9 - Small clarifications for 127.0.0.1 vs localhost for listen-address since this - apparently an important distinction for some OS's. - - Revision 1.106 2002/05/10 01:48:20 hal9 - This is mostly proposed copyright/licensing additions and changes. Docs - are still GPL, but licensing and copyright are more visible. Also, copyright - changed in doc header comments (eliminate references to JB except FAQ). - - Revision 1.105 2002/05/05 20:26:02 hal9 - Sorting out license vs copyright in these docs. - - Revision 1.104 2002/05/04 08:44:45 swa - bumped version - - Revision 1.103 2002/05/04 00:40:53 hal9 - -Remove the TOC first page kludge. It's fixed proper now in ldp.dsl.in. - -Some minor additions to Quickstart. - - Revision 1.102 2002/05/03 17:46:00 oes - Further proofread & reactivated short build instructions - - Revision 1.101 2002/05/03 03:58:30 hal9 - Move the user-manual config directive to top of section. Add note about - Privoxy needing read permissions for configs, and write for logs. - - Revision 1.100 2002/04/29 03:05:55 hal9 - Add clarification on differences of new actions files. - - Revision 1.99 2002/04/28 16:59:05 swa - more structure in starting section - - Revision 1.98 2002/04/28 05:43:59 hal9 - This is the break up of configuration.html into multiple files. This - will probably break links elsewhere :( - - Revision 1.97 2002/04/27 21:04:42 hal9 - -Rewrite of Actions File example. - -Add section for user-manual directive in config. - - Revision 1.96 2002/04/27 05:32:00 hal9 - -Add short section to Filter Files to tie in with +filter action. - -Start rewrite of examples in Actions Examples (not finished). - - Revision 1.95 2002/04/26 17:23:29 swa - bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot - - Revision 1.94 2002/04/26 05:24:36 hal9 - -Add most of Andreas suggestions to Chain of Events section. - -A few other minor corrections and touch up. - - Revision 1.92 2002/04/25 18:55:13 hal9 - More catchups on new actions files, and new actions names. - Other assorted cleanups, and minor modifications. - - Revision 1.91 2002/04/24 02:39:31 hal9 - Add 'Chain of Events' section. - - Revision 1.90 2002/04/23 21:41:25 hal9 - Linuxconf is deprecated on RH, substitute chkconfig. - - Revision 1.89 2002/04/23 21:05:28 oes - Added hint for startup on Red Hat - - Revision 1.88 2002/04/23 05:37:54 hal9 - Add AmigaOS install stuff. - - Revision 1.87 2002/04/23 02:53:15 david__schmidt - Updated Mac OS X 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). - - Revision 1.84 2002/04/18 21:17:13 hal9 - Spell Redhat correctly (ie Red Hat). A few minor grammar corrections. - - Revision 1.83 2002/04/18 18:21:12 oes - Added RPM install detail - - Revision 1.82 2002/04/18 12:04:50 oes - Cosmetics - - Revision 1.81 2002/04/18 11:50:24 oes - Extended Install section - needs fixing by packagers - - Revision 1.80 2002/04/18 10:45:19 oes - Moved text to buildsource.sgml, renamed some filters, details - - Revision 1.79 2002/04/18 03:18:06 hal9 - Spellcheck, and minor touchups. - - Revision 1.78 2002/04/17 18:04:16 oes - Proofreading part 2 - - Revision 1.77 2002/04/17 13:51:23 oes - Proofreading, part one - - Revision 1.76 2002/04/16 04:25:51 hal9 - -Added 'Note to Upgraders' and re-ordered the 'Quickstart' section. - -Note about proxy may need requests to re-read config files. - - Revision 1.75 2002/04/12 02:08:48 david__schmidt - Remove OS/2 building info... it is already in the developer-manual - - Revision 1.74 2002/04/11 00:54:38 hal9 - Add small section on submitting actions. - - Revision 1.73 2002/04/10 18:45:15 swa - generated - - Revision 1.72 2002/04/10 04:06:19 hal9 - Added actions feedback to Bookmarklets section - - Revision 1.71 2002/04/08 22:59:26 hal9 - Version update. Spell chkconfig correctly :) - - Revision 1.70 2002/04/08 20:53:56 swa - ? - - Revision 1.69 2002/04/06 05:07:29 hal9 - -Add privoxy-man-page.sgml, for man page. - -Add authors.sgml for AUTHORS (and p-authors.sgml) - -Reworked various aspects of various docs. - -Added additional comments to sub-docs. - - Revision 1.68 2002/04/04 18:46:47 swa - consistent look. reuse of copyright, history et. al. - - Revision 1.67 2002/04/04 17:27:57 swa - more single file to be included at multiple points. make maintaining easier - - Revision 1.66 2002/04/04 06:48:37 hal9 - Structural changes to allow for conditional inclusion/exclusion of content - based on entity toggles, e.g. 'entity % p-not-stable "INCLUDE"'. And - definition of internal entities, e.g. 'entity p-version "2.9.13"' that will - eventually be set by Makefile. - More boilerplate text for use across multiple docs. - - Revision 1.65 2002/04/03 19:52:07 swa - enhance squid section due to user suggestion - - Revision 1.64 2002/04/03 03:53:43 hal9 - A few minor bug fixes, and touch ups. Ready for review. - - Revision 1.63 2002/04/01 16:24:49 hal9 - Define entities to include boilerplate text. See doc/source/*. - - Revision 1.62 2002/03/30 04:15:53 hal9 - - Fix privoxy.org/config links. - - Paste in Bookmarklets from Toggle page. - - Move Quickstart nearer top, and minor rework. - - Revision 1.61 2002/03/29 01:31:08 hal9 - Minor update. - - Revision 1.60 2002/03/27 01:57:34 hal9 - Added more to Anatomy section. - - Revision 1.59 2002/03/27 00:54:33 hal9 - Touch up intro for new name. - - Revision 1.58 2002/03/26 22:29:55 swa - we have a new homepage! - - Revision 1.57 2002/03/24 20:33:30 hal9 - A few minor catch ups with name change. - - Revision 1.56 2002/03/24 16:17:06 swa - configure needs to be generated. - - Revision 1.55 2002/03/24 16:08:08 swa - we are too lazy to make a block-built - privoxy logo. hence removed the option. - - Revision 1.54 2002/03/24 15:46:20 swa - name change related issue. - - Revision 1.53 2002/03/24 11:51:00 swa - name change. changed filenames. - - Revision 1.52 2002/03/24 11:01:06 swa - name change - - Revision 1.51 2002/03/23 15:13:11 swa - renamed every reference to the old name with foobar. - fixed "application foobar application" tag, fixed - "the foobar" with "foobar". left junkbustser in cvs - comments and remarks to history untouched. - - Revision 1.50 2002/03/23 05:06:21 hal9 - Touch up. - - Revision 1.49 2002/03/21 17:01:05 hal9 - New section in Appendix. - - Revision 1.48 2002/03/12 06:33:01 hal9 - Catching up to Andreas and re_filterfile changes. - - Revision 1.47 2002/03/11 13:13:27 swa - correct feedback channels - - Revision 1.46 2002/03/10 00:51:08 hal9 - Added section on JB internal pages in Appendix. - - Revision 1.45 2002/03/09 17:43:53 swa - more distros - - Revision 1.44 2002/03/09 17:08:48 hal9 - New section on Jon's actions file editor, and move some stuff around. - - Revision 1.43 2002/03/08 00:47:32 hal9 - Added imageblock{pattern}. - - Revision 1.42 2002/03/07 18:16:55 swa - looks better - - Revision 1.41 2002/03/07 16:46:43 hal9 - Fix a few markup problems for jade. - - Revision 1.40 2002/03/07 16:28:39 swa - provide correct feedback channels - - Revision 1.39 2002/03/06 16:19:28 hal9 - Note on perceived filtering slowdown per FR. - - Revision 1.38 2002/03/05 23:55:14 hal9 - Stupid I did it again. Double hyphen in comment breaks jade. - - Revision 1.37 2002/03/05 23:53:49 hal9 - jade barfs on '- -' embedded in comments. - -user option broke it. - - Revision 1.36 2002/03/05 22:53:28 hal9 - Add new - - user option. - - Revision 1.35 2002/03/05 00:17:27 hal9 - Added section on command line options. - - Revision 1.34 2002/03/04 19:32:07 oes - Changed default port to 8118 - - Revision 1.33 2002/03/03 19:46:13 hal9 - Emphasis on where/how to report bugs, etc - - Revision 1.32 2002/03/03 09:26:06 joergs - AmigaOS changes, config is now loaded from PROGDIR: instead of - AmiTCP:db/junkbuster/ if no configuration file is specified on the - command line. - - Revision 1.31 2002/03/02 22:45:52 david__schmidt - Just tweaking - - Revision 1.30 2002/03/02 22:00:14 hal9 - Updated 'New Features' list. Ran through spell-checker. - - Revision 1.29 2002/03/02 20:34:07 david__schmidt - Update OS/2 build section - - Revision 1.28 2002/02/24 14:34:24 jongfoster - Formatting changes. Now changing the doctype to DocBook XML 4.1 - will work - no other changes are needed. - - Revision 1.27 2002/01/11 14:14:32 hal9 - Added a very short section on Templates - - Revision 1.26 2002/01/09 20:02:50 hal9 - Fix bug re: auto-detect config file changes. - - Revision 1.25 2002/01/09 18:20:30 hal9 - Touch ups for *.action files. - - Revision 1.24 2001/12/02 01:13:42 hal9 - Fix typo. - - Revision 1.23 2001/12/02 00:20:41 hal9 - Updates for recent changes. - - Revision 1.22 2001/11/05 23:57:51 hal9 - Minor update for startup now daemon mode. - - Revision 1.21 2001/10/31 21:11:03 hal9 - Correct 2 minor errors - - Revision 1.18 2001/10/24 18:45:26 hal9 - *** empty log message *** - - Revision 1.17 2001/10/24 17:10:55 hal9 - Catching up with Jon's recent work, and a few other things. - - Revision 1.16 2001/10/21 17:19:21 swa - wrong url in documentation - - Revision 1.15 2001/10/14 23:46:24 hal9 - Various minor changes. Fleshed out SEE ALSO section. - - Revision 1.13 2001/10/10 17:28:33 hal9 - Very minor changes. - - Revision 1.12 2001/09/28 02:57:04 hal9 - Ditto :/ - - Revision 1.11 2001/09/28 02:25:20 hal9 - Ditto. - - Revision 1.9 2001/09/27 23:50:29 hal9 - A few changes. A short section on regular expression in appendix. - - Revision 1.8 2001/09/25 00:34:59 hal9 - Some additions, and re-arranging. - - Revision 1.7 2001/09/24 14:31:36 hal9 - Diddling. - - Revision 1.6 2001/09/24 14:10:32 hal9 - Including David's OS/2 installation instructions. - - Revision 1.2 2001/09/13 15:27:40 swa - cosmetics - - Revision 1.1 2001/09/12 15:36:41 swa - source files for junkbuster documentation - - Revision 1.3 2001/09/10 17:43:59 swa - first proposal of a structure. - - Revision 1.2 2001/06/13 14:28:31 swa - docs should have an author. - - Revision 1.1 2001/06/13 14:20:37 swa - first import of project's documentation for the webserver. - --> </article>