1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
2 <!entity % dummy "INCLUDE">
3 <!entity supported SYSTEM "supported.sgml">
4 <!entity newfeatures SYSTEM "newfeatures.sgml">
5 <!entity p-intro SYSTEM "privoxy.sgml">
6 <!entity seealso SYSTEM "seealso.sgml">
7 <!entity buildsource SYSTEM "buildsource.sgml">
8 <!entity contacting SYSTEM "contacting.sgml">
9 <!entity history SYSTEM "history.sgml">
10 <!entity copyright SYSTEM "copyright.sgml">
11 <!entity p-version "2.9.14">
12 <!entity p-status "beta">
13 <!entity % p-not-stable "INCLUDE">
14 <!entity % p-stable "IGNORE">
15 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
16 <!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
17 <!entity % p-readme "IGNORE">
18 <!entity % p-supp-userman "IGNORE"> <!-- Omit some from supported.sgml -->
21 File : $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
24 This file belongs into
25 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
27 $Id: user-manual.sgml,v 1.75 2002/04/12 02:08:48 david__schmidt Exp $
29 Written by and Copyright (C) 2001 the SourceForge
30 Privoxy team. http://www.privoxy.org/
32 Based on the Internet Junkbuster originally written
33 by and Copyright (C) 1997 Anonymous Coders and
34 Junkbusters Corporation. http://www.junkbusters.com
37 ========================================================================
38 NOTE: Please read developer-manual/documentation.html before touching
39 anything in this, or other Privoxy documentation.
40 ========================================================================
46 <title>Privoxy User Manual</title>
48 <pubdate>$Id: user-manual.sgml,v 1.75 2002/04/12 02:08:48 david__schmidt Exp $</pubdate>
53 <orgname>By: Privoxy Developers</orgname>
62 This is here to keep vim syntax file from breaking :/
63 If I knew enough to fix it, I would.
64 PLEASE DO NOT REMOVE! HB: hal@foobox.net
70 The user manual gives users information on how to install, configure and use
72 url="http://www.privoxy.org/"><application>Privoxy</application></ulink>.
75 <!-- Include privoxy.sgml boilerplate: -->
77 <!-- end privoxy.sgml -->
80 You can find the latest version of the user manual at <ulink
81 url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink>.
82 Please see the <ulink url="contact.html">Contact section</ulink> on how to
83 contact the developers.
87 <!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
93 <!-- ~~~~~ New section ~~~~~ -->
94 <sect1 id="intro" label=""><title></title>
95 <!-- dummy section to force TOC on page by itself -->
96 <!-- DO NOT REMOVE! please ;) -->
100 <!-- ~~~~~ New section ~~~~~ -->
102 <sect1 label="1" id="introduction"><title>Introduction</title>
105 This documentation is included with the current &p-status; version of
106 <application>Privoxy</application>, v.&p-version;<![%p-not-stable;[,
107 and is mostly complete at this point. The most up to date reference for the
108 time being is still the comments in the source files and in the individual
109 configuration files. Development of version 3.0 is currently nearing
110 completion, and includes many significant changes and enhancements over
111 earlier versions. The target release date for
112 stable v3.0 is <quote>soon</quote> ;-)]]>.
116 <!-- include only in non-stable versions -->
118 Since this is a &p-status; version, not all new features are well tested. This
119 documentation may be slightly out of sync as a result (especially with
120 CVS sources). And there <emphasis>may be</emphasis> bugs, though hopefully
125 <!-- ~~~~~ New section ~~~~~ -->
126 <sect2 id="newfeatures">
127 <title>New Features</title>
129 In addition to <application>Internet Junkbuster's</application> traditional
130 feature of ad and banner blocking and cookie management,
131 <application>Privoxy</application> provides new features<![%p-not-stable;[,
132 some of them currently under development]]>:
133 <anchor id="testing"/>
136 <!-- Include newfeatures.sgml boilerplate here: -->
138 <!-- end boilerplate -->
143 <!-- ~ End section ~ -->
146 <!-- ~~~~~ New section ~~~~~ -->
147 <sect1 id="installation"><title>Installation</title>
149 <application>Privoxy</application> is available as raw source code (tarball
150 or via CVS), or pre-compiled binaries for various platforms. See the <ulink
151 url="http://sourceforge.net/projects/ijbswa/">Privoxy Project Page</ulink> for
152 the most up to date release information.
153 <application>Privoxy</application> is also available via <ulink
154 url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
155 <![%p-not-stable;[This is the recommended approach at this time.]]> But
156 please be aware that CVS is constantly changing, and it may break in
160 <!-- Include supported.sgml boilerplate -->
162 <!-- end boilerplate -->
164 <!-- ~~~~~ New section ~~~~~ -->
165 <sect2 id="installation-source"><title>Source</title>
168 <!-- include buildsource.sgml boilerplate: -->
170 <!-- end boilerplate -->
173 For Redhat and SuSE Linux RPM packages, see below.
177 <!-- ~~~~~ New section ~~~~~ -->
178 <sect3 id="installation-rh"><title>Red Hat</title>
180 To build Redhat RPM packages from source, install source as above. Then:
193 This will create both binary and src RPMs in the usual places. Example:
197 /usr/src/redhat/RPMS/i686/privoxy-&p-version;-1.i686.rpm
200 /usr/src/redhat/SRPMS/privoxy-&p-version;-1.src.rpm
204 To install, of course:
209 rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-&p-version;-1.i686.rpm
214 This will place the <application>Privoxy</application> configuration
215 files in <filename>/etc/privoxy/</filename>, and log files in
216 <filename>/var/log/privoxy/</filename>. Run
217 <quote><command>chkconfig privoxy on</command></quote> to have
218 <application>Privoxy</application> start automatically during init.
224 <!-- ~~~~~ New section ~~~~~ -->
225 <sect3 id="installation-suse"><title>SuSE</title>
227 To build SuSE RPM packages, install source as above. Then:
240 This will create both binary and src RPMs in the usual places. Example:
244 /usr/src/packages/RPMS/i686/privoxy-&p-version;-1.i686.rpm
247 /usr/src/packages/SRPMS/privoxy-&p-version;-1.src.rpm
251 To install, of course:
256 rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-&p-version;-1.i686.rpm
261 This will place the <application>Privoxy</application> configuration
262 files in <filename>/etc/privoxy/</filename>, and log files in
263 <filename>/var/log/privoxy/</filename>.
269 <!-- ~~~~~ New section ~~~~~ -->
270 <sect3 id="installation-os2"><title>OS/2</title>
277 <application>Privoxy</application> is packaged in a WarpIN self-
278 installing archive. The self-installing program will be named depending
279 on the release version, something like:
280 <filename>privoxyos2_setup_&p-version;.exe</filename>. In order to install it, simply
281 run this executable or double-click on its icon and follow the WarpIN
282 installation panels. A shadow of the <application>Privoxy</application>
283 executable will be placed in your startup folder so it will start
284 automatically whenever OS/2 starts.
288 The directory you choose to install <application>Privoxy</application>
289 into will contain all of the configuration files.
295 <!-- ~~~~~ New section ~~~~~ -->
296 <sect3 id="installation-win"><title>Windows</title>
297 <para>Click-click. (I need help on this. Not a clue here. Also for
298 configuration section below. HB.)
302 <!-- ~~~~~ New section ~~~~~ -->
303 <sect3 id="installation-other"><title>Other</title>
305 Some quick notes on other Operating Systems.
309 For FreeBSD (and other *BSDs?), the build will require <command>gmake</command>
310 instead of the included <command>make</command>. <command>gmake</command> is
311 available from <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>.
312 The rest should be the same as above for Linux/Unix.
320 <!-- ~ End section ~ -->
323 <!-- ~~~~~ New section ~~~~~ -->
325 <sect1 id="quickstart"><title>Quickstart to Using <application>Privoxy</application></title>
328 <!-- ~~~~~ New section ~~~~~ -->
329 <sect2 id="upgradersnote">
330 <title>Note to Upgraders</title>
332 There are very significant changes from older versions of
333 <application>Junkbuster</application> to the current
334 <application>Privoxy</application>. Configuration is substantially
335 changed. <application>Junkbuster 2.0.x</application> and earlier
336 configuration files will not migrate. The functionality of the old
337 <filename>blockfile</filename>, <filename>cookiefile</filename> and
338 <filename>imagelist</filename>, are now combined into the
339 <quote><filename>actions file</filename></quote>
340 (<filename>default.action</filename> for most installations).
343 A <quote><filename>filterfile</filename></quote> (typically
344 <filename>default.filter</filename>) is new with
345 <application>Privoxy 2.9.x</application>, and provides some of the new
346 sophisticaton (explained below). <filename>config</filename> is
350 If upgrading from a 2.0.x version, you will have to use the new config
351 files, and possibly adapt any personal rules from your older files.
352 If upgrading from 2.9.x development versions, it is still recommended
353 to use the new configuration files.
356 A quick list of things to be aware of before upgrading:
364 The default listening port is now 8118 due to a conflict with another
370 Some installers may remove earlier versions completely. Save any
371 important configuration files!
376 <application>Privoxy</application> is reachable with a web browser
377 at the special URL: <ulink url="http://p.p/">http://p.p/</ulink>. Many
378 aspects of configuration can be done here, including temporarily disabling
379 <application>Privoxy</application>. Alternately,
380 <ulink url="http://config.privoxy.org/">http://config.privoxy.org</ulink>
381 may work in some rare cases where the former does not.
386 The primary configuration file for cookie management, ad and banner
387 blocking, and many other aspects of <application>Privoxy</application>
388 configuration is <filename>default.action</filename>.
393 <!-- I think it is best to keep this somewhat vague, in case -->
394 <!-- the situation changes under our feet. -->
395 Some installers may not automatically start
396 <application>Privoxy</application> after installation.
405 <!-- ~~~~~ New section ~~~~~ -->
407 <title>Starting <application>Privoxy</application></title>
409 Before launching <application>Privoxy</application> for the first time, you
410 will want to configure your browser(s) to use <application>Privoxy</application>
411 as a HTTP and HTTPS proxy. The default is localhost for the proxy address,
412 and port 8118 (earlier versions used port 8000). This is the one required
413 configuration that must be done!
417 With <application>Netscape</application> (and
418 <application>Mozilla</application>), this can be set under <literal>Edit
419 -> Preferences -> Advanced -> Proxies -> HTTP Proxy</literal>.
420 For <application>Internet Explorer</application>: <literal>Tools ->
421 Internet Properties -> Connections -> LAN Setting</literal>. Then,
422 check <quote>Use Proxy</quote> and fill in the appropriate info (Address:
423 localhost, Port: 8118). Include if HTTPS proxy support too.
427 After doing this, flush your browser's disk and memory caches to force a
428 re-reading of all pages and get rid of any ads that may be cached. You
429 are now ready to start enjoying the benefits of using
430 <application>Privoxy</application>.
435 <application>Privoxy</application> is typically started by specifying the
436 main configuration file to be used on the command line. Example Unix startup
443 # /usr/sbin/privoxy /etc/privoxy/config
449 An init script is provided for SuSE and Redhat.
453 For for SuSE: <command>/etc/rc.d/privoxy start</command>
457 For RedHat: <command>/etc/rc.d/init.d/privoxy start</command>
462 If no configuration file is specified on the command line,
463 <application>Privoxy</application> will look for a file named
464 <filename>config</filename> in the current directory. Except on Win32 where
465 it will try <filename>config.txt</filename>. If no file is specified on the
466 command line and no default configuration file can be found,
467 <application>Privoxy</application> will fail to start.
472 The included default configuration files should give a reasonable starting
473 point. Most of the per site configuration is done in the
474 <quote>actions</quote> files. These are where various cookie actions are
475 defined, ad and banner blocking, and other aspects of
476 <application>Privoxy</application> configuration. There are several such
477 files included, with varying levels of aggressiveness.
481 You will probably want to keep an eye out for sites that require persistent
482 cookies, and add these to <filename>default.action</filename> as needed. By
483 default, most of these will be accepted only during the current browser
484 session (aka <quote>session cookies</quote>), until you add them to the
485 configuration. If you want the browser to handle this instead, you will need
486 to edit <filename>default.action</filename> and disable this feature. If you
487 use more than one browser, it would make more sense to let
488 <application>Privoxy</application> handle this. In which case, the
489 browser(s) should be set to accept all cookies.
493 <application>Privoxy</application> is HTTP/1.1 compliant, but not all 1.1
494 features are as yet implemented. If browsers that support HTTP/1.1 (like
495 <application>Mozilla</application> or recent versions of I.E.) experience
496 problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look
497 under <literal>Edit -> Preferences -> Debug -> Networking</literal>.
498 Or set the <quote>+downgrade</quote> config option in
499 <filename>default.action</filename>.
503 After running <application>Privoxy</application> for a while, you can
504 start to fine tune the configuration to suit your personal, or site,
505 preferences and requirements. There are many, many aspects that can
506 be customized. <quote>Actions</quote> (as specified in <filename>default.action</filename>)
507 can be adjusted by pointing your browser to
508 <ulink url="http://p.p/">http://p.p/</ulink>,
509 and then follow the link to <quote>edit the actions list</quote>.
510 (This is an internal page and does not require Internet access.)
514 In fact, various aspects of <application>Privoxy</application>
515 configuration can be viewed from this page, including
516 current configuration parameters, source code version numbers,
517 the browser's request headers, and <quote>actions</quote> that apply
518 to a given URL. In addition to the <filename>default.action</filename> file
519 editor mentioned above, <application>Privoxy</application> can also
520 be turned <quote>on</quote> and <quote>off</quote> from this page.
524 If you encounter problems, please verify it is a
525 <application>Privoxy</application> bug, by disabling
526 <application>Privoxy</application>, and then trying the same page.
527 Also, try another browser if possible to eliminate browser or site
528 problems. Before reporting it as a bug, see if there is not a configuration
529 option that is enabled that is causing the page not to load. You can then add
530 an exception for that page or site. For instance, try adding it to the
531 <literal>{fragile}</literal> section of <filename>default.action</filename>.
532 This will turn off most actions for this site. For more on troubleshooting
533 problem sites, see the <ulink
534 url="appendix.html#ACTIONSANAT">Appendix</ulink>. If a bug, please report it
535 to the developers (see below).
541 <!-- ~~~~~ New section ~~~~~ -->
543 <title>Command Line Options</title>
545 <application>Privoxy</application> may be invoked with the following
546 command-line options:
554 <emphasis>--version</emphasis>
557 Print version info and exit, Unix only.
562 <emphasis>--help</emphasis>
565 Print a short usage info and exit, Unix only.
570 <emphasis>--no-daemon</emphasis>
573 Don't become a daemon, i.e. don't fork and become process group
574 leader, don't detach from controlling tty. Unix only.
579 <emphasis>--pidfile FILE</emphasis>
583 On startup, write the process ID to <emphasis>FILE</emphasis>. Delete the
584 <emphasis>FILE</emphasis> on exit. Failiure to create or delete the
585 <emphasis>FILE</emphasis> is non-fatal. If no <emphasis>FILE</emphasis>
586 option is given, no PID file will be used. Unix only.
591 <emphasis>--user USER[.GROUP]</emphasis>
595 After (optionally) writing the PID file, assume the user ID of
596 <emphasis>USER</emphasis>, and if included the GID of GROUP. Exit if the
597 privileges are not sufficient to do so. Unix only.
602 <emphasis>configfile</emphasis>
605 If no <emphasis>configfile</emphasis> is included on the command line,
606 <application>Privoxy</application> will look for a file named
607 <quote>config</quote> in the current directory (except on Win32
608 where it will look for <quote>config.txt</quote> instead). Specify
609 full path to avoid confusion.
620 <!-- ~ End section ~ -->
623 <!-- ~~~~~ New section ~~~~~ -->
624 <sect1 id="configuration"><title><application>Privoxy</application> Configuration</title>
626 All <application>Privoxy</application> configuration is stored
627 in text files. These files can be edited with a text editor.
628 Many important aspects of <application>Privoxy</application> can
629 also be controlled easily with a web browser.
634 <!-- ~~~~~ New section ~~~~~ -->
637 <title>Controlling <application>Privoxy</application> with Your Web Browser</title>
639 <application>Privoxy</application> can be reached by the special
640 URL <ulink url="http://p.p/">http://p.p/</ulink> (or alternately
641 <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>),
642 which is an internal page. You will see the following section:
649 Please choose from the following options:
652 * Show information about the current configuration
653 * Show the source code version numbers
654 * Show the request headers.
655 * Show which actions apply to a URL and why
656 * Toggle Privoxy on or off
657 * Edit the actions list
663 This should be self-explanatory. Note the last item is an editor for the
664 <quote>actions list</quote>, which is where much of the ad, banner, cookie,
665 and URL blocking magic is configured as well as other advanced features of
666 <application>Privoxy</application>. This is an easy way to adjust various
667 aspects of <application>Privoxy</application> configuration. The actions
668 file, and other configuration files, are explained in detail below.
669 <application>Privoxy</application> will automatically detect any changes
670 to these files. Note: one or two requests to the proxy might required to
671 <quote>wake up</quote> <application>Privoxy</application>,
672 and force a re-reading of the configuration. It is not necessarily
677 <quote>Toggle Privoxy On or Off</quote> is handy for sites that might
678 have problems with your current actions and filters, or just to test if
679 a site misbehaves, whether it is <application>Privoxy</application>
680 causing the problem or not. <application>Privoxy</application> continues
681 to run as a proxy in this case, but all filtering is disabled.
687 <!-- ~ End section ~ -->
692 <!-- ~~~~~ New section ~~~~~ -->
695 <title>Configuration Files Overview</title>
697 For Unix, *BSD and Linux, all configuration files are located in
698 <filename>/etc/privoxy/</filename> by default. For MS Windows, OS/2, and
699 AmigaOS these are all in the same directory as the
700 <application>Privoxy</application> executable. <![%p-not-stable;[ The name
701 and number of configuration files has changed from previous versions, and is
702 subject to change as development progresses.]]>
706 The installed defaults provide a reasonable starting point, though possibly
707 aggressive by some standards. For the time being, there are only three
708 default configuration files (this may change in time):
716 The main configuration file is named <filename>config</filename>
717 on Linux, Unix, BSD, OS/2, and AmigaOS and <filename>config.txt</filename>
724 The <filename>default.action</filename> file is used to define various
725 <quote>actions</quote> relating to images, banners, pop-ups, access
726 restrictions, banners and cookies. There is a CGI based editor for this
727 file that can be accessed via <ulink
728 url="http://p.p">http://p.p</ulink>. (Other actions
729 files are included as well with differing levels of filtering
730 and blocking, e.g. <filename>basic.action</filename>.)
736 The <filename>default.filter</filename> file can be used to re-write the raw
737 page content, including viewable text as well as embedded HTML and JavaScript,
738 and whatever else lurks on any given web page.
746 <filename>default.action</filename> and <filename>default.filter</filename>
747 can use Perl style regular expressions for maximum flexibility. All files use
748 the <quote><literal>#</literal></quote> character to denote a comment. Such
749 lines are not processed by <application>Privoxy</application>. After
750 making any changes, there is no need to restart
751 <application>Privoxy</application> in order for the changes to take
752 effect. <application>Privoxy</application> should detect such changes
758 While under development, the configuration content is subject to change.
759 The below documentation may not be accurate by the time you read this.
760 Also, what constitutes a <quote>default</quote> setting, may change, so
761 please check all your configuration files on important issues.
767 <!-- ~~~~~ New section ~~~~~ -->
770 <title>The Main Configuration File</title>
772 Again, the main configuration file is named <filename>config</filename> on
773 Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
774 Configuration lines consist of an initial keyword followed by a list of
775 values, all separated by whitespace (any number of spaces or tabs). For
783 <emphasis>blockfile blocklist.ini</emphasis>
790 Indicates that the blockfile is named <quote>blocklist.ini</quote>. (A
791 default installation does not use this.)
795 A <quote><literal>#</literal></quote> indicates a comment. Any part of a
796 line following a <quote><literal>#</literal></quote> is ignored, except if
797 the <quote><literal>#</literal></quote> is preceded by a
798 <quote><literal>\</literal></quote>.
802 Thus, by placing a <quote><literal>#</literal></quote> at the start of an
803 existing configuration line, you can make it a comment and it will be treated
804 as if it weren't there. This is called <quote>commenting out</quote> an
805 option and can be useful to turn off features: If you comment out the
806 <quote>logfile</quote> line, <application>Privoxy</application> will not
807 log to a file at all. Watch for the <quote>default:</quote> section in each
808 explanation to see what happens if the option is left unset (or commented
813 Long lines can be continued on the next line by using a
814 <quote><literal>\</literal></quote> as the very last character.
818 There are various aspects of <application>Privoxy</application> behavior
823 <!-- ~~~~~ New section ~~~~~ -->
826 <title>Defining Other Configuration Files</title>
829 <application>Privoxy</application> can use a number of other files to tell it
830 what ads to block, what cookies to accept, and perform other functions. This
831 section of the configuration file tells <application>Privoxy</application>
832 where to find all those other files.
836 On <application>Windows</application> and <application>AmigaOS</application>,
837 <application>Privoxy</application> looks for these files in the same
838 directory as the executable. On Unix and OS/2,
839 <application>Privoxy</application> looks for these files in the current
840 working directory. In either case, an absolute path name can be used to
845 When development goes modular and multi-user, the blocker, filter, and
846 per-user config will be stored in subdirectories of <quote>confdir</quote>.
847 For now, only <filename>confdir/templates</filename> is used for storing HTML
848 templates for CGI results.
852 The location of the configuration files:
859 <emphasis>confdir /etc/privoxy</emphasis> # No trailing /, please.
866 The directory where all logging (i.e. <filename>logfile</filename> and
867 <filename>jarfile</filename>) takes place. No trailing
868 <quote><literal>/</literal></quote>, please:
875 <emphasis>logdir /var/log/privoxy</emphasis>
882 Note that all file specifications below are relative to
883 the above two directories!
887 The <quote>default.action</quote> file contains patterns to specify the
888 actions to apply to requests for each site. Default: Cookies to and from all
889 destinations are kept only during the current browser session (i.e. they are
890 not saved to disk). Pop-ups are disabled for all sites. All sites are
891 filtered through selected sections of <quote>default.filter</quote>. No sites
892 are blocked. <application>Privoxy</application> displays a checkboard type
893 pattern for filtered ads and other images. The syntax of this file is
894 explained in detail <link linkend="actionsfile">below</link>. Other
895 <quote>actions</quote> files are included, and you are free to use any of
896 them. They have varying degrees of aggressiveness.
903 <emphasis>actionsfile default.action</emphasis>
910 The <quote>default.filter</quote> file contains content modification rules
911 that use <quote>regular expressions</quote>. These rules permit powerful
912 changes on the content of Web pages, e.g., you could disable your favorite
913 JavaScript annoyances, re-write the actual displayed text, or just have some
914 fun replacing <quote>Microsoft</quote> with <quote>MicroSuck</quote> wherever
915 it appears on a Web page. Default: whatever the developers are playing with
920 Filtering requires buffering the page content, which may appear to slow down
921 page rendering since nothing is displayed until all content has passed
922 the filters. (It does not really take longer, but seems that way since
923 the page is not incrementally displayed.) This effect will be more noticeable
924 on slower connections.
932 <emphasis>filterfile default.filter</emphasis>
939 The logfile is where all logging and error messages are written. The logfile
940 can be useful for tracking down a problem with
941 <application>Privoxy</application> (e.g., it's not blocking an ad you
942 think it should block) but in most cases you probably will never look at it.
946 Your logfile will grow indefinitely, and you will probably want to
947 periodically remove it. On Unix systems, you can do this with a cron job
948 (see <quote>man cron</quote>). For Redhat, a <command>logrotate</command>
949 script has been included.
953 On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
954 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
955 the effect that cron.daily will automatically archive, gzip, and empty the
956 log, when it exceeds 1M size.
960 Default: Log to the a file named <filename>logfile</filename>.
961 Comment out to disable logging.
968 <emphasis>logfile logfile</emphasis>
975 The <quote>jarfile</quote> defines where
976 <application>Privoxy</application> stores the cookies it intercepts. Note
977 that if you use a <quote>jarfile</quote>, it may grow quite large. Default:
978 Don't store intercepted cookies.
985 <emphasis>#jarfile jarfile</emphasis>
992 If you specify a <quote>trustfile</quote>,
993 <application>Privoxy</application> will only allow access to sites that
994 are named in the trustfile. You can also mark sites as trusted referrers,
995 with the effect that access to untrusted sites will be granted, if a link
996 from a trusted referrer was used. The link target will then be added to the
997 <quote>trustfile</quote>. This is a very restrictive feature that typical
998 users most probably want to leave disabled. Default: Disabled, don't use the
1006 <emphasis>#trustfile trust</emphasis>
1013 If you use the trust mechanism, it is a good idea to write up some on-line
1014 documentation about your blocking policy and to specify the URL(s) here. They
1015 will appear on the page that your users receive when they try to access
1016 untrusted content. Use multiple times for multiple URLs. Default: Don't
1017 display links on the <quote>untrusted</quote> info page.
1024 <emphasis>trust-info-url http://www.example.com/why_we_block.html</emphasis>
1025 <emphasis>trust-info-url http://www.example.com/what_we_allow.html</emphasis>
1033 <!-- ~ End section ~ -->
1037 <!-- ~~~~~ New section ~~~~~ -->
1040 <title>Other Configuration Options</title>
1043 This part of the configuration file contains options that control how
1044 <application>Privoxy</application> operates.
1048 <quote>Admin-address</quote> should be set to the email address of the proxy
1049 administrator. It is used in many of the proxy-generated pages. Default:
1057 <emphasis>#admin-address fill@me.in.please</emphasis>
1064 <quote>Proxy-info-url</quote> can be set to a URL that contains more info
1065 about this <application>Privoxy</application> installation, it's
1066 configuration and policies. It is used in many of the proxy-generated pages
1067 and its use is highly recommended in multi-user installations, since your
1068 users will want to know why certain content is blocked or modified. Default:
1069 Don't show a link to on-line documentation.
1076 <emphasis>proxy-info-url http://www.example.com/proxy.html</emphasis>
1083 <quote>Listen-address</quote> specifies the address and port where
1084 <application>Privoxy</application> will listen for connections from your
1085 Web browser. The default is to listen on the localhost port 8118, and
1086 this is suitable for most users. (In your web browser, under proxy
1087 configuration, list the proxy server as <quote>localhost</quote> and the
1088 port as <quote>8118</quote>).
1092 If you already have another service running on port 8118, or if you want to
1093 serve requests from other machines (e.g. on your local network) as well, you
1094 will need to override the default. The syntax is
1095 <quote>listen-address [<ip-address>]:<port></quote>. If you leave
1096 out the IP address, <application>Privoxy</application> will bind to all
1097 interfaces (addresses) on your machine and may become reachable from the
1098 Internet. In that case, consider using access control lists (acl's) (see
1099 <quote>aclfile</quote> above), or a firewall.
1103 For example, suppose you are running <application>Privoxy</application> on
1104 a machine which has the address 192.168.0.1 on your local private network
1105 (192.168.0.0) and has another outside connection with a different address.
1106 You want it to serve requests from inside only:
1113 <emphasis>listen-address 192.168.0.1:8118</emphasis>
1120 If you want it to listen on all addresses (including the outside
1128 <emphasis>listen-address :8118</emphasis>
1135 If you do this, consider using ACLs (see <quote>aclfile</quote> above). Note:
1136 you will need to point your browser(s) to the address and port that you have
1137 configured here. Default: localhost:8118 (127.0.0.1:8118).
1141 The debug option sets the level of debugging information to log in the
1142 logfile (and to the console in the Windows version). A debug level of 1 is
1143 informative because it will show you each request as it happens. Higher
1144 levels of debug are probably only of interest to developers.
1151 debug 1 # GPC = show each GET/POST/CONNECT request
1152 debug 2 # CONN = show each connection status
1153 debug 4 # IO = show I/O status
1154 debug 8 # HDR = show header parsing
1155 debug 16 # LOG = log all data into the logfile
1156 debug 32 # FRC = debug force feature
1157 debug 64 # REF = debug regular expression filter
1158 debug 128 # = debug fast redirects
1159 debug 256 # = debug GIF de-animation
1160 debug 512 # CLF = Common Log Format
1161 debug 1024 # = debug kill pop-ups
1162 debug 4096 # INFO = Startup banner and warnings.
1163 debug 8192 # ERROR = Non-fatal errors
1171 It is <emphasis>highly recommended</emphasis> that you enable ERROR
1172 reporting (debug 8192), at least until v3.0 is released.
1177 The reporting of FATAL errors (i.e. ones which crash
1178 <application>Privoxy</application>) is always on and cannot be disabled.
1182 If you want to use CLF (Common Log Format), you should set <quote>debug
1183 512</quote> ONLY, do not enable anything else.
1187 Multiple <quote>debug</quote> directives, are OK - they're logical-OR'd
1195 <emphasis>debug 15 # same as setting the first 4 listed above</emphasis>
1209 <emphasis>debug 1 # URLs</emphasis>
1210 <emphasis>debug 4096 # Info</emphasis>
1211 <emphasis>debug 8192 # Errors - *we highly recommended enabling this*</emphasis>
1218 <application>Privoxy</application> normally uses
1219 <quote>multi-threading</quote>, a software technique that permits it to
1220 handle many different requests simultaneously. In some cases you may wish to
1221 disable this -- particularly if you're trying to debug a problem. The
1222 <quote>single-threaded</quote> option forces
1223 <application>Privoxy</application> to handle requests sequentially.
1224 Default: Multi-threaded mode.
1231 <emphasis>#single-threaded</emphasis>
1238 <quote>toggle</quote> allows you to temporarily disable all
1239 <application>Privoxy's</application> filtering. Just set <quote>toggle
1244 The Windows version of <application>Privoxy</application> puts an icon in
1245 the system tray, which also allows you to change this option. If you
1246 right-click on that icon (or select the <quote>Options</quote> menu), one
1247 choice is <quote>Enable</quote>. Clicking on enable toggles
1248 <application>Privoxy</application> on and off. This is useful if you want
1249 to temporarily disable <application>Privoxy</application>, e.g., to access
1250 a site that requires cookies which you would otherwise have blocked. This can also
1251 be toggled via a web browser at the <application>Privoxy</application>
1252 internal address of <ulink url="http://p.p">http://p.p</ulink> on
1257 <quote>toggle 1</quote> means <application>Privoxy</application> runs
1258 normally, <quote>toggle 0</quote> means that
1259 <application>Privoxy</application> becomes a non-anonymizing non-blocking
1260 proxy. Default: 1 (on).
1267 <emphasis>toggle 1</emphasis>
1274 For content filtering, i.e. the <quote>+filter</quote> and
1275 <quote>+deanimate-gif</quote> actions, it is necessary that
1276 <application>Privoxy</application> buffers the entire document body.
1277 This can be potentially dangerous, since a server could just keep sending
1278 data indefinitely and wait for your RAM to exhaust. With nasty consequences.
1282 The <application>buffer-limit</application> option lets you set the maximum
1283 size in Kbytes that each buffer may use. When the documents buffer exceeds
1284 this size, it is flushed to the client unfiltered and no further attempt to
1285 filter the rest of it is made. Remember that there may multiple threads
1286 running, which might require increasing the <quote>buffer-limit</quote>
1287 Kbytes <emphasis>each</emphasis>, unless you have enabled
1288 <quote>single-threaded</quote> above.
1295 <emphasis>buffer-limit 4096</emphasis>
1302 To enable the web-based <filename>default.action</filename> file editor set
1303 <application>enable-edit-actions</application> to 1, or 0 to disable. Note
1304 that you must have compiled <application>Privoxy</application> with
1305 support for this feature, otherwise this option has no effect. This
1306 internal page can be reached at <ulink
1307 url="http://p.p">http://p.p</ulink>.
1311 Security note: If this is enabled, anyone who can use the proxy
1312 can edit the actions file, and their changes will affect all users.
1313 For shared proxies, you probably want to disable this. Default: enabled.
1320 <emphasis>enable-edit-actions 1</emphasis>
1327 Allow <application>Privoxy</application> to be toggled on and off
1328 remotely, using your web browser. Set <quote>enable-remote-toggle</quote>to
1329 1 to enable, and 0 to disable. Note that you must have compiled
1330 <application>Privoxy</application> with support for this feature,
1331 otherwise this option has no effect.
1335 Security note: If this is enabled, anyone who can use the proxy can toggle
1336 it on or off (see <ulink url="http://p.p">http://p.p</ulink>), and
1337 their changes will affect all users. For shared proxies, you probably want to
1338 disable this. Default: enabled.
1345 <emphasis>enable-remote-toggle 1</emphasis>
1353 <!-- ~ End section ~ -->
1356 <!-- ~~~~~ New section ~~~~~ -->
1359 <title>Access Control List (ACL)</title>
1361 Access controls are included at the request of some ISPs and systems
1362 administrators, and are not usually needed by individual users. Please note
1363 the warnings in the FAQ that this proxy is not intended to be a substitute
1364 for a firewall or to encourage anyone to defer addressing basic security
1369 If no access settings are specified, the proxy talks to anyone that
1370 connects. If any access settings file are specified, then the proxy
1371 talks only to IP addresses permitted somewhere in this file and not
1372 denied later in this file.
1376 Summary -- if using an ACL:
1381 Client must have permission to receive service.
1386 LAST match in ACL wins.
1391 Default behavior is to deny service.
1396 The syntax for an entry in the Access Control List is:
1403 ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ]
1410 Where the individual fields are:
1417 <emphasis>ACTION</emphasis> = <quote>permit-access</quote> or <quote>deny-access</quote>
1419 <emphasis>SRC_ADDR</emphasis> = client hostname or dotted IP address
1420 <emphasis>SRC_MASKLEN</emphasis> = number of bits in the subnet mask for the source
1422 <emphasis>DST_ADDR</emphasis> = server or forwarder hostname or dotted IP address
1423 <emphasis>DST_MASKLEN</emphasis> = number of bits in the subnet mask for the target
1431 The field separator (FS) is whitespace (space or tab).
1435 IMPORTANT NOTE: If <application>Privoxy</application> is using a
1436 forwarder (see below) or a gateway for a particular destination URL, the
1437 <literal>DST_ADDR</literal> that is examined is the address of the forwarder
1438 or the gateway and <emphasis>NOT</emphasis> the address of the ultimate
1439 target. This is necessary because it may be impossible for the local
1440 <application>Privoxy</application> to determine the address of the
1441 ultimate target (that's often what gateways are used for).
1445 Here are a few examples to show how the ACL features work:
1449 <quote>localhost</quote> is OK -- no DST_ADDR implies that
1450 <emphasis>ALL</emphasis> destination addresses are OK:
1457 <emphasis>permit-access localhost</emphasis>
1464 A silly example to illustrate permitting any host on the class-C subnet with
1465 <application>Privoxy</application> to go anywhere:
1472 <emphasis>permit-access www.privoxy.com/24</emphasis>
1479 Except deny one particular IP address from using it at all:
1486 <emphasis>deny-access ident.privoxy.com</emphasis>
1493 You can also specify an explicit network address and subnet mask.
1494 Explicit addresses do not have to be resolved to be used.
1501 <emphasis>permit-access 207.153.200.0/24</emphasis>
1508 A subnet mask of 0 matches anything, so the next line permits everyone.
1515 <emphasis>permit-access 0.0.0.0/0</emphasis>
1522 Note, you <emphasis>cannot</emphasis> say:
1529 <emphasis>permit-access .org</emphasis>
1536 to allow all *.org domains. Every IP address listed must resolve fully.
1540 An ISP may want to provide a <application>Privoxy</application> that is
1541 accessible by <quote>the world</quote> and yet restrict use of some of their
1542 private content to hosts on its internal network (i.e. its own subscribers).
1543 Say, for instance the ISP owns the Class-B IP address block 123.124.0.0 (a 16
1544 bit netmask). This is how they could do it:
1551 <emphasis>permit-access 0.0.0.0/0 0.0.0.0/0</emphasis> # other clients can go anywhere
1552 # with the following exceptions:
1554 <emphasis>deny-access</emphasis> 0.0.0.0/0 123.124.0.0/16 # block all external requests for
1555 # sites on the ISP's network
1557 <emphasis>permit 0.0.0.0/0 www.my_isp.com</emphasis> # except for the ISP's main
1560 <emphasis>permit 123.124.0.0/16 0.0.0.0/0</emphasis> # the ISP's clients can go
1568 Note that if some hostnames are listed with multiple IP addresses,
1569 the primary value returned by DNS (via gethostbyname()) is used. Default:
1570 Anyone can access the proxy.
1575 <!-- ~ End section ~ -->
1578 <!-- ~~~~~ New section ~~~~~ -->
1580 <sect3 id="forwarding">
1581 <title>Forwarding</title>
1584 This feature allows chaining of HTTP requests via multiple proxies.
1585 It can be used to better protect privacy and confidentiality when
1586 accessing specific domains by routing requests to those domains
1587 to a special purpose filtering proxy such as lpwa.com. Or to use
1588 a caching proxy to speed up browsing.
1592 It can also be used in an environment with multiple networks to route
1593 requests via multiple gateways allowing transparent access to multiple
1594 networks without having to modify browser configurations.
1598 Also specified here are SOCKS proxies. <application>Privoxy</application>
1599 SOCKS 4 and SOCKS 4A. The difference is that SOCKS 4A will resolve the target
1600 hostname using DNS on the SOCKS server, not our local DNS client.
1604 The syntax of each line is:
1611 <emphasis>forward target_domain[:port] http_proxy_host[:port]</emphasis>
1612 <emphasis>forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1613 <emphasis>forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1620 If http_proxy_host is <quote>.</quote>, then requests are not forwarded to a
1621 HTTP proxy but are made directly to the web servers.
1625 Lines are checked in sequence, and the last match wins.
1629 There is an implicit line equivalent to the following, which specifies that
1630 anything not finding a match on the list is to go out without forwarding
1631 or gateway protocol, like so:
1638 <emphasis>forward .* . </emphasis># implicit
1645 In the following common configuration, everything goes to Lucent's LPWA,
1646 except SSL on port 443 (which it doesn't handle):
1653 <emphasis>forward .* lpwa.com:8000</emphasis>
1654 <emphasis>forward :443 .</emphasis>
1662 See the FAQ for instructions on how to automate the login procedure for LPWA.
1664 Some users have reported difficulties related to LPWA's use of
1665 <quote>.</quote> as the last element of the domain, and have said that this
1666 can be fixed with this:
1673 <emphasis>forward lpwa. lpwa.com:8000</emphasis>
1680 (NOTE: the syntax for specifying target_domain has changed since the
1681 previous paragraph was written -- it will not work now. More information
1686 In this fictitious example, everything goes via an ISP's caching proxy,
1687 except requests to that ISP:
1694 <emphasis>forward .* caching.myisp.net:8000</emphasis>
1695 <emphasis>forward myisp.net .</emphasis>
1702 For the @home network, we're told the forwarding configuration is this:
1710 <emphasis>forward .* proxy:8080</emphasis>
1717 Also, we're told they insist on getting cookies and JavaScript, so you should
1718 allow cookies from home.com. We consider JavaScript a potential security risk.
1719 Java need not be enabled.
1723 In this example direct connections are made to all <quote>internal</quote>
1724 domains, but everything else goes through Lucent's LPWA by way of the
1725 company's SOCKS gateway to the Internet.
1732 <emphasis>forward-socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
1733 <emphasis>forward my_company.com .</emphasis>
1740 This is how you could set up a site that always uses SOCKS but no forwarders:
1747 <emphasis>forward-socks4a .* . firewall.my_company.com:1080</emphasis>
1754 An advanced example for network administrators:
1758 If you have links to multiple ISPs that provide various special content to
1759 their subscribers, you can configure forwarding to pass requests to the
1760 specific host that's connected to that ISP so that everybody can see all
1761 of the content on all of the ISPs.
1765 This is a bit tricky, but here's an example:
1770 host-a has a PPP connection to isp-a.com. And host-b has a PPP connection to
1771 isp-b.com. host-a can run a <application>Privoxy</application> proxy with
1772 forwarding like this:
1779 <emphasis>forward .* .</emphasis>
1780 <emphasis>forward isp-b.com host-b:8118</emphasis>
1787 host-b can run a <application>Privoxy</application> proxy with forwarding
1795 <emphasis>forward .* .</emphasis>
1796 <emphasis>forward isp-a.com host-a:8118</emphasis>
1803 Now, <emphasis>anyone</emphasis> on the Internet (including users on host-a
1804 and host-b) can set their browser's proxy to <emphasis>either</emphasis>
1805 host-a or host-b and be able to browse the content on isp-a or isp-b.
1809 Here's another practical example, for University of Kent at
1810 Canterbury students with a network connection in their room, who
1811 need to use the University's Squid web cache.
1818 <emphasis>forward *. ssbcache.ukc.ac.uk:3128</emphasis> # Use the proxy, except for:
1819 <emphasis>forward .ukc.ac.uk . </emphasis> # Anything on the same domain as us
1820 <emphasis>forward * . </emphasis> # Host with no domain specified
1821 <emphasis>forward 129.12.*.* . </emphasis> # A dotted IP on our /16 network.
1822 <emphasis>forward 127.*.*.* . </emphasis> # Loopback address
1823 <emphasis>forward localhost.localdomain . </emphasis> # Loopback address
1824 <emphasis>forward www.ukc.mirror.ac.uk . </emphasis> # Specific host
1831 If you intend to chain <application>Privoxy</application> and
1832 <application>squid</application> locally, then chain as
1833 <literal>browser -> squid -> privoxy</literal> is the recommended way.
1837 Your squid configuration could then look like this (assuming that the IP
1838 address of the box is <literal>192.168.0.1</literal> ):
1845 # Define Privoxy as parent cache
1846 <!-- per feedback from user...
1847 cache_peer 127.0.0.1 8118 parent 0 no-query
1849 cache_peer 192.168.0.1 parent 8118 0 no-query
1851 # don't listen to the whole world
1852 http_port 192.168.0.1:3128
1854 # define the local lan
1855 acl mylocallan src 192.168.0.1-192.168.0.5/255.255.255.255
1857 # grant access for http to local lan
1858 http_access allow mylocallan
1860 # Define ACL for protocol FTP
1863 # Do not forward ACL FTP to privoxy
1864 always_direct allow FTP
1866 # Do not forward ACL CONNECT (https) to privoxy
1867 always_direct allow CONNECT
1869 # Forward the rest to privoxy
1870 never_direct allow all
1878 <!-- ~ End section ~ -->
1881 <!-- ~~~~~ New section ~~~~~ -->
1884 <title>Windows GUI Options</title>
1886 Removed references to Win32. HB 09/23/01
1889 <application>Privoxy</application> has a number of options specific to the
1890 Windows GUI interface:
1894 If <quote>activity-animation</quote> is set to 1, the
1895 <application>Privoxy</application> icon will animate when
1896 <quote>Privoxy</quote> is active. To turn off, set to 0.
1903 <emphasis>activity-animation 1</emphasis>
1910 If <quote>log-messages</quote> is set to 1,
1911 <application>Privoxy</application> will log messages to the console
1919 <emphasis>log-messages 1</emphasis>
1926 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1927 i.e. the amount of memory used for the log messages displayed in the
1928 console window, will be limited to <quote>log-max-lines</quote> (see below).
1932 Warning: Setting this to 0 will result in the buffer to grow infinitely and
1933 eat up all your memory!
1940 <emphasis>log-buffer-size 1</emphasis>
1947 <application>log-max-lines</application> is the maximum number of lines held
1948 in the log buffer. See above.
1955 <emphasis>log-max-lines 200</emphasis>
1962 If <quote>log-highlight-messages</quote> is set to 1,
1963 <application>Privoxy</application> will highlight portions of the log
1964 messages with a bold-faced font:
1971 <emphasis>log-highlight-messages 1</emphasis>
1978 The font used in the console window:
1985 <emphasis>log-font-name Comic Sans MS</emphasis>
1992 Font size used in the console window:
1999 <emphasis>log-font-size 8</emphasis>
2006 <quote>show-on-task-bar</quote> controls whether or not
2007 <application>Privoxy</application> will appear as a button on the Task bar
2015 <emphasis>show-on-task-bar 0</emphasis>
2022 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
2023 button will minimize <application>Privoxy</application> instead of closing
2024 the program (close with the exit option on the File menu).
2031 <emphasis>close-button-minimizes 1</emphasis>
2038 The <quote>hide-console</quote> option is specific to the MS-Win console
2039 version of <application>Privoxy</application>. If this option is used,
2040 <application>Privoxy</application> will disconnect from and hide the
2057 <!-- ~ End section ~ -->
2060 <!-- ~~~~~ New section ~~~~~ -->
2061 <sect2 id="actionsfile">
2062 <title>The Actions File</title>
2065 The <quote>default.action</quote> file (formerly
2066 <filename>actionsfile</filename> or <filename>ijb.action</filename>) is used
2067 to define what actions <application>Privoxy</application> takes, and thus
2068 determines how ad images, cookies and various other aspects of HTTP content
2069 and transactions are handled. These can be accepted or rejected for all
2070 sites, or just those sites you choose. See below for a complete list of
2074 Anything you want can blocked, including ads, banners, or just some obnoxious
2075 URL that you would rather not see. Cookies can be accepted or rejected, or
2076 accepted only during the current browser session (i.e. not written to disk).
2077 Changes to <filename>default.action</filename> should be immediately visible
2078 to <application>Privoxy</application> without the need to restart.
2082 Note that some sites may misbehave, or possibly not work at all with some
2083 actions. This may require some tinkering with the rules to get the most
2084 mileage of <application>Privoxy's</application> features, and still be
2085 able to see and enjoy just what you want to. There is no general rule of
2086 thumb on these things. There just are too many variables, and sites are
2092 The easiest way to edit the <quote>actions</quote> file is with a browser by
2093 loading <ulink url="http://p.p/">http://p.p/</ulink>, and then select
2094 <quote>Edit Actions List</quote>. A text editor can also be used.
2098 To determine which actions apply to a request, the URL of the request is
2099 compared to all patterns in this file. Every time it matches, the list of
2100 applicable actions for the URL is incrementally updated. You can trace
2101 this process by visiting <ulink
2102 url="http://p.p/show-url-info">http://p.p/show-url-info</ulink>.
2107 There are four types of lines in this file: comments (begin with a
2108 <quote>#</quote> character), actions, aliases and patterns, all of which are
2109 explained below, as well as the configuration file syntax that
2110 <application>Privoxy</application> understands.
2115 <!-- ~~~~~ New section ~~~~~ -->
2117 <title>URL Domain and Path Syntax</title>
2119 Generally, a pattern has the form <domain>/<path>, where both the
2120 <domain> and <path> part are optional. If you only specify a
2121 domain part, the <quote>/</quote> can be left out:
2125 <emphasis>www.example.com</emphasis> - is a domain only pattern and will match any request to
2126 <quote>www.example.com</quote>.
2130 <emphasis>www.example.com/</emphasis> - means exactly the same.
2134 <emphasis>www.example.com/index.html</emphasis> - matches only the single
2135 document <quote>/index.html</quote> on <quote>www.example.com</quote>.
2139 <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>,
2140 regardless of the domain. So would match any page named <quote>index.html</quote>
2145 <emphasis>index.html</emphasis> - matches nothing, since it would be
2146 interpreted as a domain name and there is no top-level domain called
2147 <quote>.html</quote>.
2151 The matching of the domain part offers some flexible options: if the
2152 domain starts or ends with a dot, it becomes unanchored at that end.
2157 <emphasis>.example.com</emphasis> - matches any domain or sub-domain that
2158 <emphasis>ENDS</emphasis> in <quote>.example.com</quote>.
2162 <emphasis>www.</emphasis> - matches any domain that <emphasis>STARTS</emphasis> with
2167 Additionally, there are wild-cards that you can use in the domain names
2168 themselves. They work pretty similar to shell wild-cards: <quote>*</quote>
2169 stands for zero or more arbitrary characters, <quote>?</quote> stands for
2170 any single character. And you can define character classes in square
2171 brackets and they can be freely mixed:
2175 <emphasis>ad*.example.com</emphasis> - matches <quote>adserver.example.com</quote>,
2176 <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>.
2180 <emphasis>*ad*.example.com</emphasis> - matches all of the above, and then some.
2184 <emphasis>.?pix.com</emphasis> - matches <quote>www.ipix.com</quote>,
2185 <quote>pictures.epix.com</quote>, <quote>a.b.c.d.e.upix.com</quote>, etc.
2189 <emphasis>www[1-9a-ez].example.com</emphasis> - matches <quote>www1.example.com</quote>,
2190 <quote>www4.example.com</quote>, <quote>wwwd.example.com</quote>,
2191 <quote>wwwz.example.com</quote>, etc., but <emphasis>not</emphasis>
2192 <quote>wwww.example.com</quote>.
2196 If <application>Privoxy</application> was compiled with
2197 <quote>pcre</quote> support (the default), Perl compatible regular expressions
2198 can be used. These are more flexible and powerful than other types
2199 of <quote>regular expressions</quote>. See the <filename>pcre/docs/</filename> directory or <quote>man
2200 perlre</quote> (also available on <ulink
2201 url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
2202 for details. A brief discussion of regular expressions is in the
2203 <link linkend="regex">Appendix</link>. For instance:
2207 <emphasis>/.*/advert[0-9]+\.jpe?g</emphasis> - would match a URL from any
2208 domain, with any path that includes <quote>advert</quote> followed
2209 immediately by one or more digits, then a <quote>.</quote> and ending in
2210 either <quote>jpeg</quote> or <quote>jpg</quote>. So we match
2211 <quote>example.com/ads/advert2.jpg</quote>, and
2212 <quote>www.example.com/ads/banners/advert39.jpeg</quote>, but not
2213 <quote>www.example.com/ads/banners/advert39.gif</quote> (no gifs in the
2218 Please note that matching in the path is case
2219 <emphasis>INSENSITIVE</emphasis> by default, but you can switch to case
2220 sensitive at any point in the pattern by using the
2221 <quote>(?-i)</quote> switch:
2225 <emphasis>www.example.com/(?-i)PaTtErN.*</emphasis> - will match only
2226 documents whose path starts with <quote>PaTtErN</quote> in
2227 <emphasis>exactly</emphasis> this capitalization.
2232 <!-- ~ End section ~ -->
2236 <!-- ~~~~~ New section ~~~~~ -->
2239 <title>Actions</title>
2241 Actions are enabled if preceded with a <quote>+</quote>, and disabled if
2242 preceded with a <quote>-</quote>. Actions are invoked by enclosing the
2243 action name in curly braces (e.g. {+some_action}), followed by a list of
2244 URLs to which the action applies. There are three classes of actions:
2252 Boolean (e.g. <quote>+/-block</quote>):
2258 <emphasis>{+name}</emphasis> # enable this action
2259 <emphasis>{-name}</emphasis> # disable this action
2269 parameterized (e.g. <quote>+/-hide-user-agent</quote>):
2275 <emphasis>{+name{param}}</emphasis> # enable action and set parameter to <quote>param</quote>
2276 <emphasis>{-name}</emphasis> # disable action
2285 Multi-value (e.g. <quote>{+/-add-header{Name: value}}</quote>, <quote>{+/-wafer{name=value}}</quote>):
2291 <emphasis>{+name{param}}</emphasis> # enable action and add parameter <quote>param</quote>
2292 <emphasis>{-name{param}}</emphasis> # remove the parameter <quote>param</quote>
2293 <emphasis>{-name}</emphasis> # disable this action totally
2304 If nothing is specified in this file, no <quote>actions</quote> are taken.
2305 So in this case <application>Privoxy</application> would just be a
2306 normal, non-blocking, non-anonymizing proxy. You must specifically
2307 enable the privacy and blocking features you need (although the
2308 provided default <filename>default.action</filename> file will
2309 give a good starting point).
2313 Later defined actions always over-ride earlier ones. So exceptions
2314 to any rules you make, should come in the latter part of the file. For
2315 multi-valued actions, the actions are applied in the order they are
2320 The list of valid <application>Privoxy</application> <quote>actions</quote> are:
2328 Add the specified HTTP header, which is not checked for validity.
2329 You may specify this many times to specify many different headers:
2335 <emphasis>+add-header{Name: value}</emphasis>
2345 Block this URL totally. In a default installation, a <quote>blocked</quote>
2346 URL will result in bright red banner that says <quote>BLOCKED</quote>,
2347 with a reason why it is being blocked, and an option to see it anyway.
2348 The page displayed for this is the <quote>blocked</quote> template
2355 <emphasis>+block</emphasis>
2365 De-animate all animated GIF images, i.e. reduce them to their last frame.
2366 This will also shrink the images considerably (in bytes, not pixels!). If
2367 the option <quote>first</quote> is given, the first frame of the animation
2368 is used as the replacement. If <quote>last</quote> is given, the last frame
2369 of the animation is used instead, which probably makes more sense for most
2370 banner animations, but also has the risk of not showing the entire last
2371 frame (if it is only a delta to an earlier frame).
2377 <emphasis>+deanimate-gifs{last}</emphasis>
2378 <emphasis>+deanimate-gifs{first}</emphasis>
2387 <quote>+downgrade</quote> will downgrade HTTP/1.1 client requests to
2388 HTTP/1.0 and downgrade the responses as well. Use this action for servers
2389 that use HTTP/1.1 protocol features that
2390 <application>Privoxy</application> doesn't handle well yet. HTTP/1.1
2391 is only partially implemented. Default is not to downgrade requests.
2397 <emphasis>+downgrade</emphasis>
2406 Many sites, like yahoo.com, don't just link to other sites. Instead, they
2407 will link to some script on their own server, giving the destination as a
2408 parameter, which will then redirect you to the final target. URLs resulting
2409 from this scheme typically look like:
2410 <emphasis>http://some.place/some_script?http://some.where-else</emphasis>.
2413 Sometimes, there are even multiple consecutive redirects encoded in the
2414 URL. These redirections via scripts make your web browsing more traceable,
2415 since the server from which you follow such a link can see where you go to.
2416 Apart from that, valuable bandwidth and time is wasted, while your browser
2417 ask the server for one redirect after the other. Plus, it feeds the
2421 The <quote>+fast-redirects</quote> option enables interception of these
2422 types of requests by <application>Privoxy</application>, who will cut off
2423 all but the last valid URL in the request and send a local redirect back to
2424 your browser without contacting the intermediate site(s).
2430 <emphasis>+fast-redirects</emphasis>
2439 Apply the filters in the <literal>section_header</literal>
2440 section of the <filename>default.filter</filename> file to the site(s).
2441 <filename>default.filter</filename> sections are grouped according to like
2442 functionality. <application>Filters</application> can be used to
2443 re-write any of the raw page content. This is a potentially a
2444 very powerful feature!
2451 <emphasis>+filter{section_header}</emphasis>
2458 Filter sections that are pre-defined in the supplied
2459 <filename>default.filter</filename> include:
2465 <emphasis>html-annoyances</emphasis>: Get rid of particularly annoying HTML abuse.
2470 <emphasis>js-annoyances</emphasis>: Get rid of particularly annoying JavaScript abuse
2475 <emphasis>no-poups</emphasis>: Kill all popups in JS and HTML
2480 <emphasis>frameset-borders</emphasis>: Give frames a border
2485 <emphasis>webbugs</emphasis>: Squish WebBugs (1x1 invisible GIFs used for user tracking)
2490 <emphasis>no-refresh</emphasis>: Automatic refresh sucks on auto-dialup lines
2495 <emphasis>fun</emphasis>: Text replacements for subversive browsing fun!
2500 <emphasis>nimda</emphasis>: Remove (virus) Nimda code.
2505 <emphasis>banners-by-size</emphasis>: Kill banners by size
2510 <emphasis>crude-parental</emphasis>: Kill all web pages that contain the words "sex" or "warez"
2519 Block any existing X-Forwarded-for header, and do not add a new one:
2525 <emphasis>+hide-forwarded</emphasis>
2534 If the browser sends a <quote>From:</quote> header containing your e-mail
2535 address, this either completely removes the header (<quote>block</quote>), or
2536 changes it to the specified e-mail address.
2542 <emphasis>+hide-from{block}</emphasis>
2543 <emphasis>+hide-from{spam@sittingduck.xqq}</emphasis>
2552 Don't send the <quote>Referer:</quote> (sic) header to the web site. You
2553 can block it, forge a URL to the same server as the request (which is
2554 preferred because some sites will not send images otherwise) or set it to a
2555 constant, user defined string of your choice.
2561 <emphasis>+hide-referer{block}</emphasis>
2562 <emphasis>+hide-referer{forge}</emphasis>
2563 <emphasis>+hide-referer{http://nowhere.com}</emphasis>
2572 Alternative spelling of <quote>+hide-referer</quote>. It has the same
2573 parameters, and can be freely mixed with, <quote>+hide-referer</quote>.
2574 (<quote>referrer</quote> is the correct English spelling, however the HTTP
2575 specification has a bug - it requires it to be spelled <quote>referer</quote>.)
2581 <emphasis>+hide-referrer{...}</emphasis>
2590 Change the <quote>User-Agent:</quote> header so web servers can't tell your
2591 browser type. Warning! This breaks many web sites. Specify the
2592 user-agent value you want. Example, pretend to be using Netscape on
2599 <emphasis>+hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)}</emphasis>
2606 Or to identify yourself explicitly as a <application>Privoxy</application> user:
2612 <emphasis>+hide-user-agent{Privoxy/1.0}</emphasis>
2617 (Don't change the version number from 1.0 - after all, why tell them?)
2624 <emphasis>+hide-user-agent{browser-type}</emphasis>
2634 Treat this URL as an image. This only matters if it's also <quote>+block</quote>ed,
2635 in which case a <quote>blocked</quote> image can be sent rather than a HTML page.
2636 See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
2637 If you want <emphasis>invisible</emphasis> ads, they should be defined as
2638 <emphasis>images</emphasis> and <emphasis>blocked</emphasis>. And also,
2639 <quote>image-blocker</quote> should be set to <quote>blank</quote>. Note you
2640 cannot treat HTML pages as images in most cases. For instance, frames
2641 require an HTML page to display. So a frame that is an ad, cannot be
2642 treated as an image. Forcing an <quote>image</quote> in this
2643 situation just will not work.
2649 <emphasis>+image</emphasis>
2657 <para> Decides what to do with URLs that end up tagged with <quote>{+block
2658 +image}</quote>, e.g an advertizement. There are five options.
2659 <quote>-image-blocker</quote> will send a HTML <quote>blocked</quote> page,
2660 usually resulting in a <quote>broken image</quote> icon.
2661 <!-- <quote>+image-blocker{logo}</quote> will send a -->
2662 <!-- <application>Privoxy</application> logo -->
2664 <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF
2665 image. And finally, <quote>+image-blocker{http://xyz.com}</quote> will send a
2666 HTTP temporary redirect to the specified image. This has the advantage of the
2667 icon being being cached by the browser, which will speed up the display.
2668 <quote>+image-blocker{pattern}</quote> will send a checkboard type pattern
2670 <!-- which scales better than the logo (which can get blocky if the browser -->
2671 <!-- enlarges it too much). -->
2677 <!-- <emphasis>+image-blocker{logo}</emphasis> -->
2678 <emphasis>+image-blocker{blank}</emphasis>
2679 <emphasis>+image-blocker{pattern}</emphasis>
2680 <emphasis>+image-blocker{http://p.p/send-banner}</emphasis>
2689 By default (i.e. in the absence of a <quote>+limit-connect</quote>
2690 action), <application>Privoxy</application> will only allow CONNECT
2691 requests to port 443, which is the standard port for https as a
2696 The CONNECT methods exists in HTTP to allow access to secure websites
2697 (https:// URLs) through proxies. It works very simply: the proxy
2698 connects to the server on the specified port, and then short-circuits
2699 its connections to the client <emphasis>and</emphasis> to the remote proxy.
2700 This can be a big security hole, since CONNECT-enabled proxies can
2701 be abused as TCP relays very easily.
2705 If you want to allow CONNECT for more ports than this, or want to forbid
2706 CONNECT altogether, you can specify a comma separated list of ports and
2707 port ranges (the latter using dashes, with the minimum defaulting to 0 and
2715 <emphasis>+limit-connect{443} # This is the default and need no be specified.</emphasis>
2716 <emphasis>+limit-connect{80,443} # Ports 80 and 443 are OK.</emphasis>
2717 <emphasis>+limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100</emphasis>
2718 <emphasis> #and above 500 are OK.</emphasis>
2728 <quote>+no-compression</quote> prevents the website from compressing the
2729 data. Some websites do this, which can be a problem for
2730 <application>Privoxy</application>, since <quote>+filter</quote>,
2731 <quote>+no-popup</quote> and <quote>+gif-deanimate</quote> will not work on
2732 compressed data. This will slow down connections to those websites,
2733 though. Default is <quote>no-compression</quote> is turned on.
2740 <emphasis>+nocompression</emphasis>
2749 If the website sets cookies, <quote>no-cookies-keep</quote> will make sure
2750 they are erased when you exit and restart your web browser. This makes
2751 profiling cookies useless, but won't break sites which require cookies so
2752 that you can log in for transactions. Default: on.
2758 <emphasis>+no-cookies-keep</emphasis>
2767 Prevent the website from reading cookies:
2773 <emphasis>+no-cookies-read</emphasis>
2782 Prevent the website from setting cookies:
2788 <emphasis>+no-cookies-set</emphasis>
2797 Filter the website through a built-in filter to disable those obnoxious
2798 JavaScript pop-up windows via window.open(), etc. The two alternative
2799 spellings are equivalent.
2805 <emphasis>+no-popup</emphasis>
2806 <emphasis>+no-popups</emphasis>
2815 This action only applies if you are using a <filename>jarfile</filename>
2816 for saving cookies. It sends a cookie to every site stating that you do not
2817 accept any copyright on cookies sent to you, and asking them not to track
2818 you. Of course, this is a (relatively) unique header they could use to
2825 <emphasis>+vanilla-wafer</emphasis>
2834 This allows you to add an arbitrary cookie. It can be specified multiple
2835 times in order to add as many cookies as you like.
2841 <emphasis>+wafer{name=value}</emphasis>
2852 The meaning of any of the above is reversed by preceding the action with a
2853 <quote>-</quote>, in place of the <quote>+</quote>.
2861 Turn off cookies by default, then allow a few through for specified sites:
2868 # Turn off all persistent cookies
2869 { +no-cookies-read }
2871 # Allow cookies for this browser session ONLY
2872 { +no-cookies-keep }
2874 # Exceptions to the above, sites that benefit from persistent cookies
2875 { -no-cookies-read }
2877 { -no-cookies-keep }
2884 # Alternative way of saying the same thing
2885 {-no-cookies-set -no-cookies-read -no-cookies-keep}
2894 Now turn off <quote>fast redirects</quote>, and then we allow two exceptions:
2904 # Reverse it for these two sites, which don't work right without it.
2906 www.ukc.ac.uk/cgi-bin/wac\.cgi\?
2914 Turn on page filtering according to rules in the defined sections
2915 of <filename>refilterfile</filename>, and make one exception for
2923 # Run everything through the filter file, using only the
2924 # specified sections:
2925 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}\
2926 +filter{webbugs} +filter{nimda} +filter{banners-by-size}
2928 # Then disable filtering of code from sourceforge!
2930 .cvs.sourceforge.net
2937 Now some URLs that we want <quote>blocked</quote> (normally generates
2938 the <quote>blocked</quote> banner). Many of these use regular expressions
2939 that will expand to match multiple URLs:
2948 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
2949 /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/])
2950 /.*/(ng)?adclient\.cgi
2951 /.*/(plain|live|rotate)[-_.]?ads?/
2952 /.*/(sponsor)s?[0-9]?/
2953 /.*/_?(plain|live)?ads?(-banners)?/
2955 /.*/ad(sdna_image|gifs?)/
2956 /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
2960 /.*/adv((er)?ts?|ertis(ing|ements?))?/
2964 /.*/cgi-bin/centralad/getimage
2965 /.*/images/addver\.gif
2966 /.*/images/marketing/.*\.(gif|jpe?g)
2970 /.*/sponsors?[0-9]?/
2971 /.*/advert[0-9]+\.jpg
2978 /graphics/defaultAd/
2980 /image\.ng/transactionID
2981 /images/.*/.*_anim\.gif # alvin brattli
2982 /ip_img/.*\.(gif|jpe?g)
2986 /cgi-bin/nph-adclick.exe/
2987 /.*/Image/BannerAdvertising/
2989 /.*/adlib/server\.cgi
2997 Note that many of these actions have the potential to cause a page to
2998 misbehave, possibly even not to display at all. There are many ways
2999 a site designer may choose to design his site, and what HTTP header
3000 content he may depend on. There is no way to have hard and fast rules
3001 for all sites. See the <link linkend="ACTIONSANAT">Appendix</link>
3002 for a brief example on troubleshooting actions.
3007 <!-- ~ End section ~ -->
3010 <!-- ~~~~~ New section ~~~~~ -->
3012 <title>Aliases</title>
3014 Custom <quote>actions</quote>, known to <application>Privoxy</application>
3015 as <quote>aliases</quote>, can be defined by combining other <quote>actions</quote>.
3016 These can in turn be invoked just like the built-in <quote>actions</quote>.
3017 Currently, an alias can contain any character except space, tab, <quote>=</quote>,
3018 <quote>{</quote> or <quote>}</quote>. But please use only <quote>a</quote>-
3019 <quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
3020 <quote>-</quote>. Alias names are not case sensitive, and
3021 <emphasis>must be defined before anything</emphasis> else in the
3022 <filename>default.action</filename>file! And there can only be one set of
3023 <quote>aliases</quote> defined.
3027 Now let's define a few aliases:
3034 # Useful custom aliases we can use later. These must come first!
3036 +no-cookies = +no-cookies-set +no-cookies-read
3037 -no-cookies = -no-cookies-set -no-cookies-read
3038 fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups
3039 shop = -no-cookies -filter -fast-redirects
3040 +imageblock = +block +image
3042 #For people who don't like to type too much: ;-)
3045 c2 = -no-cookies-set +no-cookies-read
3046 c3 = +no-cookies-set -no-cookies-read
3047 #... etc. Customize to your heart's content.
3054 Some examples using our <quote>shop</quote> and <quote>fragile</quote>
3062 # These sites are very complex and require
3063 # minimal interference.
3065 .office.microsoft.com
3066 .windowsupdate.microsoft.com
3069 # Shopping sites - still want to block ads.
3072 .worldpay.com # for quietpc.com
3076 # These shops require pop-ups
3086 The <quote>shop</quote> and <quote>fragile</quote> aliases are often used for
3087 <quote>problem</quote> sites that require most actions to be disabled
3088 in order to function properly.
3095 <!-- ~ End section ~ -->
3098 <!-- ~~~~~ New section ~~~~~ -->
3099 <sect2 id="filterfile">
3100 <title>The Filter File</title>
3102 Any web page can be dynamically modified with the filter file. This
3103 modification can be removal, or re-writing, of any web page content,
3104 including tags and non-visible content. The default filter file is
3105 <filename>default.filter</filename>, located in the config directory.
3109 This is potentially a very powerful feature, and requires knowledge of both
3110 <quote>regular expression</quote> and HTML in order create custom
3111 filters. But, there are a number of useful filters included with
3112 <application>Privoxy</application> for many common situations.
3116 The included example file is divided into sections. Each section begins
3117 with the <literal>FILTER</literal> keyword, followed by the identifier
3118 for that section, e.g. <quote>FILTER: webbugs</quote>. Each section performs
3119 a similar type of filtering, such as <quote>html-annoyances</quote>.
3123 This file uses regular expressions to alter or remove any string in the
3124 target page. The expressions can only operate on one line at a time. Some
3125 examples from the included default <filename>default.filter</filename>:
3129 Stop web pages from displaying annoying messages in the status bar by
3130 deleting such references:
3137 FILTER: html-annoyances
3139 # New browser windows should be resizeable and have a location and status
3142 s/resizable="?(no|0)"?/resizable=1/ig s/noresize/yesresize/ig
3143 s/location="?(no|0)"?/location=1/ig s/status="?(no|0)"?/status=1/ig
3144 s/scrolling="?(no|0|Auto)"?/scrolling=1/ig
3145 s/menubar="?(no|0)"?/menubar=1/ig
3147 # The <BLINK> tag was a crime!
3149 s*<blink>|</blink>**ig
3153 #s/framespacing="?(no|0)"?//ig
3154 #s/margin(height|width)=[0-9]*//gi
3161 Just for kicks, replace any occurrence of <quote>Microsoft</quote> with
3162 <quote>MicroSuck</quote>, and have a little fun with topical buzzwords:
3171 s/microsoft(?!.com)/MicroSuck/ig
3175 s/industry-leading|cutting-edge|award-winning/<font color=red><b>BINGO!</b></font>/ig
3182 Kill those pesky little web-bugs:
3189 # webbugs: Squish WebBugs (1x1 invisible GIFs used for user tracking)
3192 s/<img\s+[^>]*?(width|height)\s*=\s*['"]?1\D[^>]*?(width|height)\s*=\s*['"]?1(\D[^>]*?)?>/<!-- Squished WebBug -->/sig
3200 <!-- ~ End section ~ -->
3204 <!-- ~~~~~ New section ~~~~~ -->
3207 <title>Templates</title>
3209 When <application>Privoxy</application> displays one of its internal
3210 pages, such as a 404 Not Found error page, it uses the appropriate template.
3211 On Linux, BSD, and Unix, these are located in
3212 <filename>/etc/privoxy/templates</filename> by default. These may be
3213 customized, if desired. <filename>cgi-style.css</filename> is
3214 used to control the HTML attributes (fonts, etc).
3217 The default <quote>Blocked</quote> banner page with the bright red top
3218 banner, is called just <quote><filename>blocked</filename></quote>. This
3219 may be customized or replaced with something else if desired.
3226 <!-- ~ End section ~ -->
3230 <!-- ~~~~~ New section ~~~~~ -->
3232 <sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
3235 <!-- Include contacting.sgml boilerplate: -->
3237 <!-- end boilerplate -->
3240 <!-- ~~~~~ New section ~~~~~ -->
3241 <sect2 id="submitactions">
3242 <title>Submitting Ads and <quote>Action</quote> Problems</title>
3244 Ads and banners that are not stopped by <application>Privoxy</application>
3245 can be submitted to the developers by accessing a special page and filling
3246 out the brief, required form. Conversely, you can also report pages, images,
3247 etc. that <application>Privoxy</application> is blocking, but should not.
3248 The form itself does require Internet access.
3251 To do this, point your browser to <application>Privoxy</application>
3252 at <ulink url="http://p.p/">http://p.p/</ulink>, and then select
3253 <ulink url="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(window.open('http://www.privoxy.org/actions','Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Actions file feedback system</ulink>,
3254 near the bottom of the page. Paste in the URL that is the cause of the
3255 unwanted behavior, and follow the prompts. The developers will
3256 try to incorporate your submission into future versions.
3260 New <filename>default.actions</filename> files will occasionally be made
3261 available based on your feedback. These
3262 will be announced on the
3264 url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce">ijbswa-announce</ulink>
3272 <!-- ~~~~~ New section ~~~~~ -->
3273 <sect1 id="copyright"><title>Copyright and History</title>
3275 <sect2><title>Copyright</title>
3276 <!-- Include copyright.sgml: -->
3278 <!-- end copyright -->
3281 <!-- ~ End section ~ -->
3284 <!-- ~~~~~ New section ~~~~~ -->
3286 <sect2 id="history"><title>History</title>
3287 <!-- Include history.sgml: -->
3289 <!-- end history -->
3293 <!-- ~~~~~ New section ~~~~~ -->
3294 <sect1 id="seealso"><title>See Also</title>
3295 <!-- Include seealso.sgml: -->
3297 <!-- end seealso -->
3302 <!-- ~~~~~ New section ~~~~~ -->
3303 <sect1 id="appendix"><title>Appendix</title>
3306 <!-- ~~~~~ New section ~~~~~ -->
3308 <title>Regular Expressions</title>
3310 <application>Privoxy</application> can use <quote>regular expressions</quote>
3311 in various config files. Assuming support for <quote>pcre</quote> (Perl
3312 Compatible Regular Expressions) is compiled in, which is the default. Such
3313 configuration directives do not require regular expressions, but they can be
3314 used to increase flexibility by matching a pattern with wild-cards against
3319 If you are reading this, you probably don't understand what <quote>regular
3320 expressions</quote> are, or what they can do. So this will be a very brief
3321 introduction only. A full explanation would require a book ;-)
3325 <quote>Regular expressions</quote> is a way of matching one character
3326 expression against another to see if it matches or not. One of the
3327 <quote>expressions</quote> is a literal string of readable characters
3328 (letter, numbers, etc), and the other is a complex string of literal
3329 characters combined with wild-cards, and other special characters, called
3330 meta-characters. The <quote>meta-characters</quote> have special meanings and
3331 are used to build the complex pattern to be matched against. Perl Compatible
3332 Regular Expressions is an enhanced form of the regular expression language
3333 with backward compatibility.
3337 To make a simple analogy, we do something similar when we use wild-card
3338 characters when listing files with the <command>dir</command> command in DOS.
3339 <literal>*.*</literal> matches all filenames. The <quote>special</quote>
3340 character here is the asterisk which matches any and all characters. We can be
3341 more specific and use <literal>?</literal> to match just individual
3342 characters. So <quote>dir file?.text</quote> would match
3343 <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
3344 matching, using a similar technique to <quote>regular expressions</quote>!
3348 Regular expressions do essentially the same thing, but are much, much more
3349 powerful. There are many more <quote>special characters</quote> and ways of
3350 building complex patterns however. Let's look at a few of the common ones,
3351 and then some examples:
3356 <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
3357 <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
3363 <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
3370 <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
3377 <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
3384 <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
3385 the following character should be taken literally. This is used where one of the
3386 special characters (e.g. <quote>.</quote>) needs to be taken literally and
3387 not as a special meta-character.
3393 <emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
3394 any of the enclosed characters are encountered.
3400 <emphasis>()</emphasis> - parentheses are used to group a sub-expression,
3401 or multiple sub-expressions.
3407 <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
3408 <quote>or</quote> conditional statement. A match is successful if the
3409 sub-expression on either side of <quote>|</quote> matches.
3415 <emphasis>s/string1/string2/g</emphasis> - This is used to rewrite strings of text.
3416 <quote>string1</quote> is replaced by <quote>string2</quote> in this
3422 These are just some of the ones you are likely to use when matching URLs with
3423 <application>Privoxy</application>, and is a long way from a definitive
3424 list. This is enough to get us started with a few simple examples which may
3425 be more illuminating:
3429 <emphasis><literal>/.*/banners/.*</literal></emphasis> - A simple example
3430 that uses the common combination of <quote>.</quote> and <quote>*</quote> to
3431 denote any character, zero or more times. In other words, any string at all.
3432 So we start with a literal forward slash, then our regular expression pattern
3433 (<quote>.*</quote>) another literal forward slash, the string
3434 <quote>banners</quote>, another forward slash, and lastly another
3435 <quote>.*</quote>. We are building
3436 a directory path here. This will match any file with the path that has a
3437 directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
3438 any characters, and this could conceivably be more forward slashes, so it
3439 might expand into a much longer looking path. For example, this could match:
3440 <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
3441 <quote>/banners/annoying.html</quote>, or almost an infinite number of other
3442 possible combinations, just so it has <quote>banners</quote> in the path
3447 A now something a little more complex:
3451 <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
3452 We have several literal forward slashes again (<quote>/</quote>), so we are
3453 building another expression that is a file path statement. We have another
3454 <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
3455 it matches our expression. The only true literal that <emphasis>must
3456 match</emphasis> our pattern is <application>adv</application>, together with
3457 the forward slashes. What comes after the <quote>adv</quote> string is the
3462 Remember the <quote>?</quote> means the preceding expression (either a
3463 literal character or anything grouped with <quote>(...)</quote> in this case)
3464 can exist or not, since this means either zero or one match. So
3465 <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
3466 individual sub-expressions: <quote>(er)</quote>,
3467 <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
3468 means <quote>or</quote>. We have two of those. For instance,
3469 <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
3470 <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
3471 attempt at matching as many variations of <quote>advertisement</quote>, and
3472 similar, as possible. So this would expand to match just <quote>adv</quote>,
3473 or <quote>advert</quote>, or <quote>adverts</quote>, or
3474 <quote>advertising</quote>, or <quote>advertisement</quote>, or
3475 <quote>advertisements</quote>. You get the idea. But it would not match
3476 <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
3477 changing our regular expression to:
3478 <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
3483 <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
3484 another path statement with forward slashes. Anything in the square brackets
3485 <quote>[]</quote> can be matched. This is using <quote>0-9</quote> as a
3486 shorthand expression to mean any digit one through nine. It is the same as
3487 saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
3488 means one or more of the preceding expression must be included. The preceding
3489 expression here is what is in the square brackets -- in this case, any digit
3490 one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
3491 This includes a <quote>|</quote>, so this needs to match the expression on
3492 either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
3493 side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
3494 since the <quote>?</quote> means the letter <quote>e</quote> is optional and
3495 can be matched once or not at all. So we are building an expression here to
3496 match image GIF or JPEG type image file. It must include the literal
3497 string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
3498 (which is now a literal, and not a special character, since it is escaped
3499 with <quote>\</quote>), and lastly either <quote>gif</quote>, or
3500 <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
3501 include: <quote>//advert1.jpg</quote>,
3502 <quote>/nasty/ads/advert1234.gif</quote>,
3503 <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
3504 <quote>advert1.gif</quote> (no leading slash), or
3505 <quote>/adverts232.jpg</quote> (the expression does not include an
3506 <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
3507 in the expression anywhere).
3511 <emphasis><literal>s/microsoft(?!.com)/MicroSuck/i</literal></emphasis> - This is
3512 a substitution. <quote>MicroSuck</quote> will replace any occurrence of
3513 <quote>microsoft</quote>. The <quote>i</quote> at the end of the expression
3514 means ignore case. The <quote>(?!.com)</quote> means
3515 the match should fail if <quote>microsoft</quote> is followed by
3516 <quote>.com</quote>. In other words, this acts like a <quote>NOT</quote>
3517 modifier. In case this is a hyperlink, we don't want to break it ;-).
3521 We are barely scratching the surface of regular expressions here so that you
3522 can understand the default <application>Privoxy</application>
3523 configuration files, and maybe use this knowledge to customize your own
3524 installation. There is much, much more that can be done with regular
3525 expressions. Now that you know enough to get started, you can learn more on
3530 More reading on Perl Compatible Regular expressions:
3531 <ulink url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>
3536 <!-- ~ End section ~ -->
3539 <!-- ~~~~~ New section ~~~~~ -->
3541 <title><application>Privoxy</application>'s Internal Pages</title>
3544 Since <application>Privoxy</application> proxies each requested
3545 web page, it is easy for <application>Privoxy</application> to
3546 trap certain special URLs. In this way, we can talk directly to
3547 <application>Privoxy</application>, and see how it is
3548 configured, see how our rules are being applied, change these
3549 rules and other configuration options, and even turn
3550 <application>Privoxy's</application> filtering off, all with
3556 The URLs listed below are the special ones that allow direct access
3557 to <application>Privoxy</application>. Of course,
3558 <application>Privoxy</application> must be running to access these. If
3559 not, you will get a friendly error message. Internet access is not
3572 <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
3576 Alternately, this may be reached at <ulink
3577 url="http://p.p/">http://p.p/</ulink>, but this
3578 variation may not work as reliably as the above in some configurations.
3584 Show information about the current configuration:
3588 <ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
3595 Show the source code version numbers:
3599 <ulink url="http://config.privoxy.org/show-version">http://config.privoxy.org/show-version</ulink>
3606 Show the client's request headers:
3610 <ulink url="http://config.privoxy.org/show-request">http://config.privoxy.org/show-request</ulink>
3617 Show which actions apply to a URL and why:
3621 <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
3628 Toggle Privoxy on or off. In this case, <quote>Privoxy</quote> continues
3629 to run, but only as a pass-through proxy, with no actions taking place:
3633 <ulink url="http://config.privoxy.org/toggle">http://config.privoxy.org/toggle</ulink>
3637 Short cuts. Turn off, then on:
3641 <ulink url="http://config.privoxy.org/toggle?set=disable">http://config.privoxy.org/toggle?set=disable</ulink>
3646 <ulink url="http://config.privoxy.org/toggle?set=enable">http://config.privoxy.org/toggle?set=enable</ulink>
3653 Edit the actions list file:
3657 <ulink url="http://config.privoxy.org/edit-actions">http://config.privoxy.org/edit-actions</ulink>
3666 These may be bookmarked for quick reference.
3670 <sect3 id="bookmarklets">
3671 <title>Bookmarklets</title>
3673 Below are some <quote>bookmarklets</quote> to allow you to easily access a
3674 <quote>mini</quote> version of some of <application>Privoxy's</application>
3675 special pages. They are designed for MS Internet Explorer, but should work
3676 equally well in Netscape, Mozilla, and other browsers which support
3677 JavaScript. They are designed to run directly from your bookmarks - not by
3678 clicking the links below (although that should work for testing).
3681 To save them, right-click the link and choose <quote>Add to Favorites</quote>
3682 (IE) or <quote>Add Bookmark</quote> (Netscape). You will get a warning that
3683 the bookmark <quote>may not be safe</quote> - just click OK. Then you can run the
3684 Bookmarklet directly from your favourites/bookmarks. For even faster access,
3685 you can put them on the <quote>Links</quote> bar (IE) or the <quote>Personal
3686 Toolbar</quote> (Netscape), and run them with a single click.
3694 <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>
3700 <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>
3706 <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)
3712 <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>
3718 <ulink url="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(window.open('http://www.privoxy.org/actions','Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Actions file feedback system</ulink>
3728 Credit: The site which gave me the general idea for these bookmarklets is
3729 <ulink url="http://www.bookmarklets.com">www.bookmarklets.com</ulink>. They
3730 have more information about bookmarklets.
3739 <!-- ~~~~~ New section ~~~~~ -->
3740 <sect2 id="actionsanat">
3741 <title>Anatomy of an Action</title>
3744 The way <application>Privoxy</application> applies <quote>actions</quote>
3745 and <quote>filters</quote> to any given URL can be complex, and not always so
3746 easy to understand what is happening. And sometimes we need to be able to
3747 <emphasis>see</emphasis> just what <application>Privoxy</application> is
3748 doing. Especially, if something <application>Privoxy</application> is doing
3749 is causing us a problem inadvertantly. It can be a little daunting to look at
3750 the actions and filters files themselves, since they tend to be filled with
3751 <quote>regular expressions</quote> whose consequences are not always
3752 so obvious. <application>Privoxy</application> provides the
3753 <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
3754 page that can show us very specifically how <application>actions</application>
3755 are being applied to any given URL. This is a big help for troubleshooting.
3759 First, enter one URL (or partial URL) at the prompt, and then
3760 <application>Privoxy</application> will tell us
3761 how the current configuration will handle it. This will not
3762 help with filtering effects from the <filename>default.filter</filename> file! It
3763 also will not tell you about any other URLs that may be embedded within the
3764 URL you are testing. For instance, images such as ads are expressed as URLs
3765 within the raw page source of HTML pages. So you will only get info for the
3766 actual URL that is pasted into the prompt area -- not any sub-URLs. If you
3767 want to know about embedded URLs like ads, you will have to dig those out of
3768 the HTML source. Use your browser's <quote>View Page Source</quote> option
3769 for this. Or right click on the ad, and grab the URL.
3773 Let's look at an example, <ulink url="http://google.com">google.com</ulink>,
3774 one section at a time:
3779 System default actions:
3781 { -add-header -block -deanimate-gifs -downgrade -fast-redirects -filter
3782 -hide-forwarded -hide-from -hide-referer -hide-user-agent -image
3783 -image-blocker -limit-connect -no-compression -no-cookies-keep
3784 -no-cookies-read -no-cookies-set -no-popups -vanilla-wafer -wafer }
3790 This is the top section, and only tells us of the compiled in defaults. This
3791 is basically what <application>Privoxy</application> would do if there
3792 were not any <quote>actions</quote> defined, i.e. it does nothing. Every action
3793 is disabled. This is not particularly informative for our purposes here. OK,
3800 Matches for http://google.com:
3802 { -add-header -block +deanimate-gifs -downgrade +fast-redirects
3803 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
3804 +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
3805 +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
3806 -hide-user-agent -image +image-blocker{blank} +no-compression
3807 +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups
3808 -vanilla-wafer -wafer }
3811 { -no-cookies-keep -no-cookies-read -no-cookies-set }
3821 This is much more informative, and tells us how we have defined our
3822 <quote>actions</quote>, and which ones match for our example,
3823 <quote>google.com</quote>. The first grouping shows our default
3824 settings, which would apply to all URLs. If you look at your <quote>actions</quote>
3825 file, this would be the section just below the <quote>aliases</quote> section
3826 near the top. This applies to all URLs as signified by the single forward
3827 slash -- <quote>/</quote>.
3832 These are the default actions we have enabled. But we can define additional
3833 actions that would be exceptions to these general rules, and then list
3834 specific URLs that these exceptions would apply to. Last match wins.
3835 Just below this then are two explict matches for <quote>.google.com</quote>.
3836 The first is negating our various cookie blocking actions (i.e. we will allow
3837 cookies here). The second is allowing <quote>fast-redirects</quote>. Note
3838 that there is a leading dot here -- <quote>.google.com</quote>. This will
3839 match any hosts and sub-domains, in the google.com domain also, such as
3840 <quote>www.google.com</quote>. So, apparently, we have these actions defined
3841 somewhere in the lower part of our actions file, and
3842 <quote>google.com</quote> is referenced in these sections.
3847 And now we pull it altogether in the bottom section and summarize how
3848 <application>Privoxy</application> is appying all its <quote>actions</quote>
3849 to <quote>google.com</quote>:
3858 -add-header -block -deanimate-gifs -downgrade -fast-redirects
3859 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
3860 +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
3861 +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
3862 -hide-user-agent -image +image-blocker{blank} -limit-connect +no-compression
3863 -no-cookies-keep -no-cookies-read -no-cookies-set +no-popups -vanilla-wafer
3870 Now another example, <quote>ad.doubleclick.net</quote>:
3889 We'll just show the interesting part here, the explicit matches. It is
3890 matched three different times. Each as an <quote>+block +image</quote>,
3891 which is the expanded form of one of our aliases that had been defined as:
3892 <quote>+imageblock</quote>. (<quote>Aliases</quote> are defined in the
3893 first section of the actions file and typically used to combine more
3898 Any one of these would have done the trick and blocked this as an unwanted
3899 image. This is unnecessarily redundant since the last case effectively
3900 would also cover the first. No point in taking chances with these guys
3901 though ;-) Note that if you want an ad or obnoxious
3902 URL to be invisible, it should be defined as <quote>ad.doubleclick.net</quote>
3903 is done here -- as both a <quote>+block</quote> <emphasis>and</emphasis> an
3904 <quote>+image</quote>. The custom alias <quote>+imageblock</quote> does this
3909 One last example. Let's try <quote>http://www.rhapsodyk.net/adsl/HOWTO/</quote>.
3910 This one is giving us problems. We are getting a blank page. Hmmm...
3916 Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
3918 { -add-header -block +deanimate-gifs -downgrade +fast-redirects
3919 +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
3920 +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal}
3921 +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge}
3922 -hide-user-agent -image +image-blocker{blank} +no-compression
3923 +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups
3924 -vanilla-wafer -wafer }
3934 Ooops, the <quote>/adsl/</quote> is matching <quote>/ads</quote>! But
3935 we did not want this at all! Now we see why we get the blank page. We could
3936 now add a new action below this that explictly does <emphasis>not</emphasis>
3937 block (-block) pages with <quote>adsl</quote>. There are various ways to
3938 handle such exceptions. Example:
3951 Now the page displays ;-) Be sure to flush your browser's caches when
3952 making such changes. Or, try using <literal>Shift+Reload</literal>.
3956 But now what about a situation where we get no explicit matches like
3970 That actually was very telling and pointed us quickly to where the problem
3971 was. If you don't get this kind of match, then it means one of the default
3972 rules in the first section is causing the problem. This would require some
3973 guesswork, and maybe a little trial and error to isolate the offending rule.
3974 One likely cause would be one of the <quote>{+filter}</quote> actions. Try
3975 adding the URL for the site to one of aliases that turn off <quote>+filter</quote>:
3983 .worldpay.com # for quietpc.com
3992 <quote>{shop}</quote> is an <quote>alias</quote> that expands to
3993 <quote>{ -filter -no-cookies -no-cookies-keep }</quote>. Or you could do
3994 your own exception to negate filtering:
4008 <quote>{fragile}</quote> is an alias that disables most actions. This can be
4009 used as a last resort for problem sites. Remember to flush caches! If this
4010 still does not work, you will have to go through the remaining actions one by
4011 one to find which one(s) is causing the problem.
4020 This program is free software; you can redistribute it
4021 and/or modify it under the terms of the GNU General
4022 Public License as published by the Free Software
4023 Foundation; either version 2 of the License, or (at
4024 your option) any later version.
4026 This program is distributed in the hope that it will
4027 be useful, but WITHOUT ANY WARRANTY; without even the
4028 implied warranty of MERCHANTABILITY or FITNESS FOR A
4029 PARTICULAR PURPOSE. See the GNU General Public
4030 License for more details.
4032 The GNU General Public License should be included with
4033 this file. If not, you can view it at
4034 http://www.gnu.org/copyleft/gpl.html
4035 or write to the Free Software Foundation, Inc., 59
4036 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
4038 $Log: user-manual.sgml,v $
4039 Revision 1.75 2002/04/12 02:08:48 david__schmidt
4040 Remove OS/2 building info... it is already in the developer-manual
4042 Revision 1.74 2002/04/11 00:54:38 hal9
4043 Add small section on submitting actions.
4045 Revision 1.73 2002/04/10 18:45:15 swa
4048 Revision 1.72 2002/04/10 04:06:19 hal9
4049 Added actions feedback to Bookmarklets section
4051 Revision 1.71 2002/04/08 22:59:26 hal9
4052 Version update. Spell chkconfig correctly :)
4054 Revision 1.70 2002/04/08 20:53:56 swa
4057 Revision 1.69 2002/04/06 05:07:29 hal9
4058 -Add privoxy-man-page.sgml, for man page.
4059 -Add authors.sgml for AUTHORS (and p-authors.sgml)
4060 -Reworked various aspects of various docs.
4061 -Added additional comments to sub-docs.
4063 Revision 1.68 2002/04/04 18:46:47 swa
4064 consistent look. reuse of copyright, history et. al.
4066 Revision 1.67 2002/04/04 17:27:57 swa
4067 more single file to be included at multiple points. make maintaining easier
4069 Revision 1.66 2002/04/04 06:48:37 hal9
4070 Structural changes to allow for conditional inclusion/exclusion of content
4071 based on entity toggles, e.g. 'entity % p-not-stable "INCLUDE"'. And
4072 definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
4073 eventually be set by Makefile.
4074 More boilerplate text for use across multiple docs.
4076 Revision 1.65 2002/04/03 19:52:07 swa
4077 enhance squid section due to user suggestion
4079 Revision 1.64 2002/04/03 03:53:43 hal9
4080 A few minor bug fixes, and touch ups. Ready for review.
4082 Revision 1.63 2002/04/01 16:24:49 hal9
4083 Define entities to include boilerplate text. See doc/source/*.
4085 Revision 1.62 2002/03/30 04:15:53 hal9
4086 - Fix privoxy.org/config links.
4087 - Paste in Bookmarklets from Toggle page.
4088 - Move Quickstart nearer top, and minor rework.
4090 Revision 1.61 2002/03/29 01:31:08 hal9
4093 Revision 1.60 2002/03/27 01:57:34 hal9
4094 Added more to Anatomy section.
4096 Revision 1.59 2002/03/27 00:54:33 hal9
4097 Touch up intro for new name.
4099 Revision 1.58 2002/03/26 22:29:55 swa
4100 we have a new homepage!
4102 Revision 1.57 2002/03/24 20:33:30 hal9
4103 A few minor catch ups with name change.
4105 Revision 1.56 2002/03/24 16:17:06 swa
4106 configure needs to be generated.
4108 Revision 1.55 2002/03/24 16:08:08 swa
4109 we are too lazy to make a block-built
4110 privoxy logo. hence removed the option.
4112 Revision 1.54 2002/03/24 15:46:20 swa
4113 name change related issue.
4115 Revision 1.53 2002/03/24 11:51:00 swa
4116 name change. changed filenames.
4118 Revision 1.52 2002/03/24 11:01:06 swa
4121 Revision 1.51 2002/03/23 15:13:11 swa
4122 renamed every reference to the old name with foobar.
4123 fixed "application foobar application" tag, fixed
4124 "the foobar" with "foobar". left junkbustser in cvs
4125 comments and remarks to history untouched.
4127 Revision 1.50 2002/03/23 05:06:21 hal9
4130 Revision 1.49 2002/03/21 17:01:05 hal9
4131 New section in Appendix.
4133 Revision 1.48 2002/03/12 06:33:01 hal9
4134 Catching up to Andreas and re_filterfile changes.
4136 Revision 1.47 2002/03/11 13:13:27 swa
4137 correct feedback channels
4139 Revision 1.46 2002/03/10 00:51:08 hal9
4140 Added section on JB internal pages in Appendix.
4142 Revision 1.45 2002/03/09 17:43:53 swa
4145 Revision 1.44 2002/03/09 17:08:48 hal9
4146 New section on Jon's actions file editor, and move some stuff around.
4148 Revision 1.43 2002/03/08 00:47:32 hal9
4149 Added imageblock{pattern}.
4151 Revision 1.42 2002/03/07 18:16:55 swa
4154 Revision 1.41 2002/03/07 16:46:43 hal9
4155 Fix a few markup problems for jade.
4157 Revision 1.40 2002/03/07 16:28:39 swa
4158 provide correct feedback channels
4160 Revision 1.39 2002/03/06 16:19:28 hal9
4161 Note on perceived filtering slowdown per FR.
4163 Revision 1.38 2002/03/05 23:55:14 hal9
4164 Stupid I did it again. Double hyphen in comment breaks jade.
4166 Revision 1.37 2002/03/05 23:53:49 hal9
4167 jade barfs on '- -' embedded in comments. - -user option broke it.
4169 Revision 1.36 2002/03/05 22:53:28 hal9
4170 Add new - - user option.
4172 Revision 1.35 2002/03/05 00:17:27 hal9
4173 Added section on command line options.
4175 Revision 1.34 2002/03/04 19:32:07 oes
4176 Changed default port to 8118
4178 Revision 1.33 2002/03/03 19:46:13 hal9
4179 Emphasis on where/how to report bugs, etc
4181 Revision 1.32 2002/03/03 09:26:06 joergs
4182 AmigaOS changes, config is now loaded from PROGDIR: instead of
4183 AmiTCP:db/junkbuster/ if no configuration file is specified on the
4186 Revision 1.31 2002/03/02 22:45:52 david__schmidt
4189 Revision 1.30 2002/03/02 22:00:14 hal9
4190 Updated 'New Features' list. Ran through spell-checker.
4192 Revision 1.29 2002/03/02 20:34:07 david__schmidt
4193 Update OS/2 build section
4195 Revision 1.28 2002/02/24 14:34:24 jongfoster
4196 Formatting changes. Now changing the doctype to DocBook XML 4.1
4197 will work - no other changes are needed.
4199 Revision 1.27 2002/01/11 14:14:32 hal9
4200 Added a very short section on Templates
4202 Revision 1.26 2002/01/09 20:02:50 hal9
4203 Fix bug re: auto-detect config file changes.
4205 Revision 1.25 2002/01/09 18:20:30 hal9
4206 Touch ups for *.action files.
4208 Revision 1.24 2001/12/02 01:13:42 hal9
4211 Revision 1.23 2001/12/02 00:20:41 hal9
4212 Updates for recent changes.
4214 Revision 1.22 2001/11/05 23:57:51 hal9
4215 Minor update for startup now daemon mode.
4217 Revision 1.21 2001/10/31 21:11:03 hal9
4218 Correct 2 minor errors
4220 Revision 1.18 2001/10/24 18:45:26 hal9
4221 *** empty log message ***
4223 Revision 1.17 2001/10/24 17:10:55 hal9
4224 Catching up with Jon's recent work, and a few other things.
4226 Revision 1.16 2001/10/21 17:19:21 swa
4227 wrong url in documentation
4229 Revision 1.15 2001/10/14 23:46:24 hal9
4230 Various minor changes. Fleshed out SEE ALSO section.
4232 Revision 1.13 2001/10/10 17:28:33 hal9
4235 Revision 1.12 2001/09/28 02:57:04 hal9
4238 Revision 1.11 2001/09/28 02:25:20 hal9
4241 Revision 1.9 2001/09/27 23:50:29 hal9
4242 A few changes. A short section on regular expression in appendix.
4244 Revision 1.8 2001/09/25 00:34:59 hal9
4245 Some additions, and re-arranging.
4247 Revision 1.7 2001/09/24 14:31:36 hal9
4250 Revision 1.6 2001/09/24 14:10:32 hal9
4251 Including David's OS/2 installation instructions.
4253 Revision 1.2 2001/09/13 15:27:40 swa
4256 Revision 1.1 2001/09/12 15:36:41 swa
4257 source files for junkbuster documentation
4259 Revision 1.3 2001/09/10 17:43:59 swa
4260 first proposal of a structure.
4262 Revision 1.2 2001/06/13 14:28:31 swa
4263 docs should have an author.
4265 Revision 1.1 2001/06/13 14:20:37 swa
4266 first import of project's documentation for the webserver.
projects / privoxy.git / blob