1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
3 File : $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
7 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
9 $Id: user-manual.sgml,v 1.61 2002/03/29 01:31:08 hal9 Exp $
11 Written by and Copyright (C) 2001 the SourceForge
12 Privoxy team. http://www.privoxy.org/
14 Based on the Internet Junkbuster originally written
15 by and Copyright (C) 1997 Anonymous Coders and
16 Junkbusters Corporation. http://www.junkbusters.com
20 Sat 03/02/02 04:53:47 PM
22 This should be ready for BETA release.
24 Hal Burgiss <hal@foobox.net>
29 <title>Privoxy User Manual</title>
31 <pubdate>$Id: user-manual.sgml,v 1.61 2002/03/29 01:31:08 hal9 Exp $</pubdate>
36 <orgname>By: Privoxy Developers</orgname>
43 The user manual gives users information on how to install, configure and use
44 <application>Privoxy</application>. <application>Privoxy</application> is a
45 web proxy with advanced filtering capabilities for protecting privacy,
46 filtering web page content, managing cookies, controlling access, and
47 removing ads, banners, pop-ups and other obnoxious Internet
48 Junk. <application>Privoxy</application> has a very flexible configuration
49 and can be customized to suit individual needs and
50 tastes. <application>Privoxy</application> has application for both
51 stand-alone systems and multi-user networks.
54 You can find the latest version of the user manual at <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink>.
58 <!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
65 <!-- ~~~~~ New section ~~~~~ -->
67 <sect1 id="introduction"><title>Introduction</title>
69 <application>Privoxy</application> is a web proxy with advanced filtering
70 capabilities for protecting privacy, filtering web page content, managing
71 cookies, controlling access, and removing ads, banners, pop-ups and other
72 obnoxious Internet junk. <application>Privoxy</application> has a very
73 flexible configuration and can be customized to suit individual needs and
74 tastes. <application>Privoxy</application> has application for both
75 stand-alone systems and multi-user networks.
79 <application>Privoxy</application> is based on the code of the
80 <application>Internet Junkbuster</application>.
81 <application>Junkbuster</application> was originally written by JunkBusters
82 Corporation, and was released as free open-source software under the GNU GPL.
83 Stefan Waldherr made many improvements, and started the SourceForge project
84 to continue development.
88 <application>Privoxy</application> continues the
89 <application>Junkbuster</application> tradition, but adds many
90 refinements and enhancements.
94 This documentation is included with the current BETA 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 Since this is a BETA version, not all new features are well tested. This
105 documentation may be slightly out of sync as a result (especially with
106 CVS sources). And there <emphasis>may be</emphasis> bugs, though hopefully
111 <!-- ~~~~~ New section ~~~~~ -->
113 <title>New Features</title>
115 In addition to <application>Internet Junkbuster's</application> traditional
116 feature of ad and banner blocking and cookie management,
117 <application>Privoxy</application> provides new features, some of them
118 currently under development:
122 The section is in both user-manual and faq. Please keep in sync.
129 Integrated browser based configuration and control utility (<ulink
130 url="http://p.p">http://p.p</ulink>). Browser-based tracing of rule
137 Modularized configuration that will allow for system wide settings, and
138 individual user settings. (not implemented yet, probably a 3.1 feature)
144 Blocking of annoying pop-up browser windows.
150 HTTP/1.1 compliant (most, but not all 1.1 features are supported).
156 Support for Perl Compatible Regular Expressions in the configuration files, and
157 generally a more sophisticated and flexible configuration syntax over
170 Web page content filtering (removes banners based on size,
171 invisible <quote>web-bugs</quote>, JavaScript, pop-ups, status bar abuse,
178 Bypass many click-tracking scripts (avoids script redirection).
185 Multi-threaded (POSIX and native threads).
191 Auto-detection and re-reading of config file changes.
197 User-customizable HTML templates (e.g. 404 error page).
203 Improved cookie management features (e.g. session based cookies).
209 Improved signal handling, and a true daemon mode (Unix).
215 Builds from source on most UNIX-like systems. Packages available for: Linux
216 (RedHat, SuSE, or Debian), Windows, Sun Solaris, Mac OSX, OS/2, HP-UX 11 and AmigaOS.
223 In addition, the configuration is much more powerful and versatile over-all.
234 <!-- ~ End section ~ -->
237 <!-- ~~~~~ New section ~~~~~ -->
238 <sect1 id="installation"><title>Installation</title>
240 <application>Privoxy</application> is available as raw source code, or
241 pre-compiled binaries. See the <ulink
242 url="http://sourceforge.net/projects/ijbswa/">Privoxy Home Page</ulink>
243 for binaries and current release info. <application>Privoxy</application>
244 is also available via <ulink
245 url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
246 This is the recommended approach at this time. But please be aware that CVS
247 is constantly changing, and it may break in mysterious ways.
250 <!-- ~~~~~ New section ~~~~~ -->
251 <sect2 id="installation-source"><title>Source</title>
253 For gzipped tar archives, unpack the source:
258 tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz]
259 cd privoxy-2.9.13-beta
264 For retrieving the current CVS sources, you'll need the CVS
265 package installed first. To download CVS source:
270 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
271 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
277 This will create a directory named <filename>current/</filename>, which will
278 contain the source tree.
282 Then, in either case, to build from tarball/CVS source:
287 ./configure (--help to see options)
288 make (the make from gnu, gmake for *BSD)
290 make -n install (to see where all the files will go)
291 make install (to really install)
296 For Redhat and SuSE Linux RPM packages, see below.
302 <!-- ~~~~~ New section ~~~~~ -->
303 <sect2 id="installation-rh"><title>Red Hat</title>
305 To build Redhat RPM packages, install source as above. Then:
318 This will create both binary and src RPMs in the usual places. Example:
322 /usr/src/redhat/RPMS/i686/privoxy-2.9.11-1.i686.rpm
325 /usr/src/redhat/SRPMS/privoxy-2.9.11-1.src.rpm
329 To install, of course:
334 rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-2.9.11-1.i686.rpm
339 This will place the <application>Privoxy</application> configuration
340 files in <filename>/etc/privoxy/</filename>, and log files in
341 <filename>/var/log/privoxy/</filename>.
346 <!-- ~~~~~ New section ~~~~~ -->
347 <sect2 id="installation-suse"><title>SuSE</title>
349 To build SuSE RPM packages, install source as above. Then:
362 This will create both binary and src RPMs in the usual places. Example:
366 /usr/src/packages/RPMS/i686/privoxy-2.9.11-1.i686.rpm
369 /usr/src/packages/SRPMS/privoxy-2.9.11-1.src.rpm
373 To install, of course:
378 rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.11-1.i686.rpm
383 This will place the <application>Privoxy</application> configuration
384 files in <filename>/etc/privoxy/</filename>, and log files in
385 <filename>/var/log/privoxy/</filename>.
391 <!-- ~~~~~ New section ~~~~~ -->
392 <sect2 id="installation-os2"><title>OS/2</title>
399 <application>Privoxy</application> is packaged in a WarpIN self-
400 installing archive. The self-installing program will be named depending
401 on the release version, something like:
402 <filename>ijbos2_setup_1.2.3.exe</filename>. In order to install it, simply
403 run this executable or double-click on its icon and follow the WarpIN
404 installation panels. A shadow of the <application>Privoxy</application>
405 executable will be placed in your startup folder so it will start
406 automatically whenever OS/2 starts.
410 The directory you choose to install <application>Privoxy</application>
411 into will contain all of the configuration files.
415 If you would like to build binary images on OS/2 yourself, you will need
416 a few Unix-like tools: autoconf, autoheader and sh. These tools will be
417 used to create the required config.h file, which is not part of the
418 source distribution because it differs based on platform. You will also
420 The distribution has been created using IBM VisualAge compilers, but you
421 can use any compiler you like. GCC/EMX has the disadvantage of needing
422 to be single-threaded due to a limitation of EMX's implementation of the
423 select() socket call.
427 In addition to needing the source code distribution as outlined earlier,
428 you will want to extract the <filename>os2seutp</filename> directory from CVS:
430 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
431 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
433 This will create a directory named os2setup/, which will contain the
434 <filename>Makefile.vac</filename> makefile and <filename>os2build.cmd</filename>
435 which is used to completely create the binary distribution. The sequence
436 of events for building the executable for yourself goes something like this:
443 nmake -f Makefile.vac
445 You will see this sequence laid out in <filename>os2build.cmd</filename>.
451 <!-- ~~~~~ New section ~~~~~ -->
452 <sect2 id="installation-win"><title>Windows</title>
453 <para>Click-click. (I need help on this. Not a clue here. Also for
454 configuration section below. HB.)
458 <!-- ~~~~~ New section ~~~~~ -->
459 <sect2 id="installation-other"><title>Other</title>
461 Some quick notes on other Operating Systems.
465 For FreeBSD (and other *BSDs?), the build will require <command>gmake</command>
466 instead of the included <command>make</command>. <command>gmake</command> is
467 available from <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>.
468 The rest should be the same as above for Linux/Unix.
475 <!-- ~ End section ~ -->
478 <!-- ~~~~~ New section ~~~~~ -->
480 <sect1 id="quickstart"><title>Quickstart to Using <application>Privoxy</application></title>
482 Before launching <application>Privoxy</application> for the first time, you
483 will want to configure your browser(s) to use <application>Privoxy</application>
484 and the HTTP and HTTPS proxy. The default is localhost for the proxy address,
485 and port 8118 (earlier versions used port 800). This is the one required
486 configuration that must be done!
490 With <application>Netscape</application> (and
491 <application>Mozilla</application>), this can be set under <literal>Edit
492 -> Preferences -> Advanced -> Proxies -> HTTP Proxy</literal>.
493 For <application>Internet Explorer</application>: <literal>Tools >
494 Internet Properties -> Connections -> LAN Setting</literal>. Then,
495 check <quote>Use Proxy</quote> and fill in the appropriate info (Address:
496 localhost, Port: 8118). Include if HTTPS proxy support too.
500 After doing this, flush your browser's disk and memory caches to force a
501 re-reading of all pages and get rid of any ads that may be cached. You
502 are now ready to start enjoying the benefits of using
503 <application>Privoxy</application>.
508 <application>Privoxy</application> is typically started by specifying the
509 main configuration file to be used on the command line. Example Unix startup
516 # /usr/sbin/privoxy /etc/privoxy/config
522 An init script is provided for SuSE and Redhat.
526 For for SuSE: /etc/rc.d/privoxy start
530 For RedHat: /etc/rc.d/init.d/privoxy start
535 If no configuration file is specified on the command line,
536 <application>Privoxy</application> will look for a file named
537 <filename>config</filename> in the current directory. Except on Win32 where
538 it will try <filename>config.txt</filename>. If no file is specified on the
539 command line and no default configuration file can be found,
540 <application>Privoxy</application> will fail to start.
545 The included default configuration files should give a reasonable starting
546 point, though may be somewhat aggressive in blocking junk. Most of the
547 per site configuration is done in the <quote>actions</quote> files. These
548 are where various cookie actions are defined, ad and banner blocking,
549 and other aspects of <application>Privoxy</application> configuration. There
550 are several such files included, with varying levels of aggressiveness.
554 You will probably want to keep an eye out for sites that require persistent
555 cookies, and add these to <filename>default.action</filename> as needed. By
556 default, most of these will be accepted only during the current browser
557 session, until you add them to the configuration. If you want the browser to
558 handle this instead, you will need to edit
559 <filename>default.action</filename> and disable this feature. If you use more
560 than one browser, it would make more sense to let
561 <application>Privoxy</application> handle this. In which case, the browser(s)
562 should be set to accept all cookies.
566 <application>Privoxy</application> is HTTP/1.1 compliant, but not all 1.1
567 features are as yet implemented. If browsers that support HTTP/1.1 (like
568 <application>Mozilla</application> or recent versions of I.E.) experience
569 problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look
570 under <literal>Edit -> Preferences -> Debug -> Networking</literal>.
571 Or set the <quote>+downgrade</quote> config option in
572 <filename>default.action</filename>.
576 After running <application>Privoxy</application> for a while, you can
577 start to fine tune the configuration to suit your personal, or site,
578 preferences and requirements. There are many, many aspects that can
579 be customized. <quote>Actions</quote> (as specified in <filename>default.action</filename>)
580 can be adjusted by pointing your browser to
581 <ulink url="http://p.p/">http://p.p/</ulink>,
582 and then follow the link to <quote>edit the actions list</quote>.
583 (This is an internal page and does not require Internet access.)
587 In fact, various aspects of <application>Privoxy</application>
588 configuration can be viewed from this page, including
589 current configuration parameters, source code version numbers,
590 the browser's request headers, and <quote>actions</quote> that apply
591 to a given URL. In addition to the <filename>default.action</filename> file
592 editor mentioned above, <application>Privoxy</application> can also
593 be turned <quote>on</quote> and <quote>off</quote> from this page.
597 If you encounter problems, please verify it is a
598 <application>Privoxy</application> bug, by disabling
599 <application>Privoxy</application>, and then trying the same page.
600 Also, try another browser if possible to eliminate browser or site
601 problems. Before reporting it as a bug, see if there is not a configuration
602 option that is enabled that is causing the page not to load. You can then add
603 an exception for that page or site. For instance, try adding it to the
604 <literal>{fragile}</literal> section of <filename>default.action</filename>.
605 This will turn off most actions for this site. For more on troubleshooting
606 problem sites, see the <ulink
607 url="appendix.html#ACTIONSANAT">Appendix</ulink>. If a bug, please report it
608 to the developers (see below).
612 <!-- ~~~~~ New section ~~~~~ -->
615 <title>Command Line Options</title>
617 <application>Privoxy</application> may be invoked with the following
618 command-line options:
626 <emphasis>--version</emphasis>
629 Print version info and exit, Unix only.
634 <emphasis>--help</emphasis>
637 Print a short usage info and exit, Unix only.
642 <emphasis>--no-daemon</emphasis>
645 Don't become a daemon, i.e. don't fork and become process group
646 leader, don't detach from controlling tty. Unix only.
651 <emphasis>--pidfile FILE</emphasis>
655 On startup, write the process ID to <emphasis>FILE</emphasis>. Delete the
656 <emphasis>FILE</emphasis> on exit. Failiure to create or delete the
657 <emphasis>FILE</emphasis> is non-fatal. If no <emphasis>FILE</emphasis>
658 option is given, no PID file will be used. Unix only.
663 <emphasis>--user USER[.GROUP]</emphasis>
667 After (optionally) writing the PID file, assume the user ID of
668 <emphasis>USER</emphasis>, and if included the GID of GROUP. Exit if the
669 privileges are not sufficient to do so. Unix only.
674 <emphasis>configfile</emphasis>
677 If no <emphasis>configfile</emphasis> is included on the command line,
678 <application>Privoxy</application> will look for a file named
679 <quote>config</quote> in the current directory (except on Win32
680 where it will look for <quote>config.txt</quote> instead). Specify
681 full path to avoid confusion.
692 <!-- ~ End section ~ -->
695 <!-- ~~~~~ New section ~~~~~ -->
696 <sect1 id="configuration"><title><application>Privoxy</application> Configuration</title>
698 All <application>Privoxy</application> configuration is kept
699 in text files. These files can be edited with a text editor.
700 Many important aspects of <application>Privoxy</application> can
701 also be controlled easily with a web browser.
706 <!-- ~~~~~ New section ~~~~~ -->
709 <title>Controlling <application>Privoxy</application> with Your Web Browser</title>
711 <application>Privoxy</application> can be reached by the special
712 URL <ulink url="http://p.p/">http://p.p/</ulink> (or alternately
713 <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>),
714 which is an internal page. You will see the following section:
721 Please choose from the following options:
723 * Show information about the current configuration
724 * Show the source code version numbers
725 * Show the client's request headers.
726 * Show which actions apply to a URL and why
727 * Toggle Privoxy on or off
728 * Edit the actions list
734 This should be self-explanatory. Note the last item is an editor for the
735 <quote>actions list</quote>, which is where much of the ad, banner, cookie,
736 and URL blocking magic is configured as well as other advanced features of
737 <application>Privoxy</application>. This is an easy way to adjust various
738 aspects of <application>Privoxy</application> configuration. The actions
739 file, and other configuration files, are explained in detail below.
740 <application>Privoxy</application> will automatically detect any changes
745 <quote>Toggle Privoxy On or Off</quote> is handy for sites that might
746 have problems with your current actions and filters, or just to test if
747 a site misbehaves, whether it is <application>Privoxy</application>
748 causing the problem or not. <application>Privoxy</application> continues
749 to run as a proxy in this case, but all filtering is disabled.
755 <!-- ~ End section ~ -->
760 <!-- ~~~~~ New section ~~~~~ -->
763 <title>Configuration Files Overview</title>
765 For Unix, *BSD and Linux, all configuration files are located in
766 <filename>/etc/privoxy/</filename> by default. For MS Windows, OS/2, and
767 AmigaOS these are all in the same directory as the
768 <application>Privoxy</application> executable. The name and number of
769 configuration files has changed from previous versions, and is subject to
770 change as development progresses.
774 The installed defaults provide a reasonable starting point, though possibly
775 aggressive by some standards. For the time being, there are only three
776 default configuration files (this will change in time):
784 The main configuration file is named <filename>config</filename>
785 on Linux, Unix, BSD, OS/2, and AmigaOS and <filename>config.txt</filename>
792 The <filename>default.action</filename> file is used to define various
793 <quote>actions</quote> relating to images, banners, pop-ups, access
794 restrictions, banners and cookies. There is a CGI based editor for this
795 file that can be accessed via <ulink
796 url="http://p.p">http://p.p</ulink>. (Other actions
797 files are included as well with differing levels of filtering
798 and blocking, e.g. <filename>ijb-basic.action</filename>.)
804 The <filename>default.filter</filename> file can be used to re-write the raw
805 page content, including viewable text as well as embedded HTML and JavaScript,
806 and whatever else lurks on any given web page.
814 <filename>default.action</filename> and <filename>default.filter</filename>
815 can use Perl style regular expressions for maximum flexibility. All files use
816 the <quote><literal>#</literal></quote> character to denote a comment. Such
817 lines are not processed by <application>Privoxy</application>. After
818 making any changes, there is no need to restart
819 <application>Privoxy</application> in order for the changes to take
820 effect. <application>Privoxy</application> should detect such changes
825 While under development, the configuration content is subject to change.
826 The below documentation may not be accurate by the time you read this.
827 Also, what constitutes a <quote>default</quote> setting, may change, so
828 please check all your configuration files on important issues.
833 <!-- ~~~~~ New section ~~~~~ -->
836 <title>The Main Configuration File</title>
838 Again, the main configuration file is named <filename>config</filename> on
839 Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
840 Configuration lines consist of an initial keyword followed by a list of
841 values, all separated by whitespace (any number of spaces or tabs). For
849 <emphasis>blockfile blocklist.ini</emphasis>
856 Indicates that the blockfile is named <quote>blocklist.ini</quote>. (A
857 default installation does not use this.)
861 A <quote><literal>#</literal></quote> indicates a comment. Any part of a
862 line following a <quote><literal>#</literal></quote> is ignored, except if
863 the <quote><literal>#</literal></quote> is preceded by a
864 <quote><literal>\</literal></quote>.
868 Thus, by placing a <quote><literal>#</literal></quote> at the start of an
869 existing configuration line, you can make it a comment and it will be treated
870 as if it weren't there. This is called <quote>commenting out</quote> an
871 option and can be useful to turn off features: If you comment out the
872 <quote>logfile</quote> line, <application>Privoxy</application> will not
873 log to a file at all. Watch for the <quote>default:</quote> section in each
874 explanation to see what happens if the option is left unset (or commented
879 Long lines can be continued on the next line by using a
880 <quote><literal>\</literal></quote> as the very last character.
884 There are various aspects of <application>Privoxy</application> behavior
889 <!-- ~~~~~ New section ~~~~~ -->
892 <title>Defining Other Configuration Files</title>
895 <application>Privoxy</application> can use a number of other files to tell it
896 what ads to block, what cookies to accept, etc. This section of the
897 configuration file tells <application>Privoxy</application> where to find
898 all those other files.
902 On <application>Windows</application> and <application>AmigaOS</application>,
903 <application>Privoxy</application> looks for these files in the same
904 directory as the executable. On Unix and OS/2,
905 <application>Privoxy</application> looks for these files in the current
906 working directory. In either case, an absolute path name can be used to
911 When development goes modular and multi-user, the blocker, filter, and
912 per-user config will be stored in subdirectories of <quote>confdir</quote>.
913 For now, only <filename>confdir/templates</filename> is used for storing HTML
914 templates for CGI results.
918 The location of the configuration files:
925 <emphasis>confdir /etc/privoxy</emphasis> # No trailing /, please.
932 The directory where all logging (i.e. <filename>logfile</filename> and
933 <filename>jarfile</filename>) takes place. No trailing
934 <quote><literal>/</literal></quote>, please:
941 <emphasis>logdir /var/log/privoxy</emphasis>
948 Note that all file specifications below are relative to
949 the above two directories!
953 The <quote>default.action</quote> file contains patterns to specify the
954 actions to apply to requests for each site. Default: Cookies to and from all
955 destinations are kept only during the current browser session (i.e. they are
956 not saved to disk). Pop-ups are disabled for all sites. All sites are
957 filtered through selected sections of <quote>default.filter</quote>. No sites
958 are blocked. <application>Privoxy</application> displays a checkboard type
959 pattern for filtered ads and other images. The syntax of this file is
960 explained in detail <link linkend="actionsfile">below</link>. Other
961 <quote>actions</quote> files are included, and you are free to use any of
962 them. They have varying degrees of aggressiveness.
969 <emphasis>actionsfile default.action</emphasis>
976 The <quote>default.filter</quote> file contains content modification rules
977 that use <quote>regular expressions</quote>. These rules permit powerful
978 changes on the content of Web pages, e.g., you could disable your favorite
979 JavaScript annoyances, re-write the actual displayed text, or just have some
980 fun replacing <quote>Microsoft</quote> with <quote>MicroSuck</quote> wherever
981 it appears on a Web page. Default: whatever the developers are playing with
986 Filtering requires buffering the page content, which may appear to slow down
987 page rendering since nothing is displayed until all content has passed
988 the filters. (It does not really take longer, but seems that way since
989 the page is not incrementally displayed.) This effect will be more noticeable
990 on slower connections.
998 <emphasis>filterfile default.filter</emphasis>
1005 The logfile is where all logging and error messages are written. The logfile
1006 can be useful for tracking down a problem with
1007 <application>Privoxy</application> (e.g., it's not blocking an ad you
1008 think it should block) but in most cases you probably will never look at it.
1012 Your logfile will grow indefinitely, and you will probably want to
1013 periodically remove it. On Unix systems, you can do this with a cron job
1014 (see <quote>man cron</quote>). For Redhat, a <command>logrotate</command>
1015 script has been included.
1019 On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
1020 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
1021 the effect that cron.daily will automatically archive, gzip, and empty the
1022 log, when it exceeds 1M size.
1026 Default: Log to the a file named <filename>logfile</filename>.
1027 Comment out to disable logging.
1034 <emphasis>logfile logfile</emphasis>
1041 The <quote>jarfile</quote> defines where
1042 <application>Privoxy</application> stores the cookies it intercepts. Note
1043 that if you use a <quote>jarfile</quote>, it may grow quite large. Default:
1044 Don't store intercepted cookies.
1051 <emphasis>#jarfile jarfile</emphasis>
1058 If you specify a <quote>trustfile</quote>,
1059 <application>Privoxy</application> will only allow access to sites that
1060 are named in the trustfile. You can also mark sites as trusted referrers,
1061 with the effect that access to untrusted sites will be granted, if a link
1062 from a trusted referrer was used. The link target will then be added to the
1063 <quote>trustfile</quote>. This is a very restrictive feature that typical
1064 users most probably want to leave disabled. Default: Disabled, don't use the
1072 <emphasis>#trustfile trust</emphasis>
1079 If you use the trust mechanism, it is a good idea to write up some on-line
1080 documentation about your blocking policy and to specify the URL(s) here. They
1081 will appear on the page that your users receive when they try to access
1082 untrusted content. Use multiple times for multiple URLs. Default: Don't
1083 display links on the <quote>untrusted</quote> info page.
1090 <emphasis>trust-info-url http://www.your-site.com/why_we_block.html</emphasis>
1091 <emphasis>trust-info-url http://www.your-site.com/what_we_allow.html</emphasis>
1099 <!-- ~ End section ~ -->
1103 <!-- ~~~~~ New section ~~~~~ -->
1106 <title>Other Configuration Options</title>
1109 This part of the configuration file contains options that control how
1110 <application>Privoxy</application> operates.
1114 <quote>Admin-address</quote> should be set to the email address of the proxy
1115 administrator. It is used in many of the proxy-generated pages. Default:
1123 <emphasis>#admin-address fill@me.in.please</emphasis>
1130 <quote>Proxy-info-url</quote> can be set to a URL that contains more info
1131 about this <application>Privoxy</application> installation, it's
1132 configuration and policies. It is used in many of the proxy-generated pages
1133 and its use is highly recommended in multi-user installations, since your
1134 users will want to know why certain content is blocked or modified. Default:
1135 Don't show a link to on-line documentation.
1142 <emphasis>proxy-info-url http://www.your-site.com/proxy.html</emphasis>
1149 <quote>Listen-address</quote> specifies the address and port where
1150 <application>Privoxy</application> will listen for connections from your
1151 Web browser. The default is to listen on the localhost port 8118, and
1152 this is suitable for most users. (In your web browser, under proxy
1153 configuration, list the proxy server as <quote>localhost</quote> and the
1154 port as <quote>8118</quote>).
1158 If you already have another service running on port 8118, or if you want to
1159 serve requests from other machines (e.g. on your local network) as well, you
1160 will need to override the default. The syntax is
1161 <quote>listen-address [<ip-address>]:<port></quote>. If you leave
1162 out the IP address, <application>Privoxy</application> will bind to all
1163 interfaces (addresses) on your machine and may become reachable from the
1164 Internet. In that case, consider using access control lists (acl's) (see
1165 <quote>aclfile</quote> above), or a firewall.
1169 For example, suppose you are running <application>Privoxy</application> on
1170 a machine which has the address 192.168.0.1 on your local private network
1171 (192.168.0.0) and has another outside connection with a different address.
1172 You want it to serve requests from inside only:
1179 <emphasis>listen-address 192.168.0.1:8118</emphasis>
1186 If you want it to listen on all addresses (including the outside
1194 <emphasis>listen-address :8118</emphasis>
1201 If you do this, consider using ACLs (see <quote>aclfile</quote> above). Note:
1202 you will need to point your browser(s) to the address and port that you have
1203 configured here. Default: localhost:8118 (127.0.0.1:8118).
1207 The debug option sets the level of debugging information to log in the
1208 logfile (and to the console in the Windows version). A debug level of 1 is
1209 informative because it will show you each request as it happens. Higher
1210 levels of debug are probably only of interest to developers.
1217 debug 1 # GPC = show each GET/POST/CONNECT request
1218 debug 2 # CONN = show each connection status
1219 debug 4 # IO = show I/O status
1220 debug 8 # HDR = show header parsing
1221 debug 16 # LOG = log all data into the logfile
1222 debug 32 # FRC = debug force feature
1223 debug 64 # REF = debug regular expression filter
1224 debug 128 # = debug fast redirects
1225 debug 256 # = debug GIF de-animation
1226 debug 512 # CLF = Common Log Format
1227 debug 1024 # = debug kill pop-ups
1228 debug 4096 # INFO = Startup banner and warnings.
1229 debug 8192 # ERROR = Non-fatal errors
1236 It is <emphasis>highly recommended</emphasis> that you enable ERROR
1237 reporting (debug 8192), at least until v3.0 is released.
1241 The reporting of FATAL errors (i.e. ones which crash
1242 <application>Privoxy</application>) is always on and cannot be disabled.
1246 If you want to use CLF (Common Log Format), you should set <quote>debug
1247 512</quote> ONLY, do not enable anything else.
1251 Multiple <quote>debug</quote> directives, are OK - they're logical-OR'd
1259 <emphasis>debug 15 # same as setting the first 4 listed above</emphasis>
1273 <emphasis>debug 1 # URLs</emphasis>
1274 <emphasis>debug 4096 # Info</emphasis>
1275 <emphasis>debug 8192 # Errors - *we highly recommended enabling this*</emphasis>
1282 <application>Privoxy</application> normally uses
1283 <quote>multi-threading</quote>, a software technique that permits it to
1284 handle many different requests simultaneously. In some cases you may wish to
1285 disable this -- particularly if you're trying to debug a problem. The
1286 <quote>single-threaded</quote> option forces
1287 <application>Privoxy</application> to handle requests sequentially.
1288 Default: Multi-threaded mode.
1295 <emphasis>#single-threaded</emphasis>
1302 <quote>toggle</quote> allows you to temporarily disable all
1303 <application>Privoxy's</application> filtering. Just set <quote>toggle
1308 The Windows version of <application>Privoxy</application> puts an icon in
1309 the system tray, which also allows you to change this option. If you
1310 right-click on that icon (or select the <quote>Options</quote> menu), one
1311 choice is <quote>Enable</quote>. Clicking on enable toggles
1312 <application>Privoxy</application> on and off. This is useful if you want
1313 to temporarily disable <application>Privoxy</application>, e.g., to access
1314 a site that requires cookies which you would otherwise have blocked. This can also
1315 be toggled via a web browser at the <application>Privoxy</application>
1316 internal address of <ulink url="http://p.p">http://p.p</ulink> on
1321 <quote>toggle 1</quote> means <application>Privoxy</application> runs
1322 normally, <quote>toggle 0</quote> means that
1323 <application>Privoxy</application> becomes a non-anonymizing non-blocking
1324 proxy. Default: 1 (on).
1331 <emphasis>toggle 1</emphasis>
1338 For content filtering, i.e. the <quote>+filter</quote> and
1339 <quote>+deanimate-gif</quote> actions, it is necessary that
1340 <application>Privoxy</application> buffers the entire document body.
1341 This can be potentially dangerous, since a server could just keep sending
1342 data indefinitely and wait for your RAM to exhaust. With nasty consequences.
1346 The <application>buffer-limit</application> option lets you set the maximum
1347 size in Kbytes that each buffer may use. When the documents buffer exceeds
1348 this size, it is flushed to the client unfiltered and no further attempt to
1349 filter the rest of it is made. Remember that there may multiple threads
1350 running, which might require increasing the <quote>buffer-limit</quote>
1351 Kbytes <emphasis>each</emphasis>, unless you have enabled
1352 <quote>single-threaded</quote> above.
1359 <emphasis>buffer-limit 4069</emphasis>
1366 To enable the web-based <filename>default.action</filename> file editor set
1367 <application>enable-edit-actions</application> to 1, or 0 to disable. Note
1368 that you must have compiled <application>Privoxy</application> with
1369 support for this feature, otherwise this option has no effect. This
1370 internal page can be reached at <ulink
1371 url="http://p.p">http://p.p</ulink>.
1375 Security note: If this is enabled, anyone who can use the proxy
1376 can edit the actions file, and their changes will affect all users.
1377 For shared proxies, you probably want to disable this. Default: enabled.
1384 <emphasis>enable-edit-actions 1</emphasis>
1391 Allow <application>Privoxy</application> to be toggled on and off
1392 remotely, using your web browser. Set <quote>enable-remote-toggle</quote>to
1393 1 to enable, and 0 to disable. Note that you must have compiled
1394 <application>Privoxy</application> with support for this feature,
1395 otherwise this option has no effect.
1399 Security note: If this is enabled, anyone who can use the proxy can toggle
1400 it on or off (see <ulink url="http://p.p">http://p.p</ulink>), and
1401 their changes will affect all users. For shared proxies, you probably want to
1402 disable this. Default: enabled.
1409 <emphasis>enable-remote-toggle 1</emphasis>
1417 <!-- ~ End section ~ -->
1420 <!-- ~~~~~ New section ~~~~~ -->
1423 <title>Access Control List (ACL)</title>
1425 Access controls are included at the request of some ISPs and systems
1426 administrators, and are not usually needed by individual users. Please note
1427 the warnings in the FAQ that this proxy is not intended to be a substitute
1428 for a firewall or to encourage anyone to defer addressing basic security
1433 If no access settings are specified, the proxy talks to anyone that
1434 connects. If any access settings file are specified, then the proxy
1435 talks only to IP addresses permitted somewhere in this file and not
1436 denied later in this file.
1440 Summary -- if using an ACL:
1445 Client must have permission to receive service.
1450 LAST match in ACL wins.
1455 Default behavior is to deny service.
1460 The syntax for an entry in the Access Control List is:
1467 ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ]
1474 Where the individual fields are:
1481 <emphasis>ACTION</emphasis> = <quote>permit-access</quote> or <quote>deny-access</quote>
1483 <emphasis>SRC_ADDR</emphasis> = client hostname or dotted IP address
1484 <emphasis>SRC_MASKLEN</emphasis> = number of bits in the subnet mask for the source
1486 <emphasis>DST_ADDR</emphasis> = server or forwarder hostname or dotted IP address
1487 <emphasis>DST_MASKLEN</emphasis> = number of bits in the subnet mask for the target
1495 The field separator (FS) is whitespace (space or tab).
1499 IMPORTANT NOTE: If <application>Privoxy</application> is using a
1500 forwarder (see below) or a gateway for a particular destination URL, the
1501 <literal>DST_ADDR</literal> that is examined is the address of the forwarder
1502 or the gateway and <emphasis>NOT</emphasis> the address of the ultimate
1503 target. This is necessary because it may be impossible for the local
1504 <application>Privoxy</application> to determine the address of the
1505 ultimate target (that's often what gateways are used for).
1509 Here are a few examples to show how the ACL features work:
1513 <quote>localhost</quote> is OK -- no DST_ADDR implies that
1514 <emphasis>ALL</emphasis> destination addresses are OK:
1521 <emphasis>permit-access localhost</emphasis>
1528 A silly example to illustrate permitting any host on the class-C subnet with
1529 <application>Privoxy</application> to go anywhere:
1536 <emphasis>permit-access www.privoxy.com/24</emphasis>
1543 Except deny one particular IP address from using it at all:
1550 <emphasis>deny-access ident.privoxy.com</emphasis>
1557 You can also specify an explicit network address and subnet mask.
1558 Explicit addresses do not have to be resolved to be used.
1565 <emphasis>permit-access 207.153.200.0/24</emphasis>
1572 A subnet mask of 0 matches anything, so the next line permits everyone.
1579 <emphasis>permit-access 0.0.0.0/0</emphasis>
1586 Note, you <emphasis>cannot</emphasis> say:
1593 <emphasis>permit-access .org</emphasis>
1600 to allow all *.org domains. Every IP address listed must resolve fully.
1604 An ISP may want to provide a <application>Privoxy</application> that is
1605 accessible by <quote>the world</quote> and yet restrict use of some of their
1606 private content to hosts on its internal network (i.e. its own subscribers).
1607 Say, for instance the ISP owns the Class-B IP address block 123.124.0.0 (a 16
1608 bit netmask). This is how they could do it:
1615 <emphasis>permit-access 0.0.0.0/0 0.0.0.0/0</emphasis> # other clients can go anywhere
1616 # with the following exceptions:
1618 <emphasis>deny-access</emphasis> 0.0.0.0/0 123.124.0.0/16 # block all external requests for
1619 # sites on the ISP's network
1621 <emphasis>permit 0.0.0.0/0 www.my_isp.com</emphasis> # except for the ISP's main
1624 <emphasis>permit 123.124.0.0/16 0.0.0.0/0</emphasis> # the ISP's clients can go
1632 Note that if some hostnames are listed with multiple IP addresses,
1633 the primary value returned by DNS (via gethostbyname()) is used. Default:
1634 Anyone can access the proxy.
1639 <!-- ~ End section ~ -->
1642 <!-- ~~~~~ New section ~~~~~ -->
1644 <sect3 id="forwarding">
1645 <title>Forwarding</title>
1648 This feature allows chaining of HTTP requests via multiple proxies.
1649 It can be used to better protect privacy and confidentiality when
1650 accessing specific domains by routing requests to those domains
1651 to a special purpose filtering proxy such as lpwa.com. Or to use
1652 a caching proxy to speed up browsing.
1656 It can also be used in an environment with multiple networks to route
1657 requests via multiple gateways allowing transparent access to multiple
1658 networks without having to modify browser configurations.
1662 Also specified here are SOCKS proxies. <application>Privoxy</application>
1663 SOCKS 4 and SOCKS 4A. The difference is that SOCKS 4A will resolve the target
1664 hostname using DNS on the SOCKS server, not our local DNS client.
1668 The syntax of each line is:
1675 <emphasis>forward target_domain[:port] http_proxy_host[:port]</emphasis>
1676 <emphasis>forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1677 <emphasis>forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1684 If http_proxy_host is <quote>.</quote>, then requests are not forwarded to a
1685 HTTP proxy but are made directly to the web servers.
1689 Lines are checked in sequence, and the last match wins.
1693 There is an implicit line equivalent to the following, which specifies that
1694 anything not finding a match on the list is to go out without forwarding
1695 or gateway protocol, like so:
1702 <emphasis>forward .* . </emphasis># implicit
1709 In the following common configuration, everything goes to Lucent's LPWA,
1710 except SSL on port 443 (which it doesn't handle):
1717 <emphasis>forward .* lpwa.com:8000</emphasis>
1718 <emphasis>forward :443 .</emphasis>
1726 See the FAQ for instructions on how to automate the login procedure for LPWA.
1728 Some users have reported difficulties related to LPWA's use of
1729 <quote>.</quote> as the last element of the domain, and have said that this
1730 can be fixed with this:
1737 <emphasis>forward lpwa. lpwa.com:8000</emphasis>
1744 (NOTE: the syntax for specifying target_domain has changed since the
1745 previous paragraph was written -- it will not work now. More information
1750 In this fictitious example, everything goes via an ISP's caching proxy,
1751 except requests to that ISP:
1758 <emphasis>forward .* caching.myisp.net:8000</emphasis>
1759 <emphasis>forward myisp.net .</emphasis>
1766 For the @home network, we're told the forwarding configuration is this:
1774 <emphasis>forward .* proxy:8080</emphasis>
1781 Also, we're told they insist on getting cookies and JavaScript, so you should
1782 allow cookies from home.com. We consider JavaScript a potential security risk.
1783 Java need not be enabled.
1787 In this example direct connections are made to all <quote>internal</quote>
1788 domains, but everything else goes through Lucent's LPWA by way of the
1789 company's SOCKS gateway to the Internet.
1796 <emphasis>forward-socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
1797 <emphasis>forward my_company.com .</emphasis>
1804 This is how you could set up a site that always uses SOCKS but no forwarders:
1811 <emphasis>forward-socks4a .* . firewall.my_company.com:1080</emphasis>
1818 An advanced example for network administrators:
1822 If you have links to multiple ISPs that provide various special content to
1823 their subscribers, you can configure forwarding to pass requests to the
1824 specific host that's connected to that ISP so that everybody can see all
1825 of the content on all of the ISPs.
1829 This is a bit tricky, but here's an example:
1834 host-a has a PPP connection to isp-a.com. And host-b has a PPP connection to
1835 isp-b.com. host-a can run a <application>Privoxy</application> proxy with
1836 forwarding like this:
1843 <emphasis>forward .* .</emphasis>
1844 <emphasis>forward isp-b.com host-b:8118</emphasis>
1851 host-b can run a <application>Privoxy</application> proxy with forwarding
1859 <emphasis>forward .* .</emphasis>
1860 <emphasis>forward isp-a.com host-a:8118</emphasis>
1867 Now, <emphasis>anyone</emphasis> on the Internet (including users on host-a
1868 and host-b) can set their browser's proxy to <emphasis>either</emphasis>
1869 host-a or host-b and be able to browse the content on isp-a or isp-b.
1873 Here's another practical example, for University of Kent at
1874 Canterbury students with a network connection in their room, who
1875 need to use the University's Squid web cache.
1882 <emphasis>forward *. ssbcache.ukc.ac.uk:3128</emphasis> # Use the proxy, except for:
1883 <emphasis>forward .ukc.ac.uk . </emphasis> # Anything on the same domain as us
1884 <emphasis>forward * . </emphasis> # Host with no domain specified
1885 <emphasis>forward 129.12.*.* . </emphasis> # A dotted IP on our /16 network.
1886 <emphasis>forward 127.*.*.* . </emphasis> # Loopback address
1887 <emphasis>forward localhost.localdomain . </emphasis> # Loopback address
1888 <emphasis>forward www.ukc.mirror.ac.uk . </emphasis> # Specific host
1895 If you intend to chain <application>Privoxy</application> and
1896 <application>squid</application> locally, then chain as
1897 <literal>browser -> squid -> privoxy</literal> is the recommended way.
1901 Your squid configuration could then look like this:
1908 # Define Privoxy as parent cache
1909 <!-- per feedback from user...
1910 cache_peer 127.0.0.1 8118 parent 0 no-query
1912 cache_peer 127.0.0.1 parent 8118 0 no-query
1914 # Define ACL for protocol FTP
1917 # Do not forward ACL FTP to privoxy
1918 always_direct allow FTP
1920 # Do not forward ACL CONNECT (https) to privoxy
1921 always_direct allow CONNECT
1923 # Forward the rest to privoxy
1924 never_direct allow all
1932 <!-- ~ End section ~ -->
1935 <!-- ~~~~~ New section ~~~~~ -->
1938 <title>Windows GUI Options</title>
1940 Removed references to Win32. HB 09/23/01
1943 <application>Privoxy</application> has a number of options specific to the
1944 Windows GUI interface:
1948 If <quote>activity-animation</quote> is set to 1, the
1949 <application>Privoxy</application> icon will animate when
1950 <quote>Privoxy</quote> is active. To turn off, set to 0.
1957 <emphasis>activity-animation 1</emphasis>
1964 If <quote>log-messages</quote> is set to 1,
1965 <application>Privoxy</application> will log messages to the console
1973 <emphasis>log-messages 1</emphasis>
1980 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1981 i.e. the amount of memory used for the log messages displayed in the
1982 console window, will be limited to <quote>log-max-lines</quote> (see below).
1986 Warning: Setting this to 0 will result in the buffer to grow infinitely and
1987 eat up all your memory!
1994 <emphasis>log-buffer-size 1</emphasis>
2001 <application>log-max-lines</application> is the maximum number of lines held
2002 in the log buffer. See above.
2009 <emphasis>log-max-lines 200</emphasis>
2016 If <quote>log-highlight-messages</quote> is set to 1,
2017 <application>Privoxy</application> will highlight portions of the log
2018 messages with a bold-faced font:
2025 <emphasis>log-highlight-messages 1</emphasis>
2032 The font used in the console window:
2039 <emphasis>log-font-name Comic Sans MS</emphasis>
2046 Font size used in the console window:
2053 <emphasis>log-font-size 8</emphasis>
2060 <quote>show-on-task-bar</quote> controls whether or not
2061 <application>Privoxy</application> will appear as a button on the Task bar
2069 <emphasis>show-on-task-bar 0</emphasis>
2076 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
2077 button will minimize <application>Privoxy</application> instead of closing
2078 the program (close with the exit option on the File menu).
2085 <emphasis>close-button-minimizes 1</emphasis>
2092 The <quote>hide-console</quote> option is specific to the MS-Win console
2093 version of <application>Privoxy</application>. If this option is used,
2094 <application>Privoxy</application> will disconnect from and hide the
2111 <!-- ~ End section ~ -->
2114 <!-- ~~~~~ New section ~~~~~ -->
2115 <sect2 id="actionsfile">
2116 <title>The Actions File</title>
2119 The <quote>default.action</quote> file (formerly
2120 <filename>actionsfile</filename> or <filename>ijb.action</filename>) is used to define what actions
2121 <application>Privoxy</application> takes, and thus determines how images,
2122 cookies and various other aspects of HTTP content and transactions are
2123 handled. Images can be anything you want, including ads, banners, or just
2124 some obnoxious URL that you would rather not see. Cookies can be accepted
2125 or rejected, or accepted only during the current browser session (i.e.
2126 not written to disk). Changes to <filename>default.action</filename> should
2127 be immediately visible to <application>Privoxy</application> without
2128 the need to restart.
2132 The easiest way to edit <quote>actions</quote> file is with a browser by
2133 loading <ulink url="http://p.p/">http://p.p/</ulink>, and then select
2134 <quote>Edit Actions List</quote>. A text editor can also be used.
2138 To determine which actions apply to a request, the URL of the request is
2139 compared to all patterns in this file. Every time it matches, the list of
2140 applicable actions for the URL is incrementally updated. You can trace
2141 this process by visiting <ulink
2142 url="http://p.p/show-url-info">http://p.p/show-url-info</ulink>.
2147 There are four types of lines in this file: comments (begin with a
2148 <quote>#</quote> character), actions, aliases and patterns, all of which are
2149 explained below, as well as the configuration file syntax that
2150 <application>Privoxy</application> understands.
2155 <!-- ~~~~~ New section ~~~~~ -->
2157 <title>URL Domain and Path Syntax</title>
2159 Generally, a pattern has the form <domain>/<path>, where both the
2160 <domain> and <path> part are optional. If you only specify a
2161 domain part, the <quote>/</quote> can be left out:
2165 <emphasis>www.example.com</emphasis> - is a domain only pattern and will match any request to
2166 <quote>www.example.com</quote>.
2170 <emphasis>www.example.com/</emphasis> - means exactly the same.
2174 <emphasis>www.example.com/index.html</emphasis> - matches only the single
2175 document <quote>/index.html</quote> on <quote>www.example.com</quote>.
2179 <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>, regardless of
2184 <emphasis>index.html</emphasis> - matches nothing, since it would be
2185 interpreted as a domain name and there is no top-level domain called
2186 <quote>.html</quote>.
2190 The matching of the domain part offers some flexible options: if the
2191 domain starts or ends with a dot, it becomes unanchored at that end.
2196 <emphasis>.example.com</emphasis> - matches any domain that <emphasis>ENDS</emphasis> in
2197 <quote>.example.com</quote>.
2201 <emphasis>www.</emphasis> - matches any domain that <emphasis>STARTS</emphasis> with
2206 Additionally, there are wild-cards that you can use in the domain names
2207 themselves. They work pretty similar to shell wild-cards: <quote>*</quote>
2208 stands for zero or more arbitrary characters, <quote>?</quote> stands for
2209 any single character. And you can define character classes in square
2210 brackets and they can be freely mixed:
2214 <emphasis>ad*.example.com</emphasis> - matches <quote>adserver.example.com</quote>,
2215 <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>.
2219 <emphasis>*ad*.example.com</emphasis> - matches all of the above, and then some.
2223 <emphasis>.?pix.com</emphasis> - matches <quote>www.ipix.com</quote>,
2224 <quote>pictures.epix.com</quote>, <quote>a.b.c.d.e.upix.com</quote>, etc.
2228 <emphasis>www[1-9a-ez].example.com</emphasis> - matches <quote>www1.example.com</quote>,
2229 <quote>www4.example.com</quote>, <quote>wwwd.example.com</quote>,
2230 <quote>wwwz.example.com</quote>, etc., but <emphasis>not</emphasis>
2231 <quote>wwww.example.com</quote>.
2235 If <application>Privoxy</application> was compiled with
2236 <quote>pcre</quote> support (default), Perl compatible regular expressions
2237 can be used. See the <filename>pcre/docs/</filename> directory or <quote>man
2238 perlre</quote> (also available on <ulink
2239 url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
2240 for details. A brief discussion of regular expressions is in the
2241 <link linkend="regex">Appendix</link>. For instance:
2245 <emphasis>/.*/advert[0-9]+\.jpe?g</emphasis> - would match a URL from any
2246 domain, with any path that includes <quote>advert</quote> followed
2247 immediately by one or more digits, then a <quote>.</quote> and ending in
2248 either <quote>jpeg</quote> or <quote>jpg</quote>. So we match
2249 <quote>example.com/ads/advert2.jpg</quote>, and
2250 <quote>www.example.com/ads/banners/advert39.jpeg</quote>, but not
2251 <quote>www.example.com/ads/banners/advert39.gif</quote> (no gifs in the
2256 Please note that matching in the path is case
2257 <emphasis>INSENSITIVE</emphasis> by default, but you can switch to case
2258 sensitive at any point in the pattern by using the
2259 <quote>(?-i)</quote> switch:
2263 <emphasis>www.example.com/(?-i)PaTtErN.*</emphasis> - will match only
2264 documents whose path starts with <quote>PaTtErN</quote> in
2265 <emphasis>exactly</emphasis> this capitalization.
2270 <!-- ~ End section ~ -->
2274 <!-- ~~~~~ New section ~~~~~ -->
2277 <title>Actions</title>
2279 Actions are enabled if preceded with a <quote>+</quote>, and disabled if
2280 preceded with a <quote>-</quote>. Actions are invoked by enclosing the
2281 action name in curly braces (e.g. {+some_action}), followed by a list of
2282 URLs to which the action applies. There are three classes of actions:
2290 Boolean (e.g. <quote>+/-block</quote>):
2296 <emphasis>{+name}</emphasis> # enable this action
2297 <emphasis>{-name}</emphasis> # disable this action
2307 parameterized (e.g. <quote>+/-hide-user-agent</quote>):
2313 <emphasis>{+name{param}}</emphasis> # enable action and set parameter to <quote>param</quote>
2314 <emphasis>{-name}</emphasis> # disable action
2323 Multi-value (e.g. <quote>{+/-add-header{Name: value}}</quote>, <quote>{+/-wafer{name=value}}</quote>):
2329 <emphasis>{+name{param}}</emphasis> # enable action and add parameter <quote>param</quote>
2330 <emphasis>{-name{param}}</emphasis> # remove the parameter <quote>param</quote>
2331 <emphasis>{-name}</emphasis> # disable this action totally
2342 If nothing is specified in this file, no <quote>actions</quote> are taken.
2343 So in this case <application>Privoxy</application> would just be a
2344 normal, non-blocking, non-anonymizing proxy. You must specifically
2345 enable the privacy and blocking features you need (although the
2346 provided default <filename>default.action</filename> file will
2347 give a good starting point).
2351 Later defined actions always over-ride earlier ones. For multi-valued
2352 actions, the actions are applied in the order they are specified.
2356 The list of valid <application>Privoxy</application> <quote>actions</quote> are:
2364 Add the specified HTTP header, which is not checked for validity.
2365 You may specify this many times to specify many different headers:
2371 <emphasis>+add-header{Name: value}</emphasis>
2381 Block this URL totally. In a default installation, a <quote>blocked</quote>
2382 URL will result in bright red banner that says <quote>BLOCKED</quote>,
2383 with a reason why it is being blocked.
2389 <emphasis>+block</emphasis>
2399 De-animate all animated GIF images, i.e. reduce them to their last frame.
2400 This will also shrink the images considerably (in bytes, not pixels!). If
2401 the option <quote>first</quote> is given, the first frame of the animation
2402 is used as the replacement. If <quote>last</quote> is given, the last frame
2403 of the animation is used instead, which probably makes more sense for most
2404 banner animations, but also has the risk of not showing the entire last
2405 frame (if it is only a delta to an earlier frame).
2411 <emphasis>+deanimate-gifs{last}</emphasis>
2412 <emphasis>+deanimate-gifs{first}</emphasis>
2421 <quote>+downgrade</quote> will downgrade HTTP/1.1 client requests to
2422 HTTP/1.0 and downgrade the responses as well. Use this action for servers
2423 that use HTTP/1.1 protocol features that
2424 <application>Privoxy</application> doesn't handle well yet. HTTP/1.1
2425 is only partially implemented. Default is not to downgrade requests.
2431 <emphasis>+downgrade</emphasis>
2440 Many sites, like yahoo.com, don't just link to other sites. Instead, they
2441 will link to some script on their own server, giving the destination as a
2442 parameter, which will then redirect you to the final target. URLs resulting
2443 from this scheme typically look like:
2444 http://some.place/some_script?http://some.where-else.
2447 Sometimes, there are even multiple consecutive redirects encoded in the
2448 URL. These redirections via scripts make your web browsing more traceable,
2449 since the server from which you follow such a link can see where you go to.
2450 Apart from that, valuable bandwidth and time is wasted, while your browser
2451 ask the server for one redirect after the other. Plus, it feeds the
2455 The <quote>+fast-redirects</quote> option enables interception of these
2456 types of requests by <application>Privoxy</application>, who will cut off
2457 all but the last valid URL in the request and send a local redirect back to
2458 your browser without contacting the intermediate site(s).
2464 <emphasis>+fast-redirects</emphasis>
2473 Apply the filters in the <literal>section_header</literal>
2474 section of the <filename>default.filter</filename> file to the site(s).
2475 <filename>default.filter</filename> sections are grouped according to like
2483 <emphasis>+filter{section_header}</emphasis>
2490 Filter sections that are pre-defined in the supplied
2491 <filename>default.filter</filename> include:
2497 <emphasis>html-annoyances</emphasis>: Get rid of particularly annoying HTML abuse.
2502 <emphasis>js-annoyances</emphasis>: Get rid of particularly annoying JavaScript abuse
2507 <emphasis>no-poups</emphasis>: Kill all popups in JS and HTML
2512 <emphasis>frameset-borders</emphasis>: Give frames a border
2517 <emphasis>webbugs</emphasis>: Squish WebBugs (1x1 invisible GIFs used for user tracking)
2522 <emphasis>no-refresh</emphasis>: Automatic refresh sucks on auto-dialup lines
2527 <emphasis>fun</emphasis>: Text replacements for subversive browsing fun!
2532 <emphasis>nimda</emphasis>: Remove (virus) Nimda code.
2537 <emphasis>banners-by-size</emphasis>: Kill banners by size
2542 <emphasis>crude-parental</emphasis>: Kill all web pages that contain the words "sex" or "warez"
2551 Block any existing X-Forwarded-for header, and do not add a new one:
2557 <emphasis>+hide-forwarded</emphasis>
2566 If the browser sends a <quote>From:</quote> header containing your e-mail
2567 address, this either completely removes the header (<quote>block</quote>), or
2568 changes it to the specified e-mail address.
2574 <emphasis>+hide-from{block}</emphasis>
2575 <emphasis>+hide-from{spam@sittingduck.xqq}</emphasis>
2584 Don't send the <quote>Referer:</quote> (sic) header to the web site. You
2585 can block it, forge a URL to the same server as the request (which is
2586 preferred because some sites will not send images otherwise) or set it to a
2587 constant string of your choice.
2593 <emphasis>+hide-referer{block}</emphasis>
2594 <emphasis>+hide-referer{forge}</emphasis>
2595 <emphasis>+hide-referer{http://nowhere.com}</emphasis>
2604 Alternative spelling of <quote>+hide-referer</quote>. It has the same
2605 parameters, and can be freely mixed with, <quote>+hide-referer</quote>.
2606 (<quote>referrer</quote> is the correct English spelling, however the HTTP
2607 specification has a bug - it requires it to be spelled <quote>referer</quote>.)
2613 <emphasis>+hide-referrer{...}</emphasis>
2622 Change the <quote>User-Agent:</quote> header so web servers can't tell your
2623 browser type. Warning! This breaks many web sites. Specify the
2624 user-agent value you want. Example, pretend to be using Netscape on
2631 <emphasis>+hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)}</emphasis>
2638 Or to identify yourself explicitly as a <application>Privoxy</application> user:
2644 <emphasis>+hide-user-agent{Privoxy/1.0}</emphasis>
2649 (Don't change the version number from 1.0 - after all, why tell them?)
2656 <emphasis>+hide-user-agent{browser-type}</emphasis>
2666 Treat this URL as an image. This only matters if it's also <quote>+block</quote>ed,
2667 in which case a <quote>blocked</quote> image can be sent rather than a HTML page.
2668 See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
2669 If you want <emphasis>invisible</emphasis> ads, they should be defined as
2670 <emphasis>images</emphasis> and <emphasis>blocked</emphasis>. And also,
2671 <quote>image-blocker</quote> should be set to <quote>blank</quote>.
2677 <emphasis>+image</emphasis>
2685 <para> Decides what to do with URLs that end up tagged with <quote>{+block
2686 +image}</quote>, e.g an advertizement. There are five options.
2687 <quote>-image-blocker</quote> will send a HTML <quote>blocked</quote> page,
2688 usually resulting in a <quote>broken image</quote> icon.
2689 <!-- <quote>+image-blocker{logo}</quote> will send a -->
2690 <!-- <application>Privoxy</application> logo -->
2692 <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF
2693 image. And finally, <quote>+image-blocker{http://xyz.com}</quote> will send a
2694 HTTP temporary redirect to the specified image. This has the advantage of the
2695 icon being being cached by the browser, which will speed up the display.
2696 <quote>+image-blocker{pattern}</quote> will send a checkboard type pattern
2698 <!-- which scales better than the logo (which can get blocky if the browser -->
2699 <!-- enlarges it too much). -->
2705 <!-- <emphasis>+image-blocker{logo}</emphasis> -->
2706 <emphasis>+image-blocker{blank}</emphasis>
2707 <emphasis>+image-blocker{pattern}</emphasis>
2708 <emphasis>+image-blocker{http://p.p/send-banner}</emphasis>
2717 By default (i.e. in the absence of a <quote>+limit-connect</quote>
2718 action), <application>Privoxy</application> will only allow CONNECT
2719 requests to port 443, which is the standard port for https as a
2724 The CONNECT methods exists in HTTP to allow access to secure websites
2725 (https:// URLs) through proxies. It works very simply: the proxy
2726 connects to the server on the specified port, and then short-circuits
2727 its connections to the client <emphasis>and</emphasis> to the remote proxy.
2728 This can be a big security hole, since CONNECT-enabled proxies can
2729 be abused as TCP relays very easily.
2733 If you want to allow CONNECT for more ports than this, or want to forbid
2734 CONNECT altogether, you can specify a comma separated list of ports and
2735 port ranges (the latter using dashes, with the minimum defaulting to 0 and
2743 <emphasis>+limit-connect{443} # This is the default and need no be specified.</emphasis>
2744 <emphasis>+limit-connect{80,443} # Ports 80 and 443 are OK.</emphasis>
2745 <emphasis>+limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100</emphasis>
2746 <emphasis> #and above 500 are OK.</emphasis>
2756 <quote>+no-compression</quote> prevents the website from compressing the
2757 data. Some websites do this, which can be a problem for
2758 <application>Privoxy</application>, since <quote>+filter</quote>,
2759 <quote>+no-popup</quote> and <quote>+gif-deanimate</quote> will not work on
2760 compressed data. This will slow down connections to those websites,
2761 though. Default is <quote>nocompression</quote> is turned on.
2768 <emphasis>+nocompression</emphasis>
2777 If the website sets cookies, <quote>no-cookies-keep</quote> will make sure
2778 they are erased when you exit and restart your web browser. This makes
2779 profiling cookies useless, but won't break sites which require cookies so
2780 that you can log in for transactions. Default: on.
2786 <emphasis>+no-cookies-keep</emphasis>
2795 Prevent the website from reading cookies:
2801 <emphasis>+no-cookies-read</emphasis>
2810 Prevent the website from setting cookies:
2816 <emphasis>+no-cookies-set</emphasis>
2825 Filter the website through a built-in filter to disable those obnoxious
2826 JavaScript pop-up windows via window.open(), etc. The two alternative
2827 spellings are equivalent.
2833 <emphasis>+no-popup</emphasis>
2834 <emphasis>+no-popups</emphasis>
2843 This action only applies if you are using a <filename>jarfile</filename>
2844 for saving cookies. It sends a cookie to every site stating that you do not
2845 accept any copyright on cookies sent to you, and asking them not to track
2846 you. Of course, this is a (relatively) unique header they could use to
2853 <emphasis>+vanilla-wafer</emphasis>
2862 This allows you to add an arbitrary cookie. It can be specified multiple
2863 times in order to add as many cookies as you like.
2869 <emphasis>+wafer{name=value}</emphasis>
2880 The meaning of any of the above is reversed by preceding the action with a
2881 <quote>-</quote>, in place of the <quote>+</quote>.
2889 Turn off cookies by default, then allow a few through for specified sites:
2896 # Turn off all persistent cookies
2897 { +no-cookies-read }
2899 # Allow cookies for this browser session ONLY
2900 { +no-cookies-keep }
2902 # Exceptions to the above, sites that benefit from persistent cookies
2903 { -no-cookies-read }
2905 { -no-cookies-keep }
2912 # Alternative way of saying the same thing
2913 {-no-cookies-set -no-cookies-read -no-cookies-keep}
2922 Now turn off <quote>fast redirects</quote>, and then we allow two exceptions:
2932 # Reverse it for these two sites, which don't work right without it.
2934 www.ukc.ac.uk/cgi-bin/wac\.cgi\?
2942 Turn on page filtering according to rules in the defined sections
2943 of <filename>refilterfile</filename>, and make one exception for
2951 # Run everything through the filter file, using only the
2952 # specified sections:
2953 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}\
2954 +filter{webbugs} +filter{nimda} +filter{banners-by-size}
2956 # Then disable filtering of code from sourceforge!
2958 .cvs.sourceforge.net
2965 Now some URLs that we want <quote>blocked</quote>, ie we won't see them.
2966 Many of these use regular expressions that will expand to match multiple
2976 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
2977 /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/])
2978 /.*/(ng)?adclient\.cgi
2979 /.*/(plain|live|rotate)[-_.]?ads?/
2980 /.*/(sponsor)s?[0-9]?/
2981 /.*/_?(plain|live)?ads?(-banners)?/
2983 /.*/ad(sdna_image|gifs?)/
2984 /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
2988 /.*/adv((er)?ts?|ertis(ing|ements?))?/
2992 /.*/cgi-bin/centralad/getimage
2993 /.*/images/addver\.gif
2994 /.*/images/marketing/.*\.(gif|jpe?g)
2998 /.*/sponsors?[0-9]?/
2999 /.*/advert[0-9]+\.jpg
3006 /graphics/defaultAd/
3008 /image\.ng/transactionID
3009 /images/.*/.*_anim\.gif # alvin brattli
3010 /ip_img/.*\.(gif|jpe?g)
3014 /cgi-bin/nph-adclick.exe/
3015 /.*/Image/BannerAdvertising/
3017 /.*/adlib/server\.cgi
3025 Note that many of these actions have the potential to cause a page to
3026 misbehave, possibly even not to display at all. There are many ways
3027 a site designer may choose to design his site, and what HTTP header
3028 content he may depend on. There is no way to have hard and fast rules
3029 for all sites. See the <link linkend="ACTIONSANAT">Appendix</link>
3030 for a brief example on troubleshooting actions.
3036 <!-- ~ End section ~ -->
3039 <!-- ~~~~~ New section ~~~~~ -->
3041 <title>Aliases</title>
3043 Custom <quote>actions</quote>, known to <application>Privoxy</application>
3044 as <quote>aliases</quote>, can be defined by combining other <quote>actions</quote>.
3045 These can in turn be invoked just like the built-in <quote>actions</quote>.
3046 Currently, an alias can contain any character except space, tab, <quote>=</quote>,
3047 <quote>{</quote> or <quote>}</quote>. But please use only <quote>a</quote>-
3048 <quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
3049 <quote>-</quote>. Alias names are not case sensitive, and
3050 <emphasis>must be defined before anything</emphasis> else in the
3051 <filename>default.action</filename>file ! And there can only be one set of
3052 <quote>aliases</quote> defined.
3056 Now let's define a few aliases:
3063 # Useful customer aliases we can use later. These must come first!
3065 +no-cookies = +no-cookies-set +no-cookies-read
3066 -no-cookies = -no-cookies-set -no-cookies-read
3067 fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups
3068 shop = -no-cookies -filter -fast-redirects
3069 +imageblock = +block +image
3071 #For people who don't like to type too much: ;-)
3074 c2 = -no-cookies-set +no-cookies-read
3075 c3 = +no-cookies-set -no-cookies-read
3076 #... etc. Customize to your heart's content.
3083 Some examples using our <quote>shop</quote> and <quote>fragile</quote>
3091 # These sites are very complex and require
3092 # minimal interference.
3094 .office.microsoft.com
3095 .windowsupdate.microsoft.com
3098 # Shopping sites - still want to block ads.
3101 .worldpay.com # for quietpc.com
3105 # These shops require pop-ups
3117 <!-- ~ End section ~ -->
3120 <!-- ~~~~~ New section ~~~~~ -->
3121 <sect2 id="filterfile">
3122 <title>The Filter File</title>
3124 Any web page can be dynamically modified with the filter file. This
3125 modification can be removal, or re-writing, of any web page content,
3126 including tags and non-visible content. The default filter file is
3127 <filename>default.filter</filename>, located in the config directory.
3131 The included example file is divided into sections. Each section begins
3132 with the <literal>FILTER</literal> keyword, followed by the identifier
3133 for that section, e.g. <quote>FILTER: webbugs</quote>. Each section performs
3134 a similar type of filtering, such as <quote>html-annoyances</quote>.
3139 This file uses regular expressions to alter or remove any string in the
3140 target page. The expressions can only operate on one line at a time. Some
3141 examples from the included default <filename>default.filter</filename>:
3145 Stop web pages from displaying annoying messages in the status bar by
3146 deleting such references:
3153 FILTER: html-annoyances
3155 # New browser windows should be resizeable and have a location and status
3158 s/resizable="?(no|0)"?/resizable=1/ig s/noresize/yesresize/ig
3159 s/location="?(no|0)"?/location=1/ig s/status="?(no|0)"?/status=1/ig
3160 s/scrolling="?(no|0|Auto)"?/scrolling=1/ig
3161 s/menubar="?(no|0)"?/menubar=1/ig
3163 # The <BLINK> tag was a crime!
3165 s*<blink>|</blink>**ig
3169 #s/framespacing="?(no|0)"?//ig
3170 #s/margin(height|width)=[0-9]*//gi
3177 Just for kicks, replace any occurrence of <quote>Microsoft</quote> with
3178 <quote>MicroSuck</quote>, and have a little fun with topical buzzwords:
3187 s/microsoft(?!.com)/MicroSuck/ig
3191 s/industry-leading|cutting-edge|award-winning/<font color=red><b>BINGO!</b></font>/ig
3198 Kill those pesky little web-bugs:
3205 # webbugs: Squish WebBugs (1x1 invisible GIFs used for user tracking)
3208 s/<img\s+[^>]*?(width|height)\s*=\s*['"]?1\D[^>]*?(width|height)\s*=\s*['"]?1(\D[^>]*?)?>/<!-- Squished WebBug -->/sig
3216 <!-- ~ End section ~ -->
3220 <!-- ~~~~~ New section ~~~~~ -->
3223 <title>Templates</title>
3225 When <application>Privoxy</application> displays one of its internal
3226 pages, such as a 404 Not Found error page, it uses the appropriate template.
3227 On Linux, BSD, and Unix, these are located in
3228 <filename>/etc/privoxy/templates</filename> by default. These may be
3229 customized, if desired.
3236 <!-- ~ End section ~ -->
3240 <!-- ~~~~~ New section ~~~~~ -->
3242 <sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
3245 We value your feedback. However, to provide you with the best support,
3250 <listitem><para>Use the <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=211118">Sourceforge support forum</ulink> to get
3251 help.</para></listitem>
3253 <listitem><para>Submit bugs only thru our <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">Sourceforge bug
3255 Make sure that the bug has not already been submitted. Please try to
3256 verify that it is a <application>Privoxy</application> bug, and not
3257 a browser or site bug first. If you are using your own custom configuration,
3258 please try the stock configs to see if the problem is a configuration
3259 related bug. And if not using the latest development snapshot, please
3260 try the latest one. Or even better, CVS sources.</para>
3264 <listitem><para>Submit feature requests only thru our <ulink
3265 url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">Sourceforge feature request forum</ulink>.</para></listitem>
3273 For any other issues, feel free to use the <ulink url="http://sourceforge.net/mail/?group_id=11118">mailing lists</ulink>.
3277 Anyone interested in actively participating in development and related
3278 discussions can join the appropriate mailing list
3279 <ulink url="http://sourceforge.net/mail/?group_id=11118">here</ulink>.
3280 Archives are available here too.
3286 <!-- ~~~~~ New section ~~~~~ -->
3287 <sect1 id="copyright"><title>Copyright and History</title>
3290 <title>License</title>
3292 <application>Privoxy</application> is free software; you can
3293 redistribute it and/or modify it under the terms of the GNU General Public
3294 License as published by the Free Software Foundation; either version 2 of the
3295 License, or (at your option) any later version.
3299 This program is distributed in the hope that it will be useful, but WITHOUT
3300 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
3301 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
3302 details, which is available from <ulink
3303 url="http://www.gnu.org/copyleft/gpl.html">the Free Software Foundation,
3304 Inc</ulink>, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
3309 <!-- ~ End section ~ -->
3312 <!-- ~~~~~ New section ~~~~~ -->
3314 <sect2 id="history">
3315 <title>History</title>
3317 <application>Privoxy</application> is evolved, and derived from,
3318 <application>the Internet Junkbuster</application>, with many
3319 improvments and enhancements over the original.
3323 <application>Junkbuster</application> was originally written by Anonymous
3325 url="http://www.junkbusters.com">Junkbuster's
3326 Corporation</ulink>, and was released as free open-source software under the
3327 GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
3328 Waldherr</ulink> made many improvements, and started the <ulink
3329 url="http://sourceforge.net/projects/ijbswa/">SourceForge project
3330 Privoxy</ulink> to rekindle development. There are now several active
3331 developers contributing. The last stable release of
3332 <application>Junkbuster</application> was v2.0.2, which has now
3340 <!-- ~~~~~ New section ~~~~~ -->
3341 <sect1 id="seealso"><title>See also</title>
3346 <ulink url="http://sourceforge.net/projects/ijbswa">http://sourceforge.net/projects/ijbswa</ulink>,
3347 the Project Page for <application>Privoxy</application>.
3352 <ulink url="http://www.privoxy.org/">http://www.privoxy.org/</ulink>
3357 <ulink url="http://p.p/">http://p.p/</ulink>
3362 <ulink url="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</ulink>
3367 <ulink url="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</ulink>
3372 <ulink url="http://privacy.net/analyze/">http://privacy.net/analyze/</ulink>
3377 <ulink url="http://www.squid-cache.org/">http://www.squid-cache.org/</ulink>
3386 <!-- ~~~~~ New section ~~~~~ -->
3387 <sect1 id="appendix"><title>Appendix</title>
3390 <!-- ~~~~~ New section ~~~~~ -->
3392 <title>Regular Expressions</title>
3394 <application>Privoxy</application> can use <quote>regular expressions</quote>
3395 in various config files. Assuming support for <quote>pcre</quote> (Perl
3396 Compatible Regular Expressions) is compiled in, which is the default. Such
3397 configuration directives do not require regular expressions, but they can be
3398 used to increase flexibility by matching a pattern with wild-cards against
3403 If you are reading this, you probably don't understand what <quote>regular
3404 expressions</quote> are, or what they can do. So this will be a very brief
3405 introduction only. A full explanation would require a book ;-)
3409 <quote>Regular expressions</quote> is a way of matching one character
3410 expression against another to see if it matches or not. One of the
3411 <quote>expressions</quote> is a literal string of readable characters
3412 (letter, numbers, etc), and the other is a complex string of literal
3413 characters combined with wild-cards, and other special characters, called
3414 meta-characters. The <quote>meta-characters</quote> have special meanings and
3415 are used to build the complex pattern to be matched against. Perl Compatible
3416 Regular Expressions is an enhanced form of the regular expression language
3417 with backward compatibility.
3421 To make a simple analogy, we do something similar when we use wild-card
3422 characters when listing files with the <command>dir</command> command in DOS.
3423 <literal>*.*</literal> matches all filenames. The <quote>special</quote>
3424 character here is the asterisk which matches any and all characters. We can be
3425 more specific and use <literal>?</literal> to match just individual
3426 characters. So <quote>dir file?.text</quote> would match
3427 <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
3428 matching, using a similar technique to <quote>regular expressions</quote>!
3432 Regular expressions do essentially the same thing, but are much, much more
3433 powerful. There are many more <quote>special characters</quote> and ways of
3434 building complex patterns however. Let's look at a few of the common ones,
3435 and then some examples:
3440 <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
3441 <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
3447 <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
3454 <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
3461 <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
3468 <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
3469 the following character should be taken literally. This is used where one of the
3470 special characters (e.g. <quote>.</quote>) needs to be taken literally and
3471 not as a special meta-character.
3477 <emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
3478 any of the enclosed characters are encountered.
3484 <emphasis>()</emphasis> - parentheses are used to group a sub-expression,
3485 or multiple sub-expressions.
3491 <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
3492 <quote>or</quote> conditional statement. A match is successful if the
3493 sub-expression on either side of <quote>|</quote> matches.
3499 <emphasis>s/string1/string2/g</emphasis> - This is used to rewrite strings of text.
3500 <quote>string1</quote> is replaced by <quote>string2</quote> in this
3506 These are just some of the ones you are likely to use when matching URLs with
3507 <application>Privoxy</application>, and is a long way from a definitive
3508 list. This is enough to get us started with a few simple examples which may
3509 be more illuminating:
3513 <emphasis><literal>/.*/banners/.*</literal></emphasis> - A simple example
3514 that uses the common combination of <quote>.</quote> and <quote>*</quote> to
3515 denote any character, zero or more times. In other words, any string at all.
3516 So we start with a literal forward slash, then our regular expression pattern
3517 (<quote>.*</quote>) another literal forward slash, the string
3518 <quote>banners</quote>, another forward slash, and lastly another
3519 <quote>.*</quote>. We are building
3520 a directory path here. This will match any file with the path that has a
3521 directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
3522 any characters, and this could conceivably be more forward slashes, so it
3523 might expand into a much longer looking path. For example, this could match:
3524 <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
3525 <quote>/banners/annoying.html</quote>, or almost an infinite number of other
3526 possible combinations, just so it has <quote>banners</quote> in the path
3531 A now something a little more complex:
3535 <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
3536 We have several literal forward slashes again (<quote>/</quote>), so we are
3537 building another expression that is a file path statement. We have another
3538 <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
3539 it matches our expression. The only true literal that <emphasis>must
3540 match</emphasis> our pattern is <application>adv</application>, together with
3541 the forward slashes. What comes after the <quote>adv</quote> string is the
3546 Remember the <quote>?</quote> means the preceding expression (either a
3547 literal character or anything grouped with <quote>(...)</quote> in this case)
3548 can exist or not, since this means either zero or one match. So
3549 <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
3550 individual sub-expressions: <quote>(er)</quote>,
3551 <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
3552 means <quote>or</quote>. We have two of those. For instance,
3553 <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
3554 <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
3555 attempt at matching as many variations of <quote>advertisement</quote>, and
3556 similar, as possible. So this would expand to match just <quote>adv</quote>,
3557 or <quote>advert</quote>, or <quote>adverts</quote>, or
3558 <quote>advertising</quote>, or <quote>advertisement</quote>, or
3559 <quote>advertisements</quote>. You get the idea. But it would not match
3560 <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
3561 changing our regular expression to:
3562 <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
3567 <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
3568 another path statement with forward slashes. Anything in the square brackets
3569 <quote>[]</quote> can be matched. This is using <quote>0-9</quote> as a
3570 shorthand expression to mean any digit one through nine. It is the same as
3571 saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
3572 means one or more of the preceding expression must be included. The preceding
3573 expression here is what is in the square brackets -- in this case, any digit
3574 one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
3575 This includes a <quote>|</quote>, so this needs to match the expression on
3576 either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
3577 side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
3578 since the <quote>?</quote> means the letter <quote>e</quote> is optional and
3579 can be matched once or not at all. So we are building an expression here to
3580 match image GIF or JPEG type image file. It must include the literal
3581 string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
3582 (which is now a literal, and not a special character, since it is escaped
3583 with <quote>\</quote>), and lastly either <quote>gif</quote>, or
3584 <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
3585 include: <quote>//advert1.jpg</quote>,
3586 <quote>/nasty/ads/advert1234.gif</quote>,
3587 <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
3588 <quote>advert1.gif</quote> (no leading slash), or
3589 <quote>/adverts232.jpg</quote> (the expression does not include an
3590 <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
3591 in the expression anywhere).
3595 <emphasis><literal>s/microsoft(?!.com)/MicroSuck/i</literal></emphasis> - This is
3596 a substitution. <quote>MicroSuck</quote> will replace any occurrence of
3597 <quote>microsoft</quote>. The <quote>i</quote> at the end of the expression
3598 means ignore case. The <quote>(?!.com)</quote> means
3599 the match should fail if <quote>microsoft</quote> is followed by
3600 <quote>.com</quote>. In other words, this acts like a <quote>NOT</quote>
3601 modifier. In case this is a hyperlink, we don't want to break it ;-).
3605 We are barely scratching the surface of regular expressions here so that you
3606 can understand the default <application>Privoxy</application>
3607 configuration files, and maybe use this knowledge to customize your own
3608 installation. There is much, much more that can be done with regular
3609 expressions. Now that you know enough to get started, you can learn more on
3614 More reading on Perl Compatible Regular expressions:
3615 <ulink url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>
3620 <!-- ~ End section ~ -->
3623 <!-- ~~~~~ New section ~~~~~ -->
3625 <title><application>Privoxy</application>'s Internal Pages</title>
3628 Since <application>Privoxy</application> proxies each requested
3629 web page, it is easy for <application>Privoxy</application> to
3630 trap certain special URLs. In this way, we can talk directly to
3631 <application>Privoxy</application>, and see how it is
3632 configured, see how our rules are being applied, change these
3633 rules and other configuration options, and even turn
3634 <application>Privoxy's</application> filtering off, all with
3640 The URLs listed below are the special ones that allow direct access
3641 to <application>Privoxy</application>. Of course,
3642 <application>Privoxy</application> must be running to access these. If
3643 not, you will get a friendly error message. Internet access is not
3656 <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
3660 Alternately, this may be reached at <ulink
3661 url="http://p.p/">http://p.p/</ulink>, but this
3662 variation may not work as reliably as the above in some configurations.
3668 Show information about the current configuration:
3672 <ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
3679 Show the source code version numbers:
3683 <ulink url="http://config.privoxy.org/show-version">http://config.privoxy.org/show-version</ulink>
3690 Show the client's request headers:
3694 <ulink url="http://config.privoxy.org/show-request">http://config.privoxy.org/show-request</ulink>
3701 Show which actions apply to a URL and why:
3705 <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
3712 Toggle Privoxy on or off. In this case, <quote>Privoxy</quote> continues
3713 to run, but only as a pass-through proxy, with no actions taking place:
3717 <ulink url="http://config.privoxy.org/toggle">http://config.privoxy.org/toggle</ulink>
3721 Short cuts. Turn off, then on:
3725 <ulink url="http://config.privoxy.org/toggle?set=disable">http://config.privoxy.org/toggle?set=disable</ulink>
3730 <ulink url="http://config.privoxy.org/toggle?set=enable">http://config.privoxy.org/toggle?set=enable</ulink>
3737 Edit the actions list file:
3741 <ulink url="http://config.privoxy.org/edit-actions">http://config.privoxy.org/edit-actions</ulink>
3750 These may be bookmarked for quick reference.
3754 <sect3 id="bookmarklets">
3755 <title>Bookmarklets</title>
3757 Here are some bookmarklets to allow you to easily access a
3758 <quote>mini</quote> version of this page. They are designed for MS Internet
3759 Explorer, but should work equally well in Netscape, Mozilla, and other
3760 browsers which support JavaScript. They are designed to run directly from
3761 your bookmarks - not by clicking the links below (although that will work for
3765 To save them, right-click the link and choose <quote>Add to Favorites</quote>
3766 (IE) or <quote>Add Bookmark</quote> (Netscape). You will get a warning that
3767 the bookmark <quote>may not be safe</quote> - just click OK. Then you can run the
3768 Bookmarklet directly from your favourites/bookmarks. For even faster access,
3769 you can put them on the <quote>Links</quote> bar (IE) or the <quote>Personal
3770 Toolbar</quote> (Netscape), and run them with a single click.
3778 <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>
3784 <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>
3790 <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)
3796 <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>
3804 Credit: The site which gave me the general idea for these bookmarklets is
3805 <ulink url="http://www.bookmarklets.com">www.bookmarklets.com</ulink>. They
3806 have more information about bookmarklets.
3815 <!-- ~~~~~ New section ~~~~~ -->
3816 <sect2 id="actionsanat">
3817 <title>Anatomy of an Action</title>
3820 The way <application>Privoxy</application> applies <quote>actions</quote>
3821 to any given URL can be complex, and not always so easy to understand what
3822 is happening. And sometimes we need to be able to <emphasis>see</emphasis>
3823 just what <application>Privoxy</application> is doing. Especially,
3824 if something <application>Privoxy</application> is doing is causing
3825 us a problem inadvertantly. It can be a little daunting to look at
3826 the actions files themselves, since they tend to be filled with
3827 <quote>regular expressions</quote> whose consequences are not always
3828 so obvious. <application>Privoxy</application> provides the
3829 <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
3830 page that can show us very specifically how <application>actions</application>
3831 are being applied to any given URL. This is a big help for troubleshooting.
3835 First, enter one URL (or partial URL) at the prompt, and then
3836 <application>Privoxy</application> will tell us
3837 how the current configuration will handle it. This will not
3838 help with filtering effects from the <filename>default.filter</filename> file! It
3839 also will not tell you about any other URLs that may be embedded within the
3840 URL you are testing. For instance, images such as ads are expressed as URLs
3841 within the raw page source of HTML pages. So you will only get info for the
3842 actual URL that is pasted into the prompt area -- not any sub-URLs. If you
3843 want to know about embedded URLs like ads, you will have to dig those out of
3844 the HTML source. Use your browser's <quote>View Page Source</quote> option
3849 Let's look at an example, <ulink url="http://google.com">google.com</ulink>,
3850 one section at a time:
3855 System default actions:
3857 { -add-header -block -deanimate-gifs -downgrade -fast-redirects -filter
3858 -hide-forwarded -hide-from -hide-referer -hide-user-agent -image
3859 -image-blocker -limit-connect -no-compression -no-cookies-keep
3860 -no-cookies-read -no-cookies-set -no-popups -vanilla-wafer -wafer }
3866 This is the top section, and only tells us of the compiled in defaults. This
3867 is basically what <application>Privoxy</application> would do if there
3868 were not any <quote>actions</quote> defined, i.e. it does nothing. Every action
3869 is disabled. This is not particularly informative for our purposes here. OK,
3876 Matches for http://google.com:
3878 { -add-header -block +deanimate-gifs -downgrade +fast-redirects
3879 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
3880 +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
3881 +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
3882 -hide-user-agent -image +image-blocker{blank} +no-compression
3883 +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups
3884 -vanilla-wafer -wafer }
3887 { -no-cookies-keep -no-cookies-read -no-cookies-set }
3897 This is much more informative, and tells us how we have defined our
3898 <quote>actions</quote>, and which ones match for our example,
3899 <quote>google.com</quote>. The first grouping shows our default
3900 settings, which would apply to all URLs. If you look at your <quote>actions</quote>
3901 file, this would be the section just below the <quote>aliases</quote> section
3902 near the top. This applies to all URLs as signified by the single forward
3903 slash -- <quote>/</quote>.
3908 These are the default actions we have enabled. But we can define additional
3909 actions that would be exceptions to these general rules, and then list
3910 specific URLs that these exceptions would apply to. Last match wins.
3911 Just below this then are two explict matches for <quote>.google.com</quote>.
3912 The first is negating our various cookie blocking actions (i.e. we will allow
3913 cookies here). The second is allowing <quote>fast-redirects</quote>. Note
3914 that there is a leading dot here -- <quote>.google.com</quote>. This will
3915 match any hosts and sub-domains, in the google.com domain also, such as
3916 <quote>www.google.com</quote>. So, apparently, we have these actions defined
3917 somewhere in the lower part of our actions file, and
3918 <quote>google.com</quote> is referenced in these sections.
3923 And now we pull it altogether in the bottom section and summarize how
3924 <application>Privoxy</application> is appying all its <quote>actions</quote>
3925 to <quote>google.com</quote>:
3934 -add-header -block -deanimate-gifs -downgrade -fast-redirects
3935 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
3936 +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
3937 +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
3938 -hide-user-agent -image +image-blocker{blank} -limit-connect +no-compression
3939 -no-cookies-keep -no-cookies-read -no-cookies-set +no-popups -vanilla-wafer
3946 Now another example, <quote>ad.doubleclick.net</quote>:
3965 We'll just show the interesting part here, the explicit matches. It is
3966 matched three different times. Each as an <quote>+block +image</quote>,
3967 which is the expanded form of one of our aliases that had been defined as:
3968 <quote>+imageblock</quote>. (<quote>Aliases</quote> are defined in the
3969 first section of the actions file and typically used to combine more
3974 Any one of these would have done the trick and blocked this as an unwanted
3975 image. This is unnecessarily redundant since the last case effectively
3976 would also cover the first. No point in taking chances with these guys
3977 though ;-) Note that if you want an ad or obnoxious
3978 URL to be invisible, it should be defined as <quote>ad.doubleclick.net</quote>
3979 is done here -- as both a <quote>+block</quote> <emphasis>and</emphasis> an
3980 <quote>+image</quote>. The custom alias <quote>+imageblock</quote> does this
3985 One last example. Let's try <quote>http://www.rhapsodyk.net/adsl/HOWTO/</quote>.
3986 This one is giving us problems. We are getting a blank page. Hmmm...
3992 Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
3994 { -add-header -block +deanimate-gifs -downgrade +fast-redirects
3995 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
3996 +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
3997 +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
3998 -hide-user-agent -image +image-blocker{blank} +no-compression
3999 +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups
4000 -vanilla-wafer -wafer }
4010 Ooops, the <quote>/adsl/</quote> is matching <quote>/ads</quote>! But
4011 we did not want this at all! Now we see why we get the blank page. We could
4012 now add a new action below this that explictly does <emphasis>not</emphasis>
4013 block (-block) pages with <quote>adsl</quote>. There are various ways to
4014 handle such exceptions. Example:
4027 Now the page displays ;-)
4032 But now what about a situation where we get no explicit matches like
4047 That actually was very telling and pointed us quickly to where the problem
4048 was. If you don't get this kind of match, then it means one of the default
4049 rules in the first section is causing the problem. This would require some
4050 guesswork, and maybe a little trial and error to isolate the offending rule.
4051 One likely cause would be one of the <quote>{+filter}</quote> actions. Try
4052 adding the URL for the site to one of aliases that turn off <quote>+filter</quote>:
4060 .worldpay.com # for quietpc.com
4069 <quote>{shop}</quote> is an <quote>alias</quote> that expands to
4070 <quote>{ -filter -no-cookies -no-cookies-keep }</quote>. Or you could do
4071 your own exception to negate filtering:
4090 This program is free software; you can redistribute it
4091 and/or modify it under the terms of the GNU General
4092 Public License as published by the Free Software
4093 Foundation; either version 2 of the License, or (at
4094 your option) any later version.
4096 This program is distributed in the hope that it will
4097 be useful, but WITHOUT ANY WARRANTY; without even the
4098 implied warranty of MERCHANTABILITY or FITNESS FOR A
4099 PARTICULAR PURPOSE. See the GNU General Public
4100 License for more details.
4102 The GNU General Public License should be included with
4103 this file. If not, you can view it at
4104 http://www.gnu.org/copyleft/gpl.html
4105 or write to the Free Software Foundation, Inc., 59
4106 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
4108 $Log: user-manual.sgml,v $
4109 Revision 1.61 2002/03/29 01:31:08 hal9
4112 Revision 1.60 2002/03/27 01:57:34 hal9
4113 Added more to Anatomy section.
4115 Revision 1.59 2002/03/27 00:54:33 hal9
4116 Touch up intro for new name.
4118 Revision 1.58 2002/03/26 22:29:55 swa
4119 we have a new homepage!
4121 Revision 1.57 2002/03/24 20:33:30 hal9
4122 A few minor catch ups with name change.
4124 Revision 1.56 2002/03/24 16:17:06 swa
4125 configure needs to be generated.
4127 Revision 1.55 2002/03/24 16:08:08 swa
4128 we are too lazy to make a block-built
4129 privoxy logo. hence removed the option.
4131 Revision 1.54 2002/03/24 15:46:20 swa
4132 name change related issue.
4134 Revision 1.53 2002/03/24 11:51:00 swa
4135 name change. changed filenames.
4137 Revision 1.52 2002/03/24 11:01:06 swa
4140 Revision 1.51 2002/03/23 15:13:11 swa
4141 renamed every reference to the old name with foobar.
4142 fixed "application foobar application" tag, fixed
4143 "the foobar" with "foobar". left junkbustser in cvs
4144 comments and remarks to history untouched.
4146 Revision 1.50 2002/03/23 05:06:21 hal9
4149 Revision 1.49 2002/03/21 17:01:05 hal9
4150 New section in Appendix.
4152 Revision 1.48 2002/03/12 06:33:01 hal9
4153 Catching up to Andreas and re_filterfile changes.
4155 Revision 1.47 2002/03/11 13:13:27 swa
4156 correct feedback channels
4158 Revision 1.46 2002/03/10 00:51:08 hal9
4159 Added section on JB internal pages in Appendix.
4161 Revision 1.45 2002/03/09 17:43:53 swa
4164 Revision 1.44 2002/03/09 17:08:48 hal9
4165 New section on Jon's actions file editor, and move some stuff around.
4167 Revision 1.43 2002/03/08 00:47:32 hal9
4168 Added imageblock{pattern}.
4170 Revision 1.42 2002/03/07 18:16:55 swa
4173 Revision 1.41 2002/03/07 16:46:43 hal9
4174 Fix a few markup problems for jade.
4176 Revision 1.40 2002/03/07 16:28:39 swa
4177 provide correct feedback channels
4179 Revision 1.39 2002/03/06 16:19:28 hal9
4180 Note on perceived filtering slowdown per FR.
4182 Revision 1.38 2002/03/05 23:55:14 hal9
4183 Stupid I did it again. Double hyphen in comment breaks jade.
4185 Revision 1.37 2002/03/05 23:53:49 hal9
4186 jade barfs on '- -' embedded in comments. - -user option broke it.
4188 Revision 1.36 2002/03/05 22:53:28 hal9
4189 Add new - - user option.
4191 Revision 1.35 2002/03/05 00:17:27 hal9
4192 Added section on command line options.
4194 Revision 1.34 2002/03/04 19:32:07 oes
4195 Changed default port to 8118
4197 Revision 1.33 2002/03/03 19:46:13 hal9
4198 Emphasis on where/how to report bugs, etc
4200 Revision 1.32 2002/03/03 09:26:06 joergs
4201 AmigaOS changes, config is now loaded from PROGDIR: instead of
4202 AmiTCP:db/junkbuster/ if no configuration file is specified on the
4205 Revision 1.31 2002/03/02 22:45:52 david__schmidt
4208 Revision 1.30 2002/03/02 22:00:14 hal9
4209 Updated 'New Features' list. Ran through spell-checker.
4211 Revision 1.29 2002/03/02 20:34:07 david__schmidt
4212 Update OS/2 build section
4214 Revision 1.28 2002/02/24 14:34:24 jongfoster
4215 Formatting changes. Now changing the doctype to DocBook XML 4.1
4216 will work - no other changes are needed.
4218 Revision 1.27 2002/01/11 14:14:32 hal9
4219 Added a very short section on Templates
4221 Revision 1.26 2002/01/09 20:02:50 hal9
4222 Fix bug re: auto-detect config file changes.
4224 Revision 1.25 2002/01/09 18:20:30 hal9
4225 Touch ups for *.action files.
4227 Revision 1.24 2001/12/02 01:13:42 hal9
4230 Revision 1.23 2001/12/02 00:20:41 hal9
4231 Updates for recent changes.
4233 Revision 1.22 2001/11/05 23:57:51 hal9
4234 Minor update for startup now daemon mode.
4236 Revision 1.21 2001/10/31 21:11:03 hal9
4237 Correct 2 minor errors
4239 Revision 1.18 2001/10/24 18:45:26 hal9
4240 *** empty log message ***
4242 Revision 1.17 2001/10/24 17:10:55 hal9
4243 Catching up with Jon's recent work, and a few other things.
4245 Revision 1.16 2001/10/21 17:19:21 swa
4246 wrong url in documentation
4248 Revision 1.15 2001/10/14 23:46:24 hal9
4249 Various minor changes. Fleshed out SEE ALSO section.
4251 Revision 1.13 2001/10/10 17:28:33 hal9
4254 Revision 1.12 2001/09/28 02:57:04 hal9
4257 Revision 1.11 2001/09/28 02:25:20 hal9
4260 Revision 1.9 2001/09/27 23:50:29 hal9
4261 A few changes. A short section on regular expression in appendix.
4263 Revision 1.8 2001/09/25 00:34:59 hal9
4264 Some additions, and re-arranging.
4266 Revision 1.7 2001/09/24 14:31:36 hal9
4269 Revision 1.6 2001/09/24 14:10:32 hal9
4270 Including David's OS/2 installation instructions.
4272 Revision 1.2 2001/09/13 15:27:40 swa
4275 Revision 1.1 2001/09/12 15:36:41 swa
4276 source files for junkbuster documentation
4278 Revision 1.3 2001/09/10 17:43:59 swa
4279 first proposal of a structure.
4281 Revision 1.2 2001/06/13 14:28:31 swa
4282 docs should have an author.
4284 Revision 1.1 2001/06/13 14:20:37 swa
4285 first import of project's documentation for the webserver.
projects / privoxy.git / blob