1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
2 <!entity % dummy "INCLUDE">
3 <!entity supported SYSTEM "supported.sgml">
4 <!entity newfeatures SYSTEM "newfeatures.sgml">
5 <!entity p-intro SYSTEM "privoxy.sgml">
6 <!entity seealso SYSTEM "seealso.sgml">
7 <!entity buildsource SYSTEM "buildsource.sgml">
8 <!entity contacting SYSTEM "contacting.sgml">
9 <!entity p-version "2.9.13">
10 <!entity p-status "BETA">
11 <!entity % p-not-stable "INCLUDE"> <!-- set to IGNORE for stable release -->
12 <!entity % p-stable "IGNORE"> <!-- set INCLUDE for stable release -->
13 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
14 <!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
15 <!entity % p-readme "IGNORE">
16 <!entity % p-supp-userman "IGNORE"> <!-- Omit some from supported.sgml -->
19 File : $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
22 This file belongs into
23 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
25 $Id: user-manual.sgml,v 1.65 2002/04/03 19:52:07 swa Exp $
27 Written by and Copyright (C) 2001 the SourceForge
28 Privoxy team. http://www.privoxy.org/
30 Based on the Internet Junkbuster originally written
31 by and Copyright (C) 1997 Anonymous Coders and
32 Junkbusters Corporation. http://www.junkbusters.com
38 <title>Privoxy User Manual</title>
40 <pubdate>$Id: user-manual.sgml,v 1.65 2002/04/03 19:52:07 swa Exp $</pubdate>
45 <orgname>By: Privoxy Developers</orgname>
54 This is here to keep vim syntax file from breaking :/
55 If I knew enough to fix it, I would.
56 PLEASE DO NOT REMOVE! HB: hal@foobox.net
62 The user manual gives users information on how to install, configure and use
63 <application>Privoxy</application>. <application>Privoxy</application> is a
64 web proxy with advanced filtering capabilities for protecting privacy,
65 filtering web page content, managing cookies, controlling access, and
66 removing ads, banners, pop-ups and other obnoxious Internet
67 Junk. <application>Privoxy</application> has a very flexible configuration
68 and can be customized to suit individual needs and
69 tastes. <application>Privoxy</application> has application for both
70 stand-alone systems and multi-user networks.
73 You can find the latest version of the user manual at <ulink
74 url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink>.
78 <!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
85 <!-- ~~~~~ New section ~~~~~ -->
87 <sect1 id="introduction"><title>Introduction</title>
89 <!-- Include privoxy.sgml boilerplate: -->
91 <!-- end boilerplate -->
94 This documentation is included with the current &p-status; version of
95 <application>Privoxy</application> and is mostly complete at this
96 point. The most up to date reference for the time being is still the comments
97 in the source files and in the individual configuration files. Development
98 of version 3.0 is currently nearing completion, and includes many significant
99 changes and enhancements over earlier versions. The target release date for
100 stable v3.0 is <quote>soon</quote> ;-)
104 <!-- include only in non-stable versions -->
106 Since this is a &p-status; version, not all new features are well tested. This
107 documentation may be slightly out of sync as a result (especially with
108 CVS sources). And there <emphasis>may be</emphasis> bugs, though hopefully
113 <!-- ~~~~~ New section ~~~~~ -->
115 <title>New Features</title>
117 In addition to <application>Internet Junkbuster's</application> traditional
118 feature of ad and banner blocking and cookie management,
119 <application>Privoxy</application> provides new features<![%p-not-stable;[,
120 some of them currently under development]]>:
123 <!-- Include newfeatures.sgml boilerplate here: -->
125 <!-- end boilerplate -->
131 <!-- ~ End section ~ -->
134 <!-- ~~~~~ New section ~~~~~ -->
135 <sect1 id="installation"><title>Installation</title>
137 <application>Privoxy</application> is available as raw source code (tarball
138 or via CVS), or pre-compiled binaries for various platforms. See the <ulink
139 url="http://sourceforge.net/projects/ijbswa/">Privoxy Project Page</ulink> for
140 the most up to date release information.
141 <application>Privoxy</application> is also available via <ulink
142 url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
143 <![%p-not-stable;[This is the recommended approach at this time.]]> But
144 please be aware that CVS is constantly changing, and it may break in
148 <!-- Include supported.sgml boilerplate -->
150 <!-- end boilerplate -->
152 <!-- ~~~~~ New section ~~~~~ -->
153 <sect2 id="installation-source"><title>Source</title>
156 <!-- include buildsource.sgml boilerplate: -->
158 <!-- end boilerplate -->
161 For Redhat and SuSE Linux RPM packages, see below.
165 <!-- ~~~~~ New section ~~~~~ -->
166 <sect3 id="installation-rh"><title>Red Hat</title>
168 To build Redhat RPM packages from source, install source as above. Then:
181 This will create both binary and src RPMs in the usual places. Example:
185 /usr/src/redhat/RPMS/i686/privoxy-&p-version;-1.i686.rpm
188 /usr/src/redhat/SRPMS/privoxy-&p-version;-1.src.rpm
192 To install, of course:
197 rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-&p-version;-1.i686.rpm
202 This will place the <application>Privoxy</application> configuration
203 files in <filename>/etc/privoxy/</filename>, and log files in
204 <filename>/var/log/privoxy/</filename>. Run
205 <command>ckconfig privoxy on</command> to have
206 <application>Privoxy</application> start automatically during init.
212 <!-- ~~~~~ New section ~~~~~ -->
213 <sect3 id="installation-suse"><title>SuSE</title>
215 To build SuSE RPM packages, install source as above. Then:
228 This will create both binary and src RPMs in the usual places. Example:
232 /usr/src/packages/RPMS/i686/privoxy-&p-version;-1.i686.rpm
235 /usr/src/packages/SRPMS/privoxy-&p-version;-1.src.rpm
239 To install, of course:
244 rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-&p-version;-1.i686.rpm
249 This will place the <application>Privoxy</application> configuration
250 files in <filename>/etc/privoxy/</filename>, and log files in
251 <filename>/var/log/privoxy/</filename>.
257 <!-- ~~~~~ New section ~~~~~ -->
258 <sect3 id="installation-os2"><title>OS/2</title>
265 <application>Privoxy</application> is packaged in a WarpIN self-
266 installing archive. The self-installing program will be named depending
267 on the release version, something like:
268 <filename>privoxyos2_setup_&p-version;.exe</filename>. In order to install it, simply
269 run this executable or double-click on its icon and follow the WarpIN
270 installation panels. A shadow of the <application>Privoxy</application>
271 executable will be placed in your startup folder so it will start
272 automatically whenever OS/2 starts.
276 The directory you choose to install <application>Privoxy</application>
277 into will contain all of the configuration files.
281 If you would like to build binary images on OS/2 yourself, you will need
282 a few Unix-like tools: autoconf, autoheader and sh. These tools will be
283 used to create the required config.h file, which is not part of the
284 source distribution because it differs based on platform. You will also
286 The distribution has been created using IBM VisualAge compilers, but you
287 can use any compiler you like. GCC/EMX has the disadvantage of needing
288 to be single-threaded due to a limitation of EMX's implementation of the
289 select() socket call.
293 In addition to needing the source code distribution as outlined earlier,
294 you will want to extract the <filename>os2seutp</filename> directory from CVS:
296 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
297 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
299 This will create a directory named os2setup/, which will contain the
300 <filename>Makefile.vac</filename> makefile and <filename>os2build.cmd</filename>
301 which is used to completely create the binary distribution. The sequence
302 of events for building the executable for yourself goes something like this:
309 nmake -f Makefile.vac
311 You will see this sequence laid out in <filename>os2build.cmd</filename>.
317 <!-- ~~~~~ New section ~~~~~ -->
318 <sect3 id="installation-win"><title>Windows</title>
319 <para>Click-click. (I need help on this. Not a clue here. Also for
320 configuration section below. HB.)
324 <!-- ~~~~~ New section ~~~~~ -->
325 <sect3 id="installation-other"><title>Other</title>
327 Some quick notes on other Operating Systems.
331 For FreeBSD (and other *BSDs?), the build will require <command>gmake</command>
332 instead of the included <command>make</command>. <command>gmake</command> is
333 available from <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>.
334 The rest should be the same as above for Linux/Unix.
342 <!-- ~ End section ~ -->
345 <!-- ~~~~~ New section ~~~~~ -->
347 <sect1 id="quickstart"><title>Quickstart to Using <application>Privoxy</application></title>
349 Before launching <application>Privoxy</application> for the first time, you
350 will want to configure your browser(s) to use <application>Privoxy</application>
351 as a HTTP and HTTPS proxy. The default is localhost for the proxy address,
352 and port 8118 (earlier versions used port 800). This is the one required
353 configuration that must be done!
357 With <application>Netscape</application> (and
358 <application>Mozilla</application>), this can be set under <literal>Edit
359 -> Preferences -> Advanced -> Proxies -> HTTP Proxy</literal>.
360 For <application>Internet Explorer</application>: <literal>Tools ->
361 Internet Properties -> Connections -> LAN Setting</literal>. Then,
362 check <quote>Use Proxy</quote> and fill in the appropriate info (Address:
363 localhost, Port: 8118). Include if HTTPS proxy support too.
367 After doing this, flush your browser's disk and memory caches to force a
368 re-reading of all pages and get rid of any ads that may be cached. You
369 are now ready to start enjoying the benefits of using
370 <application>Privoxy</application>.
375 <application>Privoxy</application> is typically started by specifying the
376 main configuration file to be used on the command line. Example Unix startup
383 # /usr/sbin/privoxy /etc/privoxy/config
389 An init script is provided for SuSE and Redhat.
393 For for SuSE: /etc/rc.d/privoxy start
397 For RedHat: /etc/rc.d/init.d/privoxy start
402 If no configuration file is specified on the command line,
403 <application>Privoxy</application> will look for a file named
404 <filename>config</filename> in the current directory. Except on Win32 where
405 it will try <filename>config.txt</filename>. If no file is specified on the
406 command line and no default configuration file can be found,
407 <application>Privoxy</application> will fail to start.
412 The included default configuration files should give a reasonable starting
413 point, though may be somewhat aggressive in blocking junk. Most of the
414 per site configuration is done in the <quote>actions</quote> files. These
415 are where various cookie actions are defined, ad and banner blocking,
416 and other aspects of <application>Privoxy</application> configuration. There
417 are several such files included, with varying levels of aggressiveness.
421 You will probably want to keep an eye out for sites that require persistent
422 cookies, and add these to <filename>default.action</filename> as needed. By
423 default, most of these will be accepted only during the current browser
424 session, until you add them to the configuration. If you want the browser to
425 handle this instead, you will need to edit
426 <filename>default.action</filename> and disable this feature. If you use more
427 than one browser, it would make more sense to let
428 <application>Privoxy</application> handle this. In which case, the browser(s)
429 should be set to accept all cookies.
433 <application>Privoxy</application> is HTTP/1.1 compliant, but not all 1.1
434 features are as yet implemented. If browsers that support HTTP/1.1 (like
435 <application>Mozilla</application> or recent versions of I.E.) experience
436 problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look
437 under <literal>Edit -> Preferences -> Debug -> Networking</literal>.
438 Or set the <quote>+downgrade</quote> config option in
439 <filename>default.action</filename>.
443 After running <application>Privoxy</application> for a while, you can
444 start to fine tune the configuration to suit your personal, or site,
445 preferences and requirements. There are many, many aspects that can
446 be customized. <quote>Actions</quote> (as specified in <filename>default.action</filename>)
447 can be adjusted by pointing your browser to
448 <ulink url="http://p.p/">http://p.p/</ulink>,
449 and then follow the link to <quote>edit the actions list</quote>.
450 (This is an internal page and does not require Internet access.)
454 In fact, various aspects of <application>Privoxy</application>
455 configuration can be viewed from this page, including
456 current configuration parameters, source code version numbers,
457 the browser's request headers, and <quote>actions</quote> that apply
458 to a given URL. In addition to the <filename>default.action</filename> file
459 editor mentioned above, <application>Privoxy</application> can also
460 be turned <quote>on</quote> and <quote>off</quote> from this page.
464 If you encounter problems, please verify it is a
465 <application>Privoxy</application> bug, by disabling
466 <application>Privoxy</application>, and then trying the same page.
467 Also, try another browser if possible to eliminate browser or site
468 problems. Before reporting it as a bug, see if there is not a configuration
469 option that is enabled that is causing the page not to load. You can then add
470 an exception for that page or site. For instance, try adding it to the
471 <literal>{fragile}</literal> section of <filename>default.action</filename>.
472 This will turn off most actions for this site. For more on troubleshooting
473 problem sites, see the <ulink
474 url="appendix.html#ACTIONSANAT">Appendix</ulink>. If a bug, please report it
475 to the developers (see below).
479 <!-- ~~~~~ New section ~~~~~ -->
482 <title>Command Line Options</title>
484 <application>Privoxy</application> may be invoked with the following
485 command-line options:
493 <emphasis>--version</emphasis>
496 Print version info and exit, Unix only.
501 <emphasis>--help</emphasis>
504 Print a short usage info and exit, Unix only.
509 <emphasis>--no-daemon</emphasis>
512 Don't become a daemon, i.e. don't fork and become process group
513 leader, don't detach from controlling tty. Unix only.
518 <emphasis>--pidfile FILE</emphasis>
522 On startup, write the process ID to <emphasis>FILE</emphasis>. Delete the
523 <emphasis>FILE</emphasis> on exit. Failiure to create or delete the
524 <emphasis>FILE</emphasis> is non-fatal. If no <emphasis>FILE</emphasis>
525 option is given, no PID file will be used. Unix only.
530 <emphasis>--user USER[.GROUP]</emphasis>
534 After (optionally) writing the PID file, assume the user ID of
535 <emphasis>USER</emphasis>, and if included the GID of GROUP. Exit if the
536 privileges are not sufficient to do so. Unix only.
541 <emphasis>configfile</emphasis>
544 If no <emphasis>configfile</emphasis> is included on the command line,
545 <application>Privoxy</application> will look for a file named
546 <quote>config</quote> in the current directory (except on Win32
547 where it will look for <quote>config.txt</quote> instead). Specify
548 full path to avoid confusion.
559 <!-- ~ End section ~ -->
562 <!-- ~~~~~ New section ~~~~~ -->
563 <sect1 id="configuration"><title><application>Privoxy</application> Configuration</title>
565 All <application>Privoxy</application> configuration is stored
566 in text files. These files can be edited with a text editor.
567 Many important aspects of <application>Privoxy</application> can
568 also be controlled easily with a web browser.
573 <!-- ~~~~~ New section ~~~~~ -->
576 <title>Controlling <application>Privoxy</application> with Your Web Browser</title>
578 <application>Privoxy</application> can be reached by the special
579 URL <ulink url="http://p.p/">http://p.p/</ulink> (or alternately
580 <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>),
581 which is an internal page. You will see the following section:
588 Please choose from the following options:
590 * Show information about the current configuration
591 * Show the source code version numbers
592 * Show the client's request headers.
593 * Show which actions apply to a URL and why
594 * Toggle Privoxy on or off
595 * Edit the actions list
601 This should be self-explanatory. Note the last item is an editor for the
602 <quote>actions list</quote>, which is where much of the ad, banner, cookie,
603 and URL blocking magic is configured as well as other advanced features of
604 <application>Privoxy</application>. This is an easy way to adjust various
605 aspects of <application>Privoxy</application> configuration. The actions
606 file, and other configuration files, are explained in detail below.
607 <application>Privoxy</application> will automatically detect any changes
612 <quote>Toggle Privoxy On or Off</quote> is handy for sites that might
613 have problems with your current actions and filters, or just to test if
614 a site misbehaves, whether it is <application>Privoxy</application>
615 causing the problem or not. <application>Privoxy</application> continues
616 to run as a proxy in this case, but all filtering is disabled.
622 <!-- ~ End section ~ -->
627 <!-- ~~~~~ New section ~~~~~ -->
630 <title>Configuration Files Overview</title>
632 For Unix, *BSD and Linux, all configuration files are located in
633 <filename>/etc/privoxy/</filename> by default. For MS Windows, OS/2, and
634 AmigaOS these are all in the same directory as the
635 <application>Privoxy</application> executable. The name and number of
636 configuration files has changed from previous versions, and is subject to
637 change as development progresses.
641 The installed defaults provide a reasonable starting point, though possibly
642 aggressive by some standards. For the time being, there are only three
643 default configuration files (this will change in time):
651 The main configuration file is named <filename>config</filename>
652 on Linux, Unix, BSD, OS/2, and AmigaOS and <filename>config.txt</filename>
659 The <filename>default.action</filename> file is used to define various
660 <quote>actions</quote> relating to images, banners, pop-ups, access
661 restrictions, banners and cookies. There is a CGI based editor for this
662 file that can be accessed via <ulink
663 url="http://p.p">http://p.p</ulink>. (Other actions
664 files are included as well with differing levels of filtering
665 and blocking, e.g. <filename>basic.action</filename>.)
671 The <filename>default.filter</filename> file can be used to re-write the raw
672 page content, including viewable text as well as embedded HTML and JavaScript,
673 and whatever else lurks on any given web page.
681 <filename>default.action</filename> and <filename>default.filter</filename>
682 can use Perl style regular expressions for maximum flexibility. All files use
683 the <quote><literal>#</literal></quote> character to denote a comment. Such
684 lines are not processed by <application>Privoxy</application>. After
685 making any changes, there is no need to restart
686 <application>Privoxy</application> in order for the changes to take
687 effect. <application>Privoxy</application> should detect such changes
692 While under development, the configuration content is subject to change.
693 The below documentation may not be accurate by the time you read this.
694 Also, what constitutes a <quote>default</quote> setting, may change, so
695 please check all your configuration files on important issues.
700 <!-- ~~~~~ New section ~~~~~ -->
703 <title>The Main Configuration File</title>
705 Again, the main configuration file is named <filename>config</filename> on
706 Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
707 Configuration lines consist of an initial keyword followed by a list of
708 values, all separated by whitespace (any number of spaces or tabs). For
716 <emphasis>blockfile blocklist.ini</emphasis>
723 Indicates that the blockfile is named <quote>blocklist.ini</quote>. (A
724 default installation does not use this.)
728 A <quote><literal>#</literal></quote> indicates a comment. Any part of a
729 line following a <quote><literal>#</literal></quote> is ignored, except if
730 the <quote><literal>#</literal></quote> is preceded by a
731 <quote><literal>\</literal></quote>.
735 Thus, by placing a <quote><literal>#</literal></quote> at the start of an
736 existing configuration line, you can make it a comment and it will be treated
737 as if it weren't there. This is called <quote>commenting out</quote> an
738 option and can be useful to turn off features: If you comment out the
739 <quote>logfile</quote> line, <application>Privoxy</application> will not
740 log to a file at all. Watch for the <quote>default:</quote> section in each
741 explanation to see what happens if the option is left unset (or commented
746 Long lines can be continued on the next line by using a
747 <quote><literal>\</literal></quote> as the very last character.
751 There are various aspects of <application>Privoxy</application> behavior
756 <!-- ~~~~~ New section ~~~~~ -->
759 <title>Defining Other Configuration Files</title>
762 <application>Privoxy</application> can use a number of other files to tell it
763 what ads to block, what cookies to accept, and perform other functions. This
764 section of the configuration file tells <application>Privoxy</application>
765 where to find all those other files.
769 On <application>Windows</application> and <application>AmigaOS</application>,
770 <application>Privoxy</application> looks for these files in the same
771 directory as the executable. On Unix and OS/2,
772 <application>Privoxy</application> looks for these files in the current
773 working directory. In either case, an absolute path name can be used to
778 When development goes modular and multi-user, the blocker, filter, and
779 per-user config will be stored in subdirectories of <quote>confdir</quote>.
780 For now, only <filename>confdir/templates</filename> is used for storing HTML
781 templates for CGI results.
785 The location of the configuration files:
792 <emphasis>confdir /etc/privoxy</emphasis> # No trailing /, please.
799 The directory where all logging (i.e. <filename>logfile</filename> and
800 <filename>jarfile</filename>) takes place. No trailing
801 <quote><literal>/</literal></quote>, please:
808 <emphasis>logdir /var/log/privoxy</emphasis>
815 Note that all file specifications below are relative to
816 the above two directories!
820 The <quote>default.action</quote> file contains patterns to specify the
821 actions to apply to requests for each site. Default: Cookies to and from all
822 destinations are kept only during the current browser session (i.e. they are
823 not saved to disk). Pop-ups are disabled for all sites. All sites are
824 filtered through selected sections of <quote>default.filter</quote>. No sites
825 are blocked. <application>Privoxy</application> displays a checkboard type
826 pattern for filtered ads and other images. The syntax of this file is
827 explained in detail <link linkend="actionsfile">below</link>. Other
828 <quote>actions</quote> files are included, and you are free to use any of
829 them. They have varying degrees of aggressiveness.
836 <emphasis>actionsfile default.action</emphasis>
843 The <quote>default.filter</quote> file contains content modification rules
844 that use <quote>regular expressions</quote>. These rules permit powerful
845 changes on the content of Web pages, e.g., you could disable your favorite
846 JavaScript annoyances, re-write the actual displayed text, or just have some
847 fun replacing <quote>Microsoft</quote> with <quote>MicroSuck</quote> wherever
848 it appears on a Web page. Default: whatever the developers are playing with
853 Filtering requires buffering the page content, which may appear to slow down
854 page rendering since nothing is displayed until all content has passed
855 the filters. (It does not really take longer, but seems that way since
856 the page is not incrementally displayed.) This effect will be more noticeable
857 on slower connections.
865 <emphasis>filterfile default.filter</emphasis>
872 The logfile is where all logging and error messages are written. The logfile
873 can be useful for tracking down a problem with
874 <application>Privoxy</application> (e.g., it's not blocking an ad you
875 think it should block) but in most cases you probably will never look at it.
879 Your logfile will grow indefinitely, and you will probably want to
880 periodically remove it. On Unix systems, you can do this with a cron job
881 (see <quote>man cron</quote>). For Redhat, a <command>logrotate</command>
882 script has been included.
886 On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
887 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
888 the effect that cron.daily will automatically archive, gzip, and empty the
889 log, when it exceeds 1M size.
893 Default: Log to the a file named <filename>logfile</filename>.
894 Comment out to disable logging.
901 <emphasis>logfile logfile</emphasis>
908 The <quote>jarfile</quote> defines where
909 <application>Privoxy</application> stores the cookies it intercepts. Note
910 that if you use a <quote>jarfile</quote>, it may grow quite large. Default:
911 Don't store intercepted cookies.
918 <emphasis>#jarfile jarfile</emphasis>
925 If you specify a <quote>trustfile</quote>,
926 <application>Privoxy</application> will only allow access to sites that
927 are named in the trustfile. You can also mark sites as trusted referrers,
928 with the effect that access to untrusted sites will be granted, if a link
929 from a trusted referrer was used. The link target will then be added to the
930 <quote>trustfile</quote>. This is a very restrictive feature that typical
931 users most probably want to leave disabled. Default: Disabled, don't use the
939 <emphasis>#trustfile trust</emphasis>
946 If you use the trust mechanism, it is a good idea to write up some on-line
947 documentation about your blocking policy and to specify the URL(s) here. They
948 will appear on the page that your users receive when they try to access
949 untrusted content. Use multiple times for multiple URLs. Default: Don't
950 display links on the <quote>untrusted</quote> info page.
957 <emphasis>trust-info-url http://www.example.com/why_we_block.html</emphasis>
958 <emphasis>trust-info-url http://www.example.com/what_we_allow.html</emphasis>
966 <!-- ~ End section ~ -->
970 <!-- ~~~~~ New section ~~~~~ -->
973 <title>Other Configuration Options</title>
976 This part of the configuration file contains options that control how
977 <application>Privoxy</application> operates.
981 <quote>Admin-address</quote> should be set to the email address of the proxy
982 administrator. It is used in many of the proxy-generated pages. Default:
990 <emphasis>#admin-address fill@me.in.please</emphasis>
997 <quote>Proxy-info-url</quote> can be set to a URL that contains more info
998 about this <application>Privoxy</application> installation, it's
999 configuration and policies. It is used in many of the proxy-generated pages
1000 and its use is highly recommended in multi-user installations, since your
1001 users will want to know why certain content is blocked or modified. Default:
1002 Don't show a link to on-line documentation.
1009 <emphasis>proxy-info-url http://www.example.com/proxy.html</emphasis>
1016 <quote>Listen-address</quote> specifies the address and port where
1017 <application>Privoxy</application> will listen for connections from your
1018 Web browser. The default is to listen on the localhost port 8118, and
1019 this is suitable for most users. (In your web browser, under proxy
1020 configuration, list the proxy server as <quote>localhost</quote> and the
1021 port as <quote>8118</quote>).
1025 If you already have another service running on port 8118, or if you want to
1026 serve requests from other machines (e.g. on your local network) as well, you
1027 will need to override the default. The syntax is
1028 <quote>listen-address [<ip-address>]:<port></quote>. If you leave
1029 out the IP address, <application>Privoxy</application> will bind to all
1030 interfaces (addresses) on your machine and may become reachable from the
1031 Internet. In that case, consider using access control lists (acl's) (see
1032 <quote>aclfile</quote> above), or a firewall.
1036 For example, suppose you are running <application>Privoxy</application> on
1037 a machine which has the address 192.168.0.1 on your local private network
1038 (192.168.0.0) and has another outside connection with a different address.
1039 You want it to serve requests from inside only:
1046 <emphasis>listen-address 192.168.0.1:8118</emphasis>
1053 If you want it to listen on all addresses (including the outside
1061 <emphasis>listen-address :8118</emphasis>
1068 If you do this, consider using ACLs (see <quote>aclfile</quote> above). Note:
1069 you will need to point your browser(s) to the address and port that you have
1070 configured here. Default: localhost:8118 (127.0.0.1:8118).
1074 The debug option sets the level of debugging information to log in the
1075 logfile (and to the console in the Windows version). A debug level of 1 is
1076 informative because it will show you each request as it happens. Higher
1077 levels of debug are probably only of interest to developers.
1084 debug 1 # GPC = show each GET/POST/CONNECT request
1085 debug 2 # CONN = show each connection status
1086 debug 4 # IO = show I/O status
1087 debug 8 # HDR = show header parsing
1088 debug 16 # LOG = log all data into the logfile
1089 debug 32 # FRC = debug force feature
1090 debug 64 # REF = debug regular expression filter
1091 debug 128 # = debug fast redirects
1092 debug 256 # = debug GIF de-animation
1093 debug 512 # CLF = Common Log Format
1094 debug 1024 # = debug kill pop-ups
1095 debug 4096 # INFO = Startup banner and warnings.
1096 debug 8192 # ERROR = Non-fatal errors
1103 It is <emphasis>highly recommended</emphasis> that you enable ERROR
1104 reporting (debug 8192), at least until v3.0 is released.
1108 The reporting of FATAL errors (i.e. ones which crash
1109 <application>Privoxy</application>) is always on and cannot be disabled.
1113 If you want to use CLF (Common Log Format), you should set <quote>debug
1114 512</quote> ONLY, do not enable anything else.
1118 Multiple <quote>debug</quote> directives, are OK - they're logical-OR'd
1126 <emphasis>debug 15 # same as setting the first 4 listed above</emphasis>
1140 <emphasis>debug 1 # URLs</emphasis>
1141 <emphasis>debug 4096 # Info</emphasis>
1142 <emphasis>debug 8192 # Errors - *we highly recommended enabling this*</emphasis>
1149 <application>Privoxy</application> normally uses
1150 <quote>multi-threading</quote>, a software technique that permits it to
1151 handle many different requests simultaneously. In some cases you may wish to
1152 disable this -- particularly if you're trying to debug a problem. The
1153 <quote>single-threaded</quote> option forces
1154 <application>Privoxy</application> to handle requests sequentially.
1155 Default: Multi-threaded mode.
1162 <emphasis>#single-threaded</emphasis>
1169 <quote>toggle</quote> allows you to temporarily disable all
1170 <application>Privoxy's</application> filtering. Just set <quote>toggle
1175 The Windows version of <application>Privoxy</application> puts an icon in
1176 the system tray, which also allows you to change this option. If you
1177 right-click on that icon (or select the <quote>Options</quote> menu), one
1178 choice is <quote>Enable</quote>. Clicking on enable toggles
1179 <application>Privoxy</application> on and off. This is useful if you want
1180 to temporarily disable <application>Privoxy</application>, e.g., to access
1181 a site that requires cookies which you would otherwise have blocked. This can also
1182 be toggled via a web browser at the <application>Privoxy</application>
1183 internal address of <ulink url="http://p.p">http://p.p</ulink> on
1188 <quote>toggle 1</quote> means <application>Privoxy</application> runs
1189 normally, <quote>toggle 0</quote> means that
1190 <application>Privoxy</application> becomes a non-anonymizing non-blocking
1191 proxy. Default: 1 (on).
1198 <emphasis>toggle 1</emphasis>
1205 For content filtering, i.e. the <quote>+filter</quote> and
1206 <quote>+deanimate-gif</quote> actions, it is necessary that
1207 <application>Privoxy</application> buffers the entire document body.
1208 This can be potentially dangerous, since a server could just keep sending
1209 data indefinitely and wait for your RAM to exhaust. With nasty consequences.
1213 The <application>buffer-limit</application> option lets you set the maximum
1214 size in Kbytes that each buffer may use. When the documents buffer exceeds
1215 this size, it is flushed to the client unfiltered and no further attempt to
1216 filter the rest of it is made. Remember that there may multiple threads
1217 running, which might require increasing the <quote>buffer-limit</quote>
1218 Kbytes <emphasis>each</emphasis>, unless you have enabled
1219 <quote>single-threaded</quote> above.
1226 <emphasis>buffer-limit 4069</emphasis>
1233 To enable the web-based <filename>default.action</filename> file editor set
1234 <application>enable-edit-actions</application> to 1, or 0 to disable. Note
1235 that you must have compiled <application>Privoxy</application> with
1236 support for this feature, otherwise this option has no effect. This
1237 internal page can be reached at <ulink
1238 url="http://p.p">http://p.p</ulink>.
1242 Security note: If this is enabled, anyone who can use the proxy
1243 can edit the actions file, and their changes will affect all users.
1244 For shared proxies, you probably want to disable this. Default: enabled.
1251 <emphasis>enable-edit-actions 1</emphasis>
1258 Allow <application>Privoxy</application> to be toggled on and off
1259 remotely, using your web browser. Set <quote>enable-remote-toggle</quote>to
1260 1 to enable, and 0 to disable. Note that you must have compiled
1261 <application>Privoxy</application> with support for this feature,
1262 otherwise this option has no effect.
1266 Security note: If this is enabled, anyone who can use the proxy can toggle
1267 it on or off (see <ulink url="http://p.p">http://p.p</ulink>), and
1268 their changes will affect all users. For shared proxies, you probably want to
1269 disable this. Default: enabled.
1276 <emphasis>enable-remote-toggle 1</emphasis>
1284 <!-- ~ End section ~ -->
1287 <!-- ~~~~~ New section ~~~~~ -->
1290 <title>Access Control List (ACL)</title>
1292 Access controls are included at the request of some ISPs and systems
1293 administrators, and are not usually needed by individual users. Please note
1294 the warnings in the FAQ that this proxy is not intended to be a substitute
1295 for a firewall or to encourage anyone to defer addressing basic security
1300 If no access settings are specified, the proxy talks to anyone that
1301 connects. If any access settings file are specified, then the proxy
1302 talks only to IP addresses permitted somewhere in this file and not
1303 denied later in this file.
1307 Summary -- if using an ACL:
1312 Client must have permission to receive service.
1317 LAST match in ACL wins.
1322 Default behavior is to deny service.
1327 The syntax for an entry in the Access Control List is:
1334 ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ]
1341 Where the individual fields are:
1348 <emphasis>ACTION</emphasis> = <quote>permit-access</quote> or <quote>deny-access</quote>
1350 <emphasis>SRC_ADDR</emphasis> = client hostname or dotted IP address
1351 <emphasis>SRC_MASKLEN</emphasis> = number of bits in the subnet mask for the source
1353 <emphasis>DST_ADDR</emphasis> = server or forwarder hostname or dotted IP address
1354 <emphasis>DST_MASKLEN</emphasis> = number of bits in the subnet mask for the target
1362 The field separator (FS) is whitespace (space or tab).
1366 IMPORTANT NOTE: If <application>Privoxy</application> is using a
1367 forwarder (see below) or a gateway for a particular destination URL, the
1368 <literal>DST_ADDR</literal> that is examined is the address of the forwarder
1369 or the gateway and <emphasis>NOT</emphasis> the address of the ultimate
1370 target. This is necessary because it may be impossible for the local
1371 <application>Privoxy</application> to determine the address of the
1372 ultimate target (that's often what gateways are used for).
1376 Here are a few examples to show how the ACL features work:
1380 <quote>localhost</quote> is OK -- no DST_ADDR implies that
1381 <emphasis>ALL</emphasis> destination addresses are OK:
1388 <emphasis>permit-access localhost</emphasis>
1395 A silly example to illustrate permitting any host on the class-C subnet with
1396 <application>Privoxy</application> to go anywhere:
1403 <emphasis>permit-access www.privoxy.com/24</emphasis>
1410 Except deny one particular IP address from using it at all:
1417 <emphasis>deny-access ident.privoxy.com</emphasis>
1424 You can also specify an explicit network address and subnet mask.
1425 Explicit addresses do not have to be resolved to be used.
1432 <emphasis>permit-access 207.153.200.0/24</emphasis>
1439 A subnet mask of 0 matches anything, so the next line permits everyone.
1446 <emphasis>permit-access 0.0.0.0/0</emphasis>
1453 Note, you <emphasis>cannot</emphasis> say:
1460 <emphasis>permit-access .org</emphasis>
1467 to allow all *.org domains. Every IP address listed must resolve fully.
1471 An ISP may want to provide a <application>Privoxy</application> that is
1472 accessible by <quote>the world</quote> and yet restrict use of some of their
1473 private content to hosts on its internal network (i.e. its own subscribers).
1474 Say, for instance the ISP owns the Class-B IP address block 123.124.0.0 (a 16
1475 bit netmask). This is how they could do it:
1482 <emphasis>permit-access 0.0.0.0/0 0.0.0.0/0</emphasis> # other clients can go anywhere
1483 # with the following exceptions:
1485 <emphasis>deny-access</emphasis> 0.0.0.0/0 123.124.0.0/16 # block all external requests for
1486 # sites on the ISP's network
1488 <emphasis>permit 0.0.0.0/0 www.my_isp.com</emphasis> # except for the ISP's main
1491 <emphasis>permit 123.124.0.0/16 0.0.0.0/0</emphasis> # the ISP's clients can go
1499 Note that if some hostnames are listed with multiple IP addresses,
1500 the primary value returned by DNS (via gethostbyname()) is used. Default:
1501 Anyone can access the proxy.
1506 <!-- ~ End section ~ -->
1509 <!-- ~~~~~ New section ~~~~~ -->
1511 <sect3 id="forwarding">
1512 <title>Forwarding</title>
1515 This feature allows chaining of HTTP requests via multiple proxies.
1516 It can be used to better protect privacy and confidentiality when
1517 accessing specific domains by routing requests to those domains
1518 to a special purpose filtering proxy such as lpwa.com. Or to use
1519 a caching proxy to speed up browsing.
1523 It can also be used in an environment with multiple networks to route
1524 requests via multiple gateways allowing transparent access to multiple
1525 networks without having to modify browser configurations.
1529 Also specified here are SOCKS proxies. <application>Privoxy</application>
1530 SOCKS 4 and SOCKS 4A. The difference is that SOCKS 4A will resolve the target
1531 hostname using DNS on the SOCKS server, not our local DNS client.
1535 The syntax of each line is:
1542 <emphasis>forward target_domain[:port] http_proxy_host[:port]</emphasis>
1543 <emphasis>forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1544 <emphasis>forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1551 If http_proxy_host is <quote>.</quote>, then requests are not forwarded to a
1552 HTTP proxy but are made directly to the web servers.
1556 Lines are checked in sequence, and the last match wins.
1560 There is an implicit line equivalent to the following, which specifies that
1561 anything not finding a match on the list is to go out without forwarding
1562 or gateway protocol, like so:
1569 <emphasis>forward .* . </emphasis># implicit
1576 In the following common configuration, everything goes to Lucent's LPWA,
1577 except SSL on port 443 (which it doesn't handle):
1584 <emphasis>forward .* lpwa.com:8000</emphasis>
1585 <emphasis>forward :443 .</emphasis>
1593 See the FAQ for instructions on how to automate the login procedure for LPWA.
1595 Some users have reported difficulties related to LPWA's use of
1596 <quote>.</quote> as the last element of the domain, and have said that this
1597 can be fixed with this:
1604 <emphasis>forward lpwa. lpwa.com:8000</emphasis>
1611 (NOTE: the syntax for specifying target_domain has changed since the
1612 previous paragraph was written -- it will not work now. More information
1617 In this fictitious example, everything goes via an ISP's caching proxy,
1618 except requests to that ISP:
1625 <emphasis>forward .* caching.myisp.net:8000</emphasis>
1626 <emphasis>forward myisp.net .</emphasis>
1633 For the @home network, we're told the forwarding configuration is this:
1641 <emphasis>forward .* proxy:8080</emphasis>
1648 Also, we're told they insist on getting cookies and JavaScript, so you should
1649 allow cookies from home.com. We consider JavaScript a potential security risk.
1650 Java need not be enabled.
1654 In this example direct connections are made to all <quote>internal</quote>
1655 domains, but everything else goes through Lucent's LPWA by way of the
1656 company's SOCKS gateway to the Internet.
1663 <emphasis>forward-socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
1664 <emphasis>forward my_company.com .</emphasis>
1671 This is how you could set up a site that always uses SOCKS but no forwarders:
1678 <emphasis>forward-socks4a .* . firewall.my_company.com:1080</emphasis>
1685 An advanced example for network administrators:
1689 If you have links to multiple ISPs that provide various special content to
1690 their subscribers, you can configure forwarding to pass requests to the
1691 specific host that's connected to that ISP so that everybody can see all
1692 of the content on all of the ISPs.
1696 This is a bit tricky, but here's an example:
1701 host-a has a PPP connection to isp-a.com. And host-b has a PPP connection to
1702 isp-b.com. host-a can run a <application>Privoxy</application> proxy with
1703 forwarding like this:
1710 <emphasis>forward .* .</emphasis>
1711 <emphasis>forward isp-b.com host-b:8118</emphasis>
1718 host-b can run a <application>Privoxy</application> proxy with forwarding
1726 <emphasis>forward .* .</emphasis>
1727 <emphasis>forward isp-a.com host-a:8118</emphasis>
1734 Now, <emphasis>anyone</emphasis> on the Internet (including users on host-a
1735 and host-b) can set their browser's proxy to <emphasis>either</emphasis>
1736 host-a or host-b and be able to browse the content on isp-a or isp-b.
1740 Here's another practical example, for University of Kent at
1741 Canterbury students with a network connection in their room, who
1742 need to use the University's Squid web cache.
1749 <emphasis>forward *. ssbcache.ukc.ac.uk:3128</emphasis> # Use the proxy, except for:
1750 <emphasis>forward .ukc.ac.uk . </emphasis> # Anything on the same domain as us
1751 <emphasis>forward * . </emphasis> # Host with no domain specified
1752 <emphasis>forward 129.12.*.* . </emphasis> # A dotted IP on our /16 network.
1753 <emphasis>forward 127.*.*.* . </emphasis> # Loopback address
1754 <emphasis>forward localhost.localdomain . </emphasis> # Loopback address
1755 <emphasis>forward www.ukc.mirror.ac.uk . </emphasis> # Specific host
1762 If you intend to chain <application>Privoxy</application> and
1763 <application>squid</application> locally, then chain as
1764 <literal>browser -> squid -> privoxy</literal> is the recommended way.
1768 Your squid configuration could then look like this (assuming that the IP
1769 address of the box is <literal>192.168.0.1</literal> ):
1776 # Define Privoxy as parent cache
1777 <!-- per feedback from user...
1778 cache_peer 127.0.0.1 8118 parent 0 no-query
1780 cache_peer 192.168.0.1 parent 8118 0 no-query
1782 # don't listen to the whole world
1783 http_port 192.168.0.1:3128
1785 # define the local lan
1786 acl mylocallan src 192.168.0.1-192.168.0.5/255.255.255.255
1788 # grant access for http to local lan
1789 http_access allow mylocallan
1791 # Define ACL for protocol FTP
1794 # Do not forward ACL FTP to privoxy
1795 always_direct allow FTP
1797 # Do not forward ACL CONNECT (https) to privoxy
1798 always_direct allow CONNECT
1800 # Forward the rest to privoxy
1801 never_direct allow all
1809 <!-- ~ End section ~ -->
1812 <!-- ~~~~~ New section ~~~~~ -->
1815 <title>Windows GUI Options</title>
1817 Removed references to Win32. HB 09/23/01
1820 <application>Privoxy</application> has a number of options specific to the
1821 Windows GUI interface:
1825 If <quote>activity-animation</quote> is set to 1, the
1826 <application>Privoxy</application> icon will animate when
1827 <quote>Privoxy</quote> is active. To turn off, set to 0.
1834 <emphasis>activity-animation 1</emphasis>
1841 If <quote>log-messages</quote> is set to 1,
1842 <application>Privoxy</application> will log messages to the console
1850 <emphasis>log-messages 1</emphasis>
1857 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1858 i.e. the amount of memory used for the log messages displayed in the
1859 console window, will be limited to <quote>log-max-lines</quote> (see below).
1863 Warning: Setting this to 0 will result in the buffer to grow infinitely and
1864 eat up all your memory!
1871 <emphasis>log-buffer-size 1</emphasis>
1878 <application>log-max-lines</application> is the maximum number of lines held
1879 in the log buffer. See above.
1886 <emphasis>log-max-lines 200</emphasis>
1893 If <quote>log-highlight-messages</quote> is set to 1,
1894 <application>Privoxy</application> will highlight portions of the log
1895 messages with a bold-faced font:
1902 <emphasis>log-highlight-messages 1</emphasis>
1909 The font used in the console window:
1916 <emphasis>log-font-name Comic Sans MS</emphasis>
1923 Font size used in the console window:
1930 <emphasis>log-font-size 8</emphasis>
1937 <quote>show-on-task-bar</quote> controls whether or not
1938 <application>Privoxy</application> will appear as a button on the Task bar
1946 <emphasis>show-on-task-bar 0</emphasis>
1953 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
1954 button will minimize <application>Privoxy</application> instead of closing
1955 the program (close with the exit option on the File menu).
1962 <emphasis>close-button-minimizes 1</emphasis>
1969 The <quote>hide-console</quote> option is specific to the MS-Win console
1970 version of <application>Privoxy</application>. If this option is used,
1971 <application>Privoxy</application> will disconnect from and hide the
1988 <!-- ~ End section ~ -->
1991 <!-- ~~~~~ New section ~~~~~ -->
1992 <sect2 id="actionsfile">
1993 <title>The Actions File</title>
1996 The <quote>default.action</quote> file (formerly
1997 <filename>actionsfile</filename> or <filename>ijb.action</filename>) is used
1998 to define what actions <application>Privoxy</application> takes, and thus
1999 determines how ad images, cookies and various other aspects of HTTP content
2000 and transactions are handled. These can be accepted or rejected for all
2001 sites, or just those sites you choose. See below for a complete list of
2005 Anything you want can blocked, including ads, banners, or just some obnoxious
2006 URL that you would rather not see. Cookies can be accepted or rejected, or
2007 accepted only during the current browser session (i.e. not written to disk).
2008 Changes to <filename>default.action</filename> should be immediately visible
2009 to <application>Privoxy</application> without the need to restart.
2013 Note that some sites may misbehave, or possibly not work at all with some
2014 actions. This may require some tinkering with the rules to get the most
2015 mileage of <application>Privoxy's</application> features, and still be
2016 able to see and enjoy just what you want to. There is no general rule of
2017 thumb on these things. There just are too many variables, and sites are
2023 The easiest way to edit the <quote>actions</quote> file is with a browser by
2024 loading <ulink url="http://p.p/">http://p.p/</ulink>, and then select
2025 <quote>Edit Actions List</quote>. A text editor can also be used.
2029 To determine which actions apply to a request, the URL of the request is
2030 compared to all patterns in this file. Every time it matches, the list of
2031 applicable actions for the URL is incrementally updated. You can trace
2032 this process by visiting <ulink
2033 url="http://p.p/show-url-info">http://p.p/show-url-info</ulink>.
2038 There are four types of lines in this file: comments (begin with a
2039 <quote>#</quote> character), actions, aliases and patterns, all of which are
2040 explained below, as well as the configuration file syntax that
2041 <application>Privoxy</application> understands.
2046 <!-- ~~~~~ New section ~~~~~ -->
2048 <title>URL Domain and Path Syntax</title>
2050 Generally, a pattern has the form <domain>/<path>, where both the
2051 <domain> and <path> part are optional. If you only specify a
2052 domain part, the <quote>/</quote> can be left out:
2056 <emphasis>www.example.com</emphasis> - is a domain only pattern and will match any request to
2057 <quote>www.example.com</quote>.
2061 <emphasis>www.example.com/</emphasis> - means exactly the same.
2065 <emphasis>www.example.com/index.html</emphasis> - matches only the single
2066 document <quote>/index.html</quote> on <quote>www.example.com</quote>.
2070 <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>,
2071 regardless of the domain. So would match any page named <quote>index.html</quote>
2076 <emphasis>index.html</emphasis> - matches nothing, since it would be
2077 interpreted as a domain name and there is no top-level domain called
2078 <quote>.html</quote>.
2082 The matching of the domain part offers some flexible options: if the
2083 domain starts or ends with a dot, it becomes unanchored at that end.
2088 <emphasis>.example.com</emphasis> - matches any domain or sub-domain that
2089 <emphasis>ENDS</emphasis> in <quote>.example.com</quote>.
2093 <emphasis>www.</emphasis> - matches any domain that <emphasis>STARTS</emphasis> with
2098 Additionally, there are wild-cards that you can use in the domain names
2099 themselves. They work pretty similar to shell wild-cards: <quote>*</quote>
2100 stands for zero or more arbitrary characters, <quote>?</quote> stands for
2101 any single character. And you can define character classes in square
2102 brackets and they can be freely mixed:
2106 <emphasis>ad*.example.com</emphasis> - matches <quote>adserver.example.com</quote>,
2107 <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>.
2111 <emphasis>*ad*.example.com</emphasis> - matches all of the above, and then some.
2115 <emphasis>.?pix.com</emphasis> - matches <quote>www.ipix.com</quote>,
2116 <quote>pictures.epix.com</quote>, <quote>a.b.c.d.e.upix.com</quote>, etc.
2120 <emphasis>www[1-9a-ez].example.com</emphasis> - matches <quote>www1.example.com</quote>,
2121 <quote>www4.example.com</quote>, <quote>wwwd.example.com</quote>,
2122 <quote>wwwz.example.com</quote>, etc., but <emphasis>not</emphasis>
2123 <quote>wwww.example.com</quote>.
2127 If <application>Privoxy</application> was compiled with
2128 <quote>pcre</quote> support (the default), Perl compatible regular expressions
2129 can be used. These are more flexible and powerful than other types
2130 of <quote>regular expressions</quote>. See the <filename>pcre/docs/</filename> directory or <quote>man
2131 perlre</quote> (also available on <ulink
2132 url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
2133 for details. A brief discussion of regular expressions is in the
2134 <link linkend="regex">Appendix</link>. For instance:
2138 <emphasis>/.*/advert[0-9]+\.jpe?g</emphasis> - would match a URL from any
2139 domain, with any path that includes <quote>advert</quote> followed
2140 immediately by one or more digits, then a <quote>.</quote> and ending in
2141 either <quote>jpeg</quote> or <quote>jpg</quote>. So we match
2142 <quote>example.com/ads/advert2.jpg</quote>, and
2143 <quote>www.example.com/ads/banners/advert39.jpeg</quote>, but not
2144 <quote>www.example.com/ads/banners/advert39.gif</quote> (no gifs in the
2149 Please note that matching in the path is case
2150 <emphasis>INSENSITIVE</emphasis> by default, but you can switch to case
2151 sensitive at any point in the pattern by using the
2152 <quote>(?-i)</quote> switch:
2156 <emphasis>www.example.com/(?-i)PaTtErN.*</emphasis> - will match only
2157 documents whose path starts with <quote>PaTtErN</quote> in
2158 <emphasis>exactly</emphasis> this capitalization.
2163 <!-- ~ End section ~ -->
2167 <!-- ~~~~~ New section ~~~~~ -->
2170 <title>Actions</title>
2172 Actions are enabled if preceded with a <quote>+</quote>, and disabled if
2173 preceded with a <quote>-</quote>. Actions are invoked by enclosing the
2174 action name in curly braces (e.g. {+some_action}), followed by a list of
2175 URLs to which the action applies. There are three classes of actions:
2183 Boolean (e.g. <quote>+/-block</quote>):
2189 <emphasis>{+name}</emphasis> # enable this action
2190 <emphasis>{-name}</emphasis> # disable this action
2200 parameterized (e.g. <quote>+/-hide-user-agent</quote>):
2206 <emphasis>{+name{param}}</emphasis> # enable action and set parameter to <quote>param</quote>
2207 <emphasis>{-name}</emphasis> # disable action
2216 Multi-value (e.g. <quote>{+/-add-header{Name: value}}</quote>, <quote>{+/-wafer{name=value}}</quote>):
2222 <emphasis>{+name{param}}</emphasis> # enable action and add parameter <quote>param</quote>
2223 <emphasis>{-name{param}}</emphasis> # remove the parameter <quote>param</quote>
2224 <emphasis>{-name}</emphasis> # disable this action totally
2235 If nothing is specified in this file, no <quote>actions</quote> are taken.
2236 So in this case <application>Privoxy</application> would just be a
2237 normal, non-blocking, non-anonymizing proxy. You must specifically
2238 enable the privacy and blocking features you need (although the
2239 provided default <filename>default.action</filename> file will
2240 give a good starting point).
2244 Later defined actions always over-ride earlier ones. So exceptions
2245 to any rules you make, should come in the latter part of the file. For
2246 multi-valued actions, the actions are applied in the order they are
2251 The list of valid <application>Privoxy</application> <quote>actions</quote> are:
2259 Add the specified HTTP header, which is not checked for validity.
2260 You may specify this many times to specify many different headers:
2266 <emphasis>+add-header{Name: value}</emphasis>
2276 Block this URL totally. In a default installation, a <quote>blocked</quote>
2277 URL will result in bright red banner that says <quote>BLOCKED</quote>,
2278 with a reason why it is being blocked, and an option to see it anyway.
2279 The page displayed for this is the <quote>blocked</quote> template
2286 <emphasis>+block</emphasis>
2296 De-animate all animated GIF images, i.e. reduce them to their last frame.
2297 This will also shrink the images considerably (in bytes, not pixels!). If
2298 the option <quote>first</quote> is given, the first frame of the animation
2299 is used as the replacement. If <quote>last</quote> is given, the last frame
2300 of the animation is used instead, which probably makes more sense for most
2301 banner animations, but also has the risk of not showing the entire last
2302 frame (if it is only a delta to an earlier frame).
2308 <emphasis>+deanimate-gifs{last}</emphasis>
2309 <emphasis>+deanimate-gifs{first}</emphasis>
2318 <quote>+downgrade</quote> will downgrade HTTP/1.1 client requests to
2319 HTTP/1.0 and downgrade the responses as well. Use this action for servers
2320 that use HTTP/1.1 protocol features that
2321 <application>Privoxy</application> doesn't handle well yet. HTTP/1.1
2322 is only partially implemented. Default is not to downgrade requests.
2328 <emphasis>+downgrade</emphasis>
2337 Many sites, like yahoo.com, don't just link to other sites. Instead, they
2338 will link to some script on their own server, giving the destination as a
2339 parameter, which will then redirect you to the final target. URLs resulting
2340 from this scheme typically look like:
2341 http://some.place/some_script?http://some.where-else.
2344 Sometimes, there are even multiple consecutive redirects encoded in the
2345 URL. These redirections via scripts make your web browsing more traceable,
2346 since the server from which you follow such a link can see where you go to.
2347 Apart from that, valuable bandwidth and time is wasted, while your browser
2348 ask the server for one redirect after the other. Plus, it feeds the
2352 The <quote>+fast-redirects</quote> option enables interception of these
2353 types of requests by <application>Privoxy</application>, who will cut off
2354 all but the last valid URL in the request and send a local redirect back to
2355 your browser without contacting the intermediate site(s).
2361 <emphasis>+fast-redirects</emphasis>
2370 Apply the filters in the <literal>section_header</literal>
2371 section of the <filename>default.filter</filename> file to the site(s).
2372 <filename>default.filter</filename> sections are grouped according to like
2373 functionality. <application>Filters</application> can be used to
2374 re-write any of the raw page content. This is a potentially a
2375 very powerful feature!
2382 <emphasis>+filter{section_header}</emphasis>
2389 Filter sections that are pre-defined in the supplied
2390 <filename>default.filter</filename> include:
2396 <emphasis>html-annoyances</emphasis>: Get rid of particularly annoying HTML abuse.
2401 <emphasis>js-annoyances</emphasis>: Get rid of particularly annoying JavaScript abuse
2406 <emphasis>no-poups</emphasis>: Kill all popups in JS and HTML
2411 <emphasis>frameset-borders</emphasis>: Give frames a border
2416 <emphasis>webbugs</emphasis>: Squish WebBugs (1x1 invisible GIFs used for user tracking)
2421 <emphasis>no-refresh</emphasis>: Automatic refresh sucks on auto-dialup lines
2426 <emphasis>fun</emphasis>: Text replacements for subversive browsing fun!
2431 <emphasis>nimda</emphasis>: Remove (virus) Nimda code.
2436 <emphasis>banners-by-size</emphasis>: Kill banners by size
2441 <emphasis>crude-parental</emphasis>: Kill all web pages that contain the words "sex" or "warez"
2450 Block any existing X-Forwarded-for header, and do not add a new one:
2456 <emphasis>+hide-forwarded</emphasis>
2465 If the browser sends a <quote>From:</quote> header containing your e-mail
2466 address, this either completely removes the header (<quote>block</quote>), or
2467 changes it to the specified e-mail address.
2473 <emphasis>+hide-from{block}</emphasis>
2474 <emphasis>+hide-from{spam@sittingduck.xqq}</emphasis>
2483 Don't send the <quote>Referer:</quote> (sic) header to the web site. You
2484 can block it, forge a URL to the same server as the request (which is
2485 preferred because some sites will not send images otherwise) or set it to a
2486 constant, user defined string of your choice.
2492 <emphasis>+hide-referer{block}</emphasis>
2493 <emphasis>+hide-referer{forge}</emphasis>
2494 <emphasis>+hide-referer{http://nowhere.com}</emphasis>
2503 Alternative spelling of <quote>+hide-referer</quote>. It has the same
2504 parameters, and can be freely mixed with, <quote>+hide-referer</quote>.
2505 (<quote>referrer</quote> is the correct English spelling, however the HTTP
2506 specification has a bug - it requires it to be spelled <quote>referer</quote>.)
2512 <emphasis>+hide-referrer{...}</emphasis>
2521 Change the <quote>User-Agent:</quote> header so web servers can't tell your
2522 browser type. Warning! This breaks many web sites. Specify the
2523 user-agent value you want. Example, pretend to be using Netscape on
2530 <emphasis>+hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)}</emphasis>
2537 Or to identify yourself explicitly as a <application>Privoxy</application> user:
2543 <emphasis>+hide-user-agent{Privoxy/1.0}</emphasis>
2548 (Don't change the version number from 1.0 - after all, why tell them?)
2555 <emphasis>+hide-user-agent{browser-type}</emphasis>
2565 Treat this URL as an image. This only matters if it's also <quote>+block</quote>ed,
2566 in which case a <quote>blocked</quote> image can be sent rather than a HTML page.
2567 See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
2568 If you want <emphasis>invisible</emphasis> ads, they should be defined as
2569 <emphasis>images</emphasis> and <emphasis>blocked</emphasis>. And also,
2570 <quote>image-blocker</quote> should be set to <quote>blank</quote>. Note you
2571 cannot treat HTML pages as images in most cases. For instance, frames
2572 require an HTML page to display. Forcing an <quote>image</quote> in this
2573 situation just will not work.
2579 <emphasis>+image</emphasis>
2587 <para> Decides what to do with URLs that end up tagged with <quote>{+block
2588 +image}</quote>, e.g an advertizement. There are five options.
2589 <quote>-image-blocker</quote> will send a HTML <quote>blocked</quote> page,
2590 usually resulting in a <quote>broken image</quote> icon.
2591 <!-- <quote>+image-blocker{logo}</quote> will send a -->
2592 <!-- <application>Privoxy</application> logo -->
2594 <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF
2595 image. And finally, <quote>+image-blocker{http://xyz.com}</quote> will send a
2596 HTTP temporary redirect to the specified image. This has the advantage of the
2597 icon being being cached by the browser, which will speed up the display.
2598 <quote>+image-blocker{pattern}</quote> will send a checkboard type pattern
2600 <!-- which scales better than the logo (which can get blocky if the browser -->
2601 <!-- enlarges it too much). -->
2607 <!-- <emphasis>+image-blocker{logo}</emphasis> -->
2608 <emphasis>+image-blocker{blank}</emphasis>
2609 <emphasis>+image-blocker{pattern}</emphasis>
2610 <emphasis>+image-blocker{http://p.p/send-banner}</emphasis>
2619 By default (i.e. in the absence of a <quote>+limit-connect</quote>
2620 action), <application>Privoxy</application> will only allow CONNECT
2621 requests to port 443, which is the standard port for https as a
2626 The CONNECT methods exists in HTTP to allow access to secure websites
2627 (https:// URLs) through proxies. It works very simply: the proxy
2628 connects to the server on the specified port, and then short-circuits
2629 its connections to the client <emphasis>and</emphasis> to the remote proxy.
2630 This can be a big security hole, since CONNECT-enabled proxies can
2631 be abused as TCP relays very easily.
2635 If you want to allow CONNECT for more ports than this, or want to forbid
2636 CONNECT altogether, you can specify a comma separated list of ports and
2637 port ranges (the latter using dashes, with the minimum defaulting to 0 and
2645 <emphasis>+limit-connect{443} # This is the default and need no be specified.</emphasis>
2646 <emphasis>+limit-connect{80,443} # Ports 80 and 443 are OK.</emphasis>
2647 <emphasis>+limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100</emphasis>
2648 <emphasis> #and above 500 are OK.</emphasis>
2658 <quote>+no-compression</quote> prevents the website from compressing the
2659 data. Some websites do this, which can be a problem for
2660 <application>Privoxy</application>, since <quote>+filter</quote>,
2661 <quote>+no-popup</quote> and <quote>+gif-deanimate</quote> will not work on
2662 compressed data. This will slow down connections to those websites,
2663 though. Default is <quote>no-compression</quote> is turned on.
2670 <emphasis>+nocompression</emphasis>
2679 If the website sets cookies, <quote>no-cookies-keep</quote> will make sure
2680 they are erased when you exit and restart your web browser. This makes
2681 profiling cookies useless, but won't break sites which require cookies so
2682 that you can log in for transactions. Default: on.
2688 <emphasis>+no-cookies-keep</emphasis>
2697 Prevent the website from reading cookies:
2703 <emphasis>+no-cookies-read</emphasis>
2712 Prevent the website from setting cookies:
2718 <emphasis>+no-cookies-set</emphasis>
2727 Filter the website through a built-in filter to disable those obnoxious
2728 JavaScript pop-up windows via window.open(), etc. The two alternative
2729 spellings are equivalent.
2735 <emphasis>+no-popup</emphasis>
2736 <emphasis>+no-popups</emphasis>
2745 This action only applies if you are using a <filename>jarfile</filename>
2746 for saving cookies. It sends a cookie to every site stating that you do not
2747 accept any copyright on cookies sent to you, and asking them not to track
2748 you. Of course, this is a (relatively) unique header they could use to
2755 <emphasis>+vanilla-wafer</emphasis>
2764 This allows you to add an arbitrary cookie. It can be specified multiple
2765 times in order to add as many cookies as you like.
2771 <emphasis>+wafer{name=value}</emphasis>
2782 The meaning of any of the above is reversed by preceding the action with a
2783 <quote>-</quote>, in place of the <quote>+</quote>.
2791 Turn off cookies by default, then allow a few through for specified sites:
2798 # Turn off all persistent cookies
2799 { +no-cookies-read }
2801 # Allow cookies for this browser session ONLY
2802 { +no-cookies-keep }
2804 # Exceptions to the above, sites that benefit from persistent cookies
2805 { -no-cookies-read }
2807 { -no-cookies-keep }
2814 # Alternative way of saying the same thing
2815 {-no-cookies-set -no-cookies-read -no-cookies-keep}
2824 Now turn off <quote>fast redirects</quote>, and then we allow two exceptions:
2834 # Reverse it for these two sites, which don't work right without it.
2836 www.ukc.ac.uk/cgi-bin/wac\.cgi\?
2844 Turn on page filtering according to rules in the defined sections
2845 of <filename>refilterfile</filename>, and make one exception for
2853 # Run everything through the filter file, using only the
2854 # specified sections:
2855 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}\
2856 +filter{webbugs} +filter{nimda} +filter{banners-by-size}
2858 # Then disable filtering of code from sourceforge!
2860 .cvs.sourceforge.net
2867 Now some URLs that we want <quote>blocked</quote> (normally generates
2868 the <quote>blocked</quote> banner). Many of these use regular expressions
2869 that will expand to match multiple URLs:
2878 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
2879 /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/])
2880 /.*/(ng)?adclient\.cgi
2881 /.*/(plain|live|rotate)[-_.]?ads?/
2882 /.*/(sponsor)s?[0-9]?/
2883 /.*/_?(plain|live)?ads?(-banners)?/
2885 /.*/ad(sdna_image|gifs?)/
2886 /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
2890 /.*/adv((er)?ts?|ertis(ing|ements?))?/
2894 /.*/cgi-bin/centralad/getimage
2895 /.*/images/addver\.gif
2896 /.*/images/marketing/.*\.(gif|jpe?g)
2900 /.*/sponsors?[0-9]?/
2901 /.*/advert[0-9]+\.jpg
2908 /graphics/defaultAd/
2910 /image\.ng/transactionID
2911 /images/.*/.*_anim\.gif # alvin brattli
2912 /ip_img/.*\.(gif|jpe?g)
2916 /cgi-bin/nph-adclick.exe/
2917 /.*/Image/BannerAdvertising/
2919 /.*/adlib/server\.cgi
2927 Note that many of these actions have the potential to cause a page to
2928 misbehave, possibly even not to display at all. There are many ways
2929 a site designer may choose to design his site, and what HTTP header
2930 content he may depend on. There is no way to have hard and fast rules
2931 for all sites. See the <link linkend="ACTIONSANAT">Appendix</link>
2932 for a brief example on troubleshooting actions.
2938 <!-- ~ End section ~ -->
2941 <!-- ~~~~~ New section ~~~~~ -->
2943 <title>Aliases</title>
2945 Custom <quote>actions</quote>, known to <application>Privoxy</application>
2946 as <quote>aliases</quote>, can be defined by combining other <quote>actions</quote>.
2947 These can in turn be invoked just like the built-in <quote>actions</quote>.
2948 Currently, an alias can contain any character except space, tab, <quote>=</quote>,
2949 <quote>{</quote> or <quote>}</quote>. But please use only <quote>a</quote>-
2950 <quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
2951 <quote>-</quote>. Alias names are not case sensitive, and
2952 <emphasis>must be defined before anything</emphasis> else in the
2953 <filename>default.action</filename>file! And there can only be one set of
2954 <quote>aliases</quote> defined.
2958 Now let's define a few aliases:
2965 # Useful customer aliases we can use later. These must come first!
2967 +no-cookies = +no-cookies-set +no-cookies-read
2968 -no-cookies = -no-cookies-set -no-cookies-read
2969 fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups
2970 shop = -no-cookies -filter -fast-redirects
2971 +imageblock = +block +image
2973 #For people who don't like to type too much: ;-)
2976 c2 = -no-cookies-set +no-cookies-read
2977 c3 = +no-cookies-set -no-cookies-read
2978 #... etc. Customize to your heart's content.
2985 Some examples using our <quote>shop</quote> and <quote>fragile</quote>
2993 # These sites are very complex and require
2994 # minimal interference.
2996 .office.microsoft.com
2997 .windowsupdate.microsoft.com
3000 # Shopping sites - still want to block ads.
3003 .worldpay.com # for quietpc.com
3007 # These shops require pop-ups
3017 The <quote>shop</quote> and <quote>fragile</quote> aliases are often used for
3018 <quote>problem</quote> sites that require most actions to be disabled
3019 in order to function properly.
3026 <!-- ~ End section ~ -->
3029 <!-- ~~~~~ New section ~~~~~ -->
3030 <sect2 id="filterfile">
3031 <title>The Filter File</title>
3033 Any web page can be dynamically modified with the filter file. This
3034 modification can be removal, or re-writing, of any web page content,
3035 including tags and non-visible content. The default filter file is
3036 <filename>default.filter</filename>, located in the config directory.
3040 This is potentially a very powerful feature, and requires knowledge of both
3041 <quote>regular expression</quote> and HTML in order create custom
3042 filters. But, there are a number of useful filters included with
3043 <application>Privoxy</application> for many common situations.
3047 The included example file is divided into sections. Each section begins
3048 with the <literal>FILTER</literal> keyword, followed by the identifier
3049 for that section, e.g. <quote>FILTER: webbugs</quote>. Each section performs
3050 a similar type of filtering, such as <quote>html-annoyances</quote>.
3054 This file uses regular expressions to alter or remove any string in the
3055 target page. The expressions can only operate on one line at a time. Some
3056 examples from the included default <filename>default.filter</filename>:
3060 Stop web pages from displaying annoying messages in the status bar by
3061 deleting such references:
3068 FILTER: html-annoyances
3070 # New browser windows should be resizeable and have a location and status
3073 s/resizable="?(no|0)"?/resizable=1/ig s/noresize/yesresize/ig
3074 s/location="?(no|0)"?/location=1/ig s/status="?(no|0)"?/status=1/ig
3075 s/scrolling="?(no|0|Auto)"?/scrolling=1/ig
3076 s/menubar="?(no|0)"?/menubar=1/ig
3078 # The <BLINK> tag was a crime!
3080 s*<blink>|</blink>**ig
3084 #s/framespacing="?(no|0)"?//ig
3085 #s/margin(height|width)=[0-9]*//gi
3092 Just for kicks, replace any occurrence of <quote>Microsoft</quote> with
3093 <quote>MicroSuck</quote>, and have a little fun with topical buzzwords:
3102 s/microsoft(?!.com)/MicroSuck/ig
3106 s/industry-leading|cutting-edge|award-winning/<font color=red><b>BINGO!</b></font>/ig
3113 Kill those pesky little web-bugs:
3120 # webbugs: Squish WebBugs (1x1 invisible GIFs used for user tracking)
3123 s/<img\s+[^>]*?(width|height)\s*=\s*['"]?1\D[^>]*?(width|height)\s*=\s*['"]?1(\D[^>]*?)?>/<!-- Squished WebBug -->/sig
3131 <!-- ~ End section ~ -->
3135 <!-- ~~~~~ New section ~~~~~ -->
3138 <title>Templates</title>
3140 When <application>Privoxy</application> displays one of its internal
3141 pages, such as a 404 Not Found error page, it uses the appropriate template.
3142 On Linux, BSD, and Unix, these are located in
3143 <filename>/etc/privoxy/templates</filename> by default. These may be
3144 customized, if desired.
3147 The default <quote>Blocked</quote> banner page with the bright red top
3148 banner, is called just <quote><filename>blocked</filename></quote>. This
3149 may be customized or replaced with something else if desired.
3156 <!-- ~ End section ~ -->
3160 <!-- ~~~~~ New section ~~~~~ -->
3162 <sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
3165 <!-- Include contacting.sgml boilerplate: -->
3169 <!-- end boilerplate -->
3174 <!-- ~~~~~ New section ~~~~~ -->
3175 <sect1 id="copyright"><title>Copyright and History</title>
3178 <title>License</title>
3180 <application>Privoxy</application> is free software; you can
3181 redistribute it and/or modify it under the terms of the GNU General Public
3183 <informalfigure float="0">
3186 <imagedata fileref="gnu.jpg" format="jpg">
3189 <phrase>GNU's Pet GNU</phrase>
3194 License as published by the Free Software Foundation; either version 2 of the
3195 License, or (at your option) any later version.
3199 This program is distributed in the hope that it will be useful, but WITHOUT
3200 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
3201 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
3202 details, which is available from the Free Software Foundation,
3203 Inc, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
3207 You should have received a copy of the <ulink
3208 url="http://www.gnu.org/copyleft/gpl.html">GNU General Public License</ulink>
3209 along with this program; if not, write to the Free Software Foundation, Inc.,
3210 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
3215 <!-- ~ End section ~ -->
3218 <!-- ~~~~~ New section ~~~~~ -->
3220 <sect2 id="history">
3221 <title>History</title>
3223 <application>Privoxy</application> is evolved, and derived from,
3224 <application>the Internet Junkbuster</application>, with many
3225 improvments and enhancements over the original.
3229 <application>Junkbuster</application> was originally written by Anonymous
3231 url="http://www.junkbusters.com">Junkbuster's
3232 Corporation</ulink>, and was released as free open-source software under the
3233 GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
3234 Waldherr</ulink> made many improvements, and started the <ulink
3235 url="http://sourceforge.net/projects/ijbswa/">SourceForge project
3236 Privoxy</ulink> to rekindle development. There are now several active
3237 developers contributing. The last stable release of
3238 <application>Junkbuster</application> was v2.0.2, which has now
3246 <!-- ~~~~~ New section ~~~~~ -->
3247 <sect1 id="seealso"><title>See Also</title>
3249 <!-- Include seealso.sgml: -->
3253 <!-- end boilerplate -->
3259 <!-- ~~~~~ New section ~~~~~ -->
3260 <sect1 id="appendix"><title>Appendix</title>
3263 <!-- ~~~~~ New section ~~~~~ -->
3265 <title>Regular Expressions</title>
3267 <application>Privoxy</application> can use <quote>regular expressions</quote>
3268 in various config files. Assuming support for <quote>pcre</quote> (Perl
3269 Compatible Regular Expressions) is compiled in, which is the default. Such
3270 configuration directives do not require regular expressions, but they can be
3271 used to increase flexibility by matching a pattern with wild-cards against
3276 If you are reading this, you probably don't understand what <quote>regular
3277 expressions</quote> are, or what they can do. So this will be a very brief
3278 introduction only. A full explanation would require a book ;-)
3282 <quote>Regular expressions</quote> is a way of matching one character
3283 expression against another to see if it matches or not. One of the
3284 <quote>expressions</quote> is a literal string of readable characters
3285 (letter, numbers, etc), and the other is a complex string of literal
3286 characters combined with wild-cards, and other special characters, called
3287 meta-characters. The <quote>meta-characters</quote> have special meanings and
3288 are used to build the complex pattern to be matched against. Perl Compatible
3289 Regular Expressions is an enhanced form of the regular expression language
3290 with backward compatibility.
3294 To make a simple analogy, we do something similar when we use wild-card
3295 characters when listing files with the <command>dir</command> command in DOS.
3296 <literal>*.*</literal> matches all filenames. The <quote>special</quote>
3297 character here is the asterisk which matches any and all characters. We can be
3298 more specific and use <literal>?</literal> to match just individual
3299 characters. So <quote>dir file?.text</quote> would match
3300 <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
3301 matching, using a similar technique to <quote>regular expressions</quote>!
3305 Regular expressions do essentially the same thing, but are much, much more
3306 powerful. There are many more <quote>special characters</quote> and ways of
3307 building complex patterns however. Let's look at a few of the common ones,
3308 and then some examples:
3313 <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
3314 <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
3320 <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
3327 <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
3334 <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
3341 <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
3342 the following character should be taken literally. This is used where one of the
3343 special characters (e.g. <quote>.</quote>) needs to be taken literally and
3344 not as a special meta-character.
3350 <emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
3351 any of the enclosed characters are encountered.
3357 <emphasis>()</emphasis> - parentheses are used to group a sub-expression,
3358 or multiple sub-expressions.
3364 <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
3365 <quote>or</quote> conditional statement. A match is successful if the
3366 sub-expression on either side of <quote>|</quote> matches.
3372 <emphasis>s/string1/string2/g</emphasis> - This is used to rewrite strings of text.
3373 <quote>string1</quote> is replaced by <quote>string2</quote> in this
3379 These are just some of the ones you are likely to use when matching URLs with
3380 <application>Privoxy</application>, and is a long way from a definitive
3381 list. This is enough to get us started with a few simple examples which may
3382 be more illuminating:
3386 <emphasis><literal>/.*/banners/.*</literal></emphasis> - A simple example
3387 that uses the common combination of <quote>.</quote> and <quote>*</quote> to
3388 denote any character, zero or more times. In other words, any string at all.
3389 So we start with a literal forward slash, then our regular expression pattern
3390 (<quote>.*</quote>) another literal forward slash, the string
3391 <quote>banners</quote>, another forward slash, and lastly another
3392 <quote>.*</quote>. We are building
3393 a directory path here. This will match any file with the path that has a
3394 directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
3395 any characters, and this could conceivably be more forward slashes, so it
3396 might expand into a much longer looking path. For example, this could match:
3397 <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
3398 <quote>/banners/annoying.html</quote>, or almost an infinite number of other
3399 possible combinations, just so it has <quote>banners</quote> in the path
3404 A now something a little more complex:
3408 <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
3409 We have several literal forward slashes again (<quote>/</quote>), so we are
3410 building another expression that is a file path statement. We have another
3411 <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
3412 it matches our expression. The only true literal that <emphasis>must
3413 match</emphasis> our pattern is <application>adv</application>, together with
3414 the forward slashes. What comes after the <quote>adv</quote> string is the
3419 Remember the <quote>?</quote> means the preceding expression (either a
3420 literal character or anything grouped with <quote>(...)</quote> in this case)
3421 can exist or not, since this means either zero or one match. So
3422 <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
3423 individual sub-expressions: <quote>(er)</quote>,
3424 <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
3425 means <quote>or</quote>. We have two of those. For instance,
3426 <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
3427 <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
3428 attempt at matching as many variations of <quote>advertisement</quote>, and
3429 similar, as possible. So this would expand to match just <quote>adv</quote>,
3430 or <quote>advert</quote>, or <quote>adverts</quote>, or
3431 <quote>advertising</quote>, or <quote>advertisement</quote>, or
3432 <quote>advertisements</quote>. You get the idea. But it would not match
3433 <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
3434 changing our regular expression to:
3435 <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
3440 <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
3441 another path statement with forward slashes. Anything in the square brackets
3442 <quote>[]</quote> can be matched. This is using <quote>0-9</quote> as a
3443 shorthand expression to mean any digit one through nine. It is the same as
3444 saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
3445 means one or more of the preceding expression must be included. The preceding
3446 expression here is what is in the square brackets -- in this case, any digit
3447 one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
3448 This includes a <quote>|</quote>, so this needs to match the expression on
3449 either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
3450 side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
3451 since the <quote>?</quote> means the letter <quote>e</quote> is optional and
3452 can be matched once or not at all. So we are building an expression here to
3453 match image GIF or JPEG type image file. It must include the literal
3454 string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
3455 (which is now a literal, and not a special character, since it is escaped
3456 with <quote>\</quote>), and lastly either <quote>gif</quote>, or
3457 <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
3458 include: <quote>//advert1.jpg</quote>,
3459 <quote>/nasty/ads/advert1234.gif</quote>,
3460 <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
3461 <quote>advert1.gif</quote> (no leading slash), or
3462 <quote>/adverts232.jpg</quote> (the expression does not include an
3463 <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
3464 in the expression anywhere).
3468 <emphasis><literal>s/microsoft(?!.com)/MicroSuck/i</literal></emphasis> - This is
3469 a substitution. <quote>MicroSuck</quote> will replace any occurrence of
3470 <quote>microsoft</quote>. The <quote>i</quote> at the end of the expression
3471 means ignore case. The <quote>(?!.com)</quote> means
3472 the match should fail if <quote>microsoft</quote> is followed by
3473 <quote>.com</quote>. In other words, this acts like a <quote>NOT</quote>
3474 modifier. In case this is a hyperlink, we don't want to break it ;-).
3478 We are barely scratching the surface of regular expressions here so that you
3479 can understand the default <application>Privoxy</application>
3480 configuration files, and maybe use this knowledge to customize your own
3481 installation. There is much, much more that can be done with regular
3482 expressions. Now that you know enough to get started, you can learn more on
3487 More reading on Perl Compatible Regular expressions:
3488 <ulink url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>
3493 <!-- ~ End section ~ -->
3496 <!-- ~~~~~ New section ~~~~~ -->
3498 <title><application>Privoxy</application>'s Internal Pages</title>
3501 Since <application>Privoxy</application> proxies each requested
3502 web page, it is easy for <application>Privoxy</application> to
3503 trap certain special URLs. In this way, we can talk directly to
3504 <application>Privoxy</application>, and see how it is
3505 configured, see how our rules are being applied, change these
3506 rules and other configuration options, and even turn
3507 <application>Privoxy's</application> filtering off, all with
3513 The URLs listed below are the special ones that allow direct access
3514 to <application>Privoxy</application>. Of course,
3515 <application>Privoxy</application> must be running to access these. If
3516 not, you will get a friendly error message. Internet access is not
3529 <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
3533 Alternately, this may be reached at <ulink
3534 url="http://p.p/">http://p.p/</ulink>, but this
3535 variation may not work as reliably as the above in some configurations.
3541 Show information about the current configuration:
3545 <ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
3552 Show the source code version numbers:
3556 <ulink url="http://config.privoxy.org/show-version">http://config.privoxy.org/show-version</ulink>
3563 Show the client's request headers:
3567 <ulink url="http://config.privoxy.org/show-request">http://config.privoxy.org/show-request</ulink>
3574 Show which actions apply to a URL and why:
3578 <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
3585 Toggle Privoxy on or off. In this case, <quote>Privoxy</quote> continues
3586 to run, but only as a pass-through proxy, with no actions taking place:
3590 <ulink url="http://config.privoxy.org/toggle">http://config.privoxy.org/toggle</ulink>
3594 Short cuts. Turn off, then on:
3598 <ulink url="http://config.privoxy.org/toggle?set=disable">http://config.privoxy.org/toggle?set=disable</ulink>
3603 <ulink url="http://config.privoxy.org/toggle?set=enable">http://config.privoxy.org/toggle?set=enable</ulink>
3610 Edit the actions list file:
3614 <ulink url="http://config.privoxy.org/edit-actions">http://config.privoxy.org/edit-actions</ulink>
3623 These may be bookmarked for quick reference.
3627 <sect3 id="bookmarklets">
3628 <title>Bookmarklets</title>
3630 Here are some bookmarklets to allow you to easily access a
3631 <quote>mini</quote> version of this page. They are designed for MS Internet
3632 Explorer, but should work equally well in Netscape, Mozilla, and other
3633 browsers which support JavaScript. They are designed to run directly from
3634 your bookmarks - not by clicking the links below (although that will work for
3638 To save them, right-click the link and choose <quote>Add to Favorites</quote>
3639 (IE) or <quote>Add Bookmark</quote> (Netscape). You will get a warning that
3640 the bookmark <quote>may not be safe</quote> - just click OK. Then you can run the
3641 Bookmarklet directly from your favourites/bookmarks. For even faster access,
3642 you can put them on the <quote>Links</quote> bar (IE) or the <quote>Personal
3643 Toolbar</quote> (Netscape), and run them with a single click.
3651 <ulink url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=enabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Enable Privoxy</ulink>
3657 <ulink url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=disabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Disable Privoxy</ulink>
3663 <ulink url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=toggle','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Toggle Privoxy</ulink> (Toggles between enabled and disabled)
3669 <ulink url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y','ijbstatus','width=250,height=2,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">View Privoxy Status</ulink>
3677 Credit: The site which gave me the general idea for these bookmarklets is
3678 <ulink url="http://www.bookmarklets.com">www.bookmarklets.com</ulink>. They
3679 have more information about bookmarklets.
3688 <!-- ~~~~~ New section ~~~~~ -->
3689 <sect2 id="actionsanat">
3690 <title>Anatomy of an Action</title>
3693 The way <application>Privoxy</application> applies <quote>actions</quote>
3694 and <quote>filters</quote> to any given URL can be complex, and not always so
3695 easy to understand what is happening. And sometimes we need to be able to
3696 <emphasis>see</emphasis> just what <application>Privoxy</application> is
3697 doing. Especially, if something <application>Privoxy</application> is doing
3698 is causing us a problem inadvertantly. It can be a little daunting to look at
3699 the actions and filters files themselves, since they tend to be filled with
3700 <quote>regular expressions</quote> whose consequences are not always
3701 so obvious. <application>Privoxy</application> provides the
3702 <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
3703 page that can show us very specifically how <application>actions</application>
3704 are being applied to any given URL. This is a big help for troubleshooting.
3708 First, enter one URL (or partial URL) at the prompt, and then
3709 <application>Privoxy</application> will tell us
3710 how the current configuration will handle it. This will not
3711 help with filtering effects from the <filename>default.filter</filename> file! It
3712 also will not tell you about any other URLs that may be embedded within the
3713 URL you are testing. For instance, images such as ads are expressed as URLs
3714 within the raw page source of HTML pages. So you will only get info for the
3715 actual URL that is pasted into the prompt area -- not any sub-URLs. If you
3716 want to know about embedded URLs like ads, you will have to dig those out of
3717 the HTML source. Use your browser's <quote>View Page Source</quote> option
3722 Let's look at an example, <ulink url="http://google.com">google.com</ulink>,
3723 one section at a time:
3728 System default actions:
3730 { -add-header -block -deanimate-gifs -downgrade -fast-redirects -filter
3731 -hide-forwarded -hide-from -hide-referer -hide-user-agent -image
3732 -image-blocker -limit-connect -no-compression -no-cookies-keep
3733 -no-cookies-read -no-cookies-set -no-popups -vanilla-wafer -wafer }
3739 This is the top section, and only tells us of the compiled in defaults. This
3740 is basically what <application>Privoxy</application> would do if there
3741 were not any <quote>actions</quote> defined, i.e. it does nothing. Every action
3742 is disabled. This is not particularly informative for our purposes here. OK,
3749 Matches for http://google.com:
3751 { -add-header -block +deanimate-gifs -downgrade +fast-redirects
3752 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
3753 +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
3754 +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
3755 -hide-user-agent -image +image-blocker{blank} +no-compression
3756 +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups
3757 -vanilla-wafer -wafer }
3760 { -no-cookies-keep -no-cookies-read -no-cookies-set }
3770 This is much more informative, and tells us how we have defined our
3771 <quote>actions</quote>, and which ones match for our example,
3772 <quote>google.com</quote>. The first grouping shows our default
3773 settings, which would apply to all URLs. If you look at your <quote>actions</quote>
3774 file, this would be the section just below the <quote>aliases</quote> section
3775 near the top. This applies to all URLs as signified by the single forward
3776 slash -- <quote>/</quote>.
3781 These are the default actions we have enabled. But we can define additional
3782 actions that would be exceptions to these general rules, and then list
3783 specific URLs that these exceptions would apply to. Last match wins.
3784 Just below this then are two explict matches for <quote>.google.com</quote>.
3785 The first is negating our various cookie blocking actions (i.e. we will allow
3786 cookies here). The second is allowing <quote>fast-redirects</quote>. Note
3787 that there is a leading dot here -- <quote>.google.com</quote>. This will
3788 match any hosts and sub-domains, in the google.com domain also, such as
3789 <quote>www.google.com</quote>. So, apparently, we have these actions defined
3790 somewhere in the lower part of our actions file, and
3791 <quote>google.com</quote> is referenced in these sections.
3796 And now we pull it altogether in the bottom section and summarize how
3797 <application>Privoxy</application> is appying all its <quote>actions</quote>
3798 to <quote>google.com</quote>:
3807 -add-header -block -deanimate-gifs -downgrade -fast-redirects
3808 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
3809 +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
3810 +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
3811 -hide-user-agent -image +image-blocker{blank} -limit-connect +no-compression
3812 -no-cookies-keep -no-cookies-read -no-cookies-set +no-popups -vanilla-wafer
3819 Now another example, <quote>ad.doubleclick.net</quote>:
3838 We'll just show the interesting part here, the explicit matches. It is
3839 matched three different times. Each as an <quote>+block +image</quote>,
3840 which is the expanded form of one of our aliases that had been defined as:
3841 <quote>+imageblock</quote>. (<quote>Aliases</quote> are defined in the
3842 first section of the actions file and typically used to combine more
3847 Any one of these would have done the trick and blocked this as an unwanted
3848 image. This is unnecessarily redundant since the last case effectively
3849 would also cover the first. No point in taking chances with these guys
3850 though ;-) Note that if you want an ad or obnoxious
3851 URL to be invisible, it should be defined as <quote>ad.doubleclick.net</quote>
3852 is done here -- as both a <quote>+block</quote> <emphasis>and</emphasis> an
3853 <quote>+image</quote>. The custom alias <quote>+imageblock</quote> does this
3858 One last example. Let's try <quote>http://www.rhapsodyk.net/adsl/HOWTO/</quote>.
3859 This one is giving us problems. We are getting a blank page. Hmmm...
3865 Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
3867 { -add-header -block +deanimate-gifs -downgrade +fast-redirects
3868 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
3869 +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
3870 +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
3871 -hide-user-agent -image +image-blocker{blank} +no-compression
3872 +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups
3873 -vanilla-wafer -wafer }
3883 Ooops, the <quote>/adsl/</quote> is matching <quote>/ads</quote>! But
3884 we did not want this at all! Now we see why we get the blank page. We could
3885 now add a new action below this that explictly does <emphasis>not</emphasis>
3886 block (-block) pages with <quote>adsl</quote>. There are various ways to
3887 handle such exceptions. Example:
3900 Now the page displays ;-) Be sure to flush your browser's caches when
3901 making such changes. Or, try using <literal>Shift+Reload</literal>.
3906 But now what about a situation where we get no explicit matches like
3921 That actually was very telling and pointed us quickly to where the problem
3922 was. If you don't get this kind of match, then it means one of the default
3923 rules in the first section is causing the problem. This would require some
3924 guesswork, and maybe a little trial and error to isolate the offending rule.
3925 One likely cause would be one of the <quote>{+filter}</quote> actions. Try
3926 adding the URL for the site to one of aliases that turn off <quote>+filter</quote>:
3934 .worldpay.com # for quietpc.com
3943 <quote>{shop}</quote> is an <quote>alias</quote> that expands to
3944 <quote>{ -filter -no-cookies -no-cookies-keep }</quote>. Or you could do
3945 your own exception to negate filtering:
3959 <quote>{fragile}</quote> is an alias that disables most actions. This can be
3960 used as a last resort for problem sites. Remember to flush caches! If this
3961 still does not work, you will have to go through the remaining actions one by
3962 one to find which one(s) is causing the problem.
3971 This program is free software; you can redistribute it
3972 and/or modify it under the terms of the GNU General
3973 Public License as published by the Free Software
3974 Foundation; either version 2 of the License, or (at
3975 your option) any later version.
3977 This program is distributed in the hope that it will
3978 be useful, but WITHOUT ANY WARRANTY; without even the
3979 implied warranty of MERCHANTABILITY or FITNESS FOR A
3980 PARTICULAR PURPOSE. See the GNU General Public
3981 License for more details.
3983 The GNU General Public License should be included with
3984 this file. If not, you can view it at
3985 http://www.gnu.org/copyleft/gpl.html
3986 or write to the Free Software Foundation, Inc., 59
3987 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
3989 $Log: user-manual.sgml,v $
3990 Revision 1.65 2002/04/03 19:52:07 swa
3991 enhance squid section due to user suggestion
3993 Revision 1.64 2002/04/03 03:53:43 hal9
3994 A few minor bug fixes, and touch ups. Ready for review.
3996 Revision 1.63 2002/04/01 16:24:49 hal9
3997 Define entities to include boilerplate text. See doc/source/*.
3999 Revision 1.62 2002/03/30 04:15:53 hal9
4000 - Fix privoxy.org/config links.
4001 - Paste in Bookmarklets from Toggle page.
4002 - Move Quickstart nearer top, and minor rework.
4004 Revision 1.61 2002/03/29 01:31:08 hal9
4007 Revision 1.60 2002/03/27 01:57:34 hal9
4008 Added more to Anatomy section.
4010 Revision 1.59 2002/03/27 00:54:33 hal9
4011 Touch up intro for new name.
4013 Revision 1.58 2002/03/26 22:29:55 swa
4014 we have a new homepage!
4016 Revision 1.57 2002/03/24 20:33:30 hal9
4017 A few minor catch ups with name change.
4019 Revision 1.56 2002/03/24 16:17:06 swa
4020 configure needs to be generated.
4022 Revision 1.55 2002/03/24 16:08:08 swa
4023 we are too lazy to make a block-built
4024 privoxy logo. hence removed the option.
4026 Revision 1.54 2002/03/24 15:46:20 swa
4027 name change related issue.
4029 Revision 1.53 2002/03/24 11:51:00 swa
4030 name change. changed filenames.
4032 Revision 1.52 2002/03/24 11:01:06 swa
4035 Revision 1.51 2002/03/23 15:13:11 swa
4036 renamed every reference to the old name with foobar.
4037 fixed "application foobar application" tag, fixed
4038 "the foobar" with "foobar". left junkbustser in cvs
4039 comments and remarks to history untouched.
4041 Revision 1.50 2002/03/23 05:06:21 hal9
4044 Revision 1.49 2002/03/21 17:01:05 hal9
4045 New section in Appendix.
4047 Revision 1.48 2002/03/12 06:33:01 hal9
4048 Catching up to Andreas and re_filterfile changes.
4050 Revision 1.47 2002/03/11 13:13:27 swa
4051 correct feedback channels
4053 Revision 1.46 2002/03/10 00:51:08 hal9
4054 Added section on JB internal pages in Appendix.
4056 Revision 1.45 2002/03/09 17:43:53 swa
4059 Revision 1.44 2002/03/09 17:08:48 hal9
4060 New section on Jon's actions file editor, and move some stuff around.
4062 Revision 1.43 2002/03/08 00:47:32 hal9
4063 Added imageblock{pattern}.
4065 Revision 1.42 2002/03/07 18:16:55 swa
4068 Revision 1.41 2002/03/07 16:46:43 hal9
4069 Fix a few markup problems for jade.
4071 Revision 1.40 2002/03/07 16:28:39 swa
4072 provide correct feedback channels
4074 Revision 1.39 2002/03/06 16:19:28 hal9
4075 Note on perceived filtering slowdown per FR.
4077 Revision 1.38 2002/03/05 23:55:14 hal9
4078 Stupid I did it again. Double hyphen in comment breaks jade.
4080 Revision 1.37 2002/03/05 23:53:49 hal9
4081 jade barfs on '- -' embedded in comments. - -user option broke it.
4083 Revision 1.36 2002/03/05 22:53:28 hal9
4084 Add new - - user option.
4086 Revision 1.35 2002/03/05 00:17:27 hal9
4087 Added section on command line options.
4089 Revision 1.34 2002/03/04 19:32:07 oes
4090 Changed default port to 8118
4092 Revision 1.33 2002/03/03 19:46:13 hal9
4093 Emphasis on where/how to report bugs, etc
4095 Revision 1.32 2002/03/03 09:26:06 joergs
4096 AmigaOS changes, config is now loaded from PROGDIR: instead of
4097 AmiTCP:db/junkbuster/ if no configuration file is specified on the
4100 Revision 1.31 2002/03/02 22:45:52 david__schmidt
4103 Revision 1.30 2002/03/02 22:00:14 hal9
4104 Updated 'New Features' list. Ran through spell-checker.
4106 Revision 1.29 2002/03/02 20:34:07 david__schmidt
4107 Update OS/2 build section
4109 Revision 1.28 2002/02/24 14:34:24 jongfoster
4110 Formatting changes. Now changing the doctype to DocBook XML 4.1
4111 will work - no other changes are needed.
4113 Revision 1.27 2002/01/11 14:14:32 hal9
4114 Added a very short section on Templates
4116 Revision 1.26 2002/01/09 20:02:50 hal9
4117 Fix bug re: auto-detect config file changes.
4119 Revision 1.25 2002/01/09 18:20:30 hal9
4120 Touch ups for *.action files.
4122 Revision 1.24 2001/12/02 01:13:42 hal9
4125 Revision 1.23 2001/12/02 00:20:41 hal9
4126 Updates for recent changes.
4128 Revision 1.22 2001/11/05 23:57:51 hal9
4129 Minor update for startup now daemon mode.
4131 Revision 1.21 2001/10/31 21:11:03 hal9
4132 Correct 2 minor errors
4134 Revision 1.18 2001/10/24 18:45:26 hal9
4135 *** empty log message ***
4137 Revision 1.17 2001/10/24 17:10:55 hal9
4138 Catching up with Jon's recent work, and a few other things.
4140 Revision 1.16 2001/10/21 17:19:21 swa
4141 wrong url in documentation
4143 Revision 1.15 2001/10/14 23:46:24 hal9
4144 Various minor changes. Fleshed out SEE ALSO section.
4146 Revision 1.13 2001/10/10 17:28:33 hal9
4149 Revision 1.12 2001/09/28 02:57:04 hal9
4152 Revision 1.11 2001/09/28 02:25:20 hal9
4155 Revision 1.9 2001/09/27 23:50:29 hal9
4156 A few changes. A short section on regular expression in appendix.
4158 Revision 1.8 2001/09/25 00:34:59 hal9
4159 Some additions, and re-arranging.
4161 Revision 1.7 2001/09/24 14:31:36 hal9
4164 Revision 1.6 2001/09/24 14:10:32 hal9
4165 Including David's OS/2 installation instructions.
4167 Revision 1.2 2001/09/13 15:27:40 swa
4170 Revision 1.1 2001/09/12 15:36:41 swa
4171 source files for junkbuster documentation
4173 Revision 1.3 2001/09/10 17:43:59 swa
4174 first proposal of a structure.
4176 Revision 1.2 2001/06/13 14:28:31 swa
4177 docs should have an author.
4179 Revision 1.1 2001/06/13 14:20:37 swa
4180 first import of project's documentation for the webserver.
projects / privoxy.git / blob