2 File : $Source: /cvsroot/ijbswa/current/doc/source/p-config.sgml,v $
4 Purpose : Used with other docs and files only.
6 $Id: p-config.sgml,v 2.14 2007/03/22 14:10:59 fabiankeil Exp $
8 Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
11 ========================================================================
12 NOTE: Please read developer-manual/documentation.html before touching
13 anything in this, or other Privoxy documentation.
14 ========================================================================
17 This file contains all the config file comments and options. It used to
18 build both the user-manual config sections, and all of config (yes, the main
21 Rationale: This is broken up into two files since a file with a prolog
22 (DTD, etc) cannot be sourced as a secondary file. config.sgml is basically
23 a wrapper for this file.
27 OPTIONS: The actual options are included in this file and prefixed with
28 '@@', and processed by the Makefile to strip the '@@'. Default options
29 that should appear commented out should be listed as: '@@#OPTION'.
30 Otherwise, as '@@OPTION'. Example:
32 @@listen-address 127.0.0.1:8118
34 The Makefile does significant other processing too. The final results
35 should be checked to make sure that the perl processing does not
36 fubar something!!! Makefile processing requires w3m, fmt (shell line
40 This file is included into:
43 config (the actual Privoxy config file)
48 <!-- This part only goes into user-manual -->
50 <title>The Main Configuration File</title>
53 Again, the main configuration file is named <filename>config</filename> on
54 Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
55 Configuration lines consist of an initial keyword followed by a list of
56 values, all separated by whitespace (any number of spaces or tabs). For
64 <emphasis>confdir /etc/privoxy</emphasis></literallayout>
70 Assigns the value <literal>/etc/privoxy</literal> to the option
71 <literal>confdir</literal> and thus indicates that the configuration
72 directory is named <quote>/etc/privoxy/</quote>.
76 All options in the config file except for <literal>confdir</literal> and
77 <literal>logdir</literal> are optional. Watch out in the below description
78 for what happens if you leave them unset.
82 The main config file controls all aspects of <application>Privoxy</application>'s
83 operation that are not location dependent (i.e. they apply universally, no matter
84 where you may be surfing).
91 <!-- This part only goes into the config file -->
94 @@TITLE<!-- between the @@ is stripped by Makefile -->@@
95 Sample Configuration File for Privoxy v&p-version;
98 $Id: p-config.sgml,v 2.14 2007/03/22 14:10:59 fabiankeil Exp $
101 Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
106 #################################################################
111 II. FORMAT OF THE CONFIGURATION FILE #
113 1. LOCAL SET-UP DOCUMENTATION #
114 2. CONFIGURATION AND LOG FILE LOCATIONS #
116 4. ACCESS CONTROL AND SECURITY #
118 6. WINDOWS GUI OPTIONS #
120 #################################################################
124 <literallayout>I. INTRODUCTION
125 =============== <!-- fuck this madness --></literallayout>
128 This file holds Privoxy's main configuration. Privoxy detects
129 configuration changes automatically, so you don't have to restart it
130 unless you want to load a different configuration file.
133 The configuration will be reloaded with the first request after the
134 change was done, this request itself will still use the old configuration,
135 though. In other words: it takes two requests before you see the result of
136 your changes. Requests that are dropped due to ACL don't trigger reloads.
139 When starting Privoxy on Unix systems, give the location of this
140 file as last argument. On Windows systems, Privoxy will look for
141 this file with the name 'config.txt' in the current working directory
142 of the Privoxy process.
146 <literallayout><!-- funky spacing -->
148 II. FORMAT OF THE CONFIGURATION FILE
149 ====================================</literallayout>
152 Configuration lines consist of an initial keyword followed by a list
153 of values, all separated by whitespace (any number of spaces or
157 actionsfile default.action
160 Indicates that the actionsfile is named 'default.action'.
163 The '#' indicates a comment. Any part of a line following a '#' is
164 ignored, except if the '#' is preceded by a '\'.
167 Thus, by placing a # at the start of an existing configuration line,
168 you can make it a comment and it will be treated as if it weren't there.
169 This is called "commenting out" an option and can be useful. Removing
170 the # again is called "uncommenting".
173 Note that commenting out an option and leaving it at its default
174 are two completely different things! Most options behave very
175 differently when unset. See the the "Effect if unset" explanation
176 in each option's description for details.
179 Long lines can be continued on the next line by using a `\' as
185 <!-- ************************************************ -->
186 <!-- The following is common to both outputs (mostly) -->
187 <!-- ************************************************ -->
191 <!-- ~~~~~ New section ~~~~~ -->
192 <sect2 id="local-set-up">
193 <title>Local Set-up Documentation</title>
196 If you intend to operate <application>Privoxy</application> for more users
197 than just yourself, it might be a good idea to let them know how to reach
198 you, what you block and why you do that, your policies, etc.
202 <!-- ~~~~~ New section ~~~~~ -->
203 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
206 <term>Specifies:</term>
209 Location of the <application>Privoxy</application> User Manual.
214 <term>Type of value:</term>
216 <para>A fully qualified URI</para>
220 <term>Default value:</term>
222 <para><emphasis>Unset</emphasis></para>
226 <term>Effect if unset:</term>
229 <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/<replaceable class="parameter">version</replaceable>/user-manual/</ulink>
230 will be used, where <replaceable class="parameter">version</replaceable> is the <application>Privoxy</application> version.
238 The User Manual URI is the single best source of information on
239 <application>Privoxy</application>, and is used for help links from some
240 of the internal CGI pages. The manual itself is normally packaged with the
241 binary distributions, so you probably want to set this to a locally
249 Unix, in local filesystem (may not work with all browsers):
252 <screen> user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
255 Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
258 <screen> user-manual file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
261 Windows, UNC notation (with forward slashes):
264 <screen> user-manual file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
268 The best all purpose solution is simply to put the full local
269 <literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
273 <screen> user-manual /usr/share/doc/privoxy/user-manual</screen>
276 The User Manual is then available to anyone with access to the proxy, by
277 following the built-in URL: <literal>http://config.privoxy.org/user-manual/</literal>
278 (or the shortcut: <literal>http://p.p/user-manual/</literal>).
281 If the documentation is not on the local system, it can be accessed
282 from a remote server, as:
285 <screen> user-manual http://example.com/privoxy/user-manual/</screen>
288 <!-- this gets hammered in conversion to config. Text repeated below. -->
291 If set, this option should be <emphasis>the first option in the config
292 file</emphasis>, because it is used while the config file is being read
305 If set, this option should be the first option in the config
306 file, because it is used while the config file is being read.
315 <![%config-file;[<literallayout>@@#user-manual http://www.privoxy.org/user-manual/</literallayout>]]>
319 <!-- ~~~~~ New section ~~~~~ -->
320 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
324 <term>Specifies:</term>
327 A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
332 <term>Type of value:</term>
338 <term>Default value:</term>
340 <para>Two example URL are provided</para>
344 <term>Effect if unset:</term>
347 No links are displayed on the "untrusted" error page.
355 The value of this option only matters if the experimental trust mechanism has been
356 activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> above.)
359 If you use the trust mechanism, it is a good idea to write up some on-line
360 documentation about your trust policy and to specify the URL(s) here.
361 Use multiple times for multiple URLs.
364 The URL(s) should be added to the trustfile as well, so users don't end up
365 locked out from the information on why they were locked out in the first place!
371 <![%config-file;[<literallayout>@@trust-info-url http://www.example.com/why_we_block.html</literallayout>]]>
372 <![%config-file;[<literallayout>@@trust-info-url http://www.example.com/what_we_allow.html</literallayout>]]>
376 <!-- ~~~~~ New section ~~~~~ -->
377 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
381 <term>Specifies:</term>
384 An email address to reach the proxy administrator.
389 <term>Type of value:</term>
391 <para>Email address</para>
395 <term>Default value:</term>
397 <para><emphasis>Unset</emphasis></para>
401 <term>Effect if unset:</term>
404 No email address is displayed on error pages and the CGI user interface.
412 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
413 are unset, the whole "Local Privoxy Support" box on all generated pages will
420 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
424 <!-- ~~~~~ New section ~~~~~ -->
425 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
429 <term>Specifies:</term>
432 A URL to documentation about the local <application>Privoxy</application> setup,
433 configuration or policies.
438 <term>Type of value:</term>
444 <term>Default value:</term>
446 <para><emphasis>Unset</emphasis></para>
450 <term>Effect if unset:</term>
453 No link to local documentation is displayed on error pages and the CGI user interface.
461 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
462 are unset, the whole "Local Privoxy Support" box on all generated pages will
466 This URL shouldn't be blocked ;-)
472 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
476 <!-- ~ End section ~ -->
480 <!-- ~~~~~ New section ~~~~~ -->
482 <sect2 id="conf-log-loc">
483 <title>Configuration and Log File Locations</title>
486 <application>Privoxy</application> can (and normally does) use a number of
487 other files for additional configuration, help and logging.
488 This section of the configuration file tells <application>Privoxy</application>
489 where to find those other files.
493 The user running <application>Privoxy</application>, must have read
494 permission for all configuration files, and write permission to any files
495 that would be modified, such as log files and actions files.
499 <!-- ~~~~~ New section ~~~~~ -->
500 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
504 <term>Specifies:</term>
506 <para>The directory where the other configuration files are located</para>
510 <term>Type of value:</term>
512 <para>Path name</para>
516 <term>Default value:</term>
518 <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
522 <term>Effect if unset:</term>
524 <para><emphasis>Mandatory</emphasis></para>
531 No trailing <quote><literal>/</literal></quote>, please
534 This is really outdated and not likely to happen. HB 09/20/06
536 When development goes modular and multi-user, the blocker, filter, and
537 per-user config will be stored in subdirectories of <quote>confdir</quote>.
538 For now, the configuration directory structure is flat, except for
539 <filename>confdir/templates</filename>, where the HTML templates for CGI
540 output reside (e.g. <application>Privoxy's</application> 404 error page).
547 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
550 <!-- ~~~~~ New section ~~~~~ -->
551 <sect3 renderas="sect4" id="templdir"><title>templdir</title>
555 <term>Specifies:</term>
557 <para>An alternative directory where the templates are loaded from</para>
561 <term>Type of value:</term>
563 <para>Path name</para>
567 <term>Default value:</term>
573 <term>Effect if unset:</term>
575 <para>The templates are assumed to be located in confdir/template.</para>
582 Privoxy's original templates are usually overwritten
583 with each update. Use this option to relocate customized templates
584 that should be kept. Note that you might be missing new features
585 if you use outdated templates.
591 <![%config-file;[<literallayout>@@#templdir .</literallayout>]]>
595 <!-- ~~~~~ New section ~~~~~ -->
596 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
600 <term>Specifies:</term>
603 The directory where all logging takes place (i.e. where <filename>logfile</filename> and
604 <filename>jarfile</filename> are located)
609 <term>Type of value:</term>
611 <para>Path name</para>
615 <term>Default value:</term>
617 <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
621 <term>Effect if unset:</term>
623 <para><emphasis>Mandatory</emphasis></para>
630 No trailing <quote><literal>/</literal></quote>, please
636 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
640 <!-- ~~~~~ New section ~~~~~ -->
641 <sect3 renderas="sect4" id="actionsfile"><title>
644 <anchor id="default.action">
645 <anchor id="standard.action">
646 <anchor id="user.action">
647 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
650 <term>Specifies:</term>
653 The <link linkend="actions-file">actions file(s)</link> to use
658 <term>Type of value:</term>
660 <para>File name, relative to <literal>confdir</literal>, without the <literal>.action</literal> suffix</para>
664 <term>Default values:</term>
668 <msgtext><literallayout> standard # Internal purposes, no editing recommended</literallayout></msgtext>
671 <msgtext><literallayout> default # Main actions file</literallayout></msgtext>
674 <msgtext><literallayout> user # User customizations</literallayout></msgtext>
680 <term>Effect if unset:</term>
683 No actions are taken at all. Simple neutral proxying.
691 Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
694 The default values include standard.action, which is used for internal
695 purposes and should be loaded, default.action, which is the
696 <quote>main</quote> actions file maintained by the developers, and
697 <filename>user.action</filename>, where you can make your personal additions.
700 Actions files are where all the per site and per URL configuration is done for
701 ad blocking, cookie management, privacy considerations, etc.
702 There is no point in using <application>Privoxy</application> without at
703 least one actions file.
709 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
710 <!-- html -> text conversion, blah -->
711 <![%config-file;[<literallayout>@@actionsfile standard # Internal purpose, recommended</literallayout>]]>
712 <![%config-file;[<literallayout>@@actionsfile default # Main actions file</literallayout>]]>
713 <![%config-file;[<literallayout>@@actionsfile user # User customizations</literallayout>]]>
716 <!-- ~~~~~ New section ~~~~~ -->
717 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
718 <anchor id="default.filter">
721 <term>Specifies:</term>
724 The <link linkend="filter-file">filter file(s)</link> to use
729 <term>Type of value:</term>
731 <para>File name, relative to <literal>confdir</literal></para>
735 <term>Default value:</term>
737 <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
741 <term>Effect if unset:</term>
744 No textual content filtering takes place, i.e. all
745 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
746 actions in the actions files are turned neutral.
754 Multiple <literal>filterfile</literal> lines are permitted.
757 The <link linkend="filter-file">filter files</link> contain content modification
758 rules that use <link linkend="regex">regular expressions</link>. These rules permit
759 powerful changes on the content of Web pages, and optionally the headers
760 as well, e.g., you could disable your favorite JavaScript annoyances,
761 re-write the actual displayed text, or just have some fun
762 playing buzzword bingo with web pages.
766 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
767 actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
768 to be defined in a filter file!
771 A pre-defined filter file called <filename>default.filter</filename> that contains
772 a number of useful filters for common problems is included in the distribution.
773 See the section on the <literal><link linkend="filter">filter</link></literal>
777 It is recommended to place any locally adapted filters into a separate
778 file, such as <filename>user.filter</filename>.
784 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
785 <![%config-file;[<literallayout>@@#filterfile user.filter # User customizations</literallayout>]]>
789 <!-- ~~~~~ New section ~~~~~ -->
790 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
794 <term>Specifies:</term>
802 <term>Type of value:</term>
804 <para>File name, relative to <literal>logdir</literal></para>
808 <term>Default value:</term>
810 <para>logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows)</para>
814 <term>Effect if unset:</term>
817 No log file is used, all log messages go to the console (<literal>STDERR</literal>).
825 removed per bug report 688728 02/20/03 HB
828 The windows version will additionally log to the console.
832 The logfile is where all logging and error messages are written. The level
833 of detail and number of messages are set with the <literal>debug</literal>
834 option (see below). The logfile can be useful for tracking down a problem with
835 <application>Privoxy</application> (e.g., it's not blocking an ad you
836 think it should block) but in most cases you probably will never look at it.
839 Your logfile will grow indefinitely, and you will probably want to
840 periodically remove it. On Unix systems, you can do this with a cron job
841 (see <quote>man cron</quote>). For Red Hat, a <command>logrotate</command>
842 script has been included.
845 On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
846 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
847 the effect that cron.daily will automatically archive, gzip, and empty the
848 log, when it exceeds 1M size.
851 Any log files must be writable by whatever user <application>Privoxy</application>
852 is being run as (default on UNIX, user id is <quote>privoxy</quote>).
858 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
862 <!-- ~~~~~ New section ~~~~~ -->
863 <sect3 renderas="sect4" id="jarfile"><title>jarfile</title>
867 <term>Specifies:</term>
870 The file to store intercepted cookies in
875 <term>Type of value:</term>
877 <para>File name, relative to <literal>logdir</literal></para>
881 <term>Default value:</term>
883 <para>Unset (commented out). When activated: jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows)</para>
887 <term>Effect if unset:</term>
890 Intercepted cookies are not stored in a dedicated log file.
898 The jarfile may grow to ridiculous sizes over time.
901 If debug 8 (show header parsing) is enabled, cookies are
902 written to the logfile with the rest of the headers.
908 <![%config-file;[<literallayout>@@#jarfile jarfile</literallayout>]]>
912 <!-- ~~~~~ New section ~~~~~ -->
913 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
916 <term>Specifies:</term>
919 The name of the trust file to use
924 <term>Type of value:</term>
926 <para>File name, relative to <literal>confdir</literal></para>
930 <term>Default value:</term>
932 <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
936 <term>Effect if unset:</term>
939 The entire trust mechanism is disabled.
947 The trust mechanism is an experimental feature for building white-lists and should
948 be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
951 If you specify a trust file, <application>Privoxy</application> will only allow
952 access to sites that are specified in the trustfile. Sites can be listed
956 Prepending a <literal>~</literal> character limits access to this site
957 only (and any sub-paths within this site), e.g.
958 <literal>~www.example.com</literal> allows access to
959 <literal>~www.example.com/features/news.html</literal>, etc.
962 Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
963 prepending the name with a <literal>+</literal> character. The effect is that
964 access to untrusted sites will be granted -- but only if a link from this
965 trusted referrer was used to get there. The link target will then be added
966 to the <quote>trustfile</quote> so that future, direct accesses will be
967 granted. Sites added via this mechanism do not become trusted referrers
968 themselves (i.e. they are added with a <literal>~</literal> designation).
969 There is a limit of 512 such entries, after which new entries will not be
973 If you use the <literal>+</literal> operator in the trust file, it may grow
974 considerably over time.
977 It is recommended that <application>Privoxy</application> be compiled with
978 the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
979 <literal> --disable-editor</literal> options, if this feature is to be
983 Possible applications include limiting Internet access for children.
990 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
994 <!-- ~ End section ~ -->
996 <!-- ~~~~~ New section ~~~~~ -->
997 <sect2 id="debugging">
998 <title>Debugging</title>
1001 These options are mainly useful when tracing a problem.
1002 Note that you might also want to invoke
1003 <application>Privoxy</application> with the <literal>--no-daemon</literal>
1004 command line option when debugging.
1007 <sect3 renderas="sect4" id="debug"><title>debug</title>
1011 <term>Specifies:</term>
1014 Key values that determine what information gets logged to the
1015 <link linkend="logfile"><emphasis>logfile</emphasis></link>.
1020 <term>Type of value:</term>
1022 <para>Integer values</para>
1026 <term>Default value:</term>
1028 <para>12289 (i.e.: URLs plus informational and warning messages)</para>
1032 <term>Effect if unset:</term>
1035 Nothing gets logged.
1043 The available debug levels are:
1047 debug 1 # show each GET/POST/CONNECT request
1048 debug 2 # show each connection status
1049 debug 4 # show I/O status
1050 debug 8 # show header parsing
1051 debug 16 # log all data written to the network into the logfile
1052 debug 32 # debug force feature
1053 debug 64 # debug regular expression filters
1054 debug 128 # debug redirects
1055 debug 256 # debug GIF de-animation
1056 debug 512 # Common Log Format
1057 debug 1024 # debug kill pop-ups
1058 debug 2048 # CGI user interface
1059 debug 4096 # Startup banner and warnings.
1060 debug 8192 # Non-fatal errors
1064 To select multiple debug levels, you can either add them or use
1065 multiple <literal>debug</literal> lines.
1068 A debug level of 1 is informative because it will show you each request
1069 as it happens. <emphasis>1, 4096 and 8192 are highly recommended</emphasis>
1070 so that you will notice when things go wrong. The other levels are probably
1071 only of interest if you are hunting down a specific problem. They can produce
1072 a hell of an output (especially 16).
1076 The reporting of <emphasis>fatal</emphasis> errors (i.e. ones which causes
1077 <application>Privoxy</application> to exit) is always on and cannot be disabled.
1080 If you want to use CLF (Common Log Format), you should set <quote>debug
1081 512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1084 <application>Privoxy</application> has a hard-coded limit for the
1085 length of log messages. If it's reached, messages are logged truncated
1086 and marked with <quote>... [too long, truncated]</quote>.
1092 <![%config-file;[<literallayout>@@debug 1 # show each GET/POST/CONNECT request</literallayout>]]>
1093 <![%config-file;[<literallayout>@@debug 4096 # Startup banner and warnings</literallayout>]]>
1094 <![%config-file;[<literallayout>@@debug 8192 # Errors - *we highly recommended enabling this*</literallayout>]]>
1098 <!-- ~~~~~ New section ~~~~~ -->
1099 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1103 <term>Specifies:</term>
1106 Whether to run only one server thread
1111 <term>Type of value:</term>
1113 <para><emphasis>None</emphasis></para>
1117 <term>Default value:</term>
1119 <para><emphasis>Unset</emphasis></para>
1123 <term>Effect if unset:</term>
1126 Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1127 serve multiple requests simultaneously.
1135 This option is only there for debug purposes and you should never
1136 need to use it. <emphasis>It will drastically reduce performance.</emphasis>
1142 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1147 <!-- ~ End section ~ -->
1150 <!-- ~~~~~ New section ~~~~~ -->
1151 <sect2 id="access-control">
1152 <title>Access Control and Security</title>
1155 This section of the config file controls the security-relevant aspects
1156 of <application>Privoxy</application>'s configuration.
1160 <!-- ~~~~~ New section ~~~~~ -->
1161 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1165 <term>Specifies:</term>
1168 The IP address and TCP port on which <application>Privoxy</application> will
1169 listen for client requests.
1174 <term>Type of value:</term>
1176 <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1181 <term>Default value:</term>
1183 <para>127.0.0.1:8118</para>
1187 <term>Effect if unset:</term>
1190 Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1191 home users who run <application>Privoxy</application> on the same machine as
1200 You will need to configure your browser(s) to this proxy address and port.
1203 If you already have another service running on port 8118, or if you want to
1204 serve requests from other machines (e.g. on your local network) as well, you
1205 will need to override the default.
1208 If you leave out the IP address, <application>Privoxy</application> will
1209 bind to all interfaces (addresses) on your machine and may become reachable
1210 from the Internet. In that case, consider using <link
1211 linkend="acls">access control lists</link> (ACL's, see below), and/or
1215 If you open <application>Privoxy</application> to untrusted users, you will
1216 also want to turn off the <literal><link
1217 linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1218 <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1224 <term>Example:</term>
1227 Suppose you are running <application>Privoxy</application> on
1228 a machine which has the address 192.168.0.1 on your local private network
1229 (192.168.0.0) and has another outside connection with a different address.
1230 You want it to serve requests from inside only:
1234 listen-address 192.168.0.1:8118
1241 <![%config-file;[<literallayout>@@listen-address 127.0.0.1:8118</literallayout>]]>
1245 <!-- ~~~~~ New section ~~~~~ -->
1246 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1250 <term>Specifies:</term>
1253 Initial state of "toggle" status
1258 <term>Type of value:</term>
1264 <term>Default value:</term>
1270 <term>Effect if unset:</term>
1273 Act as if toggled on
1281 If set to 0, <application>Privoxy</application> will start in
1282 <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1283 content-neutral proxy where all ad blocking, filtering, etc are disabled. See
1284 <literal>enable-remote-toggle</literal> below. This is not really useful
1285 anymore, since toggling is much easier via <ulink
1286 url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1287 editing the <filename>conf</filename> file.
1290 The windows version will only display the toggle icon in the system tray
1291 if this option is present.
1297 <![%config-file;[<literallayout>@@toggle 1</literallayout>]]>
1301 <!-- ~~~~~ New section ~~~~~ -->
1302 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1305 <term>Specifies:</term>
1308 Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1309 feature</ulink> may be used
1314 <term>Type of value:</term>
1320 <term>Default value:</term>
1326 <term>Effect if unset:</term>
1329 The web-based toggle feature is disabled.
1337 When toggled off, <application>Privoxy</application> mostly acts like a normal,
1338 content-neutral proxy, i.e. it acts as if none of the actions applied to
1342 For the time being, access to the toggle feature can <emphasis>not</emphasis> be
1343 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1344 so that everybody who can access <application>Privoxy</application> (see
1345 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1346 toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1347 for multi-user environments with untrusted users.
1350 Note that you must have compiled <application>Privoxy</application> with
1351 support for this feature, otherwise this option has no effect.
1357 <![%config-file;[<literallayout>@@enable-remote-toggle 1</literallayout>]]>
1361 <!-- ~~~~~ New section ~~~~~ -->
1362 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1365 <term>Specifies:</term>
1368 Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1373 <term>Type of value:</term>
1379 <term>Default value:</term>
1385 <term>Effect if unset:</term>
1388 Privoxy ignores special HTTP headers.
1396 When toggled on, the client can change <application>Privoxy's</application>
1397 behaviour by setting special HTTP headers. Currently the only supported
1398 special header is <quote>X-Filter: No</quote>, to disable filtering for
1399 the ongoing request, even if it is enabled in one of the action files.
1402 If you are using <application>Privoxy</application> in a
1403 multi-user environment or with untrustworthy clients and want to
1404 enforce filtering, you will have to disable this option,
1405 otherwise you can ignore it.
1411 <![%config-file;[<literallayout>@@enable-remote-http-toggle 1</literallayout>]]>
1415 <!-- ~~~~~ New section ~~~~~ -->
1416 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1419 <term>Specifies:</term>
1422 Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1423 file editor</ulink> may be used
1428 <term>Type of value:</term>
1434 <term>Default value:</term>
1440 <term>Effect if unset:</term>
1443 The web-based actions file editor is disabled.
1451 For the time being, access to the editor can <emphasis>not</emphasis> be
1452 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1453 so that everybody who can access <application>Privoxy</application> (see
1454 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1455 modify its configuration for all users. So this option is <emphasis>not
1456 recommended</emphasis> for multi-user environments with untrusted users.
1459 Note that you must have compiled <application>Privoxy</application> with
1460 support for this feature, otherwise this option has no effect.
1466 <![%config-file;[<literallayout>@@enable-edit-actions 1</literallayout>]]>
1470 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1473 <term>Specifies:</term>
1476 Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1481 <term>Type of value:</term>
1484 <replaceable>0 or 1</replaceable>
1489 <term>Default value:</term>
1491 <para><emphasis>0</emphasis></para>
1495 <term>Effect if unset:</term>
1498 Blocks are not enforced.
1506 <application>Privoxy</application> is mainly used to block and filter
1507 requests as a service to the user, for example to block ads and other
1508 junk that clogs the pipes. <application>Privoxy's</application> configuration
1509 isn't perfect and sometimes innocent pages are blocked. In this situation it
1510 makes sense to allow the user to enforce the request and have
1511 <application>Privoxy</application> ignore the block.
1514 In the default configuration <application>Privoxy's</application>
1515 <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1516 link to adds a special string (the force prefix) to the request URL.
1517 If that link is used, <application>Privoxy</application> will
1518 detect the force prefix, remove it again and let the request pass.
1521 Of course <application>Privoxy</application> can also be used to enforce
1522 a network policy. In that case the user obviously should not be able to
1523 bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1524 option is for. If it's enabled, <application>Privoxy</application> hides
1525 the <quote>go there anyway</quote> link. If the user adds the force
1526 prefix by hand, it will not be accepted and the circumvention attempt
1532 <term>Examples:</term>
1540 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1544 <!-- ~~~~~ New section ~~~~~ -->
1545 <sect3 renderas="sect4" id="acls"><title>
1546 ACLs: permit-access and deny-access</title>
1547 <anchor id="permit-access">
1548 <anchor id="deny-access">
1552 <term>Specifies:</term>
1555 Who can access what.
1560 <term>Type of value:</term>
1563 <replaceable class="parameter">src_addr</replaceable>[/<replaceable class="parameter">src_masklen</replaceable>]
1564 [<replaceable class="parameter">dst_addr</replaceable>[/<replaceable class="parameter">dst_masklen</replaceable>]]
1567 Where <replaceable class="parameter">src_addr</replaceable> and
1568 <replaceable class="parameter">dst_addr</replaceable> are IP addresses in dotted decimal notation or valid
1569 DNS names, and <replaceable class="parameter">src_masklen</replaceable> and
1570 <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1571 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1572 destination part are optional.
1577 <term>Default value:</term>
1579 <para><emphasis>Unset</emphasis></para>
1583 <term>Effect if unset:</term>
1586 Don't restrict access further than implied by <literal>listen-address</literal>
1594 Access controls are included at the request of ISPs and systems
1595 administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1596 For a typical home user, it will normally suffice to ensure that
1597 <application>Privoxy</application> only listens on the localhost
1598 (127.0.0.1) or internal (home) network address by means of the
1599 <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1603 Please see the warnings in the FAQ that this proxy is not intended to be a substitute
1604 for a firewall or to encourage anyone to defer addressing basic security
1608 Multiple ACL lines are OK.
1609 If any ACLs are specified, <application>Privoxy</application> only talks
1610 to IP addresses that match at least one <literal>permit-access</literal> line
1611 and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1612 last match wins, with the default being <literal>deny-access</literal>.
1615 If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1616 for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1617 that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1618 of the ultimate target. This is necessary because it may be impossible for the local
1619 <application>Privoxy</application> to determine the IP address of the
1620 ultimate target (that's often what gateways are used for).
1623 You should prefer using IP addresses over DNS names, because the address lookups take
1624 time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1625 like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1626 IP addresses, only the first one is used.
1629 Denying access to particular sites by ACL may have undesired side effects
1630 if the site in question is hosted on a machine which also hosts other sites
1636 <term>Examples:</term>
1639 Explicitly define the default behavior if no ACL and
1640 <literal>listen-address</literal> are set: <quote>localhost</quote>
1641 is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1642 <emphasis>all</emphasis> destination addresses are OK:
1646 permit-access localhost
1650 Allow any host on the same class C subnet as www.privoxy.org access to
1651 nothing but www.example.com (or other domains hosted on the same system):
1655 permit-access www.privoxy.org/24 www.example.com/32
1659 Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1660 with the exception that 192.168.45.73 may not access the IP address behind
1661 www.dirty-stuff.example.com:
1665 permit-access 192.168.45.64/26
1666 deny-access 192.168.45.73 www.dirty-stuff.example.com
1675 <!-- ~~~~~ New section ~~~~~ -->
1676 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1680 <term>Specifies:</term>
1683 Maximum size of the buffer for content filtering.
1688 <term>Type of value:</term>
1690 <para>Size in Kbytes</para>
1694 <term>Default value:</term>
1700 <term>Effect if unset:</term>
1703 Use a 4MB (4096 KB) limit.
1711 For content filtering, i.e. the <literal>+filter</literal> and
1712 <literal>+deanimate-gif</literal> actions, it is necessary that
1713 <application>Privoxy</application> buffers the entire document body.
1714 This can be potentially dangerous, since a server could just keep sending
1715 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1719 When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1720 flushed to the client unfiltered and no further attempt to
1721 filter the rest of the document is made. Remember that there may be multiple threads
1722 running, which might require up to <literal>buffer-limit</literal> Kbytes
1723 <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1730 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1735 <!-- ~ End section ~ -->
1738 <!-- ~~~~~ New section ~~~~~ -->
1740 <sect2 id="forwarding">
1741 <title>Forwarding</title>
1744 This feature allows routing of HTTP requests through a chain of
1748 Forwarding can be used to chain Privoxy with a caching proxy to speed
1749 up browsing. Using a parent proxy may also be necessary if the machine
1750 that <application>Privoxy</application> runs on has no direct Internet access.
1753 Note that parent proxies can severely decrease your privacy level.
1754 For example a parent proxy could add your IP address to the request
1755 headers and if it's a caching proxy it may add the <quote>Etag</quote>
1756 header to revalidation requests again, even though you configured Privoxy
1757 to remove it. It may also ignore Privoxy's header time randomization and use the
1758 original values which could be used by the server as cookie replacement
1759 to track your steps between visits.
1763 Also specified here are SOCKS proxies. <application>Privoxy</application>
1764 supports the SOCKS 4 and SOCKS 4A protocols.
1767 <sect3 renderas="sect4" id="forward"><title>forward</title>
1770 <term>Specifies:</term>
1773 To which parent HTTP proxy specific requests should be routed.
1778 <term>Type of value:</term>
1781 <replaceable class="parameter">target_pattern</replaceable>
1782 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1785 where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1786 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1787 denote <quote>all URLs</quote>.
1788 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1789 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1790 optionally followed by its listening port (default: 8080).
1791 Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1796 <term>Default value:</term>
1798 <para><emphasis>Unset</emphasis></para>
1802 <term>Effect if unset:</term>
1805 Don't use parent HTTP proxies.
1813 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1814 forwarded to another HTTP proxy but are made directly to the web servers.
1817 Multiple lines are OK, they are checked in sequence, and the last match wins.
1822 <term>Examples:</term>
1825 Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
1829 forward / parent-proxy.example.org:8080
1834 Everything goes to our example ISP's caching proxy, except for requests
1835 to that ISP's sites:
1839 forward / caching-proxy.example-isp.net:8000
1840 forward .example-isp.net .
1849 <!-- ~~~~~ New section ~~~~~ -->
1850 <sect3 renderas="sect4" id="socks"><title>
1851 forward-socks4 and forward-socks4a</title>
1852 <anchor id="forward-socks4">
1853 <anchor id="forward-socks4a">
1857 <term>Specifies:</term>
1860 Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
1865 <term>Type of value:</term>
1868 <replaceable class="parameter">target_pattern</replaceable>
1869 <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
1870 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1873 where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1874 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1875 denote <quote>all URLs</quote>.
1876 <replaceable class="parameter">http_parent</replaceable> and <replaceable class="parameter">socks_proxy</replaceable>
1877 are IP addresses in dotted decimal notation or valid DNS names (<replaceable class="parameter">http_parent</replaceable>
1878 may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
1879 <replaceable class="parameter">port</replaceable> parameters are TCP ports, i.e. integer values from 1 to 64535
1884 <term>Default value:</term>
1886 <para><emphasis>Unset</emphasis></para>
1890 <term>Effect if unset:</term>
1893 Don't use SOCKS proxies.
1901 Multiple lines are OK, they are checked in sequence, and the last match wins.
1904 The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
1905 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
1906 server, while in SOCKS 4 it happens locally.
1909 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1910 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
1916 <term>Examples:</term>
1919 From the company example.com, direct connections are made to all
1920 <quote>internal</quote> domains, but everything outbound goes through
1921 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
1926 forward-socks4a / socks-gw.example.com:1080 www-cache.example-isp.net:8080
1927 forward .example.com .
1931 A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
1935 forward-socks4 / socks-gw.example.com:1080 .
1940 To chain Privoxy and Tor, both running on the same system, you should use
1945 forward-socks4 / 127.0.0.1:9050 .
1950 The public <application>Tor</application> network can't be used to reach your local network,
1951 therefore it's a good idea to make some exceptions:
1955 forward 192.168.*.*/ .
1957 forward 127.*.*.*/ .
1961 Unencrypted connections to systems in these address ranges will
1962 be as (un)secure as the local network is, but the alternative is that you
1963 can't reach the network at all.
1966 If you also want to be able to reach servers in your local network by
1967 using their names, you will need additional exceptions that look like
1972 forward localhost/ .
1981 <![%user-man;[ <!-- not included in config due to length -->
1982 <!-- ~~~~~ New section ~~~~~ -->
1983 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
1986 If you have links to multiple ISPs that provide various special content
1987 only to their subscribers, you can configure multiple <application>Privoxies</application>
1988 which have connections to the respective ISPs to act as forwarders to each other, so that
1989 <emphasis>your</emphasis> users can see the internal content of all ISPs.
1993 Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to
1994 isp-b.net. Both run <application>Privoxy</application>. Their forwarding
1995 configuration can look like this:
2005 forward .isp-b.net host-b:8118
2016 forward .isp-a.net host-a:8118
2021 Now, your users can set their browser's proxy to use either
2022 host-a or host-b and be able to browse the internal content
2023 of both isp-a and isp-b.
2027 If you intend to chain <application>Privoxy</application> and
2028 <application>squid</application> locally, then chain as
2029 <literal>browser -> squid -> privoxy</literal> is the recommended way.
2033 Assuming that <application>Privoxy</application> and <application>squid</application>
2034 run on the same box, your <application>squid</application> configuration could then look like this:
2039 # Define Privoxy as parent proxy (without ICP)
2040 cache_peer 127.0.0.1 parent 8118 7 no-query
2042 # Define ACL for protocol FTP
2045 # Do not forward FTP requests to Privoxy
2046 always_direct allow ftp
2048 # Forward all the rest to Privoxy
2049 never_direct allow all</screen>
2053 You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2054 Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2058 You could just as well decide to only forward requests for Windows executables through
2059 a virus-scanning parent proxy, say, on <literal>antivir.example.com</literal>, port 8010:
2065 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
2071 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2074 <term>Specifies:</term>
2077 How often Privoxy retries if a forwarded connection request fails.
2082 <term>Type of value:</term>
2085 <replaceable class="parameter">Number of retries.</replaceable>
2090 <term>Default value:</term>
2092 <para><emphasis>0</emphasis></para>
2096 <term>Effect if unset:</term>
2099 Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2107 <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2108 for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2109 The connection might have failed because of a DNS timeout in which case a retry makes sense,
2110 but it might also have failed because the server doesn't exist or isn't reachable. In this
2111 case the retry will just delay the appearance of Privoxy's error message.
2114 Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2115 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2118 Only use this option, if you are getting many forwarding related error messages,
2119 that go away when you try again manually. Start with a small value and check Privoxy's
2120 logfile from time to time, to see how many retries are usually needed.
2125 <term>Examples:</term>
2128 forwarded-connect-retries 1
2133 <![%config-file;[<literallayout>@@forwarded-connect-retries 0</literallayout>]]>
2136 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2139 <term>Specifies:</term>
2142 Whether intercepted requests should be treated as valid.
2147 <term>Type of value:</term>
2150 <replaceable>0 or 1</replaceable>
2155 <term>Default value:</term>
2157 <para><emphasis>0</emphasis></para>
2161 <term>Effect if unset:</term>
2164 Only proxy requests are accepted, intercepted requests are treated as invalid.
2172 If you don't trust your clients and want to force them
2173 to use <application>Privoxy</application>, enable this
2174 option and configure your packet filter to redirect outgoing
2175 HTTP connections into <application>Privoxy</application>.
2178 Make sure that <application>Privoxy's</application> own requests
2179 aren't redirected as well. Additionally take care that
2180 <application>Privoxy</application> can't intentionally connect
2181 to itself, otherwise you could run into redirection loops if
2182 <application>Privoxy's</application> listening port is reachable
2183 by the outside or an attacker has access to the pages you visit.
2188 <term>Examples:</term>
2191 accept-intercepted-requests 1
2196 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2199 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2202 <term>Specifies:</term>
2205 Whether the CGI interface should stay compatible with broken HTTP clients.
2210 <term>Type of value:</term>
2213 <replaceable>0 or 1</replaceable>
2218 <term>Default value:</term>
2220 <para><emphasis>0</emphasis></para>
2224 <term>Effect if unset:</term>
2227 The CGI form generate long GET URLs.
2235 <application>Privoxy's</application> CGI forms can lead to
2236 rather long URLs. This isn't a problem as far as the HTTP
2237 standard is concerned, but it can confuse clients with arbitrary
2238 URL lenght limitations.
2241 Enabling split-large-forms causes <application>Privoxy</application>
2242 to devide big forms into smaller ones to keep the URL length down.
2243 It makes editing a lot less convenient and you can no longer
2244 submit all changes at once, but at least it works around this
2248 If you don't notice any editing problems, there is no reason
2249 to enable this option, but if one of the submit buttons appears
2250 to be broken, you should give it a try.
2255 <term>Examples:</term>
2263 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2268 <!-- ~ End section ~ -->
2271 <!-- ~~~~~ New section ~~~~~ -->
2273 <sect2 id="windows-gui">
2274 <title>Windows GUI Options</title>
2276 <application>Privoxy</application> has a number of options specific to the
2277 Windows GUI interface:
2280 <anchor id="activity-animation">
2281 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2283 If <quote>activity-animation</quote> is set to 1, the
2284 <application>Privoxy</application> icon will animate when
2285 <quote>Privoxy</quote> is active. To turn off, set to 0.
2288 <![%config-file;[<literallayout>@@#activity-animation 1</literallayout>]]>
2294 <emphasis>activity-animation 1</emphasis>
2301 <anchor id="log-messages">
2302 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2304 If <quote>log-messages</quote> is set to 1,
2305 <application>Privoxy</application> will log messages to the console
2309 <![%config-file;[<literallayout>@@#log-messages 1</literallayout>]]>
2315 <emphasis>log-messages 1</emphasis>
2322 <anchor id="log-buffer-size">
2323 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2325 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
2326 i.e. the amount of memory used for the log messages displayed in the
2327 console window, will be limited to <quote>log-max-lines</quote> (see below).
2331 Warning: Setting this to 0 will result in the buffer to grow infinitely and
2332 eat up all your memory!
2335 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
2341 <emphasis>log-buffer-size 1</emphasis>
2348 <anchor id="log-max-lines">
2349 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2351 <application>log-max-lines</application> is the maximum number of lines held
2352 in the log buffer. See above.
2355 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
2361 <emphasis>log-max-lines 200</emphasis>
2368 <anchor id="log-highlight-messages">
2369 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2371 If <quote>log-highlight-messages</quote> is set to 1,
2372 <application>Privoxy</application> will highlight portions of the log
2373 messages with a bold-faced font:
2376 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
2382 <emphasis>log-highlight-messages 1</emphasis>
2389 <anchor id="log-font-name">
2390 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2392 The font used in the console window:
2395 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
2401 <emphasis>log-font-name Comic Sans MS</emphasis>
2408 <anchor id="log-font-size">
2409 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2411 Font size used in the console window:
2414 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
2420 <emphasis>log-font-size 8</emphasis>
2427 <anchor id="show-on-task-bar">
2428 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2430 <quote>show-on-task-bar</quote> controls whether or not
2431 <application>Privoxy</application> will appear as a button on the Task bar
2435 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
2441 <emphasis>show-on-task-bar 0</emphasis>
2448 <anchor id="close-button-minimizes">
2449 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2451 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
2452 button will minimize <application>Privoxy</application> instead of closing
2453 the program (close with the exit option on the File menu).
2456 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
2462 <emphasis>close-button-minimizes 1</emphasis>
2469 <anchor id="hide-console">
2470 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2472 The <quote>hide-console</quote> option is specific to the MS-Win console
2473 version of <application>Privoxy</application>. If this option is used,
2474 <application>Privoxy</application> will disconnect from and hide the
2478 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
2484 #<emphasis>hide-console</emphasis>
2494 <!-- end config content common to both outputs -->
2497 <!-- These are dummy anchors to keep the processor quiet -->
2498 <!-- when building config-file only (ie. they are used in u-m only) -->
2501 <anchor id="filter">
2502 <anchor id="filter-file">
2504 <anchor id="actions-file">
2505 <anchor id="af-patterns">
2509 <!-- eof p-config.sgml -->