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.103 2014/02/10 14:39:13 fabiankeil Exp $
8 Copyright (C) 2001-2011 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 By default, the main configuration file is named <filename>config</filename>,
54 with the exception of Windows, where it is named <filename>config.txt</filename>.
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). Like the filter and action files, the config file is
85 a plain text file and can be modified with a text editor like emacs, vim or
93 <!-- This part only goes into the config file -->
96 @@TITLE<!-- between the @@ is stripped by Makefile -->@@
97 Sample Configuration File for Privoxy &p-version;
100 $Id: p-config.sgml,v 2.103 2014/02/10 14:39:13 fabiankeil Exp $
103 Copyright (C) 2001-2013 Privoxy Developers http://www.privoxy.org/
108 #################################################################
113 II. FORMAT OF THE CONFIGURATION FILE #
115 1. LOCAL SET-UP DOCUMENTATION #
116 2. CONFIGURATION AND LOG FILE LOCATIONS #
118 4. ACCESS CONTROL AND SECURITY #
121 7. WINDOWS GUI OPTIONS #
123 #################################################################
127 <literallayout>I. INTRODUCTION
128 =============== <!-- fuck this madness --></literallayout>
131 This file holds Privoxy's main configuration. Privoxy detects
132 configuration changes automatically, so you don't have to restart it
133 unless you want to load a different configuration file.
136 The configuration will be reloaded with the first request after the
137 change was done, this request itself will still use the old configuration,
138 though. In other words: it takes two requests before you see the result of
139 your changes. Requests that are dropped due to ACL don't trigger reloads.
142 When starting Privoxy on Unix systems, give the location of this
143 file as last argument. On Windows systems, Privoxy will look for
144 this file with the name 'config.txt' in the current working directory
145 of the Privoxy process.
149 <literallayout><!-- funky spacing -->
151 II. FORMAT OF THE CONFIGURATION FILE
152 ====================================</literallayout>
155 Configuration lines consist of an initial keyword followed by a list
156 of values, all separated by whitespace (any number of spaces or
160 actionsfile default.action
163 Indicates that the actionsfile is named 'default.action'.
166 The '#' indicates a comment. Any part of a line following a '#' is
167 ignored, except if the '#' is preceded by a '\'.
170 Thus, by placing a # at the start of an existing configuration line,
171 you can make it a comment and it will be treated as if it weren't there.
172 This is called "commenting out" an option and can be useful. Removing
173 the # again is called "uncommenting".
176 Note that commenting out an option and leaving it at its default
177 are two completely different things! Most options behave very
178 differently when unset. See the "Effect if unset" explanation
179 in each option's description for details.
182 Long lines can be continued on the next line by using a `\' as
188 <!-- ************************************************ -->
189 <!-- The following is common to both outputs (mostly) -->
190 <!-- ************************************************ -->
194 <!-- ~~~~~ New section ~~~~~ -->
195 <sect2 id="local-set-up">
196 <title>Local Set-up Documentation</title>
199 If you intend to operate <application>Privoxy</application> for more users
200 than just yourself, it might be a good idea to let them know how to reach
201 you, what you block and why you do that, your policies, etc.
205 <!-- ~~~~~ New section ~~~~~ -->
206 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
209 <term>Specifies:</term>
212 Location of the <application>Privoxy</application> User Manual.
217 <term>Type of value:</term>
219 <para>A fully qualified URI</para>
223 <term>Default value:</term>
225 <para><emphasis>Unset</emphasis></para>
229 <term>Effect if unset:</term>
232 <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/<replaceable class="parameter">version</replaceable>/user-manual/</ulink>
233 will be used, where <replaceable class="parameter">version</replaceable> is the <application>Privoxy</application> version.
241 The User Manual URI is the single best source of information on
242 <application>Privoxy</application>, and is used for help links from some
243 of the internal CGI pages. The manual itself is normally packaged with the
244 binary distributions, so you probably want to set this to a locally
252 Unix, in local filesystem (may not work with all browsers):
255 <screen> user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
258 Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
261 <screen> user-manual file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
264 Windows, UNC notation (with forward slashes):
267 <screen> user-manual file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
271 The best all purpose solution is simply to put the full local
272 <literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
276 <screen> user-manual /usr/share/doc/privoxy/user-manual</screen>
279 The User Manual is then available to anyone with access to
280 <application>Privoxy</application>, by following the built-in URL:
281 <literal>http://config.privoxy.org/user-manual/</literal>
282 (or the shortcut: <literal>http://p.p/user-manual/</literal>).
285 If the documentation is not on the local system, it can be accessed
286 from a remote server, as:
289 <screen> user-manual http://example.com/privoxy/user-manual/</screen>
292 <!-- this gets hammered in conversion to config. Text repeated below. -->
295 If set, this option should be <emphasis>the first option in the config
296 file</emphasis>, because it is used while the config file is being read
309 If set, this option should be the first option in the config
310 file, because it is used while the config file is being read.
319 <![%config-file;[<literallayout>@@#user-manual http://www.privoxy.org/user-manual/</literallayout>]]>
323 <!-- ~~~~~ New section ~~~~~ -->
324 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
328 <term>Specifies:</term>
331 A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
336 <term>Type of value:</term>
342 <term>Default value:</term>
344 <para><emphasis>Unset</emphasis></para>
348 <term>Effect if unset:</term>
351 No links are displayed on the "untrusted" error page.
359 The value of this option only matters if the experimental trust mechanism has been
360 activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> below.)
363 If you use the trust mechanism, it is a good idea to write up some on-line
364 documentation about your trust policy and to specify the URL(s) here.
365 Use multiple times for multiple URLs.
368 The URL(s) should be added to the trustfile as well, so users don't end up
369 locked out from the information on why they were locked out in the first place!
375 <![%config-file;[<literallayout>@@#trust-info-url http://www.example.com/why_we_block.html</literallayout>]]>
376 <![%config-file;[<literallayout>@@#trust-info-url http://www.example.com/what_we_allow.html</literallayout>]]>
380 <!-- ~~~~~ New section ~~~~~ -->
381 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
385 <term>Specifies:</term>
388 An email address to reach the <application>Privoxy</application> administrator.
393 <term>Type of value:</term>
395 <para>Email address</para>
399 <term>Default value:</term>
401 <para><emphasis>Unset</emphasis></para>
405 <term>Effect if unset:</term>
408 No email address is displayed on error pages and the CGI user interface.
416 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
417 are unset, the whole "Local Privoxy Support" box on all generated pages will
424 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
428 <!-- ~~~~~ New section ~~~~~ -->
429 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
433 <term>Specifies:</term>
436 A URL to documentation about the local <application>Privoxy</application> setup,
437 configuration or policies.
442 <term>Type of value:</term>
448 <term>Default value:</term>
450 <para><emphasis>Unset</emphasis></para>
454 <term>Effect if unset:</term>
457 No link to local documentation is displayed on error pages and the CGI user interface.
465 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
466 are unset, the whole "Local Privoxy Support" box on all generated pages will
470 This URL shouldn't be blocked ;-)
476 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
480 <!-- ~ End section ~ -->
484 <!-- ~~~~~ New section ~~~~~ -->
486 <sect2 id="conf-log-loc">
487 <title>Configuration and Log File Locations</title>
490 <application>Privoxy</application> can (and normally does) use a number of
491 other files for additional configuration, help and logging.
492 This section of the configuration file tells <application>Privoxy</application>
493 where to find those other files.
497 The user running <application>Privoxy</application>, must have read
498 permission for all configuration files, and write permission to any files
499 that would be modified, such as log files and actions files.
503 <!-- ~~~~~ New section ~~~~~ -->
504 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
508 <term>Specifies:</term>
510 <para>The directory where the other configuration files are located.</para>
514 <term>Type of value:</term>
516 <para>Path name</para>
520 <term>Default value:</term>
522 <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
526 <term>Effect if unset:</term>
528 <para><emphasis>Mandatory</emphasis></para>
535 No trailing <quote><literal>/</literal></quote>, please.
541 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
544 <!-- ~~~~~ New section ~~~~~ -->
545 <sect3 renderas="sect4" id="templdir"><title>templdir</title>
549 <term>Specifies:</term>
551 <para>An alternative directory where the templates are loaded from.</para>
555 <term>Type of value:</term>
557 <para>Path name</para>
561 <term>Default value:</term>
567 <term>Effect if unset:</term>
569 <para>The templates are assumed to be located in confdir/template.</para>
576 <application>Privoxy's</application> original templates are usually
577 overwritten with each update. Use this option to relocate customized
578 templates that should be kept. As template variables might change
579 between updates, you shouldn't expect templates to work with
580 <application>Privoxy</application> releases other than the one
581 they were part of, though.
587 <![%config-file;[<literallayout>@@#templdir .</literallayout>]]>
591 <!-- ~~~~~ New section ~~~~~ -->
592 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
596 <term>Specifies:</term>
599 The directory where all logging takes place
600 (i.e. where the <filename>logfile</filename> is located).
605 <term>Type of value:</term>
607 <para>Path name</para>
611 <term>Default value:</term>
613 <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
617 <term>Effect if unset:</term>
619 <para><emphasis>Mandatory</emphasis></para>
626 No trailing <quote><literal>/</literal></quote>, please.
632 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
636 <!-- ~~~~~ New section ~~~~~ -->
637 <sect3 renderas="sect4" id="actionsfile"><title>
640 <anchor id="default.action">
641 <anchor id="standard.action">
642 <anchor id="user.action">
643 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
646 <term>Specifies:</term>
649 The <link linkend="actions-file">actions file(s)</link> to use
654 <term>Type of value:</term>
656 <para>Complete file name, relative to <literal>confdir</literal></para>
660 <term>Default values:</term>
664 <msgtext><literallayout> match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout></msgtext>
667 <msgtext><literallayout> default.action # Main actions file</literallayout></msgtext>
670 <msgtext><literallayout> user.action # User customizations</literallayout></msgtext>
676 <term>Effect if unset:</term>
679 No actions are taken at all. More or less neutral proxying.
687 Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
690 The default values are <filename>default.action</filename>, which is the
691 <quote>main</quote> actions file maintained by the developers, and
692 <filename>user.action</filename>, where you can make your personal additions.
695 Actions files contain all the per site and per URL configuration for
696 ad blocking, cookie management, privacy considerations, etc.
697 There is no point in using <application>Privoxy</application> without at
698 least one actions file.
701 Note that since Privoxy 3.0.7, the complete filename, including the <quote>.action</quote>
702 extension has to be specified. The syntax change was necessary to be consistent
703 with the other file options and to allow previously forbidden characters.
709 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
710 <!-- html -> text conversion, blah -->
711 <![%config-file;[<literallayout>@@actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout>]]>
712 <![%config-file;[<literallayout>@@actionsfile default.action # Main actions file</literallayout>]]>
714 XXX: Like user.filter, user.action should probably be commented out
715 by default as not all packages install it into the default directory.
718 <![%config-file;[<literallayout>@@actionsfile user.action # User customizations</literallayout>]]>
721 <!-- ~~~~~ New section ~~~~~ -->
722 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
723 <anchor id="default.filter">
726 <term>Specifies:</term>
729 The <link linkend="filter-file">filter file(s)</link> to use
734 <term>Type of value:</term>
736 <para>File name, relative to <literal>confdir</literal></para>
740 <term>Default value:</term>
742 <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
746 <term>Effect if unset:</term>
749 No textual content filtering takes place, i.e. all
750 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
751 actions in the actions files are turned neutral.
759 Multiple <literal>filterfile</literal> lines are permitted.
762 The <link linkend="filter-file">filter files</link> contain content modification
763 rules that use <link linkend="regex">regular expressions</link>. These rules permit
764 powerful changes on the content of Web pages, and optionally the headers
765 as well, e.g., you could try to disable your favorite JavaScript annoyances,
766 re-write the actual displayed text, or just have some fun
767 playing buzzword bingo with web pages.
771 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
772 actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
773 to be defined in a filter file!
776 A pre-defined filter file called <filename>default.filter</filename> that contains
777 a number of useful filters for common problems is included in the distribution.
778 See the section on the <literal><link linkend="filter">filter</link></literal>
782 It is recommended to place any locally adapted filters into a separate
783 file, such as <filename>user.filter</filename>.
789 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
790 <![%config-file;[<literallayout>@@filterfile user.filter # User customizations</literallayout>]]>
794 <!-- ~~~~~ New section ~~~~~ -->
795 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
799 <term>Specifies:</term>
807 <term>Type of value:</term>
809 <para>File name, relative to <literal>logdir</literal></para>
813 <term>Default value:</term>
815 <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
819 <term>Effect if unset:</term>
822 No logfile is written.
830 The logfile is where all logging and error messages are written. The level
831 of detail and number of messages are set with the <literal>debug</literal>
832 option (see below). The logfile can be useful for tracking down a problem with
833 <application>Privoxy</application> (e.g., it's not blocking an ad you
834 think it should block) and it can help you to monitor what your browser
838 Depending on the debug options below, the logfile may be a privacy risk
839 if third parties can get access to it. As most users will never look
840 at it, <application>Privoxy</application> 3.0.7 and later only log fatal
844 For most troubleshooting purposes, you will have to change that,
845 please refer to the debugging section for details.
848 Your logfile will grow indefinitely, and you will probably want to
849 periodically remove it. On Unix systems, you can do this with a cron job
850 (see <quote>man cron</quote>).
853 Any log files must be writable by whatever user <application>Privoxy</application>
854 is being run as (on Unix, default user id is <quote>privoxy</quote>).
860 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
864 <!-- ~~~~~ New section ~~~~~ -->
865 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
868 <term>Specifies:</term>
871 The name of the trust file to use
876 <term>Type of value:</term>
878 <para>File name, relative to <literal>confdir</literal></para>
882 <term>Default value:</term>
884 <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
888 <term>Effect if unset:</term>
891 The entire trust mechanism is disabled.
899 The trust mechanism is an experimental feature for building white-lists and should
900 be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
903 If you specify a trust file, <application>Privoxy</application> will only allow
904 access to sites that are specified in the trustfile. Sites can be listed
908 Prepending a <literal>~</literal> character limits access to this site
909 only (and any sub-paths within this site), e.g.
910 <literal>~www.example.com</literal> allows access to
911 <literal>~www.example.com/features/news.html</literal>, etc.
914 Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
915 prepending the name with a <literal>+</literal> character. The effect is that
916 access to untrusted sites will be granted -- but only if a link from this
917 trusted referrer was used to get there. The link target will then be added
918 to the <quote>trustfile</quote> so that future, direct accesses will be
919 granted. Sites added via this mechanism do not become trusted referrers
920 themselves (i.e. they are added with a <literal>~</literal> designation).
921 There is a limit of 512 such entries, after which new entries will not be
925 If you use the <literal>+</literal> operator in the trust file, it may grow
926 considerably over time.
929 It is recommended that <application>Privoxy</application> be compiled with
930 the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
931 <literal> --disable-editor</literal> options, if this feature is to be
935 Possible applications include limiting Internet access for children.
942 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
946 <!-- ~ End section ~ -->
948 <!-- ~~~~~ New section ~~~~~ -->
949 <sect2 id="debugging">
950 <title>Debugging</title>
953 These options are mainly useful when tracing a problem.
954 Note that you might also want to invoke
955 <application>Privoxy</application> with the <literal>--no-daemon</literal>
956 command line option when debugging.
959 <sect3 renderas="sect4" id="debug"><title>debug</title>
963 <term>Specifies:</term>
966 Key values that determine what information gets logged.
971 <term>Type of value:</term>
973 <para>Integer values</para>
977 <term>Default value:</term>
979 <para>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</para>
983 <term>Effect if unset:</term>
986 Default value is used (see above).
994 The available debug levels are:
998 debug 1 # Log the destination for each request &my-app; let through. See also debug 1024.
999 debug 2 # show each connection status
1000 debug 4 # show I/O status
1001 debug 8 # show header parsing
1002 debug 16 # log all data written to the network
1003 debug 32 # debug force feature
1004 debug 64 # debug regular expression filters
1005 debug 128 # debug redirects
1006 debug 256 # debug GIF de-animation
1007 debug 512 # Common Log Format
1008 debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
1009 debug 2048 # CGI user interface
1010 debug 4096 # Startup banner and warnings.
1011 debug 8192 # Non-fatal errors
1012 debug 32768 # log all data read from the network
1013 debug 65536 # Log the applying actions
1017 To select multiple debug levels, you can either add them or use
1018 multiple <literal>debug</literal> lines.
1021 A debug level of 1 is informative because it will show you each request
1022 as it happens. <emphasis>1, 1024, 4096 and 8192 are recommended</emphasis>
1023 so that you will notice when things go wrong. The other levels are
1024 probably only of interest if you are hunting down a specific problem.
1025 They can produce a hell of an output (especially 16).
1029 &my-app; used to ship with the debug levels recommended above enabled by
1030 default, but due to privacy concerns 3.0.7 and later are configured to
1031 only log fatal errors.
1034 If you are used to the more verbose settings, simply enable the debug lines
1038 If you want to use pure CLF (Common Log Format), you should set <quote>debug
1039 512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1042 <application>Privoxy</application> has a hard-coded limit for the
1043 length of log messages. If it's reached, messages are logged truncated
1044 and marked with <quote>... [too long, truncated]</quote>.
1047 Please don't file any support requests without trying to reproduce
1048 the problem with increased debug level first. Once you read the log
1049 messages, you may even be able to solve the problem on your own.
1055 <![%config-file;[<literallayout>@@#debug 1 # Log the destination for each request &my-app; let through.</literallayout>]]>
1056 <![%config-file;[<literallayout>@@#debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
1057 <![%config-file;[<literallayout>@@#debug 4096 # Startup banner and warnings</literallayout>]]>
1058 <![%config-file;[<literallayout>@@#debug 8192 # Non-fatal errors</literallayout>]]>
1062 <!-- ~~~~~ New section ~~~~~ -->
1063 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1067 <term>Specifies:</term>
1070 Whether to run only one server thread.
1075 <term>Type of value:</term>
1077 <para><emphasis>1 or 0</emphasis></para>
1081 <term>Default value:</term>
1083 <para><emphasis>0</emphasis></para>
1087 <term>Effect if unset:</term>
1090 Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1091 serve multiple requests simultaneously.
1099 This option is only there for debugging purposes.
1100 <emphasis>It will drastically reduce performance.</emphasis>
1106 <![%config-file;[<literallayout>@@#single-threaded 1</literallayout>]]>
1109 <!-- ~~~~~ New section ~~~~~ -->
1110 <sect3 renderas="sect4" id="hostname"><title>hostname</title>
1114 <term>Specifies:</term>
1117 The hostname shown on the CGI pages.
1122 <term>Type of value:</term>
1128 <term>Default value:</term>
1130 <para><emphasis>Unset</emphasis></para>
1134 <term>Effect if unset:</term>
1137 The hostname provided by the operating system is used.
1145 On some misconfigured systems resolving the hostname fails or
1146 takes too much time and slows Privoxy down. Setting a fixed hostname
1147 works around the problem.
1150 In other circumstances it might be desirable to show a hostname
1151 other than the one returned by the operating system. For example
1152 if the system has several different hostnames and you don't want
1153 to use the first one.
1156 Note that Privoxy does not validate the specified hostname value.
1162 <![%config-file;[<literallayout>@@#hostname hostname.example.org</literallayout>]]>
1167 <!-- ~ End section ~ -->
1170 <!-- ~~~~~ New section ~~~~~ -->
1171 <sect2 id="access-control">
1172 <title>Access Control and Security</title>
1175 This section of the config file controls the security-relevant aspects
1176 of <application>Privoxy</application>'s configuration.
1180 <!-- ~~~~~ New section ~~~~~ -->
1181 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1185 <term>Specifies:</term>
1188 The address and TCP port on which <application>Privoxy</application> will
1189 listen for client requests.
1194 <term>Type of value:</term>
1196 <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1197 <para>[<replaceable class="parameter">Hostname</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1202 <term>Default value:</term>
1204 <para>127.0.0.1:8118</para>
1208 <term>Effect if unset:</term>
1211 Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable and
1212 recommended for home users who run <application>Privoxy</application> on
1213 the same machine as their browser.
1221 You will need to configure your browser(s) to this proxy address and port.
1224 If you already have another service running on port 8118, or if you want to
1225 serve requests from other machines (e.g. on your local network) as well, you
1226 will need to override the default.
1229 You can use this statement multiple times to make
1230 <application>Privoxy</application> listen on more ports or more
1231 <abbrev>IP</abbrev> addresses. Suitable if your operating system does not
1232 support sharing <abbrev>IPv6</abbrev> and <abbrev>IPv4</abbrev> protocols
1236 If a hostname is used instead of an IP address, <application>Privoxy</application>
1237 will try to resolve it to an IP address and if there are multiple, use the first
1241 If the address for the hostname isn't already known on the system
1242 (for example because it's in /etc/hostname), this may result in DNS
1246 If the specified address isn't available on the system, or if the
1247 hostname can't be resolved, <application>Privoxy</application>
1251 IPv6 addresses containing colons have to be quoted by brackets.
1252 They can only be used if <application>Privoxy</application> has
1253 been compiled with IPv6 support. If you aren't sure if your version
1254 supports it, have a look at
1255 <literal>http://config.privoxy.org/show-status</literal>.
1258 Some operating systems will prefer IPv6 to IPv4 addresses even if the
1259 system has no IPv6 connectivity which is usually not expected by the user.
1260 Some even rely on DNS to resolve localhost which mean the "localhost" address
1261 used may not actually be local.
1264 It is therefore recommended to explicitly configure the intended IP address
1265 instead of relying on the operating system, unless there's a strong reason not to.
1268 If you leave out the address, <application>Privoxy</application> will bind to all
1269 IPv4 interfaces (addresses) on your machine and may become reachable from the
1270 Internet and/or the local network. Be aware that some GNU/Linux distributions
1271 modify that behaviour without updating the documentation. Check for non-standard
1272 patches if your <application>Privoxy</application> version behaves differently.
1275 If you configure <application>Privoxy</application> to be reachable from the
1276 network, consider using <link linkend="acls">access control lists</link>
1277 (ACL's, see below), and/or a firewall.
1280 If you open <application>Privoxy</application> to untrusted users, you will
1281 also want to make sure that the following actions are disabled: <literal><link
1282 linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1283 <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1288 <term>Example:</term>
1291 Suppose you are running <application>Privoxy</application> on
1292 a machine which has the address 192.168.0.1 on your local private network
1293 (192.168.0.0) and has another outside connection with a different address.
1294 You want it to serve requests from inside only:
1298 listen-address 192.168.0.1:8118
1302 Suppose you are running <application>Privoxy</application> on an
1303 IPv6-capable machine and you want it to listen on the IPv6 address
1304 of the loopback device:
1308 listen-address [::1]:8118
1315 <![%config-file;[<literallayout>@@listen-address 127.0.0.1:8118</literallayout>]]>
1319 <!-- ~~~~~ New section ~~~~~ -->
1320 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1324 <term>Specifies:</term>
1327 Initial state of "toggle" status
1332 <term>Type of value:</term>
1338 <term>Default value:</term>
1344 <term>Effect if unset:</term>
1347 Act as if toggled on
1355 If set to 0, <application>Privoxy</application> will start in
1356 <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1357 content-neutral proxy with both ad blocking and content filtering
1358 disabled. See <literal>enable-remote-toggle</literal> below.
1364 <![%config-file;[<literallayout>@@toggle 1</literallayout>]]>
1368 <!-- ~~~~~ New section ~~~~~ -->
1369 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1372 <term>Specifies:</term>
1375 Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1376 feature</ulink> may be used
1381 <term>Type of value:</term>
1387 <term>Default value:</term>
1393 <term>Effect if unset:</term>
1396 The web-based toggle feature is disabled.
1404 When toggled off, <application>Privoxy</application> mostly acts like a normal,
1405 content-neutral proxy, i.e. doesn't block ads or filter content.
1408 Access to the toggle feature can <emphasis>not</emphasis> be
1409 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1410 so that everybody who can access <application>Privoxy</application> (see
1411 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1412 toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1413 for multi-user environments with untrusted users.
1416 Note that malicious client side code (e.g Java) is also
1417 capable of using this option.
1420 As a lot of <application>Privoxy</application> users don't read
1421 documentation, this feature is disabled by default.
1424 Note that you must have compiled <application>Privoxy</application> with
1425 support for this feature, otherwise this option has no effect.
1431 <![%config-file;[<literallayout>@@enable-remote-toggle 0</literallayout>]]>
1435 <!-- ~~~~~ New section ~~~~~ -->
1436 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1439 <term>Specifies:</term>
1442 Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1447 <term>Type of value:</term>
1453 <term>Default value:</term>
1459 <term>Effect if unset:</term>
1462 Privoxy ignores special HTTP headers.
1470 When toggled on, the client can change <application>Privoxy's</application>
1471 behaviour by setting special HTTP headers. Currently the only supported
1472 special header is <quote>X-Filter: No</quote>, to disable filtering for
1473 the ongoing request, even if it is enabled in one of the action files.
1476 This feature is disabled by default. If you are using
1477 <application>Privoxy</application> in a environment with trusted clients,
1478 you may enable this feature at your discretion. Note that malicious client
1479 side code (e.g Java) is also capable of using this feature.
1482 This option will be removed in future releases as it has been obsoleted
1483 by the more general header taggers.
1489 <![%config-file;[<literallayout>@@enable-remote-http-toggle 0</literallayout>]]>
1493 <!-- ~~~~~ New section ~~~~~ -->
1494 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1497 <term>Specifies:</term>
1500 Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1501 file editor</ulink> may be used
1506 <term>Type of value:</term>
1512 <term>Default value:</term>
1518 <term>Effect if unset:</term>
1521 The web-based actions file editor is disabled.
1529 Access to the editor can <emphasis>not</emphasis> be
1530 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1531 so that everybody who can access <application>Privoxy</application> (see
1532 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1533 modify its configuration for all users.
1536 This option is <emphasis>not recommended</emphasis> for environments
1537 with untrusted users and as a lot of <application>Privoxy</application>
1538 users don't read documentation, this feature is disabled by default.
1541 Note that malicious client side code (e.g Java) is also
1542 capable of using the actions editor and you shouldn't enable
1543 this options unless you understand the consequences and are
1544 sure your browser is configured correctly.
1547 Note that you must have compiled <application>Privoxy</application> with
1548 support for this feature, otherwise this option has no effect.
1554 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1558 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1561 <term>Specifies:</term>
1564 Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1569 <term>Type of value:</term>
1572 <replaceable>0 or 1</replaceable>
1577 <term>Default value:</term>
1579 <para><emphasis>0</emphasis></para>
1583 <term>Effect if unset:</term>
1586 Blocks are not enforced.
1594 <application>Privoxy</application> is mainly used to block and filter
1595 requests as a service to the user, for example to block ads and other
1596 junk that clogs the pipes. <application>Privoxy's</application> configuration
1597 isn't perfect and sometimes innocent pages are blocked. In this situation it
1598 makes sense to allow the user to enforce the request and have
1599 <application>Privoxy</application> ignore the block.
1602 In the default configuration <application>Privoxy's</application>
1603 <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1604 link to adds a special string (the force prefix) to the request URL.
1605 If that link is used, <application>Privoxy</application> will
1606 detect the force prefix, remove it again and let the request pass.
1609 Of course <application>Privoxy</application> can also be used to enforce
1610 a network policy. In that case the user obviously should not be able to
1611 bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1612 option is for. If it's enabled, <application>Privoxy</application> hides
1613 the <quote>go there anyway</quote> link. If the user adds the force
1614 prefix by hand, it will not be accepted and the circumvention attempt
1620 <term>Examples:</term>
1628 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1632 <!-- ~~~~~ New section ~~~~~ -->
1633 <sect3 renderas="sect4" id="acls"><title>
1634 ACLs: permit-access and deny-access</title>
1635 <anchor id="permit-access">
1636 <anchor id="deny-access">
1640 <term>Specifies:</term>
1643 Who can access what.
1648 <term>Type of value:</term>
1651 <replaceable class="parameter">src_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">src_masklen</replaceable>]
1652 [<replaceable class="parameter">dst_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">dst_masklen</replaceable>]]
1655 Where <replaceable class="parameter">src_addr</replaceable> and
1656 <replaceable class="parameter">dst_addr</replaceable> are IPv4 addresses in dotted decimal notation or valid
1657 DNS names, <replaceable class="parameter">port</replaceable> is a port
1658 number, and <replaceable class="parameter">src_masklen</replaceable> and
1659 <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1660 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1661 destination part are optional.
1664 If your system implements
1665 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink>, then
1666 <replaceable class="parameter">src_addr</replaceable> and <replaceable
1667 class="parameter">dst_addr</replaceable> can be IPv6 addresses delimeted by
1668 brackets, <replaceable class="parameter">port</replaceable> can be a number
1669 or a service name, and
1670 <replaceable class="parameter">src_masklen</replaceable> and
1671 <replaceable class="parameter">dst_masklen</replaceable> can be a number
1677 <term>Default value:</term>
1679 <para><emphasis>Unset</emphasis></para>
1681 If no <replaceable class="parameter">port</replaceable> is specified,
1682 any port will match. If no <replaceable class="parameter">src_masklen</replaceable> or
1683 <replaceable class="parameter">src_masklen</replaceable> is given, the complete IP
1684 address has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1689 <term>Effect if unset:</term>
1692 Don't restrict access further than implied by <literal>listen-address</literal>
1700 Access controls are included at the request of ISPs and systems
1701 administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1702 For a typical home user, it will normally suffice to ensure that
1703 <application>Privoxy</application> only listens on the localhost
1704 (127.0.0.1) or internal (home) network address by means of the
1705 <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1709 Please see the warnings in the FAQ that <application>Privoxy</application>
1710 is not intended to be a substitute for a firewall or to encourage anyone
1711 to defer addressing basic security weaknesses.
1714 Multiple ACL lines are OK.
1715 If any ACLs are specified, <application>Privoxy</application> only talks
1716 to IP addresses that match at least one <literal>permit-access</literal> line
1717 and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1718 last match wins, with the default being <literal>deny-access</literal>.
1721 If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1722 for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1723 that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1724 of the ultimate target. This is necessary because it may be impossible for the local
1725 <application>Privoxy</application> to determine the IP address of the
1726 ultimate target (that's often what gateways are used for).
1729 You should prefer using IP addresses over DNS names, because the address lookups take
1730 time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1731 like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1732 IP addresses, only the first one is used.
1735 Some systems allow IPv4 clients to connect to IPv6 server sockets.
1736 Then the client's IPv4 address will be translated by the system into
1737 IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4
1738 mapped IPv6 address). <application>Privoxy</application> can handle it
1739 and maps such ACL addresses automatically.
1742 Denying access to particular sites by ACL may have undesired side effects
1743 if the site in question is hosted on a machine which also hosts other sites
1749 <term>Examples:</term>
1752 Explicitly define the default behavior if no ACL and
1753 <literal>listen-address</literal> are set: <quote>localhost</quote>
1754 is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1755 <emphasis>all</emphasis> destination addresses are OK:
1759 permit-access localhost
1763 Allow any host on the same class C subnet as www.privoxy.org access to
1764 nothing but www.example.com (or other domains hosted on the same system):
1768 permit-access www.privoxy.org/24 www.example.com/32
1772 Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1773 with the exception that 192.168.45.73 may not access the IP address behind
1774 www.dirty-stuff.example.com:
1778 permit-access 192.168.45.64/26
1779 deny-access 192.168.45.73 www.dirty-stuff.example.com
1783 Allow access from the IPv4 network 192.0.2.0/24 even if listening on
1784 an IPv6 wild card address (not supported on all platforms):
1788 permit-access 192.0.2.0/24
1792 This is equivalent to the following line even if listening on an
1793 IPv4 address (not supported on all platforms):
1797 permit-access [::ffff:192.0.2.0]/120
1806 <!-- ~~~~~ New section ~~~~~ -->
1807 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1811 <term>Specifies:</term>
1814 Maximum size of the buffer for content filtering.
1819 <term>Type of value:</term>
1821 <para>Size in Kbytes</para>
1825 <term>Default value:</term>
1831 <term>Effect if unset:</term>
1834 Use a 4MB (4096 KB) limit.
1842 For content filtering, i.e. the <literal>+filter</literal> and
1843 <literal>+deanimate-gif</literal> actions, it is necessary that
1844 <application>Privoxy</application> buffers the entire document body.
1845 This can be potentially dangerous, since a server could just keep sending
1846 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1850 When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1851 flushed to the client unfiltered and no further attempt to
1852 filter the rest of the document is made. Remember that there may be multiple threads
1853 running, which might require up to <literal>buffer-limit</literal> Kbytes
1854 <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1861 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1864 <!-- ~~~~~ New section ~~~~~ -->
1865 <sect3 renderas="sect4" id="enable-proxy-authentication-forwarding"><title>enable-proxy-authentication-forwarding</title>
1868 <term>Specifies:</term>
1871 Whether or not proxy authentication through &my-app; should work.
1876 <term>Type of value:</term>
1882 <term>Default value:</term>
1888 <term>Effect if unset:</term>
1891 Proxy authentication headers are removed.
1899 Privoxy itself does not support proxy authentication, but can
1900 allow clients to authenticate against Privoxy's parent proxy.
1903 By default Privoxy (3.0.21 and later) don't do that and remove
1904 Proxy-Authorization headers in requests and Proxy-Authenticate
1905 headers in responses to make it harder for malicious sites to
1906 trick inexperienced users into providing login information.
1909 If this option is enabled the headers are forwarded.
1912 Enabling this option is <emphasis>not recommended</emphasis> if there is
1913 no parent proxy that requires authentication or if the local network between
1914 Privoxy and the parent proxy isn't trustworthy. If proxy authentication is
1915 only required for some requests, it is recommended to use a client header filter
1916 to remove the authentication headers for requests where they aren't needed.
1922 <![%config-file;[<literallayout>@@enable-proxy-authentication-forwarding 0</literallayout>]]>
1927 <!-- ~ End section ~ -->
1930 <!-- ~~~~~ New section ~~~~~ -->
1932 <sect2 id="forwarding">
1933 <title>Forwarding</title>
1936 This feature allows routing of HTTP requests through a chain of
1940 Forwarding can be used to chain Privoxy with a caching proxy to speed
1941 up browsing. Using a parent proxy may also be necessary if the machine
1942 that <application>Privoxy</application> runs on has no direct Internet access.
1945 Note that parent proxies can severely decrease your privacy level.
1946 For example a parent proxy could add your IP address to the request
1947 headers and if it's a caching proxy it may add the <quote>Etag</quote>
1948 header to revalidation requests again, even though you configured Privoxy
1949 to remove it. It may also ignore Privoxy's header time randomization and use the
1950 original values which could be used by the server as cookie replacement
1951 to track your steps between visits.
1955 Also specified here are SOCKS proxies. <application>Privoxy</application>
1956 supports the SOCKS 4 and SOCKS 4A protocols.
1959 <sect3 renderas="sect4" id="forward"><title>forward</title>
1962 <term>Specifies:</term>
1965 To which parent HTTP proxy specific requests should be routed.
1970 <term>Type of value:</term>
1973 <replaceable class="parameter">target_pattern</replaceable>
1974 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1977 where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1978 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1979 denote <quote>all URLs</quote>.
1980 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1981 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1982 optionally followed by its listening port (default: 8000).
1983 Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1988 <term>Default value:</term>
1990 <para><emphasis>Unset</emphasis></para>
1994 <term>Effect if unset:</term>
1997 Don't use parent HTTP proxies.
2005 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2006 forwarded to another HTTP proxy but are made directly to the web servers.
2009 <replaceable class="parameter">http_parent</replaceable> can be a
2010 numerical IPv6 address (if
2011 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2012 implemented). To prevent clashes with the port delimiter, the whole IP
2013 address has to be put into brackets. On the other hand a <replaceable
2014 class="parameter">target_pattern</replaceable> containing an IPv6 address
2015 has to be put into angle brackets (normal brackets are reserved for
2016 regular expressions already).
2019 Multiple lines are OK, they are checked in sequence, and the last match wins.
2024 <term>Examples:</term>
2027 Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
2031 forward / parent-proxy.example.org:8080
2036 Everything goes to our example ISP's caching proxy, except for requests
2037 to that ISP's sites:
2041 forward / caching-proxy.isp.example.net:8000
2042 forward .isp.example.net .
2046 Parent proxy specified by an IPv6 address:
2050 forward / [2001:DB8::1]:8000
2054 Suppose your parent proxy doesn't support IPv6:
2058 forward / parent-proxy.example.org:8000
2059 forward ipv6-server.example.org .
2060 forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
2069 <!-- ~~~~~ New section ~~~~~ -->
2070 <sect3 renderas="sect4" id="socks"><title>
2071 forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
2072 <anchor id="forward-socks4">
2073 <anchor id="forward-socks4a">
2077 <term>Specifies:</term>
2080 Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2085 <term>Type of value:</term>
2088 <replaceable class="parameter">target_pattern</replaceable>
2089 <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
2090 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2093 where <replaceable class="parameter">target_pattern</replaceable> is a
2094 <link linkend="af-patterns">URL pattern</link> that specifies to which
2095 requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2096 denote <quote>all URLs</quote>. <replaceable class="parameter">http_parent</replaceable>
2097 and <replaceable class="parameter">socks_proxy</replaceable>
2098 are IP addresses in dotted decimal notation or valid DNS names
2099 (<replaceable class="parameter">http_parent</replaceable>
2100 may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
2101 <replaceable class="parameter">port</replaceable> parameters are TCP ports,
2102 i.e. integer values from 1 to 65535
2107 <term>Default value:</term>
2109 <para><emphasis>Unset</emphasis></para>
2113 <term>Effect if unset:</term>
2116 Don't use SOCKS proxies.
2124 Multiple lines are OK, they are checked in sequence, and the last match wins.
2127 The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
2128 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2129 server, while in SOCKS 4 it happens locally.
2132 With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
2135 <literal>forward-socks5t</literal> works like vanilla <literal>forward-socks5</literal> but
2136 lets &my-app; additionally use Tor-specific SOCKS extensions. Currently the only supported
2137 SOCKS extension is optimistic data which can reduce the latency for the first request made
2138 on a newly created connection.
2141 <replaceable class="parameter">socks_proxy</replaceable> and
2142 <replaceable class="parameter">http_parent</replaceable> can be a
2143 numerical IPv6 address (if
2144 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2145 implemented). To prevent clashes with the port delimiter, the whole IP
2146 address has to be put into brackets. On the other hand a <replaceable
2147 class="parameter">target_pattern</replaceable> containing an IPv6 address
2148 has to be put into angle brackets (normal brackets are reserved for
2149 regular expressions already).
2152 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2153 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2159 <term>Examples:</term>
2162 From the company example.com, direct connections are made to all
2163 <quote>internal</quote> domains, but everything outbound goes through
2164 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2169 forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
2170 forward .example.com .
2174 A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2178 forward-socks4 / socks-gw.example.com:1080 .
2183 To chain Privoxy and Tor, both running on the same system, you would use
2188 forward-socks5t / 127.0.0.1:9050 .
2193 The public <application>Tor</application> network can't be used to
2194 reach your local network, if you need to access local servers you
2195 therefore might want to make some exceptions:
2199 forward 192.168.*.*/ .
2201 forward 127.*.*.*/ .
2205 Unencrypted connections to systems in these address ranges will
2206 be as (un)secure as the local network is, but the alternative is that you
2207 can't reach the local network through <application>Privoxy</application>
2208 at all. Of course this may actually be desired and there is no reason
2209 to make these exceptions if you aren't sure you need them.
2212 If you also want to be able to reach servers in your local network by
2213 using their names, you will need additional exceptions that look like
2218 forward localhost/ .
2227 <![%user-man;[ <!-- not included in config due to length -->
2228 <!-- ~~~~~ New section ~~~~~ -->
2229 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2232 If you have links to multiple ISPs that provide various special content
2233 only to their subscribers, you can configure multiple <application>Privoxies</application>
2234 which have connections to the respective ISPs to act as forwarders to each other, so that
2235 <emphasis>your</emphasis> users can see the internal content of all ISPs.
2239 Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2240 isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2241 configuration can look like this:
2251 forward .isp-b.example.net host-b:8118
2262 forward .isp-a.example.org host-a:8118
2267 Now, your users can set their browser's proxy to use either
2268 host-a or host-b and be able to browse the internal content
2269 of both isp-a and isp-b.
2273 If you intend to chain <application>Privoxy</application> and
2274 <application>squid</application> locally, then chaining as
2275 <literal>browser -> squid -> privoxy</literal> is the recommended way.
2279 Assuming that <application>Privoxy</application> and <application>squid</application>
2280 run on the same box, your <application>squid</application> configuration could then look like this:
2285 # Define Privoxy as parent proxy (without ICP)
2286 cache_peer 127.0.0.1 parent 8118 7 no-query
2288 # Define ACL for protocol FTP
2291 # Do not forward FTP requests to Privoxy
2292 always_direct allow ftp
2294 # Forward all the rest to Privoxy
2295 never_direct allow all</screen>
2299 You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2300 Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2304 You could just as well decide to only forward requests you suspect
2305 of leading to Windows executables through a virus-scanning parent proxy,
2306 say, on <literal>antivir.example.com</literal>, port 8010:
2312 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
2318 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2321 <term>Specifies:</term>
2324 How often Privoxy retries if a forwarded connection request fails.
2329 <term>Type of value:</term>
2332 <replaceable class="parameter">Number of retries.</replaceable>
2337 <term>Default value:</term>
2339 <para><emphasis>0</emphasis></para>
2343 <term>Effect if unset:</term>
2346 Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2354 <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2355 for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2356 The connection might have failed because of a DNS timeout in which case a retry makes sense,
2357 but it might also have failed because the server doesn't exist or isn't reachable. In this
2358 case the retry will just delay the appearance of Privoxy's error message.
2361 Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2362 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2365 Only use this option, if you are getting lots of forwarding-related error messages
2366 that go away when you try again manually. Start with a small value and check Privoxy's
2367 logfile from time to time, to see how many retries are usually needed.
2372 <term>Examples:</term>
2375 forwarded-connect-retries 1
2380 <![%config-file;[<literallayout>@@forwarded-connect-retries 0</literallayout>]]>
2386 <title>Miscellaneous</title>
2388 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2391 <term>Specifies:</term>
2394 Whether intercepted requests should be treated as valid.
2399 <term>Type of value:</term>
2402 <replaceable>0 or 1</replaceable>
2407 <term>Default value:</term>
2409 <para><emphasis>0</emphasis></para>
2413 <term>Effect if unset:</term>
2416 Only proxy requests are accepted, intercepted requests are treated as invalid.
2424 If you don't trust your clients and want to force them
2425 to use <application>Privoxy</application>, enable this
2426 option and configure your packet filter to redirect outgoing
2427 HTTP connections into <application>Privoxy</application>.
2430 Note that intercepting encrypted connections (HTTPS) isn't supported.
2433 Make sure that <application>Privoxy's</application> own requests
2434 aren't redirected as well. Additionally take care that
2435 <application>Privoxy</application> can't intentionally connect
2436 to itself, otherwise you could run into redirection loops if
2437 <application>Privoxy's</application> listening port is reachable
2438 by the outside or an attacker has access to the pages you visit.
2443 <term>Examples:</term>
2446 accept-intercepted-requests 1
2451 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2454 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2457 <term>Specifies:</term>
2460 Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2465 <term>Type of value:</term>
2468 <replaceable>0 or 1</replaceable>
2473 <term>Default value:</term>
2475 <para><emphasis>0</emphasis></para>
2479 <term>Effect if unset:</term>
2482 <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2490 By default <application>Privoxy</application> ignores block or redirect actions
2491 for its CGI pages. Intercepting these requests can be useful in multi-user
2492 setups to implement fine-grained access control, but it can also render the complete
2493 web interface useless and make debugging problems painful if done without care.
2496 Don't enable this option unless you're sure that you really need it.
2501 <term>Examples:</term>
2504 allow-cgi-request-crunching 1
2509 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2512 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2515 <term>Specifies:</term>
2518 Whether the CGI interface should stay compatible with broken HTTP clients.
2523 <term>Type of value:</term>
2526 <replaceable>0 or 1</replaceable>
2531 <term>Default value:</term>
2533 <para><emphasis>0</emphasis></para>
2537 <term>Effect if unset:</term>
2540 The CGI form generate long GET URLs.
2548 <application>Privoxy's</application> CGI forms can lead to
2549 rather long URLs. This isn't a problem as far as the HTTP
2550 standard is concerned, but it can confuse clients with arbitrary
2551 URL length limitations.
2554 Enabling split-large-forms causes <application>Privoxy</application>
2555 to divide big forms into smaller ones to keep the URL length down.
2556 It makes editing a lot less convenient and you can no longer
2557 submit all changes at once, but at least it works around this
2561 If you don't notice any editing problems, there is no reason
2562 to enable this option, but if one of the submit buttons appears
2563 to be broken, you should give it a try.
2568 <term>Examples:</term>
2576 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2579 <sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
2582 <term>Specifies:</term>
2585 Number of seconds after which an open connection will no longer be reused.
2590 <term>Type of value:</term>
2593 <replaceable>Time in seconds.</replaceable>
2598 <term>Default value:</term>
2604 <term>Effect if unset:</term>
2607 Connections are not kept alive.
2615 This option allows clients to keep the connection to &my-app;
2616 alive. If the server supports it, &my-app; will keep
2617 the connection to the server alive as well. Under certain
2618 circumstances this may result in speed-ups.
2621 By default, &my-app; will close the connection to the server if
2622 the client connection gets closed, or if the specified timeout
2623 has been reached without a new request coming in. This behaviour
2624 can be changed with the <ulink
2625 url="#CONNECTION-SHARING">connection-sharing</ulink> option.
2628 This option has no effect if <application>Privoxy</application>
2629 has been compiled without keep-alive support.
2632 Note that a timeout of five seconds as used in the default
2633 configuration file significantly decreases the number of
2634 connections that will be reused. The value is used because
2635 some browsers limit the number of connections they open to
2636 a single host and apply the same limit to proxies. This can
2637 result in a single website <quote>grabbing</quote> all the
2638 connections the browser allows, which means connections to
2639 other websites can't be opened until the connections currently
2643 Several users have reported this as a Privoxy bug, so the
2644 default value has been reduced. Consider increasing it to
2645 300 seconds or even more if you think your browser can handle
2646 it. If your browser appears to be hanging, it probably can't.
2651 <term>Examples:</term>
2654 keep-alive-timeout 300
2659 <![%config-file;[<literallayout>@@keep-alive-timeout 5</literallayout>]]>
2663 <sect3 renderas="sect4" id="tolerate-pipelining"><title>tolerate-pipelining</title>
2666 <term>Specifies:</term>
2669 Whether or not pipelined requests should be served.
2674 <term>Type of value:</term>
2677 <replaceable>0 or 1.</replaceable>
2682 <term>Default value:</term>
2688 <term>Effect if unset:</term>
2691 If Privoxy receives more than one request at once, it terminates the
2692 client connection after serving the first one.
2700 &my-app; currently doesn't pipeline outgoing requests,
2701 thus allowing pipelining on the client connection is not
2702 guaranteed to improve the performance.
2705 By default &my-app; tries to discourage clients from pipelining
2706 by discarding aggressively pipelined requests, which forces the
2707 client to resend them through a new connection.
2710 This option lets &my-app; tolerate pipelining. Whether or not
2711 that improves performance mainly depends on the client configuration.
2714 If you are seeing problems with pages not properly loading,
2715 disabling this option could work around the problem.
2720 <term>Examples:</term>
2723 tolerate-pipelining 1
2728 <![%config-file;[<literallayout>@@tolerate-pipelining 1</literallayout>]]>
2732 <sect3 renderas="sect4" id="default-server-timeout"><title>default-server-timeout</title>
2735 <term>Specifies:</term>
2738 Assumed server-side keep-alive timeout if not specified by the server.
2743 <term>Type of value:</term>
2746 <replaceable>Time in seconds.</replaceable>
2751 <term>Default value:</term>
2757 <term>Effect if unset:</term>
2760 Connections for which the server didn't specify the keep-alive
2761 timeout are not reused.
2769 Enabling this option significantly increases the number of connections
2770 that are reused, provided the <ulink
2771 url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> option
2775 While it also increases the number of connections problems
2776 when &my-app; tries to reuse a connection that already has
2777 been closed on the server side, or is closed while &my-app;
2778 is trying to reuse it, this should only be a problem if it
2779 happens for the first request sent by the client. If it happens
2780 for requests on reused client connections, &my-app; will simply
2781 close the connection and the client is supposed to retry the
2782 request without bothering the user.
2785 Enabling this option is therefore only recommended if the
2787 url="#CONNECTION-SHARING">connection-sharing</ulink> option
2791 It is an error to specify a value larger than the <ulink
2792 url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> value.
2795 This option has no effect if <application>Privoxy</application>
2796 has been compiled without keep-alive support.
2801 <term>Examples:</term>
2804 default-server-timeout 60
2809 <![%config-file;[<literallayout>@@#default-server-timeout 60</literallayout>]]>
2813 <sect3 renderas="sect4" id="connection-sharing"><title>connection-sharing</title>
2816 <term>Specifies:</term>
2819 Whether or not outgoing connections that have been kept alive
2820 should be shared between different incoming connections.
2825 <term>Type of value:</term>
2828 <replaceable>0 or 1</replaceable>
2833 <term>Default value:</term>
2839 <term>Effect if unset:</term>
2842 Connections are not shared.
2850 This option has no effect if <application>Privoxy</application>
2851 has been compiled without keep-alive support, or if it's disabled.
2859 Note that reusing connections doesn't necessary cause speedups.
2860 There are also a few privacy implications you should be aware of.
2863 If this option is effective, outgoing connections are shared between
2864 clients (if there are more than one) and closing the browser that initiated
2865 the outgoing connection does no longer affect the connection between &my-app;
2866 and the server unless the client's request hasn't been completed yet.
2869 If the outgoing connection is idle, it will not be closed until either
2870 <application>Privoxy's</application> or the server's timeout is reached.
2871 While it's open, the server knows that the system running &my-app; is still
2875 If there are more than one client (maybe even belonging to multiple users),
2876 they will be able to reuse each others connections. This is potentially
2877 dangerous in case of authentication schemes like NTLM where only the
2878 connection is authenticated, instead of requiring authentication for
2882 If there is only a single client, and if said client can keep connections
2883 alive on its own, enabling this option has next to no effect. If the client
2884 doesn't support connection keep-alive, enabling this option may make sense
2885 as it allows &my-app; to keep outgoing connections alive even if the client
2886 itself doesn't support it.
2889 You should also be aware that enabling this option increases the likelihood
2890 of getting the "No server or forwarder data" error message, especially if you
2891 are using a slow connection to the Internet.
2894 This option should only be used by experienced users who
2895 understand the risks and can weight them against the benefits.
2900 <term>Examples:</term>
2903 connection-sharing 1
2908 <![%config-file;[<literallayout>@@#connection-sharing 1</literallayout>]]>
2912 <sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
2915 <term>Specifies:</term>
2918 Number of seconds after which a socket times out if
2919 no data is received.
2924 <term>Type of value:</term>
2927 <replaceable>Time in seconds.</replaceable>
2932 <term>Default value:</term>
2938 <term>Effect if unset:</term>
2941 A default value of 300 seconds is used.
2949 The default is quite high and you probably want to reduce it.
2950 If you aren't using an occasionally slow proxy like Tor, reducing
2951 it to a few seconds should be fine.
2956 <term>Examples:</term>
2964 <![%config-file;[<literallayout>@@socket-timeout 300</literallayout>]]>
2968 <sect3 renderas="sect4" id="max-client-connections"><title>max-client-connections</title>
2971 <term>Specifies:</term>
2974 Maximum number of client connections that will be served.
2979 <term>Type of value:</term>
2982 <replaceable>Positive number.</replaceable>
2987 <term>Default value:</term>
2993 <term>Effect if unset:</term>
2996 Connections are served until a resource limit is reached.
3004 &my-app; creates one thread (or process) for every incoming client
3005 connection that isn't rejected based on the access control settings.
3008 If the system is powerful enough, &my-app; can theoretically deal with
3009 several hundred (or thousand) connections at the same time, but some
3010 operating systems enforce resource limits by shutting down offending
3011 processes and their default limits may be below the ones &my-app; would
3012 require under heavy load.
3015 Configuring &my-app; to enforce a connection limit below the thread
3016 or process limit used by the operating system makes sure this doesn't
3017 happen. Simply increasing the operating system's limit would work too,
3018 but if &my-app; isn't the only application running on the system,
3019 you may actually want to limit the resources used by &my-app;.
3022 If &my-app; is only used by a single trusted user, limiting the
3023 number of client connections is probably unnecessary. If there
3024 are multiple possibly untrusted users you probably still want to
3025 additionally use a packet filter to limit the maximal number of
3026 incoming connections per client. Otherwise a malicious user could
3027 intentionally create a high number of connections to prevent other
3028 users from using &my-app;.
3031 Obviously using this option only makes sense if you choose a limit
3032 below the one enforced by the operating system.
3035 One most POSIX-compliant systems &my-app; can't properly deal with
3036 more than FD_SETSIZE file descriptors at the same time and has to reject
3037 connections if the limit is reached. This will likely change in a
3038 future version, but currently this limit can't be increased without
3039 recompiling &my-app; with a different FD_SETSIZE limit.
3044 <term>Examples:</term>
3047 max-client-connections 256
3052 <![%config-file;[<literallayout>@@#max-client-connections 256</literallayout>]]>
3056 <sect3 renderas="sect4" id="handle-as-empty-doc-returns-ok"><title>handle-as-empty-doc-returns-ok</title>
3059 <term>Specifies:</term>
3062 The status code Privoxy returns for pages blocked with
3063 <!-- URL will only end up in the user manual so the relative link should work. -->
3064 <literal><ulink url="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">+handle-as-empty-document</ulink></literal>.
3069 <term>Type of value:</term>
3072 <replaceable>0 or 1</replaceable>
3077 <term>Default value:</term>
3083 <term>Effect if unset:</term>
3086 Privoxy returns a status 403(forbidden) for all blocked pages.
3091 <term>Effect if set:</term>
3094 Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
3095 and a status 403(Forbidden) for all other blocked pages.
3103 This is a work-around for Firefox bug 492459:
3105 Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.
3107 (<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
3108 >https://bugzilla.mozilla.org/show_bug.cgi?id=492459</ulink>)
3109 As the bug has been fixed for quite some time this option should no longer
3110 be needed and will be removed in a future release. Please speak up if you
3111 have a reason why the option should be kept around.
3116 <![%config-file;[<literallayout>@@#handle-as-empty-doc-returns-ok 1</literallayout>]]>
3120 <sect3 renderas="sect4" id="enable-compression"><title>enable-compression</title>
3123 <term>Specifies:</term>
3126 Whether or not buffered content is compressed before delivery.
3131 <term>Type of value:</term>
3134 <replaceable>0 or 1</replaceable>
3139 <term>Default value:</term>
3145 <term>Effect if unset:</term>
3148 Privoxy does not compress buffered content.
3153 <term>Effect if set:</term>
3156 Privoxy compresses buffered content before delivering it to the client,
3157 provided the client supports it.
3165 This directive is only supported if Privoxy has been compiled with
3166 FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB.
3169 Compressing buffered content is mainly useful if Privoxy and the
3170 client are running on different systems. If they are running on the
3171 same system, enabling compression is likely to slow things down.
3172 If you didn't measure otherwise, you should assume that it does
3173 and keep this option disabled.
3176 Privoxy will not compress buffered content below a certain length.
3181 <![%config-file;[<literallayout>@@#enable-compression 1</literallayout>]]>
3185 <sect3 renderas="sect4" id="compression-level"><title>compression-level</title>
3188 <term>Specifies:</term>
3191 The compression level that is passed to the zlib library when compressing buffered content.
3196 <term>Type of value:</term>
3199 <replaceable>Positive number ranging from 0 to 9.</replaceable>
3204 <term>Default value:</term>
3213 Compressing the data more takes usually longer than compressing
3214 it less or not compressing it at all. Which level is best depends
3215 on the connection between Privoxy and the client. If you can't
3216 be bothered to benchmark it for yourself, you should stick with
3217 the default and keep compression disabled.
3220 If compression is disabled, the compression level is irrelevant.
3225 <term>Examples:</term>
3229 # Best speed (compared to the other levels)
3233 # No compression. Only useful for testing as the added header
3234 # slightly increases the amount of data that has to be sent.
3235 # If your benchmark shows that using this compression level
3236 # is superior to using no compression at all, the benchmark
3237 # is likely to be flawed.
3244 <![%config-file;[<literallayout>@@#compression-level 1</literallayout>]]>
3248 <sect3 renderas="sect4" id="client-header-order"><title>client-header-order</title>
3251 <term>Specifies:</term>
3254 The order in which client headers are sorted before forwarding them.
3259 <term>Type of value:</term>
3262 <replaceable>Client header names delimited by spaces or tabs</replaceable>
3267 <term>Default value:</term>
3276 By default &my-app; leaves the client headers in the order they
3277 were sent by the client. Headers are modified in-place, new headers
3278 are added at the end of the already existing headers.
3281 The header order can be used to fingerprint client requests
3282 independently of other headers like the User-Agent.
3285 This directive allows to sort the headers differently to better
3286 mimic a different User-Agent. Client headers will be emitted
3287 in the order given, headers whose name isn't explicitly specified
3288 are added at the end.
3291 Note that sorting headers in an uncommon way will make fingerprinting
3292 actually easier. Encrypted headers are not affected by this directive.
3297 <![%config-file;[<literallayout>@@#client-header-order Host \
3316 <!-- ~ End section ~ -->
3319 <!-- ~~~~~ New section ~~~~~ -->
3321 <sect2 id="windows-gui">
3322 <title>Windows GUI Options</title>
3324 <application>Privoxy</application> has a number of options specific to the
3325 Windows GUI interface:
3328 <anchor id="activity-animation">
3329 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3331 If <quote>activity-animation</quote> is set to 1, the
3332 <application>Privoxy</application> icon will animate when
3333 <quote>Privoxy</quote> is active. To turn off, set to 0.
3336 <![%config-file;[<literallayout>@@#activity-animation 1</literallayout>]]>
3342 <emphasis>activity-animation 1</emphasis>
3349 <anchor id="log-messages">
3350 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3352 If <quote>log-messages</quote> is set to 1,
3353 <application>Privoxy</application> copies log messages to the console
3355 The log detail depends on the <link linkend="debug">debug</link> directive.
3358 <![%config-file;[<literallayout>@@#log-messages 1</literallayout>]]>
3364 <emphasis>log-messages 1</emphasis>
3371 <anchor id="log-buffer-size">
3372 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3374 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
3375 i.e. the amount of memory used for the log messages displayed in the
3376 console window, will be limited to <quote>log-max-lines</quote> (see below).
3380 Warning: Setting this to 0 will result in the buffer to grow infinitely and
3381 eat up all your memory!
3384 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
3390 <emphasis>log-buffer-size 1</emphasis>
3397 <anchor id="log-max-lines">
3398 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3400 <application>log-max-lines</application> is the maximum number of lines held
3401 in the log buffer. See above.
3404 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
3410 <emphasis>log-max-lines 200</emphasis>
3417 <anchor id="log-highlight-messages">
3418 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3420 If <quote>log-highlight-messages</quote> is set to 1,
3421 <application>Privoxy</application> will highlight portions of the log
3422 messages with a bold-faced font:
3425 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
3431 <emphasis>log-highlight-messages 1</emphasis>
3438 <anchor id="log-font-name">
3439 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3441 The font used in the console window:
3444 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
3450 <emphasis>log-font-name Comic Sans MS</emphasis>
3457 <anchor id="log-font-size">
3458 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3460 Font size used in the console window:
3463 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
3469 <emphasis>log-font-size 8</emphasis>
3476 <anchor id="show-on-task-bar">
3477 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3479 <quote>show-on-task-bar</quote> controls whether or not
3480 <application>Privoxy</application> will appear as a button on the Task bar
3484 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
3490 <emphasis>show-on-task-bar 0</emphasis>
3497 <anchor id="close-button-minimizes">
3498 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3500 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
3501 button will minimize <application>Privoxy</application> instead of closing
3502 the program (close with the exit option on the File menu).
3505 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
3511 <emphasis>close-button-minimizes 1</emphasis>
3518 <anchor id="hide-console">
3519 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3521 The <quote>hide-console</quote> option is specific to the MS-Win console
3522 version of <application>Privoxy</application>. If this option is used,
3523 <application>Privoxy</application> will disconnect from and hide the
3527 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
3533 #<emphasis>hide-console</emphasis>
3543 <!-- end config content common to both outputs -->
3546 <!-- These are dummy anchors to keep the processor quiet -->
3547 <!-- when building config-file only (ie. they are used in u-m only) -->
3550 <anchor id="filter">
3551 <anchor id="filter-file">
3553 <anchor id="actions-file">
3554 <anchor id="af-patterns">
3558 <!-- eof p-config.sgml -->