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.104 2014/05/05 09:59:30 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.104 2014/05/05 09:59:30 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="temporary-directory"><title>temporary-directory</title>
596 <term>Specifies:</term>
598 <para>A directory where Privoxy can create temporary files.</para>
602 <term>Type of value:</term>
604 <para>Path name</para>
608 <term>Default value:</term>
614 <term>Effect if unset:</term>
616 <para>No temporary files are created, external filters don't work.</para>
623 To execute <literal><ulink url="actions-file.html#EXTERNAL-FILTER">external filters</ulink></literal>,
624 <application>Privoxy</application> has to create temporary files.
625 This directive specifies the directory the temporary files should
629 It should be a directory only <application>Privoxy</application>
630 (and trusted users) can access.
636 <![%config-file;[<literallayout>@@#temporary-directory .</literallayout>]]>
640 <!-- ~~~~~ New section ~~~~~ -->
641 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
645 <term>Specifies:</term>
648 The directory where all logging takes place
649 (i.e. where the <filename>logfile</filename> is located).
654 <term>Type of value:</term>
656 <para>Path name</para>
660 <term>Default value:</term>
662 <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
666 <term>Effect if unset:</term>
668 <para><emphasis>Mandatory</emphasis></para>
675 No trailing <quote><literal>/</literal></quote>, please.
681 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
685 <!-- ~~~~~ New section ~~~~~ -->
686 <sect3 renderas="sect4" id="actionsfile"><title>
689 <anchor id="default.action">
690 <anchor id="standard.action">
691 <anchor id="user.action">
692 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
695 <term>Specifies:</term>
698 The <link linkend="actions-file">actions file(s)</link> to use
703 <term>Type of value:</term>
705 <para>Complete file name, relative to <literal>confdir</literal></para>
709 <term>Default values:</term>
713 <msgtext><literallayout> match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout></msgtext>
716 <msgtext><literallayout> default.action # Main actions file</literallayout></msgtext>
719 <msgtext><literallayout> user.action # User customizations</literallayout></msgtext>
725 <term>Effect if unset:</term>
728 No actions are taken at all. More or less neutral proxying.
736 Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
739 The default values are <filename>default.action</filename>, which is the
740 <quote>main</quote> actions file maintained by the developers, and
741 <filename>user.action</filename>, where you can make your personal additions.
744 Actions files contain all the per site and per URL configuration for
745 ad blocking, cookie management, privacy considerations, etc.
746 There is no point in using <application>Privoxy</application> without at
747 least one actions file.
750 Note that since Privoxy 3.0.7, the complete filename, including the <quote>.action</quote>
751 extension has to be specified. The syntax change was necessary to be consistent
752 with the other file options and to allow previously forbidden characters.
758 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
759 <!-- html -> text conversion, blah -->
760 <![%config-file;[<literallayout>@@actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout>]]>
761 <![%config-file;[<literallayout>@@actionsfile default.action # Main actions file</literallayout>]]>
763 XXX: Like user.filter, user.action should probably be commented out
764 by default as not all packages install it into the default directory.
767 <![%config-file;[<literallayout>@@actionsfile user.action # User customizations</literallayout>]]>
770 <!-- ~~~~~ New section ~~~~~ -->
771 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
772 <anchor id="default.filter">
775 <term>Specifies:</term>
778 The <link linkend="filter-file">filter file(s)</link> to use
783 <term>Type of value:</term>
785 <para>File name, relative to <literal>confdir</literal></para>
789 <term>Default value:</term>
791 <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
795 <term>Effect if unset:</term>
798 No textual content filtering takes place, i.e. all
799 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
800 actions in the actions files are turned neutral.
808 Multiple <literal>filterfile</literal> lines are permitted.
811 The <link linkend="filter-file">filter files</link> contain content modification
812 rules that use <link linkend="regex">regular expressions</link>. These rules permit
813 powerful changes on the content of Web pages, and optionally the headers
814 as well, e.g., you could try to disable your favorite JavaScript annoyances,
815 re-write the actual displayed text, or just have some fun
816 playing buzzword bingo with web pages.
820 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
821 actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
822 to be defined in a filter file!
825 A pre-defined filter file called <filename>default.filter</filename> that contains
826 a number of useful filters for common problems is included in the distribution.
827 See the section on the <literal><link linkend="filter">filter</link></literal>
831 It is recommended to place any locally adapted filters into a separate
832 file, such as <filename>user.filter</filename>.
838 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
839 <![%config-file;[<literallayout>@@filterfile user.filter # User customizations</literallayout>]]>
843 <!-- ~~~~~ New section ~~~~~ -->
844 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
848 <term>Specifies:</term>
856 <term>Type of value:</term>
858 <para>File name, relative to <literal>logdir</literal></para>
862 <term>Default value:</term>
864 <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
868 <term>Effect if unset:</term>
871 No logfile is written.
879 The logfile is where all logging and error messages are written. The level
880 of detail and number of messages are set with the <literal>debug</literal>
881 option (see below). The logfile can be useful for tracking down a problem with
882 <application>Privoxy</application> (e.g., it's not blocking an ad you
883 think it should block) and it can help you to monitor what your browser
887 Depending on the debug options below, the logfile may be a privacy risk
888 if third parties can get access to it. As most users will never look
889 at it, <application>Privoxy</application> 3.0.7 and later only log fatal
893 For most troubleshooting purposes, you will have to change that,
894 please refer to the debugging section for details.
897 Your logfile will grow indefinitely, and you will probably want to
898 periodically remove it. On Unix systems, you can do this with a cron job
899 (see <quote>man cron</quote>).
902 Any log files must be writable by whatever user <application>Privoxy</application>
903 is being run as (on Unix, default user id is <quote>privoxy</quote>).
909 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
913 <!-- ~~~~~ New section ~~~~~ -->
914 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
917 <term>Specifies:</term>
920 The name of the trust file to use
925 <term>Type of value:</term>
927 <para>File name, relative to <literal>confdir</literal></para>
931 <term>Default value:</term>
933 <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
937 <term>Effect if unset:</term>
940 The entire trust mechanism is disabled.
948 The trust mechanism is an experimental feature for building white-lists and should
949 be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
952 If you specify a trust file, <application>Privoxy</application> will only allow
953 access to sites that are specified in the trustfile. Sites can be listed
957 Prepending a <literal>~</literal> character limits access to this site
958 only (and any sub-paths within this site), e.g.
959 <literal>~www.example.com</literal> allows access to
960 <literal>~www.example.com/features/news.html</literal>, etc.
963 Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
964 prepending the name with a <literal>+</literal> character. The effect is that
965 access to untrusted sites will be granted -- but only if a link from this
966 trusted referrer was used to get there. The link target will then be added
967 to the <quote>trustfile</quote> so that future, direct accesses will be
968 granted. Sites added via this mechanism do not become trusted referrers
969 themselves (i.e. they are added with a <literal>~</literal> designation).
970 There is a limit of 512 such entries, after which new entries will not be
974 If you use the <literal>+</literal> operator in the trust file, it may grow
975 considerably over time.
978 It is recommended that <application>Privoxy</application> be compiled with
979 the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
980 <literal> --disable-editor</literal> options, if this feature is to be
984 Possible applications include limiting Internet access for children.
991 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
995 <!-- ~ End section ~ -->
997 <!-- ~~~~~ New section ~~~~~ -->
998 <sect2 id="debugging">
999 <title>Debugging</title>
1002 These options are mainly useful when tracing a problem.
1003 Note that you might also want to invoke
1004 <application>Privoxy</application> with the <literal>--no-daemon</literal>
1005 command line option when debugging.
1008 <sect3 renderas="sect4" id="debug"><title>debug</title>
1012 <term>Specifies:</term>
1015 Key values that determine what information gets logged.
1020 <term>Type of value:</term>
1022 <para>Integer values</para>
1026 <term>Default value:</term>
1028 <para>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</para>
1032 <term>Effect if unset:</term>
1035 Default value is used (see above).
1043 The available debug levels are:
1047 debug 1 # Log the destination for each request &my-app; let through. See also debug 1024.
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
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 # Log the destination for requests &my-app; didn't let through, and the reason why.
1058 debug 2048 # CGI user interface
1059 debug 4096 # Startup banner and warnings.
1060 debug 8192 # Non-fatal errors
1061 debug 32768 # log all data read from the network
1062 debug 65536 # Log the applying actions
1066 To select multiple debug levels, you can either add them or use
1067 multiple <literal>debug</literal> lines.
1070 A debug level of 1 is informative because it will show you each request
1071 as it happens. <emphasis>1, 1024, 4096 and 8192 are recommended</emphasis>
1072 so that you will notice when things go wrong. The other levels are
1073 probably only of interest if you are hunting down a specific problem.
1074 They can produce a hell of an output (especially 16).
1078 &my-app; used to ship with the debug levels recommended above enabled by
1079 default, but due to privacy concerns 3.0.7 and later are configured to
1080 only log fatal errors.
1083 If you are used to the more verbose settings, simply enable the debug lines
1087 If you want to use pure CLF (Common Log Format), you should set <quote>debug
1088 512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1091 <application>Privoxy</application> has a hard-coded limit for the
1092 length of log messages. If it's reached, messages are logged truncated
1093 and marked with <quote>... [too long, truncated]</quote>.
1096 Please don't file any support requests without trying to reproduce
1097 the problem with increased debug level first. Once you read the log
1098 messages, you may even be able to solve the problem on your own.
1104 <![%config-file;[<literallayout>@@#debug 1 # Log the destination for each request &my-app; let through.</literallayout>]]>
1105 <![%config-file;[<literallayout>@@#debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
1106 <![%config-file;[<literallayout>@@#debug 4096 # Startup banner and warnings</literallayout>]]>
1107 <![%config-file;[<literallayout>@@#debug 8192 # Non-fatal errors</literallayout>]]>
1111 <!-- ~~~~~ New section ~~~~~ -->
1112 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1116 <term>Specifies:</term>
1119 Whether to run only one server thread.
1124 <term>Type of value:</term>
1126 <para><emphasis>1 or 0</emphasis></para>
1130 <term>Default value:</term>
1132 <para><emphasis>0</emphasis></para>
1136 <term>Effect if unset:</term>
1139 Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1140 serve multiple requests simultaneously.
1148 This option is only there for debugging purposes.
1149 <emphasis>It will drastically reduce performance.</emphasis>
1155 <![%config-file;[<literallayout>@@#single-threaded 1</literallayout>]]>
1158 <!-- ~~~~~ New section ~~~~~ -->
1159 <sect3 renderas="sect4" id="hostname"><title>hostname</title>
1163 <term>Specifies:</term>
1166 The hostname shown on the CGI pages.
1171 <term>Type of value:</term>
1177 <term>Default value:</term>
1179 <para><emphasis>Unset</emphasis></para>
1183 <term>Effect if unset:</term>
1186 The hostname provided by the operating system is used.
1194 On some misconfigured systems resolving the hostname fails or
1195 takes too much time and slows Privoxy down. Setting a fixed hostname
1196 works around the problem.
1199 In other circumstances it might be desirable to show a hostname
1200 other than the one returned by the operating system. For example
1201 if the system has several different hostnames and you don't want
1202 to use the first one.
1205 Note that Privoxy does not validate the specified hostname value.
1211 <![%config-file;[<literallayout>@@#hostname hostname.example.org</literallayout>]]>
1216 <!-- ~ End section ~ -->
1219 <!-- ~~~~~ New section ~~~~~ -->
1220 <sect2 id="access-control">
1221 <title>Access Control and Security</title>
1224 This section of the config file controls the security-relevant aspects
1225 of <application>Privoxy</application>'s configuration.
1229 <!-- ~~~~~ New section ~~~~~ -->
1230 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1234 <term>Specifies:</term>
1237 The address and TCP port on which <application>Privoxy</application> will
1238 listen for client requests.
1243 <term>Type of value:</term>
1245 <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1246 <para>[<replaceable class="parameter">Hostname</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1251 <term>Default value:</term>
1253 <para>127.0.0.1:8118</para>
1257 <term>Effect if unset:</term>
1260 Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable and
1261 recommended for home users who run <application>Privoxy</application> on
1262 the same machine as their browser.
1270 You will need to configure your browser(s) to this proxy address and port.
1273 If you already have another service running on port 8118, or if you want to
1274 serve requests from other machines (e.g. on your local network) as well, you
1275 will need to override the default.
1278 You can use this statement multiple times to make
1279 <application>Privoxy</application> listen on more ports or more
1280 <abbrev>IP</abbrev> addresses. Suitable if your operating system does not
1281 support sharing <abbrev>IPv6</abbrev> and <abbrev>IPv4</abbrev> protocols
1285 If a hostname is used instead of an IP address, <application>Privoxy</application>
1286 will try to resolve it to an IP address and if there are multiple, use the first
1290 If the address for the hostname isn't already known on the system
1291 (for example because it's in /etc/hostname), this may result in DNS
1295 If the specified address isn't available on the system, or if the
1296 hostname can't be resolved, <application>Privoxy</application>
1300 IPv6 addresses containing colons have to be quoted by brackets.
1301 They can only be used if <application>Privoxy</application> has
1302 been compiled with IPv6 support. If you aren't sure if your version
1303 supports it, have a look at
1304 <literal>http://config.privoxy.org/show-status</literal>.
1307 Some operating systems will prefer IPv6 to IPv4 addresses even if the
1308 system has no IPv6 connectivity which is usually not expected by the user.
1309 Some even rely on DNS to resolve localhost which mean the "localhost" address
1310 used may not actually be local.
1313 It is therefore recommended to explicitly configure the intended IP address
1314 instead of relying on the operating system, unless there's a strong reason not to.
1317 If you leave out the address, <application>Privoxy</application> will bind to all
1318 IPv4 interfaces (addresses) on your machine and may become reachable from the
1319 Internet and/or the local network. Be aware that some GNU/Linux distributions
1320 modify that behaviour without updating the documentation. Check for non-standard
1321 patches if your <application>Privoxy</application> version behaves differently.
1324 If you configure <application>Privoxy</application> to be reachable from the
1325 network, consider using <link linkend="acls">access control lists</link>
1326 (ACL's, see below), and/or a firewall.
1329 If you open <application>Privoxy</application> to untrusted users, you will
1330 also want to make sure that the following actions are disabled: <literal><link
1331 linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1332 <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1337 <term>Example:</term>
1340 Suppose you are running <application>Privoxy</application> on
1341 a machine which has the address 192.168.0.1 on your local private network
1342 (192.168.0.0) and has another outside connection with a different address.
1343 You want it to serve requests from inside only:
1347 listen-address 192.168.0.1:8118
1351 Suppose you are running <application>Privoxy</application> on an
1352 IPv6-capable machine and you want it to listen on the IPv6 address
1353 of the loopback device:
1357 listen-address [::1]:8118
1364 <![%config-file;[<literallayout>@@listen-address 127.0.0.1:8118</literallayout>]]>
1368 <!-- ~~~~~ New section ~~~~~ -->
1369 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1373 <term>Specifies:</term>
1376 Initial state of "toggle" status
1381 <term>Type of value:</term>
1387 <term>Default value:</term>
1393 <term>Effect if unset:</term>
1396 Act as if toggled on
1404 If set to 0, <application>Privoxy</application> will start in
1405 <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1406 content-neutral proxy with both ad blocking and content filtering
1407 disabled. See <literal>enable-remote-toggle</literal> below.
1413 <![%config-file;[<literallayout>@@toggle 1</literallayout>]]>
1417 <!-- ~~~~~ New section ~~~~~ -->
1418 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1421 <term>Specifies:</term>
1424 Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1425 feature</ulink> may be used
1430 <term>Type of value:</term>
1436 <term>Default value:</term>
1442 <term>Effect if unset:</term>
1445 The web-based toggle feature is disabled.
1453 When toggled off, <application>Privoxy</application> mostly acts like a normal,
1454 content-neutral proxy, i.e. doesn't block ads or filter content.
1457 Access to the toggle feature can <emphasis>not</emphasis> be
1458 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1459 so that everybody who can access <application>Privoxy</application> (see
1460 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1461 toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1462 for multi-user environments with untrusted users.
1465 Note that malicious client side code (e.g Java) is also
1466 capable of using this option.
1469 As a lot of <application>Privoxy</application> users don't read
1470 documentation, this feature is disabled by default.
1473 Note that you must have compiled <application>Privoxy</application> with
1474 support for this feature, otherwise this option has no effect.
1480 <![%config-file;[<literallayout>@@enable-remote-toggle 0</literallayout>]]>
1484 <!-- ~~~~~ New section ~~~~~ -->
1485 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1488 <term>Specifies:</term>
1491 Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1496 <term>Type of value:</term>
1502 <term>Default value:</term>
1508 <term>Effect if unset:</term>
1511 Privoxy ignores special HTTP headers.
1519 When toggled on, the client can change <application>Privoxy's</application>
1520 behaviour by setting special HTTP headers. Currently the only supported
1521 special header is <quote>X-Filter: No</quote>, to disable filtering for
1522 the ongoing request, even if it is enabled in one of the action files.
1525 This feature is disabled by default. If you are using
1526 <application>Privoxy</application> in a environment with trusted clients,
1527 you may enable this feature at your discretion. Note that malicious client
1528 side code (e.g Java) is also capable of using this feature.
1531 This option will be removed in future releases as it has been obsoleted
1532 by the more general header taggers.
1538 <![%config-file;[<literallayout>@@enable-remote-http-toggle 0</literallayout>]]>
1542 <!-- ~~~~~ New section ~~~~~ -->
1543 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1546 <term>Specifies:</term>
1549 Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1550 file editor</ulink> may be used
1555 <term>Type of value:</term>
1561 <term>Default value:</term>
1567 <term>Effect if unset:</term>
1570 The web-based actions file editor is disabled.
1578 Access to the editor can <emphasis>not</emphasis> be
1579 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1580 so that everybody who can access <application>Privoxy</application> (see
1581 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1582 modify its configuration for all users.
1585 This option is <emphasis>not recommended</emphasis> for environments
1586 with untrusted users and as a lot of <application>Privoxy</application>
1587 users don't read documentation, this feature is disabled by default.
1590 Note that malicious client side code (e.g Java) is also
1591 capable of using the actions editor and you shouldn't enable
1592 this options unless you understand the consequences and are
1593 sure your browser is configured correctly.
1596 Note that you must have compiled <application>Privoxy</application> with
1597 support for this feature, otherwise this option has no effect.
1603 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1607 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1610 <term>Specifies:</term>
1613 Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1618 <term>Type of value:</term>
1621 <replaceable>0 or 1</replaceable>
1626 <term>Default value:</term>
1628 <para><emphasis>0</emphasis></para>
1632 <term>Effect if unset:</term>
1635 Blocks are not enforced.
1643 <application>Privoxy</application> is mainly used to block and filter
1644 requests as a service to the user, for example to block ads and other
1645 junk that clogs the pipes. <application>Privoxy's</application> configuration
1646 isn't perfect and sometimes innocent pages are blocked. In this situation it
1647 makes sense to allow the user to enforce the request and have
1648 <application>Privoxy</application> ignore the block.
1651 In the default configuration <application>Privoxy's</application>
1652 <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1653 link to adds a special string (the force prefix) to the request URL.
1654 If that link is used, <application>Privoxy</application> will
1655 detect the force prefix, remove it again and let the request pass.
1658 Of course <application>Privoxy</application> can also be used to enforce
1659 a network policy. In that case the user obviously should not be able to
1660 bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1661 option is for. If it's enabled, <application>Privoxy</application> hides
1662 the <quote>go there anyway</quote> link. If the user adds the force
1663 prefix by hand, it will not be accepted and the circumvention attempt
1669 <term>Examples:</term>
1677 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1681 <!-- ~~~~~ New section ~~~~~ -->
1682 <sect3 renderas="sect4" id="acls"><title>
1683 ACLs: permit-access and deny-access</title>
1684 <anchor id="permit-access">
1685 <anchor id="deny-access">
1689 <term>Specifies:</term>
1692 Who can access what.
1697 <term>Type of value:</term>
1700 <replaceable class="parameter">src_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">src_masklen</replaceable>]
1701 [<replaceable class="parameter">dst_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">dst_masklen</replaceable>]]
1704 Where <replaceable class="parameter">src_addr</replaceable> and
1705 <replaceable class="parameter">dst_addr</replaceable> are IPv4 addresses in dotted decimal notation or valid
1706 DNS names, <replaceable class="parameter">port</replaceable> is a port
1707 number, and <replaceable class="parameter">src_masklen</replaceable> and
1708 <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1709 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1710 destination part are optional.
1713 If your system implements
1714 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink>, then
1715 <replaceable class="parameter">src_addr</replaceable> and <replaceable
1716 class="parameter">dst_addr</replaceable> can be IPv6 addresses delimeted by
1717 brackets, <replaceable class="parameter">port</replaceable> can be a number
1718 or a service name, and
1719 <replaceable class="parameter">src_masklen</replaceable> and
1720 <replaceable class="parameter">dst_masklen</replaceable> can be a number
1726 <term>Default value:</term>
1728 <para><emphasis>Unset</emphasis></para>
1730 If no <replaceable class="parameter">port</replaceable> is specified,
1731 any port will match. If no <replaceable class="parameter">src_masklen</replaceable> or
1732 <replaceable class="parameter">src_masklen</replaceable> is given, the complete IP
1733 address has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1738 <term>Effect if unset:</term>
1741 Don't restrict access further than implied by <literal>listen-address</literal>
1749 Access controls are included at the request of ISPs and systems
1750 administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1751 For a typical home user, it will normally suffice to ensure that
1752 <application>Privoxy</application> only listens on the localhost
1753 (127.0.0.1) or internal (home) network address by means of the
1754 <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1758 Please see the warnings in the FAQ that <application>Privoxy</application>
1759 is not intended to be a substitute for a firewall or to encourage anyone
1760 to defer addressing basic security weaknesses.
1763 Multiple ACL lines are OK.
1764 If any ACLs are specified, <application>Privoxy</application> only talks
1765 to IP addresses that match at least one <literal>permit-access</literal> line
1766 and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1767 last match wins, with the default being <literal>deny-access</literal>.
1770 If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1771 for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1772 that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1773 of the ultimate target. This is necessary because it may be impossible for the local
1774 <application>Privoxy</application> to determine the IP address of the
1775 ultimate target (that's often what gateways are used for).
1778 You should prefer using IP addresses over DNS names, because the address lookups take
1779 time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1780 like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1781 IP addresses, only the first one is used.
1784 Some systems allow IPv4 clients to connect to IPv6 server sockets.
1785 Then the client's IPv4 address will be translated by the system into
1786 IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4
1787 mapped IPv6 address). <application>Privoxy</application> can handle it
1788 and maps such ACL addresses automatically.
1791 Denying access to particular sites by ACL may have undesired side effects
1792 if the site in question is hosted on a machine which also hosts other sites
1798 <term>Examples:</term>
1801 Explicitly define the default behavior if no ACL and
1802 <literal>listen-address</literal> are set: <quote>localhost</quote>
1803 is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1804 <emphasis>all</emphasis> destination addresses are OK:
1808 permit-access localhost
1812 Allow any host on the same class C subnet as www.privoxy.org access to
1813 nothing but www.example.com (or other domains hosted on the same system):
1817 permit-access www.privoxy.org/24 www.example.com/32
1821 Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1822 with the exception that 192.168.45.73 may not access the IP address behind
1823 www.dirty-stuff.example.com:
1827 permit-access 192.168.45.64/26
1828 deny-access 192.168.45.73 www.dirty-stuff.example.com
1832 Allow access from the IPv4 network 192.0.2.0/24 even if listening on
1833 an IPv6 wild card address (not supported on all platforms):
1837 permit-access 192.0.2.0/24
1841 This is equivalent to the following line even if listening on an
1842 IPv4 address (not supported on all platforms):
1846 permit-access [::ffff:192.0.2.0]/120
1855 <!-- ~~~~~ New section ~~~~~ -->
1856 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1860 <term>Specifies:</term>
1863 Maximum size of the buffer for content filtering.
1868 <term>Type of value:</term>
1870 <para>Size in Kbytes</para>
1874 <term>Default value:</term>
1880 <term>Effect if unset:</term>
1883 Use a 4MB (4096 KB) limit.
1891 For content filtering, i.e. the <literal>+filter</literal> and
1892 <literal>+deanimate-gif</literal> actions, it is necessary that
1893 <application>Privoxy</application> buffers the entire document body.
1894 This can be potentially dangerous, since a server could just keep sending
1895 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1899 When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1900 flushed to the client unfiltered and no further attempt to
1901 filter the rest of the document is made. Remember that there may be multiple threads
1902 running, which might require up to <literal>buffer-limit</literal> Kbytes
1903 <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1910 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1913 <!-- ~~~~~ New section ~~~~~ -->
1914 <sect3 renderas="sect4" id="enable-proxy-authentication-forwarding"><title>enable-proxy-authentication-forwarding</title>
1917 <term>Specifies:</term>
1920 Whether or not proxy authentication through &my-app; should work.
1925 <term>Type of value:</term>
1931 <term>Default value:</term>
1937 <term>Effect if unset:</term>
1940 Proxy authentication headers are removed.
1948 Privoxy itself does not support proxy authentication, but can
1949 allow clients to authenticate against Privoxy's parent proxy.
1952 By default Privoxy (3.0.21 and later) don't do that and remove
1953 Proxy-Authorization headers in requests and Proxy-Authenticate
1954 headers in responses to make it harder for malicious sites to
1955 trick inexperienced users into providing login information.
1958 If this option is enabled the headers are forwarded.
1961 Enabling this option is <emphasis>not recommended</emphasis> if there is
1962 no parent proxy that requires authentication or if the local network between
1963 Privoxy and the parent proxy isn't trustworthy. If proxy authentication is
1964 only required for some requests, it is recommended to use a client header filter
1965 to remove the authentication headers for requests where they aren't needed.
1971 <![%config-file;[<literallayout>@@enable-proxy-authentication-forwarding 0</literallayout>]]>
1976 <!-- ~ End section ~ -->
1979 <!-- ~~~~~ New section ~~~~~ -->
1981 <sect2 id="forwarding">
1982 <title>Forwarding</title>
1985 This feature allows routing of HTTP requests through a chain of
1989 Forwarding can be used to chain Privoxy with a caching proxy to speed
1990 up browsing. Using a parent proxy may also be necessary if the machine
1991 that <application>Privoxy</application> runs on has no direct Internet access.
1994 Note that parent proxies can severely decrease your privacy level.
1995 For example a parent proxy could add your IP address to the request
1996 headers and if it's a caching proxy it may add the <quote>Etag</quote>
1997 header to revalidation requests again, even though you configured Privoxy
1998 to remove it. It may also ignore Privoxy's header time randomization and use the
1999 original values which could be used by the server as cookie replacement
2000 to track your steps between visits.
2004 Also specified here are SOCKS proxies. <application>Privoxy</application>
2005 supports the SOCKS 4 and SOCKS 4A protocols.
2008 <sect3 renderas="sect4" id="forward"><title>forward</title>
2011 <term>Specifies:</term>
2014 To which parent HTTP proxy specific requests should be routed.
2019 <term>Type of value:</term>
2022 <replaceable class="parameter">target_pattern</replaceable>
2023 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2026 where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
2027 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2028 denote <quote>all URLs</quote>.
2029 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2030 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
2031 optionally followed by its listening port (default: 8000).
2032 Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
2037 <term>Default value:</term>
2039 <para><emphasis>Unset</emphasis></para>
2043 <term>Effect if unset:</term>
2046 Don't use parent HTTP proxies.
2054 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2055 forwarded to another HTTP proxy but are made directly to the web servers.
2058 <replaceable class="parameter">http_parent</replaceable> can be a
2059 numerical IPv6 address (if
2060 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2061 implemented). To prevent clashes with the port delimiter, the whole IP
2062 address has to be put into brackets. On the other hand a <replaceable
2063 class="parameter">target_pattern</replaceable> containing an IPv6 address
2064 has to be put into angle brackets (normal brackets are reserved for
2065 regular expressions already).
2068 Multiple lines are OK, they are checked in sequence, and the last match wins.
2073 <term>Examples:</term>
2076 Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
2080 forward / parent-proxy.example.org:8080
2085 Everything goes to our example ISP's caching proxy, except for requests
2086 to that ISP's sites:
2090 forward / caching-proxy.isp.example.net:8000
2091 forward .isp.example.net .
2095 Parent proxy specified by an IPv6 address:
2099 forward / [2001:DB8::1]:8000
2103 Suppose your parent proxy doesn't support IPv6:
2107 forward / parent-proxy.example.org:8000
2108 forward ipv6-server.example.org .
2109 forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
2118 <!-- ~~~~~ New section ~~~~~ -->
2119 <sect3 renderas="sect4" id="socks"><title>
2120 forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
2121 <anchor id="forward-socks4">
2122 <anchor id="forward-socks4a">
2126 <term>Specifies:</term>
2129 Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2134 <term>Type of value:</term>
2137 <replaceable class="parameter">target_pattern</replaceable>
2138 <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
2139 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2142 where <replaceable class="parameter">target_pattern</replaceable> is a
2143 <link linkend="af-patterns">URL pattern</link> that specifies to which
2144 requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2145 denote <quote>all URLs</quote>. <replaceable class="parameter">http_parent</replaceable>
2146 and <replaceable class="parameter">socks_proxy</replaceable>
2147 are IP addresses in dotted decimal notation or valid DNS names
2148 (<replaceable class="parameter">http_parent</replaceable>
2149 may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
2150 <replaceable class="parameter">port</replaceable> parameters are TCP ports,
2151 i.e. integer values from 1 to 65535
2156 <term>Default value:</term>
2158 <para><emphasis>Unset</emphasis></para>
2162 <term>Effect if unset:</term>
2165 Don't use SOCKS proxies.
2173 Multiple lines are OK, they are checked in sequence, and the last match wins.
2176 The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
2177 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2178 server, while in SOCKS 4 it happens locally.
2181 With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
2184 <literal>forward-socks5t</literal> works like vanilla <literal>forward-socks5</literal> but
2185 lets &my-app; additionally use Tor-specific SOCKS extensions. Currently the only supported
2186 SOCKS extension is optimistic data which can reduce the latency for the first request made
2187 on a newly created connection.
2190 <replaceable class="parameter">socks_proxy</replaceable> and
2191 <replaceable class="parameter">http_parent</replaceable> can be a
2192 numerical IPv6 address (if
2193 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2194 implemented). To prevent clashes with the port delimiter, the whole IP
2195 address has to be put into brackets. On the other hand a <replaceable
2196 class="parameter">target_pattern</replaceable> containing an IPv6 address
2197 has to be put into angle brackets (normal brackets are reserved for
2198 regular expressions already).
2201 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2202 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2208 <term>Examples:</term>
2211 From the company example.com, direct connections are made to all
2212 <quote>internal</quote> domains, but everything outbound goes through
2213 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2218 forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
2219 forward .example.com .
2223 A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2227 forward-socks4 / socks-gw.example.com:1080 .
2232 To chain Privoxy and Tor, both running on the same system, you would use
2237 forward-socks5t / 127.0.0.1:9050 .
2242 The public <application>Tor</application> network can't be used to
2243 reach your local network, if you need to access local servers you
2244 therefore might want to make some exceptions:
2248 forward 192.168.*.*/ .
2250 forward 127.*.*.*/ .
2254 Unencrypted connections to systems in these address ranges will
2255 be as (un)secure as the local network is, but the alternative is that you
2256 can't reach the local network through <application>Privoxy</application>
2257 at all. Of course this may actually be desired and there is no reason
2258 to make these exceptions if you aren't sure you need them.
2261 If you also want to be able to reach servers in your local network by
2262 using their names, you will need additional exceptions that look like
2267 forward localhost/ .
2276 <![%user-man;[ <!-- not included in config due to length -->
2277 <!-- ~~~~~ New section ~~~~~ -->
2278 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2281 If you have links to multiple ISPs that provide various special content
2282 only to their subscribers, you can configure multiple <application>Privoxies</application>
2283 which have connections to the respective ISPs to act as forwarders to each other, so that
2284 <emphasis>your</emphasis> users can see the internal content of all ISPs.
2288 Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2289 isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2290 configuration can look like this:
2300 forward .isp-b.example.net host-b:8118
2311 forward .isp-a.example.org host-a:8118
2316 Now, your users can set their browser's proxy to use either
2317 host-a or host-b and be able to browse the internal content
2318 of both isp-a and isp-b.
2322 If you intend to chain <application>Privoxy</application> and
2323 <application>squid</application> locally, then chaining as
2324 <literal>browser -> squid -> privoxy</literal> is the recommended way.
2328 Assuming that <application>Privoxy</application> and <application>squid</application>
2329 run on the same box, your <application>squid</application> configuration could then look like this:
2334 # Define Privoxy as parent proxy (without ICP)
2335 cache_peer 127.0.0.1 parent 8118 7 no-query
2337 # Define ACL for protocol FTP
2340 # Do not forward FTP requests to Privoxy
2341 always_direct allow ftp
2343 # Forward all the rest to Privoxy
2344 never_direct allow all</screen>
2348 You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2349 Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2353 You could just as well decide to only forward requests you suspect
2354 of leading to Windows executables through a virus-scanning parent proxy,
2355 say, on <literal>antivir.example.com</literal>, port 8010:
2361 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
2367 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2370 <term>Specifies:</term>
2373 How often Privoxy retries if a forwarded connection request fails.
2378 <term>Type of value:</term>
2381 <replaceable class="parameter">Number of retries.</replaceable>
2386 <term>Default value:</term>
2388 <para><emphasis>0</emphasis></para>
2392 <term>Effect if unset:</term>
2395 Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2403 <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2404 for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2405 The connection might have failed because of a DNS timeout in which case a retry makes sense,
2406 but it might also have failed because the server doesn't exist or isn't reachable. In this
2407 case the retry will just delay the appearance of Privoxy's error message.
2410 Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2411 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2414 Only use this option, if you are getting lots of forwarding-related error messages
2415 that go away when you try again manually. Start with a small value and check Privoxy's
2416 logfile from time to time, to see how many retries are usually needed.
2421 <term>Examples:</term>
2424 forwarded-connect-retries 1
2429 <![%config-file;[<literallayout>@@forwarded-connect-retries 0</literallayout>]]>
2435 <title>Miscellaneous</title>
2437 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2440 <term>Specifies:</term>
2443 Whether intercepted requests should be treated as valid.
2448 <term>Type of value:</term>
2451 <replaceable>0 or 1</replaceable>
2456 <term>Default value:</term>
2458 <para><emphasis>0</emphasis></para>
2462 <term>Effect if unset:</term>
2465 Only proxy requests are accepted, intercepted requests are treated as invalid.
2473 If you don't trust your clients and want to force them
2474 to use <application>Privoxy</application>, enable this
2475 option and configure your packet filter to redirect outgoing
2476 HTTP connections into <application>Privoxy</application>.
2479 Note that intercepting encrypted connections (HTTPS) isn't supported.
2482 Make sure that <application>Privoxy's</application> own requests
2483 aren't redirected as well. Additionally take care that
2484 <application>Privoxy</application> can't intentionally connect
2485 to itself, otherwise you could run into redirection loops if
2486 <application>Privoxy's</application> listening port is reachable
2487 by the outside or an attacker has access to the pages you visit.
2492 <term>Examples:</term>
2495 accept-intercepted-requests 1
2500 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2503 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2506 <term>Specifies:</term>
2509 Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2514 <term>Type of value:</term>
2517 <replaceable>0 or 1</replaceable>
2522 <term>Default value:</term>
2524 <para><emphasis>0</emphasis></para>
2528 <term>Effect if unset:</term>
2531 <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2539 By default <application>Privoxy</application> ignores block or redirect actions
2540 for its CGI pages. Intercepting these requests can be useful in multi-user
2541 setups to implement fine-grained access control, but it can also render the complete
2542 web interface useless and make debugging problems painful if done without care.
2545 Don't enable this option unless you're sure that you really need it.
2550 <term>Examples:</term>
2553 allow-cgi-request-crunching 1
2558 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2561 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2564 <term>Specifies:</term>
2567 Whether the CGI interface should stay compatible with broken HTTP clients.
2572 <term>Type of value:</term>
2575 <replaceable>0 or 1</replaceable>
2580 <term>Default value:</term>
2582 <para><emphasis>0</emphasis></para>
2586 <term>Effect if unset:</term>
2589 The CGI form generate long GET URLs.
2597 <application>Privoxy's</application> CGI forms can lead to
2598 rather long URLs. This isn't a problem as far as the HTTP
2599 standard is concerned, but it can confuse clients with arbitrary
2600 URL length limitations.
2603 Enabling split-large-forms causes <application>Privoxy</application>
2604 to divide big forms into smaller ones to keep the URL length down.
2605 It makes editing a lot less convenient and you can no longer
2606 submit all changes at once, but at least it works around this
2610 If you don't notice any editing problems, there is no reason
2611 to enable this option, but if one of the submit buttons appears
2612 to be broken, you should give it a try.
2617 <term>Examples:</term>
2625 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2628 <sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
2631 <term>Specifies:</term>
2634 Number of seconds after which an open connection will no longer be reused.
2639 <term>Type of value:</term>
2642 <replaceable>Time in seconds.</replaceable>
2647 <term>Default value:</term>
2653 <term>Effect if unset:</term>
2656 Connections are not kept alive.
2664 This option allows clients to keep the connection to &my-app;
2665 alive. If the server supports it, &my-app; will keep
2666 the connection to the server alive as well. Under certain
2667 circumstances this may result in speed-ups.
2670 By default, &my-app; will close the connection to the server if
2671 the client connection gets closed, or if the specified timeout
2672 has been reached without a new request coming in. This behaviour
2673 can be changed with the <ulink
2674 url="#CONNECTION-SHARING">connection-sharing</ulink> option.
2677 This option has no effect if <application>Privoxy</application>
2678 has been compiled without keep-alive support.
2681 Note that a timeout of five seconds as used in the default
2682 configuration file significantly decreases the number of
2683 connections that will be reused. The value is used because
2684 some browsers limit the number of connections they open to
2685 a single host and apply the same limit to proxies. This can
2686 result in a single website <quote>grabbing</quote> all the
2687 connections the browser allows, which means connections to
2688 other websites can't be opened until the connections currently
2692 Several users have reported this as a Privoxy bug, so the
2693 default value has been reduced. Consider increasing it to
2694 300 seconds or even more if you think your browser can handle
2695 it. If your browser appears to be hanging, it probably can't.
2700 <term>Examples:</term>
2703 keep-alive-timeout 300
2708 <![%config-file;[<literallayout>@@keep-alive-timeout 5</literallayout>]]>
2712 <sect3 renderas="sect4" id="tolerate-pipelining"><title>tolerate-pipelining</title>
2715 <term>Specifies:</term>
2718 Whether or not pipelined requests should be served.
2723 <term>Type of value:</term>
2726 <replaceable>0 or 1.</replaceable>
2731 <term>Default value:</term>
2737 <term>Effect if unset:</term>
2740 If Privoxy receives more than one request at once, it terminates the
2741 client connection after serving the first one.
2749 &my-app; currently doesn't pipeline outgoing requests,
2750 thus allowing pipelining on the client connection is not
2751 guaranteed to improve the performance.
2754 By default &my-app; tries to discourage clients from pipelining
2755 by discarding aggressively pipelined requests, which forces the
2756 client to resend them through a new connection.
2759 This option lets &my-app; tolerate pipelining. Whether or not
2760 that improves performance mainly depends on the client configuration.
2763 If you are seeing problems with pages not properly loading,
2764 disabling this option could work around the problem.
2769 <term>Examples:</term>
2772 tolerate-pipelining 1
2777 <![%config-file;[<literallayout>@@tolerate-pipelining 1</literallayout>]]>
2781 <sect3 renderas="sect4" id="default-server-timeout"><title>default-server-timeout</title>
2784 <term>Specifies:</term>
2787 Assumed server-side keep-alive timeout if not specified by the server.
2792 <term>Type of value:</term>
2795 <replaceable>Time in seconds.</replaceable>
2800 <term>Default value:</term>
2806 <term>Effect if unset:</term>
2809 Connections for which the server didn't specify the keep-alive
2810 timeout are not reused.
2818 Enabling this option significantly increases the number of connections
2819 that are reused, provided the <ulink
2820 url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> option
2824 While it also increases the number of connections problems
2825 when &my-app; tries to reuse a connection that already has
2826 been closed on the server side, or is closed while &my-app;
2827 is trying to reuse it, this should only be a problem if it
2828 happens for the first request sent by the client. If it happens
2829 for requests on reused client connections, &my-app; will simply
2830 close the connection and the client is supposed to retry the
2831 request without bothering the user.
2834 Enabling this option is therefore only recommended if the
2836 url="#CONNECTION-SHARING">connection-sharing</ulink> option
2840 It is an error to specify a value larger than the <ulink
2841 url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> value.
2844 This option has no effect if <application>Privoxy</application>
2845 has been compiled without keep-alive support.
2850 <term>Examples:</term>
2853 default-server-timeout 60
2858 <![%config-file;[<literallayout>@@#default-server-timeout 60</literallayout>]]>
2862 <sect3 renderas="sect4" id="connection-sharing"><title>connection-sharing</title>
2865 <term>Specifies:</term>
2868 Whether or not outgoing connections that have been kept alive
2869 should be shared between different incoming connections.
2874 <term>Type of value:</term>
2877 <replaceable>0 or 1</replaceable>
2882 <term>Default value:</term>
2888 <term>Effect if unset:</term>
2891 Connections are not shared.
2899 This option has no effect if <application>Privoxy</application>
2900 has been compiled without keep-alive support, or if it's disabled.
2908 Note that reusing connections doesn't necessary cause speedups.
2909 There are also a few privacy implications you should be aware of.
2912 If this option is effective, outgoing connections are shared between
2913 clients (if there are more than one) and closing the browser that initiated
2914 the outgoing connection does no longer affect the connection between &my-app;
2915 and the server unless the client's request hasn't been completed yet.
2918 If the outgoing connection is idle, it will not be closed until either
2919 <application>Privoxy's</application> or the server's timeout is reached.
2920 While it's open, the server knows that the system running &my-app; is still
2924 If there are more than one client (maybe even belonging to multiple users),
2925 they will be able to reuse each others connections. This is potentially
2926 dangerous in case of authentication schemes like NTLM where only the
2927 connection is authenticated, instead of requiring authentication for
2931 If there is only a single client, and if said client can keep connections
2932 alive on its own, enabling this option has next to no effect. If the client
2933 doesn't support connection keep-alive, enabling this option may make sense
2934 as it allows &my-app; to keep outgoing connections alive even if the client
2935 itself doesn't support it.
2938 You should also be aware that enabling this option increases the likelihood
2939 of getting the "No server or forwarder data" error message, especially if you
2940 are using a slow connection to the Internet.
2943 This option should only be used by experienced users who
2944 understand the risks and can weight them against the benefits.
2949 <term>Examples:</term>
2952 connection-sharing 1
2957 <![%config-file;[<literallayout>@@#connection-sharing 1</literallayout>]]>
2961 <sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
2964 <term>Specifies:</term>
2967 Number of seconds after which a socket times out if
2968 no data is received.
2973 <term>Type of value:</term>
2976 <replaceable>Time in seconds.</replaceable>
2981 <term>Default value:</term>
2987 <term>Effect if unset:</term>
2990 A default value of 300 seconds is used.
2998 The default is quite high and you probably want to reduce it.
2999 If you aren't using an occasionally slow proxy like Tor, reducing
3000 it to a few seconds should be fine.
3005 <term>Examples:</term>
3013 <![%config-file;[<literallayout>@@socket-timeout 300</literallayout>]]>
3017 <sect3 renderas="sect4" id="max-client-connections"><title>max-client-connections</title>
3020 <term>Specifies:</term>
3023 Maximum number of client connections that will be served.
3028 <term>Type of value:</term>
3031 <replaceable>Positive number.</replaceable>
3036 <term>Default value:</term>
3042 <term>Effect if unset:</term>
3045 Connections are served until a resource limit is reached.
3053 &my-app; creates one thread (or process) for every incoming client
3054 connection that isn't rejected based on the access control settings.
3057 If the system is powerful enough, &my-app; can theoretically deal with
3058 several hundred (or thousand) connections at the same time, but some
3059 operating systems enforce resource limits by shutting down offending
3060 processes and their default limits may be below the ones &my-app; would
3061 require under heavy load.
3064 Configuring &my-app; to enforce a connection limit below the thread
3065 or process limit used by the operating system makes sure this doesn't
3066 happen. Simply increasing the operating system's limit would work too,
3067 but if &my-app; isn't the only application running on the system,
3068 you may actually want to limit the resources used by &my-app;.
3071 If &my-app; is only used by a single trusted user, limiting the
3072 number of client connections is probably unnecessary. If there
3073 are multiple possibly untrusted users you probably still want to
3074 additionally use a packet filter to limit the maximal number of
3075 incoming connections per client. Otherwise a malicious user could
3076 intentionally create a high number of connections to prevent other
3077 users from using &my-app;.
3080 Obviously using this option only makes sense if you choose a limit
3081 below the one enforced by the operating system.
3084 One most POSIX-compliant systems &my-app; can't properly deal with
3085 more than FD_SETSIZE file descriptors at the same time and has to reject
3086 connections if the limit is reached. This will likely change in a
3087 future version, but currently this limit can't be increased without
3088 recompiling &my-app; with a different FD_SETSIZE limit.
3093 <term>Examples:</term>
3096 max-client-connections 256
3101 <![%config-file;[<literallayout>@@#max-client-connections 256</literallayout>]]>
3105 <sect3 renderas="sect4" id="handle-as-empty-doc-returns-ok"><title>handle-as-empty-doc-returns-ok</title>
3108 <term>Specifies:</term>
3111 The status code Privoxy returns for pages blocked with
3112 <!-- URL will only end up in the user manual so the relative link should work. -->
3113 <literal><ulink url="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">+handle-as-empty-document</ulink></literal>.
3118 <term>Type of value:</term>
3121 <replaceable>0 or 1</replaceable>
3126 <term>Default value:</term>
3132 <term>Effect if unset:</term>
3135 Privoxy returns a status 403(forbidden) for all blocked pages.
3140 <term>Effect if set:</term>
3143 Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
3144 and a status 403(Forbidden) for all other blocked pages.
3152 This is a work-around for Firefox bug 492459:
3154 Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.
3156 (<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
3157 >https://bugzilla.mozilla.org/show_bug.cgi?id=492459</ulink>)
3158 As the bug has been fixed for quite some time this option should no longer
3159 be needed and will be removed in a future release. Please speak up if you
3160 have a reason why the option should be kept around.
3165 <![%config-file;[<literallayout>@@#handle-as-empty-doc-returns-ok 1</literallayout>]]>
3169 <sect3 renderas="sect4" id="enable-compression"><title>enable-compression</title>
3172 <term>Specifies:</term>
3175 Whether or not buffered content is compressed before delivery.
3180 <term>Type of value:</term>
3183 <replaceable>0 or 1</replaceable>
3188 <term>Default value:</term>
3194 <term>Effect if unset:</term>
3197 Privoxy does not compress buffered content.
3202 <term>Effect if set:</term>
3205 Privoxy compresses buffered content before delivering it to the client,
3206 provided the client supports it.
3214 This directive is only supported if Privoxy has been compiled with
3215 FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB.
3218 Compressing buffered content is mainly useful if Privoxy and the
3219 client are running on different systems. If they are running on the
3220 same system, enabling compression is likely to slow things down.
3221 If you didn't measure otherwise, you should assume that it does
3222 and keep this option disabled.
3225 Privoxy will not compress buffered content below a certain length.
3230 <![%config-file;[<literallayout>@@#enable-compression 1</literallayout>]]>
3234 <sect3 renderas="sect4" id="compression-level"><title>compression-level</title>
3237 <term>Specifies:</term>
3240 The compression level that is passed to the zlib library when compressing buffered content.
3245 <term>Type of value:</term>
3248 <replaceable>Positive number ranging from 0 to 9.</replaceable>
3253 <term>Default value:</term>
3262 Compressing the data more takes usually longer than compressing
3263 it less or not compressing it at all. Which level is best depends
3264 on the connection between Privoxy and the client. If you can't
3265 be bothered to benchmark it for yourself, you should stick with
3266 the default and keep compression disabled.
3269 If compression is disabled, the compression level is irrelevant.
3274 <term>Examples:</term>
3278 # Best speed (compared to the other levels)
3282 # No compression. Only useful for testing as the added header
3283 # slightly increases the amount of data that has to be sent.
3284 # If your benchmark shows that using this compression level
3285 # is superior to using no compression at all, the benchmark
3286 # is likely to be flawed.
3293 <![%config-file;[<literallayout>@@#compression-level 1</literallayout>]]>
3297 <sect3 renderas="sect4" id="client-header-order"><title>client-header-order</title>
3300 <term>Specifies:</term>
3303 The order in which client headers are sorted before forwarding them.
3308 <term>Type of value:</term>
3311 <replaceable>Client header names delimited by spaces or tabs</replaceable>
3316 <term>Default value:</term>
3325 By default &my-app; leaves the client headers in the order they
3326 were sent by the client. Headers are modified in-place, new headers
3327 are added at the end of the already existing headers.
3330 The header order can be used to fingerprint client requests
3331 independently of other headers like the User-Agent.
3334 This directive allows to sort the headers differently to better
3335 mimic a different User-Agent. Client headers will be emitted
3336 in the order given, headers whose name isn't explicitly specified
3337 are added at the end.
3340 Note that sorting headers in an uncommon way will make fingerprinting
3341 actually easier. Encrypted headers are not affected by this directive.
3346 <![%config-file;[<literallayout>@@#client-header-order Host \
3365 <!-- ~ End section ~ -->
3368 <!-- ~~~~~ New section ~~~~~ -->
3370 <sect2 id="windows-gui">
3371 <title>Windows GUI Options</title>
3373 <application>Privoxy</application> has a number of options specific to the
3374 Windows GUI interface:
3377 <anchor id="activity-animation">
3378 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3380 If <quote>activity-animation</quote> is set to 1, the
3381 <application>Privoxy</application> icon will animate when
3382 <quote>Privoxy</quote> is active. To turn off, set to 0.
3385 <![%config-file;[<literallayout>@@#activity-animation 1</literallayout>]]>
3391 <emphasis>activity-animation 1</emphasis>
3398 <anchor id="log-messages">
3399 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3401 If <quote>log-messages</quote> is set to 1,
3402 <application>Privoxy</application> copies log messages to the console
3404 The log detail depends on the <link linkend="debug">debug</link> directive.
3407 <![%config-file;[<literallayout>@@#log-messages 1</literallayout>]]>
3413 <emphasis>log-messages 1</emphasis>
3420 <anchor id="log-buffer-size">
3421 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3423 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
3424 i.e. the amount of memory used for the log messages displayed in the
3425 console window, will be limited to <quote>log-max-lines</quote> (see below).
3429 Warning: Setting this to 0 will result in the buffer to grow infinitely and
3430 eat up all your memory!
3433 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
3439 <emphasis>log-buffer-size 1</emphasis>
3446 <anchor id="log-max-lines">
3447 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3449 <application>log-max-lines</application> is the maximum number of lines held
3450 in the log buffer. See above.
3453 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
3459 <emphasis>log-max-lines 200</emphasis>
3466 <anchor id="log-highlight-messages">
3467 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3469 If <quote>log-highlight-messages</quote> is set to 1,
3470 <application>Privoxy</application> will highlight portions of the log
3471 messages with a bold-faced font:
3474 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
3480 <emphasis>log-highlight-messages 1</emphasis>
3487 <anchor id="log-font-name">
3488 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3490 The font used in the console window:
3493 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
3499 <emphasis>log-font-name Comic Sans MS</emphasis>
3506 <anchor id="log-font-size">
3507 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3509 Font size used in the console window:
3512 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
3518 <emphasis>log-font-size 8</emphasis>
3525 <anchor id="show-on-task-bar">
3526 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3528 <quote>show-on-task-bar</quote> controls whether or not
3529 <application>Privoxy</application> will appear as a button on the Task bar
3533 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
3539 <emphasis>show-on-task-bar 0</emphasis>
3546 <anchor id="close-button-minimizes">
3547 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3549 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
3550 button will minimize <application>Privoxy</application> instead of closing
3551 the program (close with the exit option on the File menu).
3554 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
3560 <emphasis>close-button-minimizes 1</emphasis>
3567 <anchor id="hide-console">
3568 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3570 The <quote>hide-console</quote> option is specific to the MS-Win console
3571 version of <application>Privoxy</application>. If this option is used,
3572 <application>Privoxy</application> will disconnect from and hide the
3576 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
3582 #<emphasis>hide-console</emphasis>
3592 <!-- end config content common to both outputs -->
3595 <!-- These are dummy anchors to keep the processor quiet -->
3596 <!-- when building config-file only (ie. they are used in u-m only) -->
3599 <anchor id="filter">
3600 <anchor id="filter-file">
3602 <anchor id="actions-file">
3603 <anchor id="af-patterns">
3607 <!-- eof p-config.sgml -->
projects / privoxy.git / blob