1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
2 <!entity % dummy "INCLUDE">
3 <!entity supported SYSTEM "supported.sgml">
4 <!entity newfeatures SYSTEM "newfeatures.sgml">
5 <!entity p-intro SYSTEM "privoxy.sgml">
6 <!entity seealso SYSTEM "seealso.sgml">
9 File : $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
12 This file belongs into
13 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
15 $Id: user-manual.sgml,v 1.64 2002/04/03 03:53:43 hal9 Exp $
17 Written by and Copyright (C) 2001 the SourceForge
18 Privoxy team. http://www.privoxy.org/
20 Based on the Internet Junkbuster originally written
21 by and Copyright (C) 1997 Anonymous Coders and
22 Junkbusters Corporation. http://www.junkbusters.com
26 Sat 03/02/02 04:53:47 PM
28 This should be ready for BETA release.
30 Hal Burgiss <hal@foobox.net>
35 <title>Privoxy User Manual</title>
37 <pubdate>$Id: user-manual.sgml,v 1.64 2002/04/03 03:53:43 hal9 Exp $</pubdate>
42 <orgname>By: Privoxy Developers</orgname>
51 This is here to keep vim syntax file from breaking :/
52 If I knew enough to fix it, I would.
53 PLEASE DO NOT REMOVE! HB: hal@foobox.net
59 The user manual gives users information on how to install, configure and use
60 <application>Privoxy</application>. <application>Privoxy</application> is a
61 web proxy with advanced filtering capabilities for protecting privacy,
62 filtering web page content, managing cookies, controlling access, and
63 removing ads, banners, pop-ups and other obnoxious Internet
64 Junk. <application>Privoxy</application> has a very flexible configuration
65 and can be customized to suit individual needs and
66 tastes. <application>Privoxy</application> has application for both
67 stand-alone systems and multi-user networks.
70 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>.
74 <!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
81 <!-- ~~~~~ New section ~~~~~ -->
83 <sect1 id="introduction"><title>Introduction</title>
85 Include privoxy.sgml boilerplate:
90 This documentation is included with the current BETA version of
91 <application>Privoxy</application> and is mostly complete at this
92 point. The most up to date reference for the time being is still the comments
93 in the source files and in the individual configuration files. Development
94 of version 3.0 is currently nearing completion, and includes many significant
95 changes and enhancements over earlier versions. The target release date for
96 stable v3.0 is <quote>soon</quote> ;-)
100 Since this is a BETA version, not all new features are well tested. This
101 documentation may be slightly out of sync as a result (especially with
102 CVS sources). And there <emphasis>may be</emphasis> bugs, though hopefully
107 <!-- ~~~~~ New section ~~~~~ -->
109 <title>New Features</title>
111 In addition to <application>Internet Junkbuster's</application> traditional
112 feature of ad and banner blocking and cookie management,
113 <application>Privoxy</application> provides new features, some of them
114 currently under development:
118 Include newfeatures.sgml here:
127 <!-- ~ End section ~ -->
130 <!-- ~~~~~ New section ~~~~~ -->
131 <sect1 id="installation"><title>Installation</title>
133 <application>Privoxy</application> is available as raw source code, or
134 pre-compiled binaries. See the <ulink
135 url="http://sourceforge.net/projects/ijbswa/">Privoxy Home Page</ulink>
136 for binaries and current release info. <application>Privoxy</application>
137 is also available via <ulink
138 url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
139 This is the recommended approach at this time. But please be aware that CVS
140 is constantly changing, and it may break in mysterious ways.
143 <!-- ~~~~~ New section ~~~~~ -->
144 <sect2 id="installation-source"><title>Source</title>
146 For gzipped tar archives, unpack the source:
151 tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz]
152 cd privoxy-2.9.13-beta
157 For retrieving the current CVS sources, you'll need the CVS
158 package installed first. To download CVS source:
163 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
164 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
170 This will create a directory named <filename>current/</filename>, which will
171 contain the source tree.
175 Then, in either case, to build from tarball/CVS source:
180 ./configure (--help to see options)
181 make (the make from gnu, gmake for *BSD)
183 make -n install (to see where all the files will go)
184 make install (to really install)
189 For Redhat and SuSE Linux RPM packages, see below.
195 <!-- ~~~~~ New section ~~~~~ -->
196 <sect2 id="installation-rh"><title>Red Hat</title>
198 To build Redhat RPM packages, install source as above. Then:
211 This will create both binary and src RPMs in the usual places. Example:
215 /usr/src/redhat/RPMS/i686/privoxy-2.9.11-1.i686.rpm
218 /usr/src/redhat/SRPMS/privoxy-2.9.11-1.src.rpm
222 To install, of course:
227 rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-2.9.11-1.i686.rpm
232 This will place the <application>Privoxy</application> configuration
233 files in <filename>/etc/privoxy/</filename>, and log files in
234 <filename>/var/log/privoxy/</filename>.
239 <!-- ~~~~~ New section ~~~~~ -->
240 <sect2 id="installation-suse"><title>SuSE</title>
242 To build SuSE RPM packages, install source as above. Then:
255 This will create both binary and src RPMs in the usual places. Example:
259 /usr/src/packages/RPMS/i686/privoxy-2.9.11-1.i686.rpm
262 /usr/src/packages/SRPMS/privoxy-2.9.11-1.src.rpm
266 To install, of course:
271 rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.11-1.i686.rpm
276 This will place the <application>Privoxy</application> configuration
277 files in <filename>/etc/privoxy/</filename>, and log files in
278 <filename>/var/log/privoxy/</filename>.
284 <!-- ~~~~~ New section ~~~~~ -->
285 <sect2 id="installation-os2"><title>OS/2</title>
292 <application>Privoxy</application> is packaged in a WarpIN self-
293 installing archive. The self-installing program will be named depending
294 on the release version, something like:
295 <filename>privoxyos2_setup_1.2.3.exe</filename>. In order to install it, simply
296 run this executable or double-click on its icon and follow the WarpIN
297 installation panels. A shadow of the <application>Privoxy</application>
298 executable will be placed in your startup folder so it will start
299 automatically whenever OS/2 starts.
303 The directory you choose to install <application>Privoxy</application>
304 into will contain all of the configuration files.
308 If you would like to build binary images on OS/2 yourself, you will need
309 a few Unix-like tools: autoconf, autoheader and sh. These tools will be
310 used to create the required config.h file, which is not part of the
311 source distribution because it differs based on platform. You will also
313 The distribution has been created using IBM VisualAge compilers, but you
314 can use any compiler you like. GCC/EMX has the disadvantage of needing
315 to be single-threaded due to a limitation of EMX's implementation of the
316 select() socket call.
320 In addition to needing the source code distribution as outlined earlier,
321 you will want to extract the <filename>os2seutp</filename> directory from CVS:
323 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
324 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
326 This will create a directory named os2setup/, which will contain the
327 <filename>Makefile.vac</filename> makefile and <filename>os2build.cmd</filename>
328 which is used to completely create the binary distribution. The sequence
329 of events for building the executable for yourself goes something like this:
336 nmake -f Makefile.vac
338 You will see this sequence laid out in <filename>os2build.cmd</filename>.
344 <!-- ~~~~~ New section ~~~~~ -->
345 <sect2 id="installation-win"><title>Windows</title>
346 <para>Click-click. (I need help on this. Not a clue here. Also for
347 configuration section below. HB.)
351 <!-- ~~~~~ New section ~~~~~ -->
352 <sect2 id="installation-other"><title>Other</title>
354 Some quick notes on other Operating Systems.
358 For FreeBSD (and other *BSDs?), the build will require <command>gmake</command>
359 instead of the included <command>make</command>. <command>gmake</command> is
360 available from <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>.
361 The rest should be the same as above for Linux/Unix.
368 <!-- ~ End section ~ -->
371 <!-- ~~~~~ New section ~~~~~ -->
373 <sect1 id="quickstart"><title>Quickstart to Using <application>Privoxy</application></title>
375 Before launching <application>Privoxy</application> for the first time, you
376 will want to configure your browser(s) to use <application>Privoxy</application>
377 as a HTTP and HTTPS proxy. The default is localhost for the proxy address,
378 and port 8118 (earlier versions used port 800). This is the one required
379 configuration that must be done!
383 With <application>Netscape</application> (and
384 <application>Mozilla</application>), this can be set under <literal>Edit
385 -> Preferences -> Advanced -> Proxies -> HTTP Proxy</literal>.
386 For <application>Internet Explorer</application>: <literal>Tools ->
387 Internet Properties -> Connections -> LAN Setting</literal>. Then,
388 check <quote>Use Proxy</quote> and fill in the appropriate info (Address:
389 localhost, Port: 8118). Include if HTTPS proxy support too.
393 After doing this, flush your browser's disk and memory caches to force a
394 re-reading of all pages and get rid of any ads that may be cached. You
395 are now ready to start enjoying the benefits of using
396 <application>Privoxy</application>.
401 <application>Privoxy</application> is typically started by specifying the
402 main configuration file to be used on the command line. Example Unix startup
409 # /usr/sbin/privoxy /etc/privoxy/config
415 An init script is provided for SuSE and Redhat.
419 For for SuSE: /etc/rc.d/privoxy start
423 For RedHat: /etc/rc.d/init.d/privoxy start
428 If no configuration file is specified on the command line,
429 <application>Privoxy</application> will look for a file named
430 <filename>config</filename> in the current directory. Except on Win32 where
431 it will try <filename>config.txt</filename>. If no file is specified on the
432 command line and no default configuration file can be found,
433 <application>Privoxy</application> will fail to start.
438 The included default configuration files should give a reasonable starting
439 point, though may be somewhat aggressive in blocking junk. Most of the
440 per site configuration is done in the <quote>actions</quote> files. These
441 are where various cookie actions are defined, ad and banner blocking,
442 and other aspects of <application>Privoxy</application> configuration. There
443 are several such files included, with varying levels of aggressiveness.
447 You will probably want to keep an eye out for sites that require persistent
448 cookies, and add these to <filename>default.action</filename> as needed. By
449 default, most of these will be accepted only during the current browser
450 session, until you add them to the configuration. If you want the browser to
451 handle this instead, you will need to edit
452 <filename>default.action</filename> and disable this feature. If you use more
453 than one browser, it would make more sense to let
454 <application>Privoxy</application> handle this. In which case, the browser(s)
455 should be set to accept all cookies.
459 <application>Privoxy</application> is HTTP/1.1 compliant, but not all 1.1
460 features are as yet implemented. If browsers that support HTTP/1.1 (like
461 <application>Mozilla</application> or recent versions of I.E.) experience
462 problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look
463 under <literal>Edit -> Preferences -> Debug -> Networking</literal>.
464 Or set the <quote>+downgrade</quote> config option in
465 <filename>default.action</filename>.
469 After running <application>Privoxy</application> for a while, you can
470 start to fine tune the configuration to suit your personal, or site,
471 preferences and requirements. There are many, many aspects that can
472 be customized. <quote>Actions</quote> (as specified in <filename>default.action</filename>)
473 can be adjusted by pointing your browser to
474 <ulink url="http://p.p/">http://p.p/</ulink>,
475 and then follow the link to <quote>edit the actions list</quote>.
476 (This is an internal page and does not require Internet access.)
480 In fact, various aspects of <application>Privoxy</application>
481 configuration can be viewed from this page, including
482 current configuration parameters, source code version numbers,
483 the browser's request headers, and <quote>actions</quote> that apply
484 to a given URL. In addition to the <filename>default.action</filename> file
485 editor mentioned above, <application>Privoxy</application> can also
486 be turned <quote>on</quote> and <quote>off</quote> from this page.
490 If you encounter problems, please verify it is a
491 <application>Privoxy</application> bug, by disabling
492 <application>Privoxy</application>, and then trying the same page.
493 Also, try another browser if possible to eliminate browser or site
494 problems. Before reporting it as a bug, see if there is not a configuration
495 option that is enabled that is causing the page not to load. You can then add
496 an exception for that page or site. For instance, try adding it to the
497 <literal>{fragile}</literal> section of <filename>default.action</filename>.
498 This will turn off most actions for this site. For more on troubleshooting
499 problem sites, see the <ulink
500 url="appendix.html#ACTIONSANAT">Appendix</ulink>. If a bug, please report it
501 to the developers (see below).
505 <!-- ~~~~~ New section ~~~~~ -->
508 <title>Command Line Options</title>
510 <application>Privoxy</application> may be invoked with the following
511 command-line options:
519 <emphasis>--version</emphasis>
522 Print version info and exit, Unix only.
527 <emphasis>--help</emphasis>
530 Print a short usage info and exit, Unix only.
535 <emphasis>--no-daemon</emphasis>
538 Don't become a daemon, i.e. don't fork and become process group
539 leader, don't detach from controlling tty. Unix only.
544 <emphasis>--pidfile FILE</emphasis>
548 On startup, write the process ID to <emphasis>FILE</emphasis>. Delete the
549 <emphasis>FILE</emphasis> on exit. Failiure to create or delete the
550 <emphasis>FILE</emphasis> is non-fatal. If no <emphasis>FILE</emphasis>
551 option is given, no PID file will be used. Unix only.
556 <emphasis>--user USER[.GROUP]</emphasis>
560 After (optionally) writing the PID file, assume the user ID of
561 <emphasis>USER</emphasis>, and if included the GID of GROUP. Exit if the
562 privileges are not sufficient to do so. Unix only.
567 <emphasis>configfile</emphasis>
570 If no <emphasis>configfile</emphasis> is included on the command line,
571 <application>Privoxy</application> will look for a file named
572 <quote>config</quote> in the current directory (except on Win32
573 where it will look for <quote>config.txt</quote> instead). Specify
574 full path to avoid confusion.
585 <!-- ~ End section ~ -->
588 <!-- ~~~~~ New section ~~~~~ -->
589 <sect1 id="configuration"><title><application>Privoxy</application> Configuration</title>
591 All <application>Privoxy</application> configuration is stored
592 in text files. These files can be edited with a text editor.
593 Many important aspects of <application>Privoxy</application> can
594 also be controlled easily with a web browser.
599 <!-- ~~~~~ New section ~~~~~ -->
602 <title>Controlling <application>Privoxy</application> with Your Web Browser</title>
604 <application>Privoxy</application> can be reached by the special
605 URL <ulink url="http://p.p/">http://p.p/</ulink> (or alternately
606 <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>),
607 which is an internal page. You will see the following section:
614 Please choose from the following options:
616 * Show information about the current configuration
617 * Show the source code version numbers
618 * Show the client's request headers.
619 * Show which actions apply to a URL and why
620 * Toggle Privoxy on or off
621 * Edit the actions list
627 This should be self-explanatory. Note the last item is an editor for the
628 <quote>actions list</quote>, which is where much of the ad, banner, cookie,
629 and URL blocking magic is configured as well as other advanced features of
630 <application>Privoxy</application>. This is an easy way to adjust various
631 aspects of <application>Privoxy</application> configuration. The actions
632 file, and other configuration files, are explained in detail below.
633 <application>Privoxy</application> will automatically detect any changes
638 <quote>Toggle Privoxy On or Off</quote> is handy for sites that might
639 have problems with your current actions and filters, or just to test if
640 a site misbehaves, whether it is <application>Privoxy</application>
641 causing the problem or not. <application>Privoxy</application> continues
642 to run as a proxy in this case, but all filtering is disabled.
648 <!-- ~ End section ~ -->
653 <!-- ~~~~~ New section ~~~~~ -->
656 <title>Configuration Files Overview</title>
658 For Unix, *BSD and Linux, all configuration files are located in
659 <filename>/etc/privoxy/</filename> by default. For MS Windows, OS/2, and
660 AmigaOS these are all in the same directory as the
661 <application>Privoxy</application> executable. The name and number of
662 configuration files has changed from previous versions, and is subject to
663 change as development progresses.
667 The installed defaults provide a reasonable starting point, though possibly
668 aggressive by some standards. For the time being, there are only three
669 default configuration files (this will change in time):
677 The main configuration file is named <filename>config</filename>
678 on Linux, Unix, BSD, OS/2, and AmigaOS and <filename>config.txt</filename>
685 The <filename>default.action</filename> file is used to define various
686 <quote>actions</quote> relating to images, banners, pop-ups, access
687 restrictions, banners and cookies. There is a CGI based editor for this
688 file that can be accessed via <ulink
689 url="http://p.p">http://p.p</ulink>. (Other actions
690 files are included as well with differing levels of filtering
691 and blocking, e.g. <filename>basic.action</filename>.)
697 The <filename>default.filter</filename> file can be used to re-write the raw
698 page content, including viewable text as well as embedded HTML and JavaScript,
699 and whatever else lurks on any given web page.
707 <filename>default.action</filename> and <filename>default.filter</filename>
708 can use Perl style regular expressions for maximum flexibility. All files use
709 the <quote><literal>#</literal></quote> character to denote a comment. Such
710 lines are not processed by <application>Privoxy</application>. After
711 making any changes, there is no need to restart
712 <application>Privoxy</application> in order for the changes to take
713 effect. <application>Privoxy</application> should detect such changes
718 While under development, the configuration content is subject to change.
719 The below documentation may not be accurate by the time you read this.
720 Also, what constitutes a <quote>default</quote> setting, may change, so
721 please check all your configuration files on important issues.
726 <!-- ~~~~~ New section ~~~~~ -->
729 <title>The Main Configuration File</title>
731 Again, the main configuration file is named <filename>config</filename> on
732 Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
733 Configuration lines consist of an initial keyword followed by a list of
734 values, all separated by whitespace (any number of spaces or tabs). For
742 <emphasis>blockfile blocklist.ini</emphasis>
749 Indicates that the blockfile is named <quote>blocklist.ini</quote>. (A
750 default installation does not use this.)
754 A <quote><literal>#</literal></quote> indicates a comment. Any part of a
755 line following a <quote><literal>#</literal></quote> is ignored, except if
756 the <quote><literal>#</literal></quote> is preceded by a
757 <quote><literal>\</literal></quote>.
761 Thus, by placing a <quote><literal>#</literal></quote> at the start of an
762 existing configuration line, you can make it a comment and it will be treated
763 as if it weren't there. This is called <quote>commenting out</quote> an
764 option and can be useful to turn off features: If you comment out the
765 <quote>logfile</quote> line, <application>Privoxy</application> will not
766 log to a file at all. Watch for the <quote>default:</quote> section in each
767 explanation to see what happens if the option is left unset (or commented
772 Long lines can be continued on the next line by using a
773 <quote><literal>\</literal></quote> as the very last character.
777 There are various aspects of <application>Privoxy</application> behavior
782 <!-- ~~~~~ New section ~~~~~ -->
785 <title>Defining Other Configuration Files</title>
788 <application>Privoxy</application> can use a number of other files to tell it
789 what ads to block, what cookies to accept, and perform other functions. This
790 section of the configuration file tells <application>Privoxy</application>
791 where to find all those other files.
795 On <application>Windows</application> and <application>AmigaOS</application>,
796 <application>Privoxy</application> looks for these files in the same
797 directory as the executable. On Unix and OS/2,
798 <application>Privoxy</application> looks for these files in the current
799 working directory. In either case, an absolute path name can be used to
804 When development goes modular and multi-user, the blocker, filter, and
805 per-user config will be stored in subdirectories of <quote>confdir</quote>.
806 For now, only <filename>confdir/templates</filename> is used for storing HTML
807 templates for CGI results.
811 The location of the configuration files:
818 <emphasis>confdir /etc/privoxy</emphasis> # No trailing /, please.
825 The directory where all logging (i.e. <filename>logfile</filename> and
826 <filename>jarfile</filename>) takes place. No trailing
827 <quote><literal>/</literal></quote>, please:
834 <emphasis>logdir /var/log/privoxy</emphasis>
841 Note that all file specifications below are relative to
842 the above two directories!
846 The <quote>default.action</quote> file contains patterns to specify the
847 actions to apply to requests for each site. Default: Cookies to and from all
848 destinations are kept only during the current browser session (i.e. they are
849 not saved to disk). Pop-ups are disabled for all sites. All sites are
850 filtered through selected sections of <quote>default.filter</quote>. No sites
851 are blocked. <application>Privoxy</application> displays a checkboard type
852 pattern for filtered ads and other images. The syntax of this file is
853 explained in detail <link linkend="actionsfile">below</link>. Other
854 <quote>actions</quote> files are included, and you are free to use any of
855 them. They have varying degrees of aggressiveness.
862 <emphasis>actionsfile default.action</emphasis>
869 The <quote>default.filter</quote> file contains content modification rules
870 that use <quote>regular expressions</quote>. These rules permit powerful
871 changes on the content of Web pages, e.g., you could disable your favorite
872 JavaScript annoyances, re-write the actual displayed text, or just have some
873 fun replacing <quote>Microsoft</quote> with <quote>MicroSuck</quote> wherever
874 it appears on a Web page. Default: whatever the developers are playing with
879 Filtering requires buffering the page content, which may appear to slow down
880 page rendering since nothing is displayed until all content has passed
881 the filters. (It does not really take longer, but seems that way since
882 the page is not incrementally displayed.) This effect will be more noticeable
883 on slower connections.
891 <emphasis>filterfile default.filter</emphasis>
898 The logfile is where all logging and error messages are written. The logfile
899 can be useful for tracking down a problem with
900 <application>Privoxy</application> (e.g., it's not blocking an ad you
901 think it should block) but in most cases you probably will never look at it.
905 Your logfile will grow indefinitely, and you will probably want to
906 periodically remove it. On Unix systems, you can do this with a cron job
907 (see <quote>man cron</quote>). For Redhat, a <command>logrotate</command>
908 script has been included.
912 On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
913 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
914 the effect that cron.daily will automatically archive, gzip, and empty the
915 log, when it exceeds 1M size.
919 Default: Log to the a file named <filename>logfile</filename>.
920 Comment out to disable logging.
927 <emphasis>logfile logfile</emphasis>
934 The <quote>jarfile</quote> defines where
935 <application>Privoxy</application> stores the cookies it intercepts. Note
936 that if you use a <quote>jarfile</quote>, it may grow quite large. Default:
937 Don't store intercepted cookies.
944 <emphasis>#jarfile jarfile</emphasis>
951 If you specify a <quote>trustfile</quote>,
952 <application>Privoxy</application> will only allow access to sites that
953 are named in the trustfile. You can also mark sites as trusted referrers,
954 with the effect that access to untrusted sites will be granted, if a link
955 from a trusted referrer was used. The link target will then be added to the
956 <quote>trustfile</quote>. This is a very restrictive feature that typical
957 users most probably want to leave disabled. Default: Disabled, don't use the
965 <emphasis>#trustfile trust</emphasis>
972 If you use the trust mechanism, it is a good idea to write up some on-line
973 documentation about your blocking policy and to specify the URL(s) here. They
974 will appear on the page that your users receive when they try to access
975 untrusted content. Use multiple times for multiple URLs. Default: Don't
976 display links on the <quote>untrusted</quote> info page.
983 <emphasis>trust-info-url http://www.example.com/why_we_block.html</emphasis>
984 <emphasis>trust-info-url http://www.example.com/what_we_allow.html</emphasis>
992 <!-- ~ End section ~ -->
996 <!-- ~~~~~ New section ~~~~~ -->
999 <title>Other Configuration Options</title>
1002 This part of the configuration file contains options that control how
1003 <application>Privoxy</application> operates.
1007 <quote>Admin-address</quote> should be set to the email address of the proxy
1008 administrator. It is used in many of the proxy-generated pages. Default:
1016 <emphasis>#admin-address fill@me.in.please</emphasis>
1023 <quote>Proxy-info-url</quote> can be set to a URL that contains more info
1024 about this <application>Privoxy</application> installation, it's
1025 configuration and policies. It is used in many of the proxy-generated pages
1026 and its use is highly recommended in multi-user installations, since your
1027 users will want to know why certain content is blocked or modified. Default:
1028 Don't show a link to on-line documentation.
1035 <emphasis>proxy-info-url http://www.example.com/proxy.html</emphasis>
1042 <quote>Listen-address</quote> specifies the address and port where
1043 <application>Privoxy</application> will listen for connections from your
1044 Web browser. The default is to listen on the localhost port 8118, and
1045 this is suitable for most users. (In your web browser, under proxy
1046 configuration, list the proxy server as <quote>localhost</quote> and the
1047 port as <quote>8118</quote>).
1051 If you already have another service running on port 8118, or if you want to
1052 serve requests from other machines (e.g. on your local network) as well, you
1053 will need to override the default. The syntax is
1054 <quote>listen-address [<ip-address>]:<port></quote>. If you leave
1055 out the IP address, <application>Privoxy</application> will bind to all
1056 interfaces (addresses) on your machine and may become reachable from the
1057 Internet. In that case, consider using access control lists (acl's) (see
1058 <quote>aclfile</quote> above), or a firewall.
1062 For example, suppose you are running <application>Privoxy</application> on
1063 a machine which has the address 192.168.0.1 on your local private network
1064 (192.168.0.0) and has another outside connection with a different address.
1065 You want it to serve requests from inside only:
1072 <emphasis>listen-address 192.168.0.1:8118</emphasis>
1079 If you want it to listen on all addresses (including the outside
1087 <emphasis>listen-address :8118</emphasis>
1094 If you do this, consider using ACLs (see <quote>aclfile</quote> above). Note:
1095 you will need to point your browser(s) to the address and port that you have
1096 configured here. Default: localhost:8118 (127.0.0.1:8118).
1100 The debug option sets the level of debugging information to log in the
1101 logfile (and to the console in the Windows version). A debug level of 1 is
1102 informative because it will show you each request as it happens. Higher
1103 levels of debug are probably only of interest to developers.
1110 debug 1 # GPC = show each GET/POST/CONNECT request
1111 debug 2 # CONN = show each connection status
1112 debug 4 # IO = show I/O status
1113 debug 8 # HDR = show header parsing
1114 debug 16 # LOG = log all data into the logfile
1115 debug 32 # FRC = debug force feature
1116 debug 64 # REF = debug regular expression filter
1117 debug 128 # = debug fast redirects
1118 debug 256 # = debug GIF de-animation
1119 debug 512 # CLF = Common Log Format
1120 debug 1024 # = debug kill pop-ups
1121 debug 4096 # INFO = Startup banner and warnings.
1122 debug 8192 # ERROR = Non-fatal errors
1129 It is <emphasis>highly recommended</emphasis> that you enable ERROR
1130 reporting (debug 8192), at least until v3.0 is released.
1134 The reporting of FATAL errors (i.e. ones which crash
1135 <application>Privoxy</application>) is always on and cannot be disabled.
1139 If you want to use CLF (Common Log Format), you should set <quote>debug
1140 512</quote> ONLY, do not enable anything else.
1144 Multiple <quote>debug</quote> directives, are OK - they're logical-OR'd
1152 <emphasis>debug 15 # same as setting the first 4 listed above</emphasis>
1166 <emphasis>debug 1 # URLs</emphasis>
1167 <emphasis>debug 4096 # Info</emphasis>
1168 <emphasis>debug 8192 # Errors - *we highly recommended enabling this*</emphasis>
1175 <application>Privoxy</application> normally uses
1176 <quote>multi-threading</quote>, a software technique that permits it to
1177 handle many different requests simultaneously. In some cases you may wish to
1178 disable this -- particularly if you're trying to debug a problem. The
1179 <quote>single-threaded</quote> option forces
1180 <application>Privoxy</application> to handle requests sequentially.
1181 Default: Multi-threaded mode.
1188 <emphasis>#single-threaded</emphasis>
1195 <quote>toggle</quote> allows you to temporarily disable all
1196 <application>Privoxy's</application> filtering. Just set <quote>toggle
1201 The Windows version of <application>Privoxy</application> puts an icon in
1202 the system tray, which also allows you to change this option. If you
1203 right-click on that icon (or select the <quote>Options</quote> menu), one
1204 choice is <quote>Enable</quote>. Clicking on enable toggles
1205 <application>Privoxy</application> on and off. This is useful if you want
1206 to temporarily disable <application>Privoxy</application>, e.g., to access
1207 a site that requires cookies which you would otherwise have blocked. This can also
1208 be toggled via a web browser at the <application>Privoxy</application>
1209 internal address of <ulink url="http://p.p">http://p.p</ulink> on
1214 <quote>toggle 1</quote> means <application>Privoxy</application> runs
1215 normally, <quote>toggle 0</quote> means that
1216 <application>Privoxy</application> becomes a non-anonymizing non-blocking
1217 proxy. Default: 1 (on).
1224 <emphasis>toggle 1</emphasis>
1231 For content filtering, i.e. the <quote>+filter</quote> and
1232 <quote>+deanimate-gif</quote> actions, it is necessary that
1233 <application>Privoxy</application> buffers the entire document body.
1234 This can be potentially dangerous, since a server could just keep sending
1235 data indefinitely and wait for your RAM to exhaust. With nasty consequences.
1239 The <application>buffer-limit</application> option lets you set the maximum
1240 size in Kbytes that each buffer may use. When the documents buffer exceeds
1241 this size, it is flushed to the client unfiltered and no further attempt to
1242 filter the rest of it is made. Remember that there may multiple threads
1243 running, which might require increasing the <quote>buffer-limit</quote>
1244 Kbytes <emphasis>each</emphasis>, unless you have enabled
1245 <quote>single-threaded</quote> above.
1252 <emphasis>buffer-limit 4069</emphasis>
1259 To enable the web-based <filename>default.action</filename> file editor set
1260 <application>enable-edit-actions</application> to 1, or 0 to disable. Note
1261 that you must have compiled <application>Privoxy</application> with
1262 support for this feature, otherwise this option has no effect. This
1263 internal page can be reached at <ulink
1264 url="http://p.p">http://p.p</ulink>.
1268 Security note: If this is enabled, anyone who can use the proxy
1269 can edit the actions file, and their changes will affect all users.
1270 For shared proxies, you probably want to disable this. Default: enabled.
1277 <emphasis>enable-edit-actions 1</emphasis>
1284 Allow <application>Privoxy</application> to be toggled on and off
1285 remotely, using your web browser. Set <quote>enable-remote-toggle</quote>to
1286 1 to enable, and 0 to disable. Note that you must have compiled
1287 <application>Privoxy</application> with support for this feature,
1288 otherwise this option has no effect.
1292 Security note: If this is enabled, anyone who can use the proxy can toggle
1293 it on or off (see <ulink url="http://p.p">http://p.p</ulink>), and
1294 their changes will affect all users. For shared proxies, you probably want to
1295 disable this. Default: enabled.
1302 <emphasis>enable-remote-toggle 1</emphasis>
1310 <!-- ~ End section ~ -->
1313 <!-- ~~~~~ New section ~~~~~ -->
1316 <title>Access Control List (ACL)</title>
1318 Access controls are included at the request of some ISPs and systems
1319 administrators, and are not usually needed by individual users. Please note
1320 the warnings in the FAQ that this proxy is not intended to be a substitute
1321 for a firewall or to encourage anyone to defer addressing basic security
1326 If no access settings are specified, the proxy talks to anyone that
1327 connects. If any access settings file are specified, then the proxy
1328 talks only to IP addresses permitted somewhere in this file and not
1329 denied later in this file.
1333 Summary -- if using an ACL:
1338 Client must have permission to receive service.
1343 LAST match in ACL wins.
1348 Default behavior is to deny service.
1353 The syntax for an entry in the Access Control List is:
1360 ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ]
1367 Where the individual fields are:
1374 <emphasis>ACTION</emphasis> = <quote>permit-access</quote> or <quote>deny-access</quote>
1376 <emphasis>SRC_ADDR</emphasis> = client hostname or dotted IP address
1377 <emphasis>SRC_MASKLEN</emphasis> = number of bits in the subnet mask for the source
1379 <emphasis>DST_ADDR</emphasis> = server or forwarder hostname or dotted IP address
1380 <emphasis>DST_MASKLEN</emphasis> = number of bits in the subnet mask for the target
1388 The field separator (FS) is whitespace (space or tab).
1392 IMPORTANT NOTE: If <application>Privoxy</application> is using a
1393 forwarder (see below) or a gateway for a particular destination URL, the
1394 <literal>DST_ADDR</literal> that is examined is the address of the forwarder
1395 or the gateway and <emphasis>NOT</emphasis> the address of the ultimate
1396 target. This is necessary because it may be impossible for the local
1397 <application>Privoxy</application> to determine the address of the
1398 ultimate target (that's often what gateways are used for).
1402 Here are a few examples to show how the ACL features work:
1406 <quote>localhost</quote> is OK -- no DST_ADDR implies that
1407 <emphasis>ALL</emphasis> destination addresses are OK:
1414 <emphasis>permit-access localhost</emphasis>
1421 A silly example to illustrate permitting any host on the class-C subnet with
1422 <application>Privoxy</application> to go anywhere:
1429 <emphasis>permit-access www.privoxy.com/24</emphasis>
1436 Except deny one particular IP address from using it at all:
1443 <emphasis>deny-access ident.privoxy.com</emphasis>
1450 You can also specify an explicit network address and subnet mask.
1451 Explicit addresses do not have to be resolved to be used.
1458 <emphasis>permit-access 207.153.200.0/24</emphasis>
1465 A subnet mask of 0 matches anything, so the next line permits everyone.
1472 <emphasis>permit-access 0.0.0.0/0</emphasis>
1479 Note, you <emphasis>cannot</emphasis> say:
1486 <emphasis>permit-access .org</emphasis>
1493 to allow all *.org domains. Every IP address listed must resolve fully.
1497 An ISP may want to provide a <application>Privoxy</application> that is
1498 accessible by <quote>the world</quote> and yet restrict use of some of their
1499 private content to hosts on its internal network (i.e. its own subscribers).
1500 Say, for instance the ISP owns the Class-B IP address block 123.124.0.0 (a 16
1501 bit netmask). This is how they could do it:
1508 <emphasis>permit-access 0.0.0.0/0 0.0.0.0/0</emphasis> # other clients can go anywhere
1509 # with the following exceptions:
1511 <emphasis>deny-access</emphasis> 0.0.0.0/0 123.124.0.0/16 # block all external requests for
1512 # sites on the ISP's network
1514 <emphasis>permit 0.0.0.0/0 www.my_isp.com</emphasis> # except for the ISP's main
1517 <emphasis>permit 123.124.0.0/16 0.0.0.0/0</emphasis> # the ISP's clients can go
1525 Note that if some hostnames are listed with multiple IP addresses,
1526 the primary value returned by DNS (via gethostbyname()) is used. Default:
1527 Anyone can access the proxy.
1532 <!-- ~ End section ~ -->
1535 <!-- ~~~~~ New section ~~~~~ -->
1537 <sect3 id="forwarding">
1538 <title>Forwarding</title>
1541 This feature allows chaining of HTTP requests via multiple proxies.
1542 It can be used to better protect privacy and confidentiality when
1543 accessing specific domains by routing requests to those domains
1544 to a special purpose filtering proxy such as lpwa.com. Or to use
1545 a caching proxy to speed up browsing.
1549 It can also be used in an environment with multiple networks to route
1550 requests via multiple gateways allowing transparent access to multiple
1551 networks without having to modify browser configurations.
1555 Also specified here are SOCKS proxies. <application>Privoxy</application>
1556 SOCKS 4 and SOCKS 4A. The difference is that SOCKS 4A will resolve the target
1557 hostname using DNS on the SOCKS server, not our local DNS client.
1561 The syntax of each line is:
1568 <emphasis>forward target_domain[:port] http_proxy_host[:port]</emphasis>
1569 <emphasis>forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1570 <emphasis>forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1577 If http_proxy_host is <quote>.</quote>, then requests are not forwarded to a
1578 HTTP proxy but are made directly to the web servers.
1582 Lines are checked in sequence, and the last match wins.
1586 There is an implicit line equivalent to the following, which specifies that
1587 anything not finding a match on the list is to go out without forwarding
1588 or gateway protocol, like so:
1595 <emphasis>forward .* . </emphasis># implicit
1602 In the following common configuration, everything goes to Lucent's LPWA,
1603 except SSL on port 443 (which it doesn't handle):
1610 <emphasis>forward .* lpwa.com:8000</emphasis>
1611 <emphasis>forward :443 .</emphasis>
1619 See the FAQ for instructions on how to automate the login procedure for LPWA.
1621 Some users have reported difficulties related to LPWA's use of
1622 <quote>.</quote> as the last element of the domain, and have said that this
1623 can be fixed with this:
1630 <emphasis>forward lpwa. lpwa.com:8000</emphasis>
1637 (NOTE: the syntax for specifying target_domain has changed since the
1638 previous paragraph was written -- it will not work now. More information
1643 In this fictitious example, everything goes via an ISP's caching proxy,
1644 except requests to that ISP:
1651 <emphasis>forward .* caching.myisp.net:8000</emphasis>
1652 <emphasis>forward myisp.net .</emphasis>
1659 For the @home network, we're told the forwarding configuration is this:
1667 <emphasis>forward .* proxy:8080</emphasis>
1674 Also, we're told they insist on getting cookies and JavaScript, so you should
1675 allow cookies from home.com. We consider JavaScript a potential security risk.
1676 Java need not be enabled.
1680 In this example direct connections are made to all <quote>internal</quote>
1681 domains, but everything else goes through Lucent's LPWA by way of the
1682 company's SOCKS gateway to the Internet.
1689 <emphasis>forward-socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
1690 <emphasis>forward my_company.com .</emphasis>
1697 This is how you could set up a site that always uses SOCKS but no forwarders:
1704 <emphasis>forward-socks4a .* . firewall.my_company.com:1080</emphasis>
1711 An advanced example for network administrators:
1715 If you have links to multiple ISPs that provide various special content to
1716 their subscribers, you can configure forwarding to pass requests to the
1717 specific host that's connected to that ISP so that everybody can see all
1718 of the content on all of the ISPs.
1722 This is a bit tricky, but here's an example:
1727 host-a has a PPP connection to isp-a.com. And host-b has a PPP connection to
1728 isp-b.com. host-a can run a <application>Privoxy</application> proxy with
1729 forwarding like this:
1736 <emphasis>forward .* .</emphasis>
1737 <emphasis>forward isp-b.com host-b:8118</emphasis>
1744 host-b can run a <application>Privoxy</application> proxy with forwarding
1752 <emphasis>forward .* .</emphasis>
1753 <emphasis>forward isp-a.com host-a:8118</emphasis>
1760 Now, <emphasis>anyone</emphasis> on the Internet (including users on host-a
1761 and host-b) can set their browser's proxy to <emphasis>either</emphasis>
1762 host-a or host-b and be able to browse the content on isp-a or isp-b.
1766 Here's another practical example, for University of Kent at
1767 Canterbury students with a network connection in their room, who
1768 need to use the University's Squid web cache.
1775 <emphasis>forward *. ssbcache.ukc.ac.uk:3128</emphasis> # Use the proxy, except for:
1776 <emphasis>forward .ukc.ac.uk . </emphasis> # Anything on the same domain as us
1777 <emphasis>forward * . </emphasis> # Host with no domain specified
1778 <emphasis>forward 129.12.*.* . </emphasis> # A dotted IP on our /16 network.
1779 <emphasis>forward 127.*.*.* . </emphasis> # Loopback address
1780 <emphasis>forward localhost.localdomain . </emphasis> # Loopback address
1781 <emphasis>forward www.ukc.mirror.ac.uk . </emphasis> # Specific host
1788 If you intend to chain <application>Privoxy</application> and
1789 <application>squid</application> locally, then chain as
1790 <literal>browser -> squid -> privoxy</literal> is the recommended way.
1794 Your squid configuration could then look like this (assuming that the IP
1795 address of the box is <literal>192.168.0.1</literal> ):
1802 # Define Privoxy as parent cache
1803 <!-- per feedback from user...
1804 cache_peer 127.0.0.1 8118 parent 0 no-query
1806 cache_peer 192.168.0.1 parent 8118 0 no-query
1808 # don't listen to the whole world
1809 http_port 192.168.0.1:3128
1811 # define the local lan
1812 acl mylocallan src 192.168.0.1-192.168.0.5/255.255.255.255
1814 # grant access for http to local lan
1815 http_access allow mylocallan
1817 # Define ACL for protocol FTP
1820 # Do not forward ACL FTP to privoxy
1821 always_direct allow FTP
1823 # Do not forward ACL CONNECT (https) to privoxy
1824 always_direct allow CONNECT
1826 # Forward the rest to privoxy
1827 never_direct allow all
1835 <!-- ~ End section ~ -->
1838 <!-- ~~~~~ New section ~~~~~ -->
1841 <title>Windows GUI Options</title>
1843 Removed references to Win32. HB 09/23/01
1846 <application>Privoxy</application> has a number of options specific to the
1847 Windows GUI interface:
1851 If <quote>activity-animation</quote> is set to 1, the
1852 <application>Privoxy</application> icon will animate when
1853 <quote>Privoxy</quote> is active. To turn off, set to 0.
1860 <emphasis>activity-animation 1</emphasis>
1867 If <quote>log-messages</quote> is set to 1,
1868 <application>Privoxy</application> will log messages to the console
1876 <emphasis>log-messages 1</emphasis>
1883 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1884 i.e. the amount of memory used for the log messages displayed in the
1885 console window, will be limited to <quote>log-max-lines</quote> (see below).
1889 Warning: Setting this to 0 will result in the buffer to grow infinitely and
1890 eat up all your memory!
1897 <emphasis>log-buffer-size 1</emphasis>
1904 <application>log-max-lines</application> is the maximum number of lines held
1905 in the log buffer. See above.
1912 <emphasis>log-max-lines 200</emphasis>
1919 If <quote>log-highlight-messages</quote> is set to 1,
1920 <application>Privoxy</application> will highlight portions of the log
1921 messages with a bold-faced font:
1928 <emphasis>log-highlight-messages 1</emphasis>
1935 The font used in the console window:
1942 <emphasis>log-font-name Comic Sans MS</emphasis>
1949 Font size used in the console window:
1956 <emphasis>log-font-size 8</emphasis>
1963 <quote>show-on-task-bar</quote> controls whether or not
1964 <application>Privoxy</application> will appear as a button on the Task bar
1972 <emphasis>show-on-task-bar 0</emphasis>
1979 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
1980 button will minimize <application>Privoxy</application> instead of closing
1981 the program (close with the exit option on the File menu).
1988 <emphasis>close-button-minimizes 1</emphasis>
1995 The <quote>hide-console</quote> option is specific to the MS-Win console
1996 version of <application>Privoxy</application>. If this option is used,
1997 <application>Privoxy</application> will disconnect from and hide the
2014 <!-- ~ End section ~ -->
2017 <!-- ~~~~~ New section ~~~~~ -->
2018 <sect2 id="actionsfile">
2019 <title>The Actions File</title>
2022 The <quote>default.action</quote> file (formerly
2023 <filename>actionsfile</filename> or <filename>ijb.action</filename>) is used
2024 to define what actions <application>Privoxy</application> takes, and thus
2025 determines how ad images, cookies and various other aspects of HTTP content
2026 and transactions are handled. These can be accepted or rejected for all
2027 sites, or just those sites you choose. See below for a complete list of
2031 Anything you want can blocked, including ads, banners, or just some obnoxious
2032 URL that you would rather not see. Cookies can be accepted or rejected, or
2033 accepted only during the current browser session (i.e. not written to disk).
2034 Changes to <filename>default.action</filename> should be immediately visible
2035 to <application>Privoxy</application> without the need to restart.
2039 Note that some sites may misbehave, or possibly not work at all with some
2040 actions. This may require some tinkering with the rules to get the most
2041 mileage of <application>Privoxy's</application> features, and still be
2042 able to see and enjoy just what you want to. There is no general rule of
2043 thumb on these things. There just are too many variables, and sites are
2049 The easiest way to edit the <quote>actions</quote> file is with a browser by
2050 loading <ulink url="http://p.p/">http://p.p/</ulink>, and then select
2051 <quote>Edit Actions List</quote>. A text editor can also be used.
2055 To determine which actions apply to a request, the URL of the request is
2056 compared to all patterns in this file. Every time it matches, the list of
2057 applicable actions for the URL is incrementally updated. You can trace
2058 this process by visiting <ulink
2059 url="http://p.p/show-url-info">http://p.p/show-url-info</ulink>.
2064 There are four types of lines in this file: comments (begin with a
2065 <quote>#</quote> character), actions, aliases and patterns, all of which are
2066 explained below, as well as the configuration file syntax that
2067 <application>Privoxy</application> understands.
2072 <!-- ~~~~~ New section ~~~~~ -->
2074 <title>URL Domain and Path Syntax</title>
2076 Generally, a pattern has the form <domain>/<path>, where both the
2077 <domain> and <path> part are optional. If you only specify a
2078 domain part, the <quote>/</quote> can be left out:
2082 <emphasis>www.example.com</emphasis> - is a domain only pattern and will match any request to
2083 <quote>www.example.com</quote>.
2087 <emphasis>www.example.com/</emphasis> - means exactly the same.
2091 <emphasis>www.example.com/index.html</emphasis> - matches only the single
2092 document <quote>/index.html</quote> on <quote>www.example.com</quote>.
2096 <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>,
2097 regardless of the domain. So would match any page named <quote>index.html</quote>
2102 <emphasis>index.html</emphasis> - matches nothing, since it would be
2103 interpreted as a domain name and there is no top-level domain called
2104 <quote>.html</quote>.
2108 The matching of the domain part offers some flexible options: if the
2109 domain starts or ends with a dot, it becomes unanchored at that end.
2114 <emphasis>.example.com</emphasis> - matches any domain or sub-domain that
2115 <emphasis>ENDS</emphasis> in <quote>.example.com</quote>.
2119 <emphasis>www.</emphasis> - matches any domain that <emphasis>STARTS</emphasis> with
2124 Additionally, there are wild-cards that you can use in the domain names
2125 themselves. They work pretty similar to shell wild-cards: <quote>*</quote>
2126 stands for zero or more arbitrary characters, <quote>?</quote> stands for
2127 any single character. And you can define character classes in square
2128 brackets and they can be freely mixed:
2132 <emphasis>ad*.example.com</emphasis> - matches <quote>adserver.example.com</quote>,
2133 <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>.
2137 <emphasis>*ad*.example.com</emphasis> - matches all of the above, and then some.
2141 <emphasis>.?pix.com</emphasis> - matches <quote>www.ipix.com</quote>,
2142 <quote>pictures.epix.com</quote>, <quote>a.b.c.d.e.upix.com</quote>, etc.
2146 <emphasis>www[1-9a-ez].example.com</emphasis> - matches <quote>www1.example.com</quote>,
2147 <quote>www4.example.com</quote>, <quote>wwwd.example.com</quote>,
2148 <quote>wwwz.example.com</quote>, etc., but <emphasis>not</emphasis>
2149 <quote>wwww.example.com</quote>.
2153 If <application>Privoxy</application> was compiled with
2154 <quote>pcre</quote> support (the default), Perl compatible regular expressions
2155 can be used. These are more flexible and powerful than other types
2156 of <quote>regular expressions</quote>. See the <filename>pcre/docs/</filename> directory or <quote>man
2157 perlre</quote> (also available on <ulink
2158 url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
2159 for details. A brief discussion of regular expressions is in the
2160 <link linkend="regex">Appendix</link>. For instance:
2164 <emphasis>/.*/advert[0-9]+\.jpe?g</emphasis> - would match a URL from any
2165 domain, with any path that includes <quote>advert</quote> followed
2166 immediately by one or more digits, then a <quote>.</quote> and ending in
2167 either <quote>jpeg</quote> or <quote>jpg</quote>. So we match
2168 <quote>example.com/ads/advert2.jpg</quote>, and
2169 <quote>www.example.com/ads/banners/advert39.jpeg</quote>, but not
2170 <quote>www.example.com/ads/banners/advert39.gif</quote> (no gifs in the
2175 Please note that matching in the path is case
2176 <emphasis>INSENSITIVE</emphasis> by default, but you can switch to case
2177 sensitive at any point in the pattern by using the
2178 <quote>(?-i)</quote> switch:
2182 <emphasis>www.example.com/(?-i)PaTtErN.*</emphasis> - will match only
2183 documents whose path starts with <quote>PaTtErN</quote> in
2184 <emphasis>exactly</emphasis> this capitalization.
2189 <!-- ~ End section ~ -->
2193 <!-- ~~~~~ New section ~~~~~ -->
2196 <title>Actions</title>
2198 Actions are enabled if preceded with a <quote>+</quote>, and disabled if
2199 preceded with a <quote>-</quote>. Actions are invoked by enclosing the
2200 action name in curly braces (e.g. {+some_action}), followed by a list of
2201 URLs to which the action applies. There are three classes of actions:
2209 Boolean (e.g. <quote>+/-block</quote>):
2215 <emphasis>{+name}</emphasis> # enable this action
2216 <emphasis>{-name}</emphasis> # disable this action
2226 parameterized (e.g. <quote>+/-hide-user-agent</quote>):
2232 <emphasis>{+name{param}}</emphasis> # enable action and set parameter to <quote>param</quote>
2233 <emphasis>{-name}</emphasis> # disable action
2242 Multi-value (e.g. <quote>{+/-add-header{Name: value}}</quote>, <quote>{+/-wafer{name=value}}</quote>):
2248 <emphasis>{+name{param}}</emphasis> # enable action and add parameter <quote>param</quote>
2249 <emphasis>{-name{param}}</emphasis> # remove the parameter <quote>param</quote>
2250 <emphasis>{-name}</emphasis> # disable this action totally
2261 If nothing is specified in this file, no <quote>actions</quote> are taken.
2262 So in this case <application>Privoxy</application> would just be a
2263 normal, non-blocking, non-anonymizing proxy. You must specifically
2264 enable the privacy and blocking features you need (although the
2265 provided default <filename>default.action</filename> file will
2266 give a good starting point).
2270 Later defined actions always over-ride earlier ones. So exceptions
2271 to any rules you make, should come in the latter part of the file. For
2272 multi-valued actions, the actions are applied in the order they are
2277 The list of valid <application>Privoxy</application> <quote>actions</quote> are:
2285 Add the specified HTTP header, which is not checked for validity.
2286 You may specify this many times to specify many different headers:
2292 <emphasis>+add-header{Name: value}</emphasis>
2302 Block this URL totally. In a default installation, a <quote>blocked</quote>
2303 URL will result in bright red banner that says <quote>BLOCKED</quote>,
2304 with a reason why it is being blocked, and an option to see it anyway.
2305 The page displayed for this is the <quote>blocked</quote> template
2312 <emphasis>+block</emphasis>
2322 De-animate all animated GIF images, i.e. reduce them to their last frame.
2323 This will also shrink the images considerably (in bytes, not pixels!). If
2324 the option <quote>first</quote> is given, the first frame of the animation
2325 is used as the replacement. If <quote>last</quote> is given, the last frame
2326 of the animation is used instead, which probably makes more sense for most
2327 banner animations, but also has the risk of not showing the entire last
2328 frame (if it is only a delta to an earlier frame).
2334 <emphasis>+deanimate-gifs{last}</emphasis>
2335 <emphasis>+deanimate-gifs{first}</emphasis>
2344 <quote>+downgrade</quote> will downgrade HTTP/1.1 client requests to
2345 HTTP/1.0 and downgrade the responses as well. Use this action for servers
2346 that use HTTP/1.1 protocol features that
2347 <application>Privoxy</application> doesn't handle well yet. HTTP/1.1
2348 is only partially implemented. Default is not to downgrade requests.
2354 <emphasis>+downgrade</emphasis>
2363 Many sites, like yahoo.com, don't just link to other sites. Instead, they
2364 will link to some script on their own server, giving the destination as a
2365 parameter, which will then redirect you to the final target. URLs resulting
2366 from this scheme typically look like:
2367 http://some.place/some_script?http://some.where-else.
2370 Sometimes, there are even multiple consecutive redirects encoded in the
2371 URL. These redirections via scripts make your web browsing more traceable,
2372 since the server from which you follow such a link can see where you go to.
2373 Apart from that, valuable bandwidth and time is wasted, while your browser
2374 ask the server for one redirect after the other. Plus, it feeds the
2378 The <quote>+fast-redirects</quote> option enables interception of these
2379 types of requests by <application>Privoxy</application>, who will cut off
2380 all but the last valid URL in the request and send a local redirect back to
2381 your browser without contacting the intermediate site(s).
2387 <emphasis>+fast-redirects</emphasis>
2396 Apply the filters in the <literal>section_header</literal>
2397 section of the <filename>default.filter</filename> file to the site(s).
2398 <filename>default.filter</filename> sections are grouped according to like
2399 functionality. <application>Filters</application> can be used to
2400 re-write any of the raw page content. This is a potentially a
2401 very powerful feature!
2408 <emphasis>+filter{section_header}</emphasis>
2415 Filter sections that are pre-defined in the supplied
2416 <filename>default.filter</filename> include:
2422 <emphasis>html-annoyances</emphasis>: Get rid of particularly annoying HTML abuse.
2427 <emphasis>js-annoyances</emphasis>: Get rid of particularly annoying JavaScript abuse
2432 <emphasis>no-poups</emphasis>: Kill all popups in JS and HTML
2437 <emphasis>frameset-borders</emphasis>: Give frames a border
2442 <emphasis>webbugs</emphasis>: Squish WebBugs (1x1 invisible GIFs used for user tracking)
2447 <emphasis>no-refresh</emphasis>: Automatic refresh sucks on auto-dialup lines
2452 <emphasis>fun</emphasis>: Text replacements for subversive browsing fun!
2457 <emphasis>nimda</emphasis>: Remove (virus) Nimda code.
2462 <emphasis>banners-by-size</emphasis>: Kill banners by size
2467 <emphasis>crude-parental</emphasis>: Kill all web pages that contain the words "sex" or "warez"
2476 Block any existing X-Forwarded-for header, and do not add a new one:
2482 <emphasis>+hide-forwarded</emphasis>
2491 If the browser sends a <quote>From:</quote> header containing your e-mail
2492 address, this either completely removes the header (<quote>block</quote>), or
2493 changes it to the specified e-mail address.
2499 <emphasis>+hide-from{block}</emphasis>
2500 <emphasis>+hide-from{spam@sittingduck.xqq}</emphasis>
2509 Don't send the <quote>Referer:</quote> (sic) header to the web site. You
2510 can block it, forge a URL to the same server as the request (which is
2511 preferred because some sites will not send images otherwise) or set it to a
2512 constant, user defined string of your choice.
2518 <emphasis>+hide-referer{block}</emphasis>
2519 <emphasis>+hide-referer{forge}</emphasis>
2520 <emphasis>+hide-referer{http://nowhere.com}</emphasis>
2529 Alternative spelling of <quote>+hide-referer</quote>. It has the same
2530 parameters, and can be freely mixed with, <quote>+hide-referer</quote>.
2531 (<quote>referrer</quote> is the correct English spelling, however the HTTP
2532 specification has a bug - it requires it to be spelled <quote>referer</quote>.)
2538 <emphasis>+hide-referrer{...}</emphasis>
2547 Change the <quote>User-Agent:</quote> header so web servers can't tell your
2548 browser type. Warning! This breaks many web sites. Specify the
2549 user-agent value you want. Example, pretend to be using Netscape on
2556 <emphasis>+hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)}</emphasis>
2563 Or to identify yourself explicitly as a <application>Privoxy</application> user:
2569 <emphasis>+hide-user-agent{Privoxy/1.0}</emphasis>
2574 (Don't change the version number from 1.0 - after all, why tell them?)
2581 <emphasis>+hide-user-agent{browser-type}</emphasis>
2591 Treat this URL as an image. This only matters if it's also <quote>+block</quote>ed,
2592 in which case a <quote>blocked</quote> image can be sent rather than a HTML page.
2593 See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
2594 If you want <emphasis>invisible</emphasis> ads, they should be defined as
2595 <emphasis>images</emphasis> and <emphasis>blocked</emphasis>. And also,
2596 <quote>image-blocker</quote> should be set to <quote>blank</quote>. Note you
2597 cannot treat HTML pages as images in most cases. For instance, frames
2598 require an HTML page to display. Forcing an <quote>image</quote> in this
2599 situation just will not work.
2605 <emphasis>+image</emphasis>
2613 <para> Decides what to do with URLs that end up tagged with <quote>{+block
2614 +image}</quote>, e.g an advertizement. There are five options.
2615 <quote>-image-blocker</quote> will send a HTML <quote>blocked</quote> page,
2616 usually resulting in a <quote>broken image</quote> icon.
2617 <!-- <quote>+image-blocker{logo}</quote> will send a -->
2618 <!-- <application>Privoxy</application> logo -->
2620 <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF
2621 image. And finally, <quote>+image-blocker{http://xyz.com}</quote> will send a
2622 HTTP temporary redirect to the specified image. This has the advantage of the
2623 icon being being cached by the browser, which will speed up the display.
2624 <quote>+image-blocker{pattern}</quote> will send a checkboard type pattern
2626 <!-- which scales better than the logo (which can get blocky if the browser -->
2627 <!-- enlarges it too much). -->
2633 <!-- <emphasis>+image-blocker{logo}</emphasis> -->
2634 <emphasis>+image-blocker{blank}</emphasis>
2635 <emphasis>+image-blocker{pattern}</emphasis>
2636 <emphasis>+image-blocker{http://p.p/send-banner}</emphasis>
2645 By default (i.e. in the absence of a <quote>+limit-connect</quote>
2646 action), <application>Privoxy</application> will only allow CONNECT
2647 requests to port 443, which is the standard port for https as a
2652 The CONNECT methods exists in HTTP to allow access to secure websites
2653 (https:// URLs) through proxies. It works very simply: the proxy
2654 connects to the server on the specified port, and then short-circuits
2655 its connections to the client <emphasis>and</emphasis> to the remote proxy.
2656 This can be a big security hole, since CONNECT-enabled proxies can
2657 be abused as TCP relays very easily.
2661 If you want to allow CONNECT for more ports than this, or want to forbid
2662 CONNECT altogether, you can specify a comma separated list of ports and
2663 port ranges (the latter using dashes, with the minimum defaulting to 0 and
2671 <emphasis>+limit-connect{443} # This is the default and need no be specified.</emphasis>
2672 <emphasis>+limit-connect{80,443} # Ports 80 and 443 are OK.</emphasis>
2673 <emphasis>+limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100</emphasis>
2674 <emphasis> #and above 500 are OK.</emphasis>
2684 <quote>+no-compression</quote> prevents the website from compressing the
2685 data. Some websites do this, which can be a problem for
2686 <application>Privoxy</application>, since <quote>+filter</quote>,
2687 <quote>+no-popup</quote> and <quote>+gif-deanimate</quote> will not work on
2688 compressed data. This will slow down connections to those websites,
2689 though. Default is <quote>no-compression</quote> is turned on.
2696 <emphasis>+nocompression</emphasis>
2705 If the website sets cookies, <quote>no-cookies-keep</quote> will make sure
2706 they are erased when you exit and restart your web browser. This makes
2707 profiling cookies useless, but won't break sites which require cookies so
2708 that you can log in for transactions. Default: on.
2714 <emphasis>+no-cookies-keep</emphasis>
2723 Prevent the website from reading cookies:
2729 <emphasis>+no-cookies-read</emphasis>
2738 Prevent the website from setting cookies:
2744 <emphasis>+no-cookies-set</emphasis>
2753 Filter the website through a built-in filter to disable those obnoxious
2754 JavaScript pop-up windows via window.open(), etc. The two alternative
2755 spellings are equivalent.
2761 <emphasis>+no-popup</emphasis>
2762 <emphasis>+no-popups</emphasis>
2771 This action only applies if you are using a <filename>jarfile</filename>
2772 for saving cookies. It sends a cookie to every site stating that you do not
2773 accept any copyright on cookies sent to you, and asking them not to track
2774 you. Of course, this is a (relatively) unique header they could use to
2781 <emphasis>+vanilla-wafer</emphasis>
2790 This allows you to add an arbitrary cookie. It can be specified multiple
2791 times in order to add as many cookies as you like.
2797 <emphasis>+wafer{name=value}</emphasis>
2808 The meaning of any of the above is reversed by preceding the action with a
2809 <quote>-</quote>, in place of the <quote>+</quote>.
2817 Turn off cookies by default, then allow a few through for specified sites:
2824 # Turn off all persistent cookies
2825 { +no-cookies-read }
2827 # Allow cookies for this browser session ONLY
2828 { +no-cookies-keep }
2830 # Exceptions to the above, sites that benefit from persistent cookies
2831 { -no-cookies-read }
2833 { -no-cookies-keep }
2840 # Alternative way of saying the same thing
2841 {-no-cookies-set -no-cookies-read -no-cookies-keep}
2850 Now turn off <quote>fast redirects</quote>, and then we allow two exceptions:
2860 # Reverse it for these two sites, which don't work right without it.
2862 www.ukc.ac.uk/cgi-bin/wac\.cgi\?
2870 Turn on page filtering according to rules in the defined sections
2871 of <filename>refilterfile</filename>, and make one exception for
2879 # Run everything through the filter file, using only the
2880 # specified sections:
2881 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}\
2882 +filter{webbugs} +filter{nimda} +filter{banners-by-size}
2884 # Then disable filtering of code from sourceforge!
2886 .cvs.sourceforge.net
2893 Now some URLs that we want <quote>blocked</quote> (normally generates
2894 the <quote>blocked</quote> banner). Many of these use regular expressions
2895 that will expand to match multiple URLs:
2904 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
2905 /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/])
2906 /.*/(ng)?adclient\.cgi
2907 /.*/(plain|live|rotate)[-_.]?ads?/
2908 /.*/(sponsor)s?[0-9]?/
2909 /.*/_?(plain|live)?ads?(-banners)?/
2911 /.*/ad(sdna_image|gifs?)/
2912 /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
2916 /.*/adv((er)?ts?|ertis(ing|ements?))?/
2920 /.*/cgi-bin/centralad/getimage
2921 /.*/images/addver\.gif
2922 /.*/images/marketing/.*\.(gif|jpe?g)
2926 /.*/sponsors?[0-9]?/
2927 /.*/advert[0-9]+\.jpg
2934 /graphics/defaultAd/
2936 /image\.ng/transactionID
2937 /images/.*/.*_anim\.gif # alvin brattli
2938 /ip_img/.*\.(gif|jpe?g)
2942 /cgi-bin/nph-adclick.exe/
2943 /.*/Image/BannerAdvertising/
2945 /.*/adlib/server\.cgi
2953 Note that many of these actions have the potential to cause a page to
2954 misbehave, possibly even not to display at all. There are many ways
2955 a site designer may choose to design his site, and what HTTP header
2956 content he may depend on. There is no way to have hard and fast rules
2957 for all sites. See the <link linkend="ACTIONSANAT">Appendix</link>
2958 for a brief example on troubleshooting actions.
2964 <!-- ~ End section ~ -->
2967 <!-- ~~~~~ New section ~~~~~ -->
2969 <title>Aliases</title>
2971 Custom <quote>actions</quote>, known to <application>Privoxy</application>
2972 as <quote>aliases</quote>, can be defined by combining other <quote>actions</quote>.
2973 These can in turn be invoked just like the built-in <quote>actions</quote>.
2974 Currently, an alias can contain any character except space, tab, <quote>=</quote>,
2975 <quote>{</quote> or <quote>}</quote>. But please use only <quote>a</quote>-
2976 <quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
2977 <quote>-</quote>. Alias names are not case sensitive, and
2978 <emphasis>must be defined before anything</emphasis> else in the
2979 <filename>default.action</filename>file! And there can only be one set of
2980 <quote>aliases</quote> defined.
2984 Now let's define a few aliases:
2991 # Useful customer aliases we can use later. These must come first!
2993 +no-cookies = +no-cookies-set +no-cookies-read
2994 -no-cookies = -no-cookies-set -no-cookies-read
2995 fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups
2996 shop = -no-cookies -filter -fast-redirects
2997 +imageblock = +block +image
2999 #For people who don't like to type too much: ;-)
3002 c2 = -no-cookies-set +no-cookies-read
3003 c3 = +no-cookies-set -no-cookies-read
3004 #... etc. Customize to your heart's content.
3011 Some examples using our <quote>shop</quote> and <quote>fragile</quote>
3019 # These sites are very complex and require
3020 # minimal interference.
3022 .office.microsoft.com
3023 .windowsupdate.microsoft.com
3026 # Shopping sites - still want to block ads.
3029 .worldpay.com # for quietpc.com
3033 # These shops require pop-ups
3043 The <quote>shop</quote> and <quote>fragile</quote> aliases are often used for
3044 <quote>problem</quote> sites that require most actions to be disabled
3045 in order to function properly.
3052 <!-- ~ End section ~ -->
3055 <!-- ~~~~~ New section ~~~~~ -->
3056 <sect2 id="filterfile">
3057 <title>The Filter File</title>
3059 Any web page can be dynamically modified with the filter file. This
3060 modification can be removal, or re-writing, of any web page content,
3061 including tags and non-visible content. The default filter file is
3062 <filename>default.filter</filename>, located in the config directory.
3066 This is potentially a very powerful feature, and requires knowledge of both
3067 <quote>regular expression</quote> and HTML in order create custom
3068 filters. But, there are a number of useful filters included with
3069 <application>Privoxy</application> for many common situations.
3073 The included example file is divided into sections. Each section begins
3074 with the <literal>FILTER</literal> keyword, followed by the identifier
3075 for that section, e.g. <quote>FILTER: webbugs</quote>. Each section performs
3076 a similar type of filtering, such as <quote>html-annoyances</quote>.
3080 This file uses regular expressions to alter or remove any string in the
3081 target page. The expressions can only operate on one line at a time. Some
3082 examples from the included default <filename>default.filter</filename>:
3086 Stop web pages from displaying annoying messages in the status bar by
3087 deleting such references:
3094 FILTER: html-annoyances
3096 # New browser windows should be resizeable and have a location and status
3099 s/resizable="?(no|0)"?/resizable=1/ig s/noresize/yesresize/ig
3100 s/location="?(no|0)"?/location=1/ig s/status="?(no|0)"?/status=1/ig
3101 s/scrolling="?(no|0|Auto)"?/scrolling=1/ig
3102 s/menubar="?(no|0)"?/menubar=1/ig
3104 # The <BLINK> tag was a crime!
3106 s*<blink>|</blink>**ig
3110 #s/framespacing="?(no|0)"?//ig
3111 #s/margin(height|width)=[0-9]*//gi
3118 Just for kicks, replace any occurrence of <quote>Microsoft</quote> with
3119 <quote>MicroSuck</quote>, and have a little fun with topical buzzwords:
3128 s/microsoft(?!.com)/MicroSuck/ig
3132 s/industry-leading|cutting-edge|award-winning/<font color=red><b>BINGO!</b></font>/ig
3139 Kill those pesky little web-bugs:
3146 # webbugs: Squish WebBugs (1x1 invisible GIFs used for user tracking)
3149 s/<img\s+[^>]*?(width|height)\s*=\s*['"]?1\D[^>]*?(width|height)\s*=\s*['"]?1(\D[^>]*?)?>/<!-- Squished WebBug -->/sig
3157 <!-- ~ End section ~ -->
3161 <!-- ~~~~~ New section ~~~~~ -->
3164 <title>Templates</title>
3166 When <application>Privoxy</application> displays one of its internal
3167 pages, such as a 404 Not Found error page, it uses the appropriate template.
3168 On Linux, BSD, and Unix, these are located in
3169 <filename>/etc/privoxy/templates</filename> by default. These may be
3170 customized, if desired.
3173 The default <quote>Blocked</quote> banner page with the bright red top
3174 banner, is called just <quote><filename>blocked</filename></quote>. This
3175 may be customized or replaced with something else if desired.
3182 <!-- ~ End section ~ -->
3186 <!-- ~~~~~ New section ~~~~~ -->
3188 <sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
3191 We value your feedback. However, to provide you with the best support,
3196 <listitem><para>Use the <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=211118">Sourceforge support forum</ulink> to get
3197 help.</para></listitem>
3199 <listitem><para>Submit bugs only thru our <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">Sourceforge bug
3203 Make sure that the bug has not already been submitted. Please try to
3204 verify that it is a <application>Privoxy</application> bug, and not a
3205 browser or site bug first. If you are using your own custom configuration,
3206 please try the stock configs to see if the problem is a configuration
3207 related bug. And if not using the latest development snapshot, please try
3208 the latest one. Or even better, CVS sources. Please be sure to include the
3209 <application>Privoxy</application>/<application>Junkbuster</application>
3210 version, platform, browser, any pertinent log data, any other relevant
3211 details (please be specific) and, if possible, some way to reproduce the
3216 <listitem><para>Submit feature requests only thru our <ulink
3217 url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">Sourceforge feature request forum</ulink>.</para></listitem>
3225 For any other issues, feel free to use the <ulink url="http://sourceforge.net/mail/?group_id=11118">mailing lists</ulink>.
3229 Anyone interested in actively participating in development and related
3230 discussions can join the appropriate mailing list
3231 <ulink url="http://sourceforge.net/mail/?group_id=11118">here</ulink>.
3232 Archives are available here too.
3238 <!-- ~~~~~ New section ~~~~~ -->
3239 <sect1 id="copyright"><title>Copyright and History</title>
3242 <title>License</title>
3244 <application>Privoxy</application> is free software; you can
3245 redistribute it and/or modify it under the terms of the GNU General Public
3247 <informalfigure float="0">
3250 <imagedata fileref="gnu.jpg" format="jpg">
3253 <phrase>GNU's Pet GNU</phrase>
3258 License as published by the Free Software Foundation; either version 2 of the
3259 License, or (at your option) any later version.
3264 This program is distributed in the hope that it will be useful, but WITHOUT
3265 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
3266 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
3267 details, which is available from the Free Software Foundation,
3268 Inc, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
3272 You should have received a copy of the <ulink
3273 url="http://www.gnu.org/copyleft/gpl.html">GNU General Public License</ulink>
3274 along with this program; if not, write to the Free Software Foundation, Inc.,
3275 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
3280 <!-- ~ End section ~ -->
3283 <!-- ~~~~~ New section ~~~~~ -->
3285 <sect2 id="history">
3286 <title>History</title>
3288 <application>Privoxy</application> is evolved, and derived from,
3289 <application>the Internet Junkbuster</application>, with many
3290 improvments and enhancements over the original.
3294 <application>Junkbuster</application> was originally written by Anonymous
3296 url="http://www.junkbusters.com">Junkbuster's
3297 Corporation</ulink>, and was released as free open-source software under the
3298 GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
3299 Waldherr</ulink> made many improvements, and started the <ulink
3300 url="http://sourceforge.net/projects/ijbswa/">SourceForge project
3301 Privoxy</ulink> to rekindle development. There are now several active
3302 developers contributing. The last stable release of
3303 <application>Junkbuster</application> was v2.0.2, which has now
3311 <!-- ~~~~~ New section ~~~~~ -->
3312 <sect1 id="seealso"><title>See Also</title>
3314 Include seealso.sgml:
3322 <!-- ~~~~~ New section ~~~~~ -->
3323 <sect1 id="appendix"><title>Appendix</title>
3326 <!-- ~~~~~ New section ~~~~~ -->
3328 <title>Regular Expressions</title>
3330 <application>Privoxy</application> can use <quote>regular expressions</quote>
3331 in various config files. Assuming support for <quote>pcre</quote> (Perl
3332 Compatible Regular Expressions) is compiled in, which is the default. Such
3333 configuration directives do not require regular expressions, but they can be
3334 used to increase flexibility by matching a pattern with wild-cards against
3339 If you are reading this, you probably don't understand what <quote>regular
3340 expressions</quote> are, or what they can do. So this will be a very brief
3341 introduction only. A full explanation would require a book ;-)
3345 <quote>Regular expressions</quote> is a way of matching one character
3346 expression against another to see if it matches or not. One of the
3347 <quote>expressions</quote> is a literal string of readable characters
3348 (letter, numbers, etc), and the other is a complex string of literal
3349 characters combined with wild-cards, and other special characters, called
3350 meta-characters. The <quote>meta-characters</quote> have special meanings and
3351 are used to build the complex pattern to be matched against. Perl Compatible
3352 Regular Expressions is an enhanced form of the regular expression language
3353 with backward compatibility.
3357 To make a simple analogy, we do something similar when we use wild-card
3358 characters when listing files with the <command>dir</command> command in DOS.
3359 <literal>*.*</literal> matches all filenames. The <quote>special</quote>
3360 character here is the asterisk which matches any and all characters. We can be
3361 more specific and use <literal>?</literal> to match just individual
3362 characters. So <quote>dir file?.text</quote> would match
3363 <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
3364 matching, using a similar technique to <quote>regular expressions</quote>!
3368 Regular expressions do essentially the same thing, but are much, much more
3369 powerful. There are many more <quote>special characters</quote> and ways of
3370 building complex patterns however. Let's look at a few of the common ones,
3371 and then some examples:
3376 <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
3377 <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
3383 <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
3390 <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
3397 <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
3404 <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
3405 the following character should be taken literally. This is used where one of the
3406 special characters (e.g. <quote>.</quote>) needs to be taken literally and
3407 not as a special meta-character.
3413 <emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
3414 any of the enclosed characters are encountered.
3420 <emphasis>()</emphasis> - parentheses are used to group a sub-expression,
3421 or multiple sub-expressions.
3427 <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
3428 <quote>or</quote> conditional statement. A match is successful if the
3429 sub-expression on either side of <quote>|</quote> matches.
3435 <emphasis>s/string1/string2/g</emphasis> - This is used to rewrite strings of text.
3436 <quote>string1</quote> is replaced by <quote>string2</quote> in this
3442 These are just some of the ones you are likely to use when matching URLs with
3443 <application>Privoxy</application>, and is a long way from a definitive
3444 list. This is enough to get us started with a few simple examples which may
3445 be more illuminating:
3449 <emphasis><literal>/.*/banners/.*</literal></emphasis> - A simple example
3450 that uses the common combination of <quote>.</quote> and <quote>*</quote> to
3451 denote any character, zero or more times. In other words, any string at all.
3452 So we start with a literal forward slash, then our regular expression pattern
3453 (<quote>.*</quote>) another literal forward slash, the string
3454 <quote>banners</quote>, another forward slash, and lastly another
3455 <quote>.*</quote>. We are building
3456 a directory path here. This will match any file with the path that has a
3457 directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
3458 any characters, and this could conceivably be more forward slashes, so it
3459 might expand into a much longer looking path. For example, this could match:
3460 <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
3461 <quote>/banners/annoying.html</quote>, or almost an infinite number of other
3462 possible combinations, just so it has <quote>banners</quote> in the path
3467 A now something a little more complex:
3471 <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
3472 We have several literal forward slashes again (<quote>/</quote>), so we are
3473 building another expression that is a file path statement. We have another
3474 <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
3475 it matches our expression. The only true literal that <emphasis>must
3476 match</emphasis> our pattern is <application>adv</application>, together with
3477 the forward slashes. What comes after the <quote>adv</quote> string is the
3482 Remember the <quote>?</quote> means the preceding expression (either a
3483 literal character or anything grouped with <quote>(...)</quote> in this case)
3484 can exist or not, since this means either zero or one match. So
3485 <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
3486 individual sub-expressions: <quote>(er)</quote>,
3487 <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
3488 means <quote>or</quote>. We have two of those. For instance,
3489 <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
3490 <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
3491 attempt at matching as many variations of <quote>advertisement</quote>, and
3492 similar, as possible. So this would expand to match just <quote>adv</quote>,
3493 or <quote>advert</quote>, or <quote>adverts</quote>, or
3494 <quote>advertising</quote>, or <quote>advertisement</quote>, or
3495 <quote>advertisements</quote>. You get the idea. But it would not match
3496 <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
3497 changing our regular expression to:
3498 <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
3503 <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
3504 another path statement with forward slashes. Anything in the square brackets
3505 <quote>[]</quote> can be matched. This is using <quote>0-9</quote> as a
3506 shorthand expression to mean any digit one through nine. It is the same as
3507 saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
3508 means one or more of the preceding expression must be included. The preceding
3509 expression here is what is in the square brackets -- in this case, any digit
3510 one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
3511 This includes a <quote>|</quote>, so this needs to match the expression on
3512 either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
3513 side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
3514 since the <quote>?</quote> means the letter <quote>e</quote> is optional and
3515 can be matched once or not at all. So we are building an expression here to
3516 match image GIF or JPEG type image file. It must include the literal
3517 string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
3518 (which is now a literal, and not a special character, since it is escaped
3519 with <quote>\</quote>), and lastly either <quote>gif</quote>, or
3520 <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
3521 include: <quote>//advert1.jpg</quote>,
3522 <quote>/nasty/ads/advert1234.gif</quote>,
3523 <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
3524 <quote>advert1.gif</quote> (no leading slash), or
3525 <quote>/adverts232.jpg</quote> (the expression does not include an
3526 <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
3527 in the expression anywhere).
3531 <emphasis><literal>s/microsoft(?!.com)/MicroSuck/i</literal></emphasis> - This is
3532 a substitution. <quote>MicroSuck</quote> will replace any occurrence of
3533 <quote>microsoft</quote>. The <quote>i</quote> at the end of the expression
3534 means ignore case. The <quote>(?!.com)</quote> means
3535 the match should fail if <quote>microsoft</quote> is followed by
3536 <quote>.com</quote>. In other words, this acts like a <quote>NOT</quote>
3537 modifier. In case this is a hyperlink, we don't want to break it ;-).
3541 We are barely scratching the surface of regular expressions here so that you
3542 can understand the default <application>Privoxy</application>
3543 configuration files, and maybe use this knowledge to customize your own
3544 installation. There is much, much more that can be done with regular
3545 expressions. Now that you know enough to get started, you can learn more on
3550 More reading on Perl Compatible Regular expressions:
3551 <ulink url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>
3556 <!-- ~ End section ~ -->
3559 <!-- ~~~~~ New section ~~~~~ -->
3561 <title><application>Privoxy</application>'s Internal Pages</title>
3564 Since <application>Privoxy</application> proxies each requested
3565 web page, it is easy for <application>Privoxy</application> to
3566 trap certain special URLs. In this way, we can talk directly to
3567 <application>Privoxy</application>, and see how it is
3568 configured, see how our rules are being applied, change these
3569 rules and other configuration options, and even turn
3570 <application>Privoxy's</application> filtering off, all with
3576 The URLs listed below are the special ones that allow direct access
3577 to <application>Privoxy</application>. Of course,
3578 <application>Privoxy</application> must be running to access these. If
3579 not, you will get a friendly error message. Internet access is not
3592 <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
3596 Alternately, this may be reached at <ulink
3597 url="http://p.p/">http://p.p/</ulink>, but this
3598 variation may not work as reliably as the above in some configurations.
3604 Show information about the current configuration:
3608 <ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
3615 Show the source code version numbers:
3619 <ulink url="http://config.privoxy.org/show-version">http://config.privoxy.org/show-version</ulink>
3626 Show the client's request headers:
3630 <ulink url="http://config.privoxy.org/show-request">http://config.privoxy.org/show-request</ulink>
3637 Show which actions apply to a URL and why:
3641 <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
3648 Toggle Privoxy on or off. In this case, <quote>Privoxy</quote> continues
3649 to run, but only as a pass-through proxy, with no actions taking place:
3653 <ulink url="http://config.privoxy.org/toggle">http://config.privoxy.org/toggle</ulink>
3657 Short cuts. Turn off, then on:
3661 <ulink url="http://config.privoxy.org/toggle?set=disable">http://config.privoxy.org/toggle?set=disable</ulink>
3666 <ulink url="http://config.privoxy.org/toggle?set=enable">http://config.privoxy.org/toggle?set=enable</ulink>
3673 Edit the actions list file:
3677 <ulink url="http://config.privoxy.org/edit-actions">http://config.privoxy.org/edit-actions</ulink>
3686 These may be bookmarked for quick reference.
3690 <sect3 id="bookmarklets">
3691 <title>Bookmarklets</title>
3693 Here are some bookmarklets to allow you to easily access a
3694 <quote>mini</quote> version of this page. They are designed for MS Internet
3695 Explorer, but should work equally well in Netscape, Mozilla, and other
3696 browsers which support JavaScript. They are designed to run directly from
3697 your bookmarks - not by clicking the links below (although that will work for
3701 To save them, right-click the link and choose <quote>Add to Favorites</quote>
3702 (IE) or <quote>Add Bookmark</quote> (Netscape). You will get a warning that
3703 the bookmark <quote>may not be safe</quote> - just click OK. Then you can run the
3704 Bookmarklet directly from your favourites/bookmarks. For even faster access,
3705 you can put them on the <quote>Links</quote> bar (IE) or the <quote>Personal
3706 Toolbar</quote> (Netscape), and run them with a single click.
3714 <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>
3720 <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>
3726 <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)
3732 <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>
3740 Credit: The site which gave me the general idea for these bookmarklets is
3741 <ulink url="http://www.bookmarklets.com">www.bookmarklets.com</ulink>. They
3742 have more information about bookmarklets.
3751 <!-- ~~~~~ New section ~~~~~ -->
3752 <sect2 id="actionsanat">
3753 <title>Anatomy of an Action</title>
3756 The way <application>Privoxy</application> applies <quote>actions</quote>
3757 and <quote>filters</quote> to any given URL can be complex, and not always so
3758 easy to understand what is happening. And sometimes we need to be able to
3759 <emphasis>see</emphasis> just what <application>Privoxy</application> is
3760 doing. Especially, if something <application>Privoxy</application> is doing
3761 is causing us a problem inadvertantly. It can be a little daunting to look at
3762 the actions and filters files themselves, since they tend to be filled with
3763 <quote>regular expressions</quote> whose consequences are not always
3764 so obvious. <application>Privoxy</application> provides the
3765 <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
3766 page that can show us very specifically how <application>actions</application>
3767 are being applied to any given URL. This is a big help for troubleshooting.
3771 First, enter one URL (or partial URL) at the prompt, and then
3772 <application>Privoxy</application> will tell us
3773 how the current configuration will handle it. This will not
3774 help with filtering effects from the <filename>default.filter</filename> file! It
3775 also will not tell you about any other URLs that may be embedded within the
3776 URL you are testing. For instance, images such as ads are expressed as URLs
3777 within the raw page source of HTML pages. So you will only get info for the
3778 actual URL that is pasted into the prompt area -- not any sub-URLs. If you
3779 want to know about embedded URLs like ads, you will have to dig those out of
3780 the HTML source. Use your browser's <quote>View Page Source</quote> option
3785 Let's look at an example, <ulink url="http://google.com">google.com</ulink>,
3786 one section at a time:
3791 System default actions:
3793 { -add-header -block -deanimate-gifs -downgrade -fast-redirects -filter
3794 -hide-forwarded -hide-from -hide-referer -hide-user-agent -image
3795 -image-blocker -limit-connect -no-compression -no-cookies-keep
3796 -no-cookies-read -no-cookies-set -no-popups -vanilla-wafer -wafer }
3802 This is the top section, and only tells us of the compiled in defaults. This
3803 is basically what <application>Privoxy</application> would do if there
3804 were not any <quote>actions</quote> defined, i.e. it does nothing. Every action
3805 is disabled. This is not particularly informative for our purposes here. OK,
3812 Matches for http://google.com:
3814 { -add-header -block +deanimate-gifs -downgrade +fast-redirects
3815 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
3816 +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
3817 +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
3818 -hide-user-agent -image +image-blocker{blank} +no-compression
3819 +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups
3820 -vanilla-wafer -wafer }
3823 { -no-cookies-keep -no-cookies-read -no-cookies-set }
3833 This is much more informative, and tells us how we have defined our
3834 <quote>actions</quote>, and which ones match for our example,
3835 <quote>google.com</quote>. The first grouping shows our default
3836 settings, which would apply to all URLs. If you look at your <quote>actions</quote>
3837 file, this would be the section just below the <quote>aliases</quote> section
3838 near the top. This applies to all URLs as signified by the single forward
3839 slash -- <quote>/</quote>.
3844 These are the default actions we have enabled. But we can define additional
3845 actions that would be exceptions to these general rules, and then list
3846 specific URLs that these exceptions would apply to. Last match wins.
3847 Just below this then are two explict matches for <quote>.google.com</quote>.
3848 The first is negating our various cookie blocking actions (i.e. we will allow
3849 cookies here). The second is allowing <quote>fast-redirects</quote>. Note
3850 that there is a leading dot here -- <quote>.google.com</quote>. This will
3851 match any hosts and sub-domains, in the google.com domain also, such as
3852 <quote>www.google.com</quote>. So, apparently, we have these actions defined
3853 somewhere in the lower part of our actions file, and
3854 <quote>google.com</quote> is referenced in these sections.
3859 And now we pull it altogether in the bottom section and summarize how
3860 <application>Privoxy</application> is appying all its <quote>actions</quote>
3861 to <quote>google.com</quote>:
3870 -add-header -block -deanimate-gifs -downgrade -fast-redirects
3871 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
3872 +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
3873 +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
3874 -hide-user-agent -image +image-blocker{blank} -limit-connect +no-compression
3875 -no-cookies-keep -no-cookies-read -no-cookies-set +no-popups -vanilla-wafer
3882 Now another example, <quote>ad.doubleclick.net</quote>:
3901 We'll just show the interesting part here, the explicit matches. It is
3902 matched three different times. Each as an <quote>+block +image</quote>,
3903 which is the expanded form of one of our aliases that had been defined as:
3904 <quote>+imageblock</quote>. (<quote>Aliases</quote> are defined in the
3905 first section of the actions file and typically used to combine more
3910 Any one of these would have done the trick and blocked this as an unwanted
3911 image. This is unnecessarily redundant since the last case effectively
3912 would also cover the first. No point in taking chances with these guys
3913 though ;-) Note that if you want an ad or obnoxious
3914 URL to be invisible, it should be defined as <quote>ad.doubleclick.net</quote>
3915 is done here -- as both a <quote>+block</quote> <emphasis>and</emphasis> an
3916 <quote>+image</quote>. The custom alias <quote>+imageblock</quote> does this
3921 One last example. Let's try <quote>http://www.rhapsodyk.net/adsl/HOWTO/</quote>.
3922 This one is giving us problems. We are getting a blank page. Hmmm...
3928 Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
3930 { -add-header -block +deanimate-gifs -downgrade +fast-redirects
3931 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
3932 +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
3933 +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
3934 -hide-user-agent -image +image-blocker{blank} +no-compression
3935 +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups
3936 -vanilla-wafer -wafer }
3946 Ooops, the <quote>/adsl/</quote> is matching <quote>/ads</quote>! But
3947 we did not want this at all! Now we see why we get the blank page. We could
3948 now add a new action below this that explictly does <emphasis>not</emphasis>
3949 block (-block) pages with <quote>adsl</quote>. There are various ways to
3950 handle such exceptions. Example:
3963 Now the page displays ;-) Be sure to flush your browser's caches when
3964 making such changes. Or, try using <literal>Shift+Reload</literal>.
3969 But now what about a situation where we get no explicit matches like
3984 That actually was very telling and pointed us quickly to where the problem
3985 was. If you don't get this kind of match, then it means one of the default
3986 rules in the first section is causing the problem. This would require some
3987 guesswork, and maybe a little trial and error to isolate the offending rule.
3988 One likely cause would be one of the <quote>{+filter}</quote> actions. Try
3989 adding the URL for the site to one of aliases that turn off <quote>+filter</quote>:
3997 .worldpay.com # for quietpc.com
4006 <quote>{shop}</quote> is an <quote>alias</quote> that expands to
4007 <quote>{ -filter -no-cookies -no-cookies-keep }</quote>. Or you could do
4008 your own exception to negate filtering:
4022 <quote>{fragile}</quote> is an alias that disables most actions. This can be
4023 used as a last resort for problem sites. Remember to flush caches! If this
4024 still does not work, you will have to go through the remaining actions one by
4025 one to find which one(s) is causing the problem.
4034 This program is free software; you can redistribute it
4035 and/or modify it under the terms of the GNU General
4036 Public License as published by the Free Software
4037 Foundation; either version 2 of the License, or (at
4038 your option) any later version.
4040 This program is distributed in the hope that it will
4041 be useful, but WITHOUT ANY WARRANTY; without even the
4042 implied warranty of MERCHANTABILITY or FITNESS FOR A
4043 PARTICULAR PURPOSE. See the GNU General Public
4044 License for more details.
4046 The GNU General Public License should be included with
4047 this file. If not, you can view it at
4048 http://www.gnu.org/copyleft/gpl.html
4049 or write to the Free Software Foundation, Inc., 59
4050 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
4052 $Log: user-manual.sgml,v $
4053 Revision 1.64 2002/04/03 03:53:43 hal9
4054 A few minor bug fixes, and touch ups. Ready for review.
4056 Revision 1.63 2002/04/01 16:24:49 hal9
4057 Define entities to include boilerplate text. See doc/source/*.
4059 Revision 1.62 2002/03/30 04:15:53 hal9
4060 - Fix privoxy.org/config links.
4061 - Paste in Bookmarklets from Toggle page.
4062 - Move Quickstart nearer top, and minor rework.
4064 Revision 1.61 2002/03/29 01:31:08 hal9
4067 Revision 1.60 2002/03/27 01:57:34 hal9
4068 Added more to Anatomy section.
4070 Revision 1.59 2002/03/27 00:54:33 hal9
4071 Touch up intro for new name.
4073 Revision 1.58 2002/03/26 22:29:55 swa
4074 we have a new homepage!
4076 Revision 1.57 2002/03/24 20:33:30 hal9
4077 A few minor catch ups with name change.
4079 Revision 1.56 2002/03/24 16:17:06 swa
4080 configure needs to be generated.
4082 Revision 1.55 2002/03/24 16:08:08 swa
4083 we are too lazy to make a block-built
4084 privoxy logo. hence removed the option.
4086 Revision 1.54 2002/03/24 15:46:20 swa
4087 name change related issue.
4089 Revision 1.53 2002/03/24 11:51:00 swa
4090 name change. changed filenames.
4092 Revision 1.52 2002/03/24 11:01:06 swa
4095 Revision 1.51 2002/03/23 15:13:11 swa
4096 renamed every reference to the old name with foobar.
4097 fixed "application foobar application" tag, fixed
4098 "the foobar" with "foobar". left junkbustser in cvs
4099 comments and remarks to history untouched.
4101 Revision 1.50 2002/03/23 05:06:21 hal9
4104 Revision 1.49 2002/03/21 17:01:05 hal9
4105 New section in Appendix.
4107 Revision 1.48 2002/03/12 06:33:01 hal9
4108 Catching up to Andreas and re_filterfile changes.
4110 Revision 1.47 2002/03/11 13:13:27 swa
4111 correct feedback channels
4113 Revision 1.46 2002/03/10 00:51:08 hal9
4114 Added section on JB internal pages in Appendix.
4116 Revision 1.45 2002/03/09 17:43:53 swa
4119 Revision 1.44 2002/03/09 17:08:48 hal9
4120 New section on Jon's actions file editor, and move some stuff around.
4122 Revision 1.43 2002/03/08 00:47:32 hal9
4123 Added imageblock{pattern}.
4125 Revision 1.42 2002/03/07 18:16:55 swa
4128 Revision 1.41 2002/03/07 16:46:43 hal9
4129 Fix a few markup problems for jade.
4131 Revision 1.40 2002/03/07 16:28:39 swa
4132 provide correct feedback channels
4134 Revision 1.39 2002/03/06 16:19:28 hal9
4135 Note on perceived filtering slowdown per FR.
4137 Revision 1.38 2002/03/05 23:55:14 hal9
4138 Stupid I did it again. Double hyphen in comment breaks jade.
4140 Revision 1.37 2002/03/05 23:53:49 hal9
4141 jade barfs on '- -' embedded in comments. - -user option broke it.
4143 Revision 1.36 2002/03/05 22:53:28 hal9
4144 Add new - - user option.
4146 Revision 1.35 2002/03/05 00:17:27 hal9
4147 Added section on command line options.
4149 Revision 1.34 2002/03/04 19:32:07 oes
4150 Changed default port to 8118
4152 Revision 1.33 2002/03/03 19:46:13 hal9
4153 Emphasis on where/how to report bugs, etc
4155 Revision 1.32 2002/03/03 09:26:06 joergs
4156 AmigaOS changes, config is now loaded from PROGDIR: instead of
4157 AmiTCP:db/junkbuster/ if no configuration file is specified on the
4160 Revision 1.31 2002/03/02 22:45:52 david__schmidt
4163 Revision 1.30 2002/03/02 22:00:14 hal9
4164 Updated 'New Features' list. Ran through spell-checker.
4166 Revision 1.29 2002/03/02 20:34:07 david__schmidt
4167 Update OS/2 build section
4169 Revision 1.28 2002/02/24 14:34:24 jongfoster
4170 Formatting changes. Now changing the doctype to DocBook XML 4.1
4171 will work - no other changes are needed.
4173 Revision 1.27 2002/01/11 14:14:32 hal9
4174 Added a very short section on Templates
4176 Revision 1.26 2002/01/09 20:02:50 hal9
4177 Fix bug re: auto-detect config file changes.
4179 Revision 1.25 2002/01/09 18:20:30 hal9
4180 Touch ups for *.action files.
4182 Revision 1.24 2001/12/02 01:13:42 hal9
4185 Revision 1.23 2001/12/02 00:20:41 hal9
4186 Updates for recent changes.
4188 Revision 1.22 2001/11/05 23:57:51 hal9
4189 Minor update for startup now daemon mode.
4191 Revision 1.21 2001/10/31 21:11:03 hal9
4192 Correct 2 minor errors
4194 Revision 1.18 2001/10/24 18:45:26 hal9
4195 *** empty log message ***
4197 Revision 1.17 2001/10/24 17:10:55 hal9
4198 Catching up with Jon's recent work, and a few other things.
4200 Revision 1.16 2001/10/21 17:19:21 swa
4201 wrong url in documentation
4203 Revision 1.15 2001/10/14 23:46:24 hal9
4204 Various minor changes. Fleshed out SEE ALSO section.
4206 Revision 1.13 2001/10/10 17:28:33 hal9
4209 Revision 1.12 2001/09/28 02:57:04 hal9
4212 Revision 1.11 2001/09/28 02:25:20 hal9
4215 Revision 1.9 2001/09/27 23:50:29 hal9
4216 A few changes. A short section on regular expression in appendix.
4218 Revision 1.8 2001/09/25 00:34:59 hal9
4219 Some additions, and re-arranging.
4221 Revision 1.7 2001/09/24 14:31:36 hal9
4224 Revision 1.6 2001/09/24 14:10:32 hal9
4225 Including David's OS/2 installation instructions.
4227 Revision 1.2 2001/09/13 15:27:40 swa
4230 Revision 1.1 2001/09/12 15:36:41 swa
4231 source files for junkbuster documentation
4233 Revision 1.3 2001/09/10 17:43:59 swa
4234 first proposal of a structure.
4236 Revision 1.2 2001/06/13 14:28:31 swa
4237 docs should have an author.
4239 Revision 1.1 2001/06/13 14:20:37 swa
4240 first import of project's documentation for the webserver.
projects / privoxy.git / blob