8e171f1a853943f06c787dc2b6f5387850e721ff
[privoxy.git] / doc / source / p-config.sgml
1 <!--
2  File        :  $Source: /cvsroot/ijbswa/current/doc/source/p-config.sgml,v $
3
4  Purpose     :  Used with other docs and files only.
5
6  $Id: p-config.sgml,v 2.80 2012/03/19 12:56:26 fabiankeil Exp $
7
8  Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/
9  See LICENSE.
10
11  ========================================================================
12  NOTE: Please read developer-manual/documentation.html before touching
13  anything in this, or other Privoxy documentation.
14  ========================================================================
15
16
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
19  config file) itself.
20
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.
24
25  IMPORTANT:
26
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:
31
32   @@listen-address  127.0.0.1:8118
33
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
37  formatter), and perl.
38
39
40  This file is included into:
41
42    user-manual.sgml
43    config   (the actual Privoxy config file)
44
45 -->
46
47 <![%user-man;[
48 <!-- This part only goes into user-manual -->
49 <sect1 id="config">
50 <title>The Main Configuration File</title>
51
52 <para>
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
57  example:
58 </para>
59
60 <para>
61  <literal>
62   <msgtext>
63    <literallayout>
64   <emphasis>confdir /etc/privoxy</emphasis></literallayout>
65   </msgtext>
66  </literal>
67 </para>
68
69 <para>
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>.
73 </para>
74
75 <para>
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.
79 </para>
80
81 <para>
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
86  notepad.exe.
87 </para>
88
89 ]]>
90
91
92 <![%config-file;[
93 <!-- This part only goes into the config file -->
94 <sect1 id="config">
95 <title>
96  @@TITLE<!-- between the @@ is stripped by Makefile -->@@
97  Sample Configuration File for Privoxy v&p-version;
98 </title>
99 <para>
100  $Id: p-config.sgml,v 2.80 2012/03/19 12:56:26 fabiankeil Exp $
101 </para>
102 <para>
103 Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/
104 </para>
105
106 <para>
107  <literallayout>
108 #################################################################
109                                                                 #
110                     Table of Contents                           #
111                                                                 #
112       I. INTRODUCTION                                           #
113      II. FORMAT OF THE CONFIGURATION FILE                       #
114                                                                 #
115       1. LOCAL SET-UP DOCUMENTATION                             #
116       2. CONFIGURATION AND LOG FILE LOCATIONS                   #
117       3. DEBUGGING                                              #
118       4. ACCESS CONTROL AND SECURITY                            #
119       5. FORWARDING                                             #
120       6. WINDOWS GUI OPTIONS                                    #
121                                                                 #
122 #################################################################
123  </literallayout>
124 </para>
125
126 <literallayout>I. INTRODUCTION
127  ===============  <!-- fuck this madness --></literallayout>
128
129 <para>
130  This file holds Privoxy's main configuration.  Privoxy detects
131  configuration changes automatically, so you don't have to restart it
132  unless you want to load a different configuration file.
133 </para>
134 <para>
135  The configuration will be reloaded with the first request after the
136  change was done, this request itself will still use the old configuration,
137  though. In other words: it takes two requests before you see the result of
138  your changes. Requests that are dropped due to ACL don't trigger reloads.
139 </para>
140 <para>
141  When starting Privoxy on Unix systems, give the location of this
142  file as last argument.  On Windows systems, Privoxy will look for
143  this file with the name 'config.txt' in the current working directory
144  of the Privoxy process.
145 </para>
146
147 <para>
148  <literallayout><!-- funky spacing -->
149
150 II. FORMAT OF THE CONFIGURATION FILE
151 ====================================</literallayout>
152 </para>
153 <para>
154  Configuration lines consist of an initial keyword followed by a list
155  of values, all separated by whitespace (any number of spaces or
156  tabs).  For example,
157 </para>
158 <para>
159  actionsfile default.action
160 </para>
161 <para>
162  Indicates that the actionsfile is named 'default.action'.
163 </para>
164 <para>
165  The '#' indicates a comment.  Any part of a line following a '#' is
166  ignored, except if the '#' is preceded by a '\'.
167 </para>
168 <para>
169  Thus, by placing a # at the start of an existing configuration line,
170  you can make it a comment and it will be treated as if it weren't there.
171  This is called "commenting out" an option and can be useful. Removing
172  the # again is called "uncommenting".
173 </para>
174 <para>
175  Note that commenting out an option and leaving it at its default
176  are two completely different things! Most options behave very
177  differently when unset. See the "Effect if unset" explanation
178  in each option's description for details.
179 </para>
180 <para>
181  Long lines can be continued on the next line by using a `\' as
182  the last character.
183 </para>
184
185 ]]>
186
187 <!-- ************************************************ -->
188 <!-- The following is common to both outputs (mostly) -->
189 <!-- ************************************************ -->
190
191
192
193 <!--   ~~~~~       New section      ~~~~~     -->
194 <sect2 id="local-set-up">
195 <title>Local Set-up Documentation</title>
196
197   <para>
198     If you intend to operate <application>Privoxy</application> for more users
199     than just yourself, it might be a good idea to let them know how to reach
200     you, what you block and why you do that, your policies, etc.
201    </para>
202
203
204 <!--   ~~~~~       New section      ~~~~~     -->
205 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
206 <variablelist>
207  <varlistentry>
208   <term>Specifies:</term>
209   <listitem>
210    <para>
211     Location of the <application>Privoxy</application> User Manual.
212    </para>
213   </listitem>
214  </varlistentry>
215  <varlistentry>
216   <term>Type of value:</term>
217   <listitem>
218    <para>A fully qualified URI</para>
219   </listitem>
220  </varlistentry>
221  <varlistentry>
222   <term>Default value:</term>
223   <listitem>
224    <para><emphasis>Unset</emphasis></para>
225   </listitem>
226  </varlistentry>
227  <varlistentry>
228   <term>Effect if unset:</term>
229   <listitem>
230    <para>
231     <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/<replaceable class="parameter">version</replaceable>/user-manual/</ulink>
232     will be used, where <replaceable class="parameter">version</replaceable> is the <application>Privoxy</application> version.
233    </para>
234   </listitem>
235  </varlistentry>
236  <varlistentry>
237   <term>Notes:</term>
238   <listitem>
239     <para>
240     The User Manual URI is the single best source of information on
241     <application>Privoxy</application>, and is used for help links from some
242     of the internal CGI pages. The manual itself is normally packaged with the
243     binary distributions, so you probably want to set this to a locally
244     installed copy.
245    </para>
246    <para>
247     Examples:
248    </para>
249   <!--
250   <para>
251    Unix, in local filesystem (may not work with all browsers):
252   </para>
253   <para>
254    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
255   </para>
256   <para>
257    Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
258   </para>
259   <para>
260    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
261   </para>
262   <para>
263    Windows, UNC notation (with forward slashes):
264   </para>
265   <para>
266    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
267   </para>
268  -->
269   <para>
270    The best all purpose solution is simply to put the full local
271    <literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
272    located:
273   </para>
274   <para>
275    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;/usr/share/doc/privoxy/user-manual</screen>
276   </para>
277   <para>
278    The User Manual is then available to anyone with access to
279    <application>Privoxy</application>, by following the built-in URL:
280    <literal>http://config.privoxy.org/user-manual/</literal>
281    (or the shortcut: <literal>http://p.p/user-manual/</literal>).
282   </para>
283   <para>
284    If the documentation is not on the local system, it can be accessed
285    from a remote server, as:
286   </para>
287   <para>
288    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;http://example.com/privoxy/user-manual/</screen>
289   </para>
290   <![%user-man;[
291    <!-- this gets hammered in conversion to config. Text repeated below. -->
292   <warning>
293    <para>
294      If set, this option should be <emphasis>the first option in the config
295      file</emphasis>, because it is used while the config file is being read
296      on start-up.
297    </para>
298   </warning>
299   ]]>
300
301   <![%config-file;[
302    <!-- alternate -->
303    <para>
304     WARNING!!!
305    </para>
306    <blockquote>
307     <para>
308      If set, this option should be the first option in the config
309      file, because it is used while the config file is being read.
310     </para>
311    </blockquote>
312   ]]>
313
314  </listitem>
315  </varlistentry>
316 </variablelist>
317
318 <![%config-file;[<literallayout>@@#user-manual http://www.privoxy.org/user-manual/</literallayout>]]>
319 </sect3>
320
321
322 <!--   ~~~~~       New section      ~~~~~     -->
323 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
324
325 <variablelist>
326  <varlistentry>
327   <term>Specifies:</term>
328   <listitem>
329    <para>
330     A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
331    </para>
332   </listitem>
333  </varlistentry>
334  <varlistentry>
335   <term>Type of value:</term>
336   <listitem>
337    <para>URL</para>
338   </listitem>
339  </varlistentry>
340  <varlistentry>
341   <term>Default value:</term>
342   <listitem>
343    <para><emphasis>Unset</emphasis></para>
344   </listitem>
345  </varlistentry>
346  <varlistentry>
347   <term>Effect if unset:</term>
348   <listitem>
349    <para>
350     No links are displayed on the "untrusted" error page.
351    </para>
352   </listitem>
353  </varlistentry>
354  <varlistentry>
355   <term>Notes:</term>
356   <listitem>
357    <para>
358     The value of this option only matters if the experimental trust mechanism has been
359     activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> below.)
360    </para>
361    <para>
362     If you use the trust mechanism, it is a good idea to write up some on-line
363     documentation about your trust policy and to specify the URL(s) here.
364     Use multiple times for multiple URLs.
365    </para>
366    <para>
367     The URL(s) should be added to the trustfile as well, so users don't end up
368     locked out from the information on why they were locked out in the first place!
369    </para>
370   </listitem>
371  </varlistentry>
372 </variablelist>
373
374 <![%config-file;[<literallayout>@@#trust-info-url  http://www.example.com/why_we_block.html</literallayout>]]>
375 <![%config-file;[<literallayout>@@#trust-info-url  http://www.example.com/what_we_allow.html</literallayout>]]>
376 </sect3>
377
378
379 <!--   ~~~~~       New section      ~~~~~     -->
380 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
381
382 <variablelist>
383  <varlistentry>
384   <term>Specifies:</term>
385   <listitem>
386    <para>
387     An email address to reach the <application>Privoxy</application> administrator.
388    </para>
389   </listitem>
390  </varlistentry>
391  <varlistentry>
392   <term>Type of value:</term>
393   <listitem>
394    <para>Email address</para>
395   </listitem>
396  </varlistentry>
397  <varlistentry>
398   <term>Default value:</term>
399   <listitem>
400    <para><emphasis>Unset</emphasis></para>
401   </listitem>
402  </varlistentry>
403  <varlistentry>
404   <term>Effect if unset:</term>
405   <listitem>
406    <para>
407     No email address is displayed on error pages and the CGI user interface.
408    </para>
409   </listitem>
410  </varlistentry>
411  <varlistentry>
412   <term>Notes:</term>
413   <listitem>
414    <para>
415     If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
416     are unset, the whole "Local Privoxy Support" box on all generated pages will
417     not be shown.
418    </para>
419   </listitem>
420  </varlistentry>
421 </variablelist>
422
423 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
424 </sect3>
425
426
427 <!--   ~~~~~       New section      ~~~~~     -->
428 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
429
430 <variablelist>
431  <varlistentry>
432   <term>Specifies:</term>
433   <listitem>
434    <para>
435     A URL to documentation about the local <application>Privoxy</application> setup,
436     configuration or policies.
437    </para>
438   </listitem>
439  </varlistentry>
440  <varlistentry>
441   <term>Type of value:</term>
442   <listitem>
443    <para>URL</para>
444   </listitem>
445  </varlistentry>
446  <varlistentry>
447   <term>Default value:</term>
448   <listitem>
449    <para><emphasis>Unset</emphasis></para>
450   </listitem>
451  </varlistentry>
452  <varlistentry>
453   <term>Effect if unset:</term>
454   <listitem>
455    <para>
456     No link to local documentation is displayed on error pages and the CGI user interface.
457    </para>
458   </listitem>
459  </varlistentry>
460  <varlistentry>
461   <term>Notes:</term>
462   <listitem>
463    <para>
464     If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
465     are unset, the whole "Local Privoxy Support" box on all generated pages will
466     not be shown.
467    </para>
468    <para>
469     This URL shouldn't be blocked ;-)
470    </para>
471   </listitem>
472  </varlistentry>
473 </variablelist>
474
475 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
476 </sect3>
477
478 </sect2>
479 <!--  ~  End section  ~  -->
480
481
482
483 <!--   ~~~~~       New section      ~~~~~     -->
484
485 <sect2 id="conf-log-loc">
486 <title>Configuration and Log File Locations</title>
487
488 <para>
489  <application>Privoxy</application> can (and normally does) use a number of
490  other files for additional configuration, help and logging.
491  This section of the configuration file tells <application>Privoxy</application>
492  where to find those other files.
493 </para>
494
495 <para>
496  The user running <application>Privoxy</application>, must have read
497  permission for all configuration files, and write permission to any files
498  that would be modified, such as log files and actions files.
499 </para>
500
501
502 <!--   ~~~~~       New section      ~~~~~     -->
503 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
504
505 <variablelist>
506  <varlistentry>
507   <term>Specifies:</term>
508   <listitem>
509    <para>The directory where the other configuration files are located.</para>
510   </listitem>
511  </varlistentry>
512  <varlistentry>
513   <term>Type of value:</term>
514   <listitem>
515    <para>Path name</para>
516   </listitem>
517  </varlistentry>
518  <varlistentry>
519   <term>Default value:</term>
520   <listitem>
521    <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
522   </listitem>
523  </varlistentry>
524  <varlistentry>
525   <term>Effect if unset:</term>
526   <listitem>
527    <para><emphasis>Mandatory</emphasis></para>
528   </listitem>
529  </varlistentry>
530  <varlistentry>
531   <term>Notes:</term>
532   <listitem>
533    <para>
534     No trailing <quote><literal>/</literal></quote>, please.
535    </para>
536   <!--
537    This is really outdated and not likely to happen. HB 09/20/06
538    <para>
539     When development goes modular and multi-user, the blocker, filter, and
540     per-user config will be stored in subdirectories of <quote>confdir</quote>.
541     For now, the configuration directory structure is flat, except for
542     <filename>confdir/templates</filename>, where the HTML templates for CGI
543     output reside (e.g. <application>Privoxy's</application> 404 error page).
544    </para>
545   -->
546   </listitem>
547  </varlistentry>
548 </variablelist>
549
550 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
551 </sect3>
552
553 <!--   ~~~~~       New section      ~~~~~     -->
554 <sect3 renderas="sect4" id="templdir"><title>templdir</title>
555
556 <variablelist>
557  <varlistentry>
558   <term>Specifies:</term>
559   <listitem>
560    <para>An alternative directory where the templates are loaded from.</para>
561   </listitem>
562  </varlistentry>
563  <varlistentry>
564   <term>Type of value:</term>
565   <listitem>
566    <para>Path name</para>
567   </listitem>
568  </varlistentry>
569  <varlistentry>
570   <term>Default value:</term>
571   <listitem>
572    <para>unset</para>
573   </listitem>
574  </varlistentry>
575  <varlistentry>
576   <term>Effect if unset:</term>
577   <listitem>
578    <para>The templates are assumed to be located in confdir/template.</para>
579   </listitem>
580  </varlistentry>
581  <varlistentry>
582   <term>Notes:</term>
583   <listitem>
584    <para>
585     <application>Privoxy's</application> original templates are usually
586     overwritten with each update. Use this option to relocate customized
587     templates that should be kept. As template variables might change
588     between updates, you shouldn't expect templates to work with
589     <application>Privoxy</application> releases other than the one
590     they were part of, though.
591    </para>
592   </listitem>
593  </varlistentry>
594 </variablelist>
595
596 <![%config-file;[<literallayout>@@#templdir .</literallayout>]]>
597 </sect3>
598
599
600 <!--   ~~~~~       New section      ~~~~~     -->
601 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
602
603 <variablelist>
604  <varlistentry>
605   <term>Specifies:</term>
606   <listitem>
607    <para>
608     The directory where all logging takes place
609     (i.e. where the <filename>logfile</filename> is located).
610    </para>
611   </listitem>
612  </varlistentry>
613  <varlistentry>
614   <term>Type of value:</term>
615   <listitem>
616    <para>Path name</para>
617   </listitem>
618  </varlistentry>
619  <varlistentry>
620   <term>Default value:</term>
621   <listitem>
622    <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
623   </listitem>
624  </varlistentry>
625  <varlistentry>
626   <term>Effect if unset:</term>
627   <listitem>
628    <para><emphasis>Mandatory</emphasis></para>
629   </listitem>
630  </varlistentry>
631  <varlistentry>
632   <term>Notes:</term>
633   <listitem>
634    <para>
635     No trailing <quote><literal>/</literal></quote>, please.
636    </para>
637   </listitem>
638  </varlistentry>
639 </variablelist>
640
641 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
642 </sect3>
643
644
645 <!--   ~~~~~       New section      ~~~~~     -->
646 <sect3 renderas="sect4" id="actionsfile"><title>
647 actionsfile
648 </title>
649 <anchor id="default.action">
650 <anchor id="standard.action">
651 <anchor id="user.action">
652 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
653 <variablelist>
654  <varlistentry>
655   <term>Specifies:</term>
656   <listitem>
657    <para>
658     The <link linkend="actions-file">actions file(s)</link> to use
659    </para>
660   </listitem>
661  </varlistentry>
662  <varlistentry>
663   <term>Type of value:</term>
664   <listitem>
665    <para>Complete file name, relative to <literal>confdir</literal></para>
666   </listitem>
667  </varlistentry>
668  <varlistentry>
669   <term>Default values:</term>
670   <listitem>
671    <simplelist>
672     <member>
673      <msgtext><literallayout>  match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout></msgtext>
674     </member>
675     <member>
676      <msgtext><literallayout>  default.action   # Main actions file</literallayout></msgtext>
677     </member>
678     <member>
679      <msgtext><literallayout>  user.action      # User customizations</literallayout></msgtext>
680     </member>
681    </simplelist>
682   </listitem>
683  </varlistentry>
684  <varlistentry>
685   <term>Effect if unset:</term>
686   <listitem>
687    <para>
688     No actions are taken at all. More or less neutral proxying.
689    </para>
690   </listitem>
691  </varlistentry>
692  <varlistentry>
693   <term>Notes:</term>
694   <listitem>
695    <para>
696     Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
697    </para>
698    <para>
699     The default values are <filename>default.action</filename>, which is the
700     <quote>main</quote> actions file maintained by the developers, and
701     <filename>user.action</filename>, where you can make your personal additions.
702    </para>
703    <para>
704     Actions files contain all the per site and per URL configuration for
705     ad blocking, cookie management, privacy considerations, etc.
706     There is no point in using <application>Privoxy</application> without at
707     least one actions file.
708    </para>
709    <para>
710     Note that since Privoxy 3.0.7, the complete filename, including the <quote>.action</quote>
711     extension has to be specified.  The syntax change was necessary to be consistent
712     with the other file options and to allow previously forbidden characters.
713    </para>
714   </listitem>
715  </varlistentry>
716 </variablelist>
717
718 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
719 <!-- html -> text conversion, blah -->
720 <![%config-file;[<literallayout>@@actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout>]]>
721 <![%config-file;[<literallayout>@@actionsfile default.action   # Main actions file</literallayout>]]>
722 <!--
723  XXX: Like user.filter, user.action should probably be commented out
724  by default as not all packages install it into the default directory.
725  fk 2007-11-07
726 -->
727 <![%config-file;[<literallayout>@@actionsfile user.action      # User customizations</literallayout>]]>
728 </sect3>
729
730 <!--   ~~~~~       New section      ~~~~~     -->
731 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
732 <anchor id="default.filter">
733 <variablelist>
734  <varlistentry>
735   <term>Specifies:</term>
736   <listitem>
737    <para>
738     The <link linkend="filter-file">filter file(s)</link> to use
739    </para>
740   </listitem>
741  </varlistentry>
742  <varlistentry>
743   <term>Type of value:</term>
744   <listitem>
745    <para>File name, relative to <literal>confdir</literal></para>
746   </listitem>
747  </varlistentry>
748  <varlistentry>
749   <term>Default value:</term>
750   <listitem>
751    <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
752   </listitem>
753  </varlistentry>
754  <varlistentry>
755   <term>Effect if unset:</term>
756   <listitem>
757    <para>
758     No textual content filtering takes place, i.e. all
759     <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
760     actions in the actions files are turned neutral.
761    </para>
762   </listitem>
763  </varlistentry>
764  <varlistentry>
765   <term>Notes:</term>
766   <listitem>
767    <para>
768     Multiple <literal>filterfile</literal> lines are permitted.
769    </para>
770    <para>
771     The <link linkend="filter-file">filter files</link> contain content modification
772     rules that use <link linkend="regex">regular expressions</link>. These rules permit
773     powerful changes on the content of Web pages, and optionally the headers
774     as well, e.g., you could try to disable your favorite JavaScript annoyances,
775     re-write the actual displayed text, or just have some fun
776     playing buzzword bingo with web pages.
777    </para>
778    <para>
779     The
780     <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
781     actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
782     to be defined in a filter file!
783    </para>
784    <para>
785     A pre-defined filter file called <filename>default.filter</filename> that contains
786     a number of useful filters for common problems is included in the distribution.
787     See the section on the <literal><link linkend="filter">filter</link></literal>
788     action for a list.
789    </para>
790    <para>
791     It is recommended to place any locally adapted filters into a separate
792     file, such as <filename>user.filter</filename>.
793    </para>
794   </listitem>
795  </varlistentry>
796 </variablelist>
797
798 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
799 <![%config-file;[<literallayout>@@filterfile user.filter      # User customizations</literallayout>]]>
800 </sect3>
801
802
803 <!--   ~~~~~       New section      ~~~~~     -->
804 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
805
806 <variablelist>
807  <varlistentry>
808   <term>Specifies:</term>
809   <listitem>
810    <para>
811     The log file to use
812    </para>
813   </listitem>
814  </varlistentry>
815  <varlistentry>
816   <term>Type of value:</term>
817   <listitem>
818    <para>File name, relative to <literal>logdir</literal></para>
819   </listitem>
820  </varlistentry>
821  <varlistentry>
822   <term>Default value:</term>
823   <listitem>
824    <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
825   </listitem>
826  </varlistentry>
827  <varlistentry>
828   <term>Effect if unset:</term>
829   <listitem>
830    <para>
831     No logfile is written.
832    </para>
833   </listitem>
834  </varlistentry>
835  <varlistentry>
836   <term>Notes:</term>
837   <listitem>
838    <para>
839     The logfile is where all logging and error messages are written. The level
840     of detail and number of messages are set with the <literal>debug</literal>
841     option (see below). The logfile can be useful for tracking down a problem with
842     <application>Privoxy</application> (e.g., it's not blocking an ad you
843     think it should block) and it can help you to monitor what your browser
844     is doing.
845    </para>
846    <para>
847     Depending on the debug options below, the logfile may be a privacy risk
848     if third parties can get access to it. As most users will never look
849     at it, <application>Privoxy</application> 3.0.7 and later only log fatal
850     errors by default.
851    </para>
852    <para>
853     For most troubleshooting purposes, you will have to change that,
854     please refer to the debugging section for details.
855    </para>
856    <para>
857     Your logfile will grow indefinitely, and you will probably want to
858     periodically remove it.  On Unix systems, you can do this with a cron job
859     (see <quote>man cron</quote>). For Red Hat based Linux distributions, a
860     <command>logrotate</command> script has been included.
861    </para>
862    <para>
863     Any log files must be writable by whatever user <application>Privoxy</application>
864     is being run as (on Unix, default user id is <quote>privoxy</quote>).
865    </para>
866   </listitem>
867  </varlistentry>
868 </variablelist>
869
870 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
871 </sect3>
872
873
874 <!--   ~~~~~       New section      ~~~~~     -->
875 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
876 <variablelist>
877  <varlistentry>
878   <term>Specifies:</term>
879   <listitem>
880    <para>
881     The name of the trust file to use
882    </para>
883   </listitem>
884  </varlistentry>
885  <varlistentry>
886   <term>Type of value:</term>
887   <listitem>
888    <para>File name, relative to <literal>confdir</literal></para>
889   </listitem>
890  </varlistentry>
891  <varlistentry>
892   <term>Default value:</term>
893   <listitem>
894    <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
895   </listitem>
896  </varlistentry>
897  <varlistentry>
898   <term>Effect if unset:</term>
899   <listitem>
900    <para>
901     The entire trust mechanism is disabled.
902    </para>
903   </listitem>
904  </varlistentry>
905  <varlistentry>
906   <term>Notes:</term>
907   <listitem>
908    <para>
909     The trust mechanism is an experimental feature for building white-lists and should
910     be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
911    </para>
912    <para>
913     If you specify a trust file, <application>Privoxy</application> will only allow
914     access to sites that are specified in the trustfile. Sites can be listed
915     in one of two ways:
916    </para>
917    <para>
918     Prepending a <literal>~</literal> character limits access to this site
919     only (and any sub-paths within this site), e.g.
920     <literal>~www.example.com</literal> allows access to
921     <literal>~www.example.com/features/news.html</literal>, etc.
922    </para>
923    <para>
924     Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
925     prepending the name with a <literal>+</literal> character. The effect is that
926     access to untrusted sites will be granted -- but only if a link from this
927     trusted referrer was used to get there. The link target will then be added
928     to the <quote>trustfile</quote> so that future, direct accesses will be
929     granted. Sites added via this mechanism do not become trusted referrers
930     themselves (i.e. they are added with a <literal>~</literal> designation).
931     There is a limit of 512 such entries, after which new entries will not be
932     made.
933    </para>
934    <para>
935     If you use the <literal>+</literal> operator in the trust file, it may grow
936     considerably over time.
937    </para>
938    <para>
939     It is recommended that <application>Privoxy</application> be compiled with
940     the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
941     <literal> --disable-editor</literal> options, if this feature is to be
942     used.
943    </para>
944    <para>
945     Possible applications include limiting Internet access for children.
946    </para>
947
948   </listitem>
949  </varlistentry>
950 </variablelist>
951
952 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
953 </sect3>
954 </sect2>
955
956 <!--  ~  End section  ~  -->
957
958 <!--   ~~~~~       New section      ~~~~~     -->
959 <sect2 id="debugging">
960 <title>Debugging</title>
961
962  <para>
963   These options are mainly useful when tracing a problem.
964   Note that you might also want to invoke
965   <application>Privoxy</application> with the <literal>--no-daemon</literal>
966   command line option when debugging.
967  </para>
968
969 <sect3 renderas="sect4" id="debug"><title>debug</title>
970
971 <variablelist>
972  <varlistentry>
973   <term>Specifies:</term>
974   <listitem>
975    <para>
976     Key values that determine what information gets logged.
977    </para>
978   </listitem>
979  </varlistentry>
980  <varlistentry>
981   <term>Type of value:</term>
982   <listitem>
983    <para>Integer values</para>
984   </listitem>
985  </varlistentry>
986  <varlistentry>
987   <term>Default value:</term>
988   <listitem>
989    <para>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</para>
990   </listitem>
991  </varlistentry>
992  <varlistentry>
993   <term>Effect if unset:</term>
994   <listitem>
995    <para>
996     Default value is used (see above).
997    </para>
998   </listitem>
999  </varlistentry>
1000  <varlistentry>
1001   <term>Notes:</term>
1002   <listitem>
1003    <para>
1004     The available debug levels are:
1005    </para>
1006    <para>
1007     <programlisting>
1008   debug     1 # Log the destination for each request &my-app; let through. See also debug 1024.
1009   debug     2 # show each connection status
1010   debug     4 # show I/O status
1011   debug     8 # show header parsing
1012   debug    16 # log all data written to the network
1013   debug    32 # debug force feature
1014   debug    64 # debug regular expression filters
1015   debug   128 # debug redirects
1016   debug   256 # debug GIF de-animation
1017   debug   512 # Common Log Format
1018   debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
1019   debug  2048 # CGI user interface
1020   debug  4096 # Startup banner and warnings.
1021   debug  8192 # Non-fatal errors
1022   debug 32768 # log all data read from the network
1023 </programlisting>
1024    </para>
1025    <para>
1026     To select multiple debug levels, you can either add them or use
1027     multiple <literal>debug</literal> lines.
1028    </para>
1029    <para>
1030     A debug level of 1 is informative because it will show you each request
1031     as it happens. <emphasis>1, 1024, 4096 and 8192 are recommended</emphasis>
1032     so that you will notice when things go wrong. The other levels are
1033     probably only of interest if you are hunting down a specific problem.
1034     They can produce a hell of an output (especially 16).
1035     <!-- LOL -->
1036    </para>
1037    <para>
1038     &my-app; used to ship with the debug levels recommended above enabled by
1039     default, but due to privacy concerns 3.0.7 and later are configured to
1040     only log fatal errors.
1041    </para>
1042    <para>
1043     If you are used to the more verbose settings, simply enable the debug lines
1044     below again.
1045    </para>
1046    <para>
1047     If you want to use pure CLF (Common Log Format), you should set <quote>debug
1048     512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1049    </para>
1050    <para>
1051     <application>Privoxy</application> has a hard-coded limit for the
1052     length of log messages. If it's reached, messages are logged truncated
1053     and marked with <quote>... [too long, truncated]</quote>.
1054    </para>
1055    <para>
1056     Please don't file any support requests without trying to reproduce
1057     the problem with increased debug level first. Once you read the log
1058     messages, you may even be able to solve the problem on your own.
1059    </para>
1060   </listitem>
1061  </varlistentry>
1062 </variablelist>
1063
1064 <![%config-file;[<literallayout>@@#debug     1 # Log the destination for each request &my-app; let through.</literallayout>]]>
1065 <![%config-file;[<literallayout>@@#debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
1066 <![%config-file;[<literallayout>@@#debug  4096 # Startup banner and warnings</literallayout>]]>
1067 <![%config-file;[<literallayout>@@#debug  8192 # Non-fatal errors</literallayout>]]>
1068 </sect3>
1069
1070
1071 <!--   ~~~~~       New section      ~~~~~     -->
1072 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1073
1074 <variablelist>
1075  <varlistentry>
1076   <term>Specifies:</term>
1077   <listitem>
1078    <para>
1079     Whether to run only one server thread.
1080    </para>
1081   </listitem>
1082  </varlistentry>
1083  <varlistentry>
1084   <term>Type of value:</term>
1085   <listitem>
1086    <para><emphasis>None</emphasis></para>
1087   </listitem>
1088  </varlistentry>
1089  <varlistentry>
1090   <term>Default value:</term>
1091   <listitem>
1092    <para><emphasis>Unset</emphasis></para>
1093   </listitem>
1094  </varlistentry>
1095  <varlistentry>
1096   <term>Effect if unset:</term>
1097   <listitem>
1098    <para>
1099     Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1100     serve multiple requests simultaneously.
1101    </para>
1102   </listitem>
1103  </varlistentry>
1104  <varlistentry>
1105   <term>Notes:</term>
1106   <listitem>
1107    <para>
1108     This option is only there for debugging purposes.
1109     <emphasis>It will drastically reduce performance.</emphasis>
1110    </para>
1111   </listitem>
1112  </varlistentry>
1113 </variablelist>
1114
1115 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1116 </sect3>
1117
1118 <!--   ~~~~~       New section      ~~~~~     -->
1119 <sect3 renderas="sect4" id="hostname"><title>hostname</title>
1120
1121 <variablelist>
1122  <varlistentry>
1123   <term>Specifies:</term>
1124   <listitem>
1125    <para>
1126     The hostname shown on the CGI pages.
1127    </para>
1128   </listitem>
1129  </varlistentry>
1130  <varlistentry>
1131   <term>Type of value:</term>
1132   <listitem>
1133    <para>Text</para>
1134   </listitem>
1135  </varlistentry>
1136  <varlistentry>
1137   <term>Default value:</term>
1138   <listitem>
1139    <para><emphasis>Unset</emphasis></para>
1140   </listitem>
1141  </varlistentry>
1142  <varlistentry>
1143   <term>Effect if unset:</term>
1144   <listitem>
1145    <para>
1146     The hostname provided by the operating system is used.
1147    </para>
1148   </listitem>
1149  </varlistentry>
1150  <varlistentry>
1151   <term>Notes:</term>
1152   <listitem>
1153    <para>
1154     On some misconfigured systems resolving the hostname fails or
1155     takes too much time and slows Privoxy down. Setting a fixed hostname
1156     works around the problem.
1157    </para>
1158    <para>
1159     In other circumstances it might be desirable to show a hostname
1160     other than the one returned by the operating system. For example
1161     if the system has several different hostnames and you don't want
1162     to use the first one.
1163    </para>
1164    <para>
1165     Note that Privoxy does not validate the specified hostname value.
1166    </para>
1167   </listitem>
1168  </varlistentry>
1169 </variablelist>
1170
1171 <![%config-file;[<literallayout>@@#hostname hostname.example.org</literallayout>]]>
1172 </sect3>
1173
1174 </sect2>
1175
1176 <!--  ~  End section  ~  -->
1177
1178
1179 <!--   ~~~~~       New section      ~~~~~     -->
1180 <sect2 id="access-control">
1181 <title>Access Control and Security</title>
1182
1183  <para>
1184   This section of the config file controls the security-relevant aspects
1185   of <application>Privoxy</application>'s configuration.
1186  </para>
1187
1188
1189 <!--   ~~~~~       New section      ~~~~~     -->
1190 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1191
1192 <variablelist>
1193  <varlistentry>
1194   <term>Specifies:</term>
1195   <listitem>
1196    <para>
1197     The address and TCP port on which <application>Privoxy</application> will
1198     listen for client requests.
1199    </para>
1200   </listitem>
1201  </varlistentry>
1202  <varlistentry>
1203   <term>Type of value:</term>
1204   <listitem>
1205    <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1206    <para>[<replaceable class="parameter">Hostname</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1207   </listitem>
1208  </varlistentry>
1209
1210  <varlistentry>
1211   <term>Default value:</term>
1212   <listitem>
1213    <para>127.0.0.1:8118</para>
1214   </listitem>
1215  </varlistentry>
1216  <varlistentry>
1217   <term>Effect if unset:</term>
1218   <listitem>
1219    <para>
1220     Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable and
1221     recommended for home users who run <application>Privoxy</application> on
1222     the same machine as their browser.
1223    </para>
1224   </listitem>
1225  </varlistentry>
1226  <varlistentry>
1227   <term>Notes:</term>
1228   <listitem>
1229    <para>
1230     You will need to configure your browser(s) to this proxy address and port.
1231    </para>
1232    <para>
1233     If you already have another service running on port 8118, or if you want to
1234     serve requests from other machines (e.g. on your local network) as well, you
1235     will need to override the default.
1236    </para>
1237    <para>
1238     You can use this statement multiple times to make
1239     <application>Privoxy</application> listen on more ports or more
1240     <abbrev>IP</abbrev> addresses. Suitable if your operating system does not
1241     support sharing <abbrev>IPv6</abbrev> and <abbrev>IPv4</abbrev> protocols
1242     on the same socket.
1243    </para>
1244    <para>
1245     If a hostname is used instead of an IP address, <application>Privoxy</application>
1246     will try to resolve it to an IP address and if there are multiple, use the first
1247     one returned.
1248    </para>
1249    <para>
1250     If the address for the hostname isn't already known on the system
1251     (for example because it's in /etc/hostname), this may result in DNS
1252     traffic.
1253    </para>
1254    <para>
1255     If the specified address isn't available on the system, or if the
1256     hostname can't be resolved, <application>Privoxy</application>
1257     will fail to start.
1258    </para>
1259    <para>
1260     IPv6 addresses containing colons have to be quoted by brackets.
1261     They can only be used if <application>Privoxy</application> has
1262     been compiled with IPv6 support. If you aren't sure if your version
1263     supports it, have a look at
1264     <literal>http://config.privoxy.org/show-status</literal>.
1265    </para>
1266    <para>
1267     Some operating systems will prefer IPv6 to IPv4 addresses even if the
1268     system has no IPv6 connectivity which is usually not expected by the user.
1269     Some even rely on DNS to resolve localhost which mean the "localhost" address
1270     used may not actually be local.
1271    </para>
1272    <para>
1273     It is therefore recommended to explicitly configure the intended IP address
1274     instead of relying on the operating system, unless there's a strong reason not to.
1275    </para>
1276    <para>
1277     If you leave out the address, <application>Privoxy</application> will bind to all
1278     IPv4 interfaces (addresses) on your machine and may become reachable from the
1279     Internet and/or the local network. Be aware that some GNU/Linux distributions
1280     modify that behaviour without updating the documentation. Check for non-standard
1281     patches if your <application>Privoxy</application> version behaves differently.
1282    </para>
1283    <para>
1284     If you configure <application>Privoxy</application> to be reachable from the
1285     network, consider using <link linkend="acls">access control lists</link>
1286     (ACL's, see below), and/or a firewall.
1287    </para>
1288    <para>
1289     If you open <application>Privoxy</application> to untrusted users, you will
1290     also want to make sure that the following actions are disabled:  <literal><link
1291     linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1292     <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1293    </para>
1294   </listitem>
1295  </varlistentry>
1296  <varlistentry>
1297   <term>Example:</term>
1298   <listitem>
1299    <para>
1300      Suppose you are running <application>Privoxy</application> on
1301      a machine which has the address 192.168.0.1 on your local private network
1302      (192.168.0.0) and has another outside connection with a different address.
1303      You want it to serve requests from inside only:
1304    </para>
1305    <para>
1306     <programlisting>
1307   listen-address  192.168.0.1:8118
1308 </programlisting>
1309    </para>
1310    <para>
1311     Suppose you are running <application>Privoxy</application> on an
1312     IPv6-capable machine and you want it to listen on the IPv6 address
1313     of the loopback device:
1314    </para>
1315    <para>
1316     <programlisting>
1317   listen-address [::1]:8118
1318 </programlisting>
1319    </para>
1320   </listitem>
1321  </varlistentry>
1322 </variablelist>
1323
1324 <![%config-file;[<literallayout>@@listen-address  127.0.0.1:8118</literallayout>]]>
1325 </sect3>
1326
1327
1328 <!--   ~~~~~       New section      ~~~~~     -->
1329 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1330
1331 <variablelist>
1332  <varlistentry>
1333   <term>Specifies:</term>
1334   <listitem>
1335    <para>
1336     Initial state of "toggle" status
1337    </para>
1338   </listitem>
1339  </varlistentry>
1340  <varlistentry>
1341   <term>Type of value:</term>
1342   <listitem>
1343    <para>1 or 0</para>
1344   </listitem>
1345  </varlistentry>
1346  <varlistentry>
1347   <term>Default value:</term>
1348   <listitem>
1349    <para>1</para>
1350   </listitem>
1351  </varlistentry>
1352  <varlistentry>
1353   <term>Effect if unset:</term>
1354   <listitem>
1355    <para>
1356     Act as if toggled on
1357    </para>
1358   </listitem>
1359  </varlistentry>
1360  <varlistentry>
1361   <term>Notes:</term>
1362   <listitem>
1363    <para>
1364     If set to 0, <application>Privoxy</application> will start in
1365     <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1366     content-neutral proxy with both ad blocking and content filtering
1367     disabled. See <literal>enable-remote-toggle</literal> below.
1368 <!--
1369     This is not really useful
1370     anymore, since toggling is much easier via <ulink
1371     url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1372     editing the <filename>conf</filename> file.
1373
1374     Remote toggling is now disabled by default. fk 2007-11-07)
1375 -->
1376    </para>
1377    <para>
1378     The windows version will only display the toggle icon in the system tray
1379     if this option is present.
1380    </para>
1381   </listitem>
1382  </varlistentry>
1383 </variablelist>
1384
1385 <![%config-file;[<literallayout>@@toggle  1</literallayout>]]>
1386 </sect3>
1387
1388
1389 <!--   ~~~~~       New section      ~~~~~     -->
1390 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1391 <variablelist>
1392  <varlistentry>
1393   <term>Specifies:</term>
1394   <listitem>
1395    <para>
1396     Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1397     feature</ulink> may be used
1398    </para>
1399   </listitem>
1400  </varlistentry>
1401  <varlistentry>
1402   <term>Type of value:</term>
1403   <listitem>
1404    <para>0 or 1</para>
1405   </listitem>
1406  </varlistentry>
1407  <varlistentry>
1408   <term>Default value:</term>
1409   <listitem>
1410    <para>0</para>
1411   </listitem>
1412  </varlistentry>
1413  <varlistentry>
1414   <term>Effect if unset:</term>
1415   <listitem>
1416    <para>
1417     The web-based toggle feature is disabled.
1418    </para>
1419   </listitem>
1420  </varlistentry>
1421  <varlistentry>
1422   <term>Notes:</term>
1423   <listitem>
1424    <para>
1425     When toggled off, <application>Privoxy</application> mostly acts like a normal,
1426     content-neutral proxy, i.e. doesn't block ads or filter content.
1427    </para>
1428    <para>
1429     Access to the toggle feature can <emphasis>not</emphasis> be
1430     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1431     so that everybody who can access <application>Privoxy</application> (see
1432     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1433     toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1434     for multi-user environments with untrusted users.
1435    </para>
1436    <para>
1437     Note that malicious client side code (e.g Java) is also
1438     capable of using this option.
1439    </para>
1440    <para>
1441     As a lot of <application>Privoxy</application> users don't read
1442     documentation, this feature is disabled by default.
1443    </para>
1444    <para>
1445     Note that you must have compiled <application>Privoxy</application> with
1446     support for this feature, otherwise this option has no effect.
1447    </para>
1448   </listitem>
1449  </varlistentry>
1450 </variablelist>
1451
1452 <![%config-file;[<literallayout>@@enable-remote-toggle  0</literallayout>]]>
1453 </sect3>
1454
1455
1456 <!--   ~~~~~       New section      ~~~~~     -->
1457 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1458 <variablelist>
1459  <varlistentry>
1460   <term>Specifies:</term>
1461   <listitem>
1462    <para>
1463     Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1464    </para>
1465   </listitem>
1466  </varlistentry>
1467  <varlistentry>
1468   <term>Type of value:</term>
1469   <listitem>
1470    <para>0 or 1</para>
1471   </listitem>
1472  </varlistentry>
1473  <varlistentry>
1474   <term>Default value:</term>
1475   <listitem>
1476    <para>0</para>
1477   </listitem>
1478  </varlistentry>
1479  <varlistentry>
1480   <term>Effect if unset:</term>
1481   <listitem>
1482    <para>
1483     Privoxy ignores special HTTP headers.
1484    </para>
1485   </listitem>
1486  </varlistentry>
1487  <varlistentry>
1488   <term>Notes:</term>
1489   <listitem>
1490    <para>
1491     When toggled on, the client can change <application>Privoxy's</application>
1492     behaviour by setting special HTTP headers. Currently the only supported
1493     special header is <quote>X-Filter: No</quote>, to disable filtering for
1494     the ongoing request, even if it is enabled in one of the action files.
1495    </para>
1496    <para>
1497     This feature is disabled by default. If you are using
1498     <application>Privoxy</application> in a environment with trusted clients,
1499     you may enable this feature at your discretion. Note that malicious client
1500     side code (e.g Java) is also capable of using this feature.
1501    </para>
1502    <para>
1503     This option will be removed in future releases as it has been obsoleted
1504     by the more general header taggers.
1505    </para>
1506   </listitem>
1507  </varlistentry>
1508 </variablelist>
1509
1510 <![%config-file;[<literallayout>@@enable-remote-http-toggle  0</literallayout>]]>
1511 </sect3>
1512
1513
1514 <!--   ~~~~~       New section      ~~~~~     -->
1515 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1516 <variablelist>
1517  <varlistentry>
1518   <term>Specifies:</term>
1519   <listitem>
1520    <para>
1521     Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1522     file editor</ulink> may be used
1523    </para>
1524   </listitem>
1525  </varlistentry>
1526  <varlistentry>
1527   <term>Type of value:</term>
1528   <listitem>
1529    <para>0 or 1</para>
1530   </listitem>
1531  </varlistentry>
1532  <varlistentry>
1533   <term>Default value:</term>
1534   <listitem>
1535    <para>0</para>
1536   </listitem>
1537  </varlistentry>
1538  <varlistentry>
1539   <term>Effect if unset:</term>
1540   <listitem>
1541    <para>
1542     The web-based actions file editor is disabled.
1543    </para>
1544   </listitem>
1545  </varlistentry>
1546  <varlistentry>
1547   <term>Notes:</term>
1548   <listitem>
1549    <para>
1550     Access to the editor can <emphasis>not</emphasis> be
1551     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1552     so that everybody who can access <application>Privoxy</application> (see
1553     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1554     modify its configuration for all users.
1555    </para>
1556    <para>
1557     This option is <emphasis>not recommended</emphasis> for environments
1558     with untrusted users and as a lot of <application>Privoxy</application>
1559     users don't read documentation, this feature is disabled by default.
1560    </para>
1561    <para>
1562     Note that malicious client side code (e.g Java) is also
1563     capable of using the actions editor and you shouldn't enable
1564     this options unless you understand the consequences and are
1565     sure your browser is configured correctly.
1566    </para>
1567    <para>
1568     Note that you must have compiled <application>Privoxy</application> with
1569     support for this feature, otherwise this option has no effect.
1570    </para>
1571   </listitem>
1572  </varlistentry>
1573 </variablelist>
1574
1575 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1576 </sect3>
1577
1578
1579 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1580 <variablelist>
1581  <varlistentry>
1582   <term>Specifies:</term>
1583   <listitem>
1584    <para>
1585     Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1586    </para>
1587   </listitem>
1588  </varlistentry>
1589  <varlistentry>
1590   <term>Type of value:</term>
1591   <listitem>
1592    <para>
1593     <replaceable>0 or 1</replaceable>
1594    </para>
1595   </listitem>
1596  </varlistentry>
1597  <varlistentry>
1598   <term>Default value:</term>
1599   <listitem>
1600    <para><emphasis>0</emphasis></para>
1601   </listitem>
1602  </varlistentry>
1603  <varlistentry>
1604   <term>Effect if unset:</term>
1605   <listitem>
1606    <para>
1607     Blocks are not enforced.
1608    </para>
1609   </listitem>
1610  </varlistentry>
1611  <varlistentry>
1612   <term>Notes:</term>
1613   <listitem>
1614    <para>
1615     <application>Privoxy</application> is mainly used to block and filter
1616     requests as a service to the user, for example to block ads and other
1617     junk that clogs the pipes. <application>Privoxy's</application> configuration
1618     isn't perfect and sometimes innocent pages are blocked. In this situation it
1619     makes sense to allow the user to enforce the request and have
1620     <application>Privoxy</application> ignore the block.
1621    </para>
1622    <para>
1623     In the default configuration <application>Privoxy's</application>
1624     <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1625     link to adds a special string (the force prefix) to the request URL.
1626     If that link is used, <application>Privoxy</application> will
1627     detect the force prefix, remove it again and let the request pass.
1628    </para>
1629    <para>
1630     Of course <application>Privoxy</application> can also be used to enforce
1631     a network policy. In that case the user obviously should not be able to
1632     bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1633     option is for. If it's enabled, <application>Privoxy</application> hides
1634     the <quote>go there anyway</quote> link. If the user adds the force
1635     prefix by hand, it will not be accepted and the circumvention attempt
1636     is logged.
1637    </para>
1638   </listitem>
1639  </varlistentry>
1640  <varlistentry>
1641   <term>Examples:</term>
1642   <listitem>
1643    <para>
1644     enforce-blocks 1
1645    </para>
1646   </listitem>
1647  </varlistentry>
1648 </variablelist>
1649 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1650 </sect3>
1651
1652
1653 <!--   ~~~~~       New section      ~~~~~     -->
1654 <sect3 renderas="sect4" id="acls"><title>
1655 ACLs: permit-access and deny-access</title>
1656 <anchor id="permit-access">
1657 <anchor id="deny-access">
1658
1659 <variablelist>
1660  <varlistentry>
1661   <term>Specifies:</term>
1662   <listitem>
1663    <para>
1664     Who can access what.
1665    </para>
1666   </listitem>
1667  </varlistentry>
1668  <varlistentry>
1669   <term>Type of value:</term>
1670   <listitem>
1671    <para>
1672     <replaceable class="parameter">src_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">src_masklen</replaceable>]
1673     [<replaceable class="parameter">dst_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">dst_masklen</replaceable>]]
1674    </para>
1675    <para>
1676     Where <replaceable class="parameter">src_addr</replaceable> and
1677    <replaceable class="parameter">dst_addr</replaceable> are IPv4 addresses in dotted decimal notation or valid
1678     DNS names, <replaceable class="parameter">port</replaceable> is a port
1679     number, and <replaceable class="parameter">src_masklen</replaceable> and
1680     <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1681     values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1682     destination part are optional.
1683    </para>
1684    <para>
1685     If your system implements
1686     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink>, then
1687     <replaceable class="parameter">src_addr</replaceable> and <replaceable
1688     class="parameter">dst_addr</replaceable> can be IPv6 addresses delimeted by
1689     brackets, <replaceable class="parameter">port</replaceable> can be a number
1690     or a service name, and
1691     <replaceable class="parameter">src_masklen</replaceable> and
1692     <replaceable class="parameter">dst_masklen</replaceable> can be a number
1693     from 0 to 128.
1694    </para>
1695   </listitem>
1696  </varlistentry>
1697  <varlistentry>
1698   <term>Default value:</term>
1699   <listitem>
1700    <para><emphasis>Unset</emphasis></para>
1701    <para>
1702     If no <replaceable class="parameter">port</replaceable> is specified,
1703     any port will match. If no <replaceable class="parameter">src_masklen</replaceable> or
1704     <replaceable class="parameter">src_masklen</replaceable> is given, the complete IP
1705     address has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1706    </para>
1707   </listitem>
1708  </varlistentry>
1709  <varlistentry>
1710   <term>Effect if unset:</term>
1711   <listitem>
1712    <para>
1713     Don't restrict access further than implied by <literal>listen-address</literal>
1714    </para>
1715   </listitem>
1716  </varlistentry>
1717  <varlistentry>
1718   <term>Notes:</term>
1719   <listitem>
1720    <para>
1721     Access controls are included at the request of ISPs and systems
1722     administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1723     For a typical home user, it will normally suffice to ensure that
1724     <application>Privoxy</application> only listens on the localhost
1725     (127.0.0.1) or internal (home) network address by means of the
1726     <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1727     option.
1728    </para>
1729    <para>
1730     Please see the warnings in the FAQ that <application>Privoxy</application>
1731     is not intended to be a substitute for a firewall or to encourage anyone
1732     to defer addressing basic security weaknesses.
1733    </para>
1734    <para>
1735     Multiple ACL lines are OK.
1736     If any ACLs are specified, <application>Privoxy</application> only talks
1737     to IP addresses that match at least one <literal>permit-access</literal> line
1738     and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1739     last match wins, with the default being <literal>deny-access</literal>.
1740    </para>
1741    <para>
1742     If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1743     for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1744     that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1745     of the ultimate target. This is necessary because it may be impossible for the local
1746     <application>Privoxy</application> to determine the IP address of the
1747     ultimate target (that's often what gateways are used for).
1748    </para>
1749    <para>
1750     You should prefer using IP addresses over DNS names, because the address lookups take
1751     time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1752     like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1753     IP addresses, only the first one is used.
1754    </para>
1755    <para>
1756      Some systems allow IPv4 clients to connect to IPv6 server sockets.
1757      Then the client's IPv4 address will be translated by the system into
1758      IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4
1759      mapped IPv6 address). <application>Privoxy</application> can handle it
1760      and maps such ACL addresses automatically.
1761    </para>
1762    <para>
1763     Denying access to particular sites by ACL may have undesired side effects
1764     if the site in question is hosted on a machine which also hosts other sites
1765     (most sites are).
1766    </para>
1767   </listitem>
1768  </varlistentry>
1769  <varlistentry>
1770   <term>Examples:</term>
1771   <listitem>
1772    <para>
1773     Explicitly define the default behavior if no ACL and
1774     <literal>listen-address</literal> are set: <quote>localhost</quote>
1775     is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1776     <emphasis>all</emphasis> destination addresses are OK:
1777    </para>
1778    <para>
1779     <screen>
1780   permit-access  localhost
1781 </screen>
1782    </para>
1783    <para>
1784     Allow any host on the same class C subnet as www.privoxy.org access to
1785     nothing but www.example.com (or other domains hosted on the same system):
1786    </para>
1787    <para>
1788     <screen>
1789   permit-access  www.privoxy.org/24 www.example.com/32
1790 </screen>
1791    </para>
1792    <para>
1793     Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1794     with the exception that 192.168.45.73 may not access the IP address behind
1795     www.dirty-stuff.example.com:
1796    </para>
1797    <para>
1798     <screen>
1799   permit-access  192.168.45.64/26
1800   deny-access    192.168.45.73    www.dirty-stuff.example.com
1801 </screen>
1802    </para>
1803    <para>
1804      Allow access from the IPv4 network 192.0.2.0/24 even if listening on
1805      an IPv6 wild card address (not supported on all platforms):
1806    </para>
1807    <para>
1808     <programlisting>
1809   permit-access  192.0.2.0/24
1810 </programlisting>
1811    </para>
1812    <para>
1813      This is equivalent to the following line even if listening on an
1814      IPv4 address (not supported on all platforms):
1815    </para>
1816    <para>
1817     <programlisting>
1818   permit-access  [::ffff:192.0.2.0]/120
1819 </programlisting>
1820    </para>
1821   </listitem>
1822  </varlistentry>
1823 </variablelist>
1824 </sect3>
1825
1826
1827 <!--   ~~~~~       New section      ~~~~~     -->
1828 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1829
1830 <variablelist>
1831  <varlistentry>
1832   <term>Specifies:</term>
1833   <listitem>
1834    <para>
1835     Maximum size of the buffer for content filtering.
1836    </para>
1837   </listitem>
1838  </varlistentry>
1839  <varlistentry>
1840   <term>Type of value:</term>
1841   <listitem>
1842    <para>Size in Kbytes</para>
1843   </listitem>
1844  </varlistentry>
1845  <varlistentry>
1846   <term>Default value:</term>
1847   <listitem>
1848    <para>4096</para>
1849   </listitem>
1850  </varlistentry>
1851  <varlistentry>
1852   <term>Effect if unset:</term>
1853   <listitem>
1854    <para>
1855     Use a 4MB (4096 KB) limit.
1856    </para>
1857   </listitem>
1858  </varlistentry>
1859  <varlistentry>
1860   <term>Notes:</term>
1861   <listitem>
1862    <para>
1863     For content filtering, i.e. the <literal>+filter</literal> and
1864     <literal>+deanimate-gif</literal> actions, it is necessary that
1865     <application>Privoxy</application> buffers the entire document body.
1866     This can be potentially dangerous, since a server could just keep sending
1867     data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1868     Hence this option.
1869    </para>
1870    <para>
1871     When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1872     flushed to the client unfiltered and no further attempt to
1873     filter the rest of the document is made. Remember that there may be multiple threads
1874     running, which might require up to <literal>buffer-limit</literal> Kbytes
1875     <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1876     above.
1877    </para>
1878   </listitem>
1879  </varlistentry>
1880 </variablelist>
1881
1882 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1883 </sect3>
1884
1885 </sect2>
1886
1887 <!--  ~  End section  ~  -->
1888
1889
1890 <!--   ~~~~~       New section      ~~~~~     -->
1891
1892 <sect2 id="forwarding">
1893 <title>Forwarding</title>
1894
1895 <para>
1896  This feature allows routing of HTTP requests through a chain of
1897  multiple proxies.
1898 </para>
1899 <para>
1900  Forwarding can be used to chain Privoxy with a caching proxy to speed
1901  up browsing. Using a parent proxy may also be necessary if the machine
1902  that <application>Privoxy</application> runs on has no direct Internet access.
1903 </para>
1904 <para>
1905  Note that parent proxies can severely decrease your privacy level.
1906  For example a parent proxy could add your IP address to the request
1907  headers and if it's a caching proxy it may add the <quote>Etag</quote>
1908  header to revalidation requests again, even though you configured Privoxy
1909  to remove it. It may also ignore Privoxy's header time randomization and use the
1910  original values which could be used by the server as cookie replacement
1911  to track your steps between visits.
1912 </para>
1913
1914 <para>
1915  Also specified here are SOCKS proxies. <application>Privoxy</application>
1916  supports the SOCKS 4 and SOCKS 4A protocols.
1917 </para>
1918
1919 <sect3 renderas="sect4" id="forward"><title>forward</title>
1920 <variablelist>
1921  <varlistentry>
1922   <term>Specifies:</term>
1923   <listitem>
1924    <para>
1925     To which parent HTTP proxy specific requests should be routed.
1926    </para>
1927   </listitem>
1928  </varlistentry>
1929  <varlistentry>
1930   <term>Type of value:</term>
1931   <listitem>
1932    <para>
1933     <replaceable class="parameter">target_pattern</replaceable>
1934     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1935    </para>
1936    <para>
1937     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1938     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1939     denote <quote>all URLs</quote>.
1940     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1941     is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1942     optionally followed by its listening port (default: 8000).
1943     Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1944    </para>
1945   </listitem>
1946  </varlistentry>
1947  <varlistentry>
1948   <term>Default value:</term>
1949   <listitem>
1950    <para><emphasis>Unset</emphasis></para>
1951   </listitem>
1952  </varlistentry>
1953  <varlistentry>
1954   <term>Effect if unset:</term>
1955   <listitem>
1956    <para>
1957     Don't use parent HTTP proxies.
1958    </para>
1959   </listitem>
1960  </varlistentry>
1961  <varlistentry>
1962   <term>Notes:</term>
1963   <listitem>
1964    <para>
1965     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1966     forwarded to another HTTP proxy but are made directly to the web servers.
1967    </para>
1968    <para>
1969     <replaceable class="parameter">http_parent</replaceable> can be a
1970      numerical IPv6 address (if
1971     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
1972     implemented). To prevent clashes with the port delimiter, the whole IP
1973     address has to be put into brackets. On the other hand a <replaceable
1974     class="parameter">target_pattern</replaceable> containing an IPv6 address
1975     has to be put into angle brackets (normal brackets are reserved for
1976     regular expressions already).
1977    </para>
1978    <para>
1979     Multiple lines are OK, they are checked in sequence, and the last match wins.
1980    </para>
1981   </listitem>
1982  </varlistentry>
1983  <varlistentry>
1984   <term>Examples:</term>
1985   <listitem>
1986    <para>
1987     Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
1988    </para>
1989    <para>
1990     <screen>
1991   forward   /      parent-proxy.example.org:8080
1992   forward   :443   .
1993 </screen>
1994    </para>
1995    <para>
1996     Everything goes to our example ISP's caching proxy, except for requests
1997     to that ISP's sites:
1998    </para>
1999    <para>
2000     <screen>
2001   forward   /                  caching-proxy.isp.example.net:8000
2002   forward   .isp.example.net   .
2003 </screen>
2004    </para>
2005    <para>
2006     Parent proxy specified by an IPv6 address:
2007    </para>
2008    <para>
2009     <programlisting>
2010   forward   /                   [2001:DB8::1]:8000
2011 </programlisting>
2012    </para>
2013    <para>
2014     Suppose your parent proxy doesn't support IPv6:
2015    </para>
2016    <para>
2017     <programlisting>
2018   forward  /                        parent-proxy.example.org:8000
2019   forward  ipv6-server.example.org  .
2020   forward  &lt;[2-3][0-9a-f][0-9a-f][0-9a-f]:*&gt;   .
2021 </programlisting>
2022    </para>
2023   </listitem>
2024  </varlistentry>
2025 </variablelist>
2026 </sect3>
2027
2028
2029 <!--   ~~~~~       New section      ~~~~~     -->
2030 <sect3 renderas="sect4" id="socks"><title>
2031 forward-socks4, forward-socks4a and forward-socks5</title>
2032 <anchor id="forward-socks4">
2033 <anchor id="forward-socks4a">
2034
2035 <variablelist>
2036  <varlistentry>
2037   <term>Specifies:</term>
2038   <listitem>
2039    <para>
2040     Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2041    </para>
2042   </listitem>
2043  </varlistentry>
2044  <varlistentry>
2045   <term>Type of value:</term>
2046   <listitem>
2047    <para>
2048     <replaceable class="parameter">target_pattern</replaceable>
2049     <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
2050     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2051    </para>
2052    <para>
2053     where <replaceable class="parameter">target_pattern</replaceable> is a
2054     <link linkend="af-patterns">URL pattern</link> that specifies to which
2055     requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2056     denote <quote>all URLs</quote>. <replaceable class="parameter">http_parent</replaceable>
2057     and <replaceable class="parameter">socks_proxy</replaceable>
2058     are IP addresses in dotted decimal notation or valid DNS names
2059     (<replaceable class="parameter">http_parent</replaceable>
2060     may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
2061     <replaceable class="parameter">port</replaceable> parameters are TCP ports,
2062     i.e. integer values from 1 to 65535
2063    </para>
2064   </listitem>
2065  </varlistentry>
2066  <varlistentry>
2067   <term>Default value:</term>
2068   <listitem>
2069    <para><emphasis>Unset</emphasis></para>
2070   </listitem>
2071  </varlistentry>
2072  <varlistentry>
2073   <term>Effect if unset:</term>
2074   <listitem>
2075    <para>
2076     Don't use SOCKS proxies.
2077    </para>
2078   </listitem>
2079  </varlistentry>
2080  <varlistentry>
2081   <term>Notes:</term>
2082   <listitem>
2083    <para>
2084     Multiple lines are OK, they are checked in sequence, and the last match wins.
2085    </para>
2086    <para>
2087     The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
2088     is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2089     server, while in SOCKS 4 it happens locally.
2090    </para>
2091    <para>
2092     With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
2093    </para>
2094    <para>
2095     <replaceable class="parameter">socks_proxy</replaceable> and
2096     <replaceable class="parameter">http_parent</replaceable> can be a
2097      numerical IPv6 address (if
2098     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2099     implemented). To prevent clashes with the port delimiter, the whole IP
2100     address has to be put into brackets. On the other hand a <replaceable
2101     class="parameter">target_pattern</replaceable> containing an IPv6 address
2102     has to be put into angle brackets (normal brackets are reserved for
2103     regular expressions already).
2104    </para>
2105    <para>
2106     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2107     forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2108     a SOCKS proxy.
2109    </para>
2110   </listitem>
2111  </varlistentry>
2112  <varlistentry>
2113   <term>Examples:</term>
2114   <listitem>
2115    <para>
2116      From the company example.com, direct connections are made to all
2117      <quote>internal</quote> domains, but everything outbound goes through
2118      their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2119      the Internet.
2120    </para>
2121    <para>
2122     <screen>
2123   forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
2124   forward           .example.com   .
2125 </screen>
2126    </para>
2127    <para>
2128     A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2129    </para>
2130    <para>
2131     <screen>
2132   forward-socks4   /               socks-gw.example.com:1080  .
2133 </screen>
2134    </para>
2135
2136     <para>
2137     To chain Privoxy and Tor, both running on the same system, you would use
2138     something like:
2139    </para>
2140    <para>
2141     <screen>
2142   forward-socks5   /               127.0.0.1:9050 .
2143 </screen>
2144    </para>
2145
2146     <para>
2147     The public <application>Tor</application> network can't be used to
2148     reach your local network, if you need to access local servers you
2149     therefore might want to make some exceptions:
2150    </para>
2151    <para>
2152     <screen>
2153   forward         192.168.*.*/     .
2154   forward            10.*.*.*/     .
2155   forward           127.*.*.*/     .
2156 </screen>
2157    </para>
2158    <para>
2159     Unencrypted connections to systems in these address ranges will
2160     be as (un)secure as the local network is, but the alternative is that you
2161     can't reach the local network through <application>Privoxy</application>
2162     at all. Of course this may actually be desired and there is no reason
2163     to make these exceptions if you aren't sure you need them.
2164    </para>
2165    <para>
2166     If you also want to be able to reach servers in your local network by
2167     using their names, you will need additional exceptions that look like
2168     this:
2169    </para>
2170    <para>
2171     <screen>
2172  forward           localhost/     .
2173 </screen>
2174    </para>
2175
2176   </listitem>
2177  </varlistentry>
2178 </variablelist>
2179 </sect3>
2180
2181 <![%user-man;[     <!-- not included in config due to length -->
2182 <!--   ~~~~~       New section      ~~~~~     -->
2183 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2184
2185 <para>
2186  If you have links to multiple ISPs that provide various special content
2187  only to their subscribers, you can configure multiple <application>Privoxies</application>
2188  which have connections to the respective ISPs to act as forwarders to each other, so that
2189  <emphasis>your</emphasis> users can see the internal content of all ISPs.
2190 </para>
2191
2192 <para>
2193  Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2194  isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2195  configuration can look like this:
2196 </para>
2197
2198 <para>
2199  host-a:
2200 </para>
2201
2202 <para>
2203  <screen>
2204   forward    /           .
2205   forward    .isp-b.example.net  host-b:8118
2206 </screen>
2207 </para>
2208
2209 <para>
2210  host-b:
2211 </para>
2212
2213 <para>
2214  <screen>
2215   forward    /           .
2216   forward    .isp-a.example.org  host-a:8118
2217 </screen>
2218 </para>
2219
2220 <para>
2221  Now, your users can set their browser's proxy to use either
2222  host-a or host-b and be able to browse the internal content
2223  of both isp-a and isp-b.
2224 </para>
2225
2226 <para>
2227  If you intend to chain <application>Privoxy</application> and
2228  <application>squid</application> locally, then chaining as
2229  <literal>browser -> squid -> privoxy</literal> is the recommended way.
2230 </para>
2231
2232 <para>
2233  Assuming that <application>Privoxy</application> and <application>squid</application>
2234  run on the same box, your <application>squid</application> configuration could then look like this:
2235 </para>
2236
2237 <para>
2238  <screen>
2239   # Define Privoxy as parent proxy (without ICP)
2240   cache_peer 127.0.0.1 parent 8118 7 no-query
2241
2242   # Define ACL for protocol FTP
2243   acl ftp proto FTP
2244
2245   # Do not forward FTP requests to Privoxy
2246   always_direct allow ftp
2247
2248   # Forward all the rest to Privoxy
2249   never_direct allow all</screen>
2250 </para>
2251
2252 <para>
2253  You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2254  Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2255 </para>
2256
2257 <para>
2258  You could just as well decide to only forward requests you suspect
2259  of leading to Windows executables through a virus-scanning parent proxy,
2260  say, on <literal>antivir.example.com</literal>, port 8010:
2261 </para>
2262
2263 <para>
2264  <screen>
2265   forward   /                          .
2266   forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010</screen>
2267 </para>
2268
2269 </sect3>
2270 ]]>
2271
2272 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2273 <variablelist>
2274  <varlistentry>
2275   <term>Specifies:</term>
2276   <listitem>
2277    <para>
2278     How often Privoxy retries if a forwarded connection request fails.
2279    </para>
2280   </listitem>
2281  </varlistentry>
2282  <varlistentry>
2283   <term>Type of value:</term>
2284   <listitem>
2285    <para>
2286     <replaceable class="parameter">Number of retries.</replaceable>
2287    </para>
2288   </listitem>
2289  </varlistentry>
2290  <varlistentry>
2291   <term>Default value:</term>
2292   <listitem>
2293    <para><emphasis>0</emphasis></para>
2294   </listitem>
2295  </varlistentry>
2296  <varlistentry>
2297   <term>Effect if unset:</term>
2298   <listitem>
2299    <para>
2300     Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2301    </para>
2302   </listitem>
2303  </varlistentry>
2304  <varlistentry>
2305   <term>Notes:</term>
2306   <listitem>
2307    <para>
2308     <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2309     for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2310     The connection might have failed because of a DNS timeout in which case a retry makes sense,
2311     but it might also have failed because the server doesn't exist or isn't reachable. In this
2312     case the retry will just delay the appearance of Privoxy's error message.
2313    </para>
2314    <para>
2315     Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2316     that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2317    </para>
2318    <para>
2319     Only use this option, if you are getting lots of forwarding-related error messages
2320     that go away when you try again manually. Start with a small value and check Privoxy's
2321     logfile from time to time, to see how many retries are usually needed.
2322    </para>
2323   </listitem>
2324  </varlistentry>
2325  <varlistentry>
2326   <term>Examples:</term>
2327   <listitem>
2328    <para>
2329     forwarded-connect-retries 1
2330    </para>
2331   </listitem>
2332  </varlistentry>
2333 </variablelist>
2334 <![%config-file;[<literallayout>@@forwarded-connect-retries  0</literallayout>]]>
2335 </sect3>
2336
2337 </sect2>
2338
2339 <sect2 id="misc">
2340 <title>Miscellaneous</title>
2341
2342 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2343 <variablelist>
2344  <varlistentry>
2345   <term>Specifies:</term>
2346   <listitem>
2347    <para>
2348     Whether intercepted requests should be treated as valid.
2349    </para>
2350   </listitem>
2351  </varlistentry>
2352  <varlistentry>
2353   <term>Type of value:</term>
2354   <listitem>
2355    <para>
2356     <replaceable>0 or 1</replaceable>
2357    </para>
2358   </listitem>
2359  </varlistentry>
2360  <varlistentry>
2361   <term>Default value:</term>
2362   <listitem>
2363    <para><emphasis>0</emphasis></para>
2364   </listitem>
2365  </varlistentry>
2366  <varlistentry>
2367   <term>Effect if unset:</term>
2368   <listitem>
2369    <para>
2370     Only proxy requests are accepted, intercepted requests are treated as invalid.
2371    </para>
2372   </listitem>
2373  </varlistentry>
2374  <varlistentry>
2375   <term>Notes:</term>
2376   <listitem>
2377    <para>
2378     If you don't trust your clients and want to force them
2379     to use <application>Privoxy</application>, enable this
2380     option and configure your packet filter to redirect outgoing
2381     HTTP connections into <application>Privoxy</application>.
2382    </para>
2383    <para>
2384     Make sure that <application>Privoxy's</application> own requests
2385     aren't redirected as well. Additionally take care that
2386     <application>Privoxy</application> can't intentionally connect
2387     to itself, otherwise you could run into redirection loops if
2388     <application>Privoxy's</application> listening port is reachable
2389     by the outside or an attacker has access to the pages you visit.
2390    </para>
2391   </listitem>
2392  </varlistentry>
2393  <varlistentry>
2394   <term>Examples:</term>
2395   <listitem>
2396    <para>
2397     accept-intercepted-requests 1
2398    </para>
2399   </listitem>
2400  </varlistentry>
2401 </variablelist>
2402 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2403 </sect3>
2404
2405 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2406 <variablelist>
2407  <varlistentry>
2408   <term>Specifies:</term>
2409   <listitem>
2410    <para>
2411     Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2412    </para>
2413   </listitem>
2414  </varlistentry>
2415  <varlistentry>
2416   <term>Type of value:</term>
2417   <listitem>
2418    <para>
2419     <replaceable>0 or 1</replaceable>
2420    </para>
2421   </listitem>
2422  </varlistentry>
2423  <varlistentry>
2424   <term>Default value:</term>
2425   <listitem>
2426    <para><emphasis>0</emphasis></para>
2427   </listitem>
2428  </varlistentry>
2429  <varlistentry>
2430   <term>Effect if unset:</term>
2431   <listitem>
2432    <para>
2433     <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2434    </para>
2435   </listitem>
2436  </varlistentry>
2437  <varlistentry>
2438   <term>Notes:</term>
2439   <listitem>
2440    <para>
2441     By default <application>Privoxy</application> ignores block or redirect actions
2442     for its CGI pages. Intercepting these requests can be useful in multi-user
2443     setups to implement fine-grained access control, but it can also render the complete
2444     web interface useless and make debugging problems painful if done without care.
2445    </para>
2446    <para>
2447     Don't enable this option unless you're sure that you really need it.
2448    </para>
2449   </listitem>
2450  </varlistentry>
2451  <varlistentry>
2452   <term>Examples:</term>
2453   <listitem>
2454    <para>
2455     allow-cgi-request-crunching 1
2456    </para>
2457   </listitem>
2458  </varlistentry>
2459 </variablelist>
2460 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2461 </sect3>
2462
2463 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2464 <variablelist>
2465  <varlistentry>
2466   <term>Specifies:</term>
2467   <listitem>
2468    <para>
2469     Whether the CGI interface should stay compatible with broken HTTP clients.
2470    </para>
2471   </listitem>
2472  </varlistentry>
2473  <varlistentry>
2474   <term>Type of value:</term>
2475   <listitem>
2476    <para>
2477     <replaceable>0 or 1</replaceable>
2478    </para>
2479   </listitem>
2480  </varlistentry>
2481  <varlistentry>
2482   <term>Default value:</term>
2483   <listitem>
2484    <para><emphasis>0</emphasis></para>
2485   </listitem>
2486  </varlistentry>
2487  <varlistentry>
2488   <term>Effect if unset:</term>
2489   <listitem>
2490    <para>
2491     The CGI form generate long GET URLs.
2492    </para>
2493   </listitem>
2494  </varlistentry>
2495  <varlistentry>
2496   <term>Notes:</term>
2497   <listitem>
2498    <para>
2499     <application>Privoxy's</application> CGI forms can lead to
2500     rather long URLs. This isn't a problem as far as the HTTP
2501     standard is concerned, but it can confuse clients with arbitrary
2502     URL length limitations.
2503    </para>
2504    <para>
2505     Enabling split-large-forms causes <application>Privoxy</application>
2506     to divide big forms into smaller ones to keep the URL length down.
2507     It makes editing a lot less convenient and you can no longer
2508     submit all changes at once, but at least it works around this
2509     browser bug.
2510    </para>
2511    <para>
2512     If you don't notice any editing problems, there is no reason
2513     to enable this option, but if one of the submit buttons appears
2514     to be broken, you should give it a try.
2515    </para>
2516   </listitem>
2517  </varlistentry>
2518  <varlistentry>
2519   <term>Examples:</term>
2520   <listitem>
2521    <para>
2522     split-large-forms 1
2523    </para>
2524   </listitem>
2525  </varlistentry>
2526 </variablelist>
2527 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2528 </sect3>
2529
2530 <sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
2531 <variablelist>
2532  <varlistentry>
2533   <term>Specifies:</term>
2534   <listitem>
2535    <para>
2536     Number of seconds after which an open connection will no longer be reused.
2537    </para>
2538   </listitem>
2539  </varlistentry>
2540  <varlistentry>
2541   <term>Type of value:</term>
2542   <listitem>
2543    <para>
2544     <replaceable>Time in seconds.</replaceable>
2545    </para>
2546   </listitem>
2547  </varlistentry>
2548  <varlistentry>
2549   <term>Default value:</term>
2550   <listitem>
2551    <para>None</para>
2552   </listitem>
2553  </varlistentry>
2554  <varlistentry>
2555   <term>Effect if unset:</term>
2556   <listitem>
2557    <para>
2558     Connections are not kept alive.
2559    </para>
2560   </listitem>
2561  </varlistentry>
2562  <varlistentry>
2563   <term>Notes:</term>
2564   <listitem>
2565    <para>
2566     This option allows clients to keep the connection to &my-app;
2567     alive. If the server supports it, &my-app; will keep
2568     the connection to the server alive as well. Under certain
2569     circumstances this may result in speed-ups.
2570    </para>
2571    <para>
2572     By default, &my-app; will close the connection to the server if
2573     the client connection gets closed, or if the specified timeout
2574     has been reached without a new request coming in. This behaviour
2575     can be changed with the <ulink
2576      url="#CONNECTION-SHARING">connection-sharing</ulink> option.
2577    </para>
2578    <para>
2579     This option has no effect if <application>Privoxy</application>
2580     has been compiled without keep-alive support.
2581    </para>
2582    <para>
2583     Note that a timeout of five seconds as used in the default
2584     configuration file significantly decreases the number of
2585     connections that will be reused. The value is used because
2586     some browsers limit the number of connections they open to
2587     a single host and apply the same limit to proxies. This can
2588     result in a single website <quote>grabbing</quote> all the
2589     connections the browser allows, which means connections to
2590     other websites can't be opened until the connections currently
2591     in use time out.
2592    </para>
2593    <para>
2594     Several users have reported this as a Privoxy bug, so the
2595     default value has been reduced. Consider increasing it to
2596     300 seconds or even more if you think your browser can handle
2597     it. If your browser appears to be hanging it can't.
2598    </para>
2599   </listitem>
2600  </varlistentry>
2601  <varlistentry>
2602   <term>Examples:</term>
2603   <listitem>
2604    <para>
2605     keep-alive-timeout 300
2606    </para>
2607   </listitem>
2608  </varlistentry>
2609 </variablelist>
2610 <![%config-file;[<literallayout>@@keep-alive-timeout 5</literallayout>]]>
2611 </sect3>
2612
2613
2614 <sect3 renderas="sect4" id="default-server-timeout"><title>default-server-timeout</title>
2615 <variablelist>
2616  <varlistentry>
2617   <term>Specifies:</term>
2618   <listitem>
2619    <para>
2620     Assumed server-side keep-alive timeout if not specified by the server.
2621    </para>
2622   </listitem>
2623  </varlistentry>
2624  <varlistentry>
2625   <term>Type of value:</term>
2626   <listitem>
2627    <para>
2628     <replaceable>Time in seconds.</replaceable>
2629    </para>
2630   </listitem>
2631  </varlistentry>
2632  <varlistentry>
2633   <term>Default value:</term>
2634   <listitem>
2635    <para>None</para>
2636   </listitem>
2637  </varlistentry>
2638  <varlistentry>
2639   <term>Effect if unset:</term>
2640   <listitem>
2641    <para>
2642     Connections for which the server didn't specify the keep-alive
2643     timeout are not reused.
2644    </para>
2645   </listitem>
2646  </varlistentry>
2647  <varlistentry>
2648   <term>Notes:</term>
2649   <listitem>
2650    <para>
2651     Enabling this option significantly increases the number of connections
2652     that are reused, provided the <ulink
2653      url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> option
2654     is also enabled.
2655    </para>
2656    <para>
2657     While it also increases the number of connections problems
2658     when &my-app; tries to reuse a connection that already has
2659     been closed on the server side, or is closed while &my-app;
2660     is trying to reuse it, this should only be a problem if it
2661     happens for the first request sent by the client. If it happens
2662     for requests on reused client connections, &my-app; will simply
2663     close the connection and the client is supposed to retry the
2664     request without bothering the user.
2665    </para>
2666    <para>
2667     Enabling this option is therefore only recommended if the
2668     <ulink
2669      url="#CONNECTION-SHARING">connection-sharing</ulink> option
2670     is disabled.
2671    </para>
2672    <para>
2673     It is an error to specify a value larger than the <ulink
2674      url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> value.
2675    </para>
2676    <para>
2677     This option has no effect if <application>Privoxy</application>
2678     has been compiled without keep-alive support.
2679    </para>
2680   </listitem>
2681  </varlistentry>
2682  <varlistentry>
2683   <term>Examples:</term>
2684   <listitem>
2685    <para>
2686     default-server-timeout 60
2687    </para>
2688   </listitem>
2689  </varlistentry>
2690 </variablelist>
2691 <![%config-file;[<literallayout>@@#default-server-timeout 60</literallayout>]]>
2692 </sect3>
2693
2694
2695 <sect3 renderas="sect4" id="connection-sharing"><title>connection-sharing</title>
2696 <variablelist>
2697  <varlistentry>
2698   <term>Specifies:</term>
2699   <listitem>
2700    <para>
2701     Whether or not outgoing connections that have been kept alive
2702     should be shared between different incoming connections.
2703    </para>
2704   </listitem>
2705  </varlistentry>
2706  <varlistentry>
2707   <term>Type of value:</term>
2708   <listitem>
2709    <para>
2710     <replaceable>0 or 1</replaceable>
2711    </para>
2712   </listitem>
2713  </varlistentry>
2714  <varlistentry>
2715   <term>Default value:</term>
2716   <listitem>
2717    <para>None</para>
2718   </listitem>
2719  </varlistentry>
2720  <varlistentry>
2721   <term>Effect if unset:</term>
2722   <listitem>
2723    <para>
2724     Connections are not shared.
2725    </para>
2726   </listitem>
2727  </varlistentry>
2728  <varlistentry>
2729   <term>Notes:</term>
2730   <listitem>
2731    <para>
2732     This option has no effect if <application>Privoxy</application>
2733     has been compiled without keep-alive support, or if it's disabled.
2734    </para>
2735   </listitem>
2736  </varlistentry>
2737  <varlistentry>
2738   <term>Notes:</term>
2739   <listitem>
2740    <para>
2741     Note that reusing connections doesn't necessary cause speedups.
2742     There are also a few privacy implications you should be aware of.
2743    </para>
2744    <para>
2745     If this option is effective, outgoing connections are shared between
2746     clients (if there are more than one) and closing the browser that initiated
2747     the outgoing connection does no longer affect the connection between &my-app;
2748     and the server unless the client's request hasn't been completed yet.
2749    </para>
2750    <para>
2751     If the outgoing connection  is idle, it will not be closed until either
2752     <application>Privoxy's</application> or the server's timeout is reached.
2753     While it's open, the server knows that the system running &my-app; is still
2754     there.
2755    </para>
2756    <para>
2757     If there are more than one client (maybe even belonging to multiple users),
2758     they will be able to reuse each others connections. This is potentially
2759     dangerous in case of authentication schemes like NTLM where only the
2760     connection is authenticated, instead of requiring authentication for
2761     each request.
2762    </para>
2763    <para>
2764     If there is only a single client, and if said client can keep connections
2765     alive on its own, enabling this option has next to no effect. If the client
2766     doesn't support connection keep-alive, enabling this option may make sense
2767     as it allows &my-app; to keep outgoing connections alive even if the client
2768     itself doesn't support it.
2769    </para>
2770    <para>
2771     You should also be aware that enabling this option increases the likelihood
2772     of getting the "No server or forwarder data" error message, especially if you
2773     are using a slow connection to the Internet.
2774    </para>
2775    <para>
2776     This option should only be used by experienced users who
2777     understand the risks and can weight them against the benefits.
2778    </para>
2779   </listitem>
2780  </varlistentry>
2781  <varlistentry>
2782   <term>Examples:</term>
2783   <listitem>
2784    <para>
2785     connection-sharing 1
2786    </para>
2787   </listitem>
2788  </varlistentry>
2789 </variablelist>
2790 <![%config-file;[<literallayout>@@#connection-sharing 1</literallayout>]]>
2791 </sect3>
2792
2793
2794 <sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
2795 <variablelist>
2796  <varlistentry>
2797   <term>Specifies:</term>
2798   <listitem>
2799    <para>
2800     Number of seconds after which a socket times out if
2801     no data is received.
2802    </para>
2803   </listitem>
2804  </varlistentry>
2805  <varlistentry>
2806   <term>Type of value:</term>
2807   <listitem>
2808    <para>
2809     <replaceable>Time in seconds.</replaceable>
2810    </para>
2811   </listitem>
2812  </varlistentry>
2813  <varlistentry>
2814   <term>Default value:</term>
2815   <listitem>
2816    <para>None</para>
2817   </listitem>
2818  </varlistentry>
2819  <varlistentry>
2820   <term>Effect if unset:</term>
2821   <listitem>
2822    <para>
2823     A default value of 300 seconds is used.
2824    </para>
2825   </listitem>
2826  </varlistentry>
2827  <varlistentry>
2828   <term>Notes:</term>
2829   <listitem>
2830    <para>
2831     The default is quite high and you probably want to reduce it.
2832     If you aren't using an occasionally slow proxy like Tor, reducing
2833     it to a few seconds should be fine.
2834    </para>
2835   </listitem>
2836  </varlistentry>
2837  <varlistentry>
2838   <term>Examples:</term>
2839   <listitem>
2840    <para>
2841     socket-timeout 300
2842    </para>
2843   </listitem>
2844  </varlistentry>
2845 </variablelist>
2846 <![%config-file;[<literallayout>@@socket-timeout 300</literallayout>]]>
2847 </sect3>
2848
2849
2850 <sect3 renderas="sect4" id="max-client-connections"><title>max-client-connections</title>
2851 <variablelist>
2852  <varlistentry>
2853   <term>Specifies:</term>
2854   <listitem>
2855    <para>
2856     Maximum number of client connections that will be served.
2857    </para>
2858   </listitem>
2859  </varlistentry>
2860  <varlistentry>
2861   <term>Type of value:</term>
2862   <listitem>
2863    <para>
2864     <replaceable>Positive number.</replaceable>
2865    </para>
2866   </listitem>
2867  </varlistentry>
2868  <varlistentry>
2869   <term>Default value:</term>
2870   <listitem>
2871    <para>None</para>
2872   </listitem>
2873  </varlistentry>
2874  <varlistentry>
2875   <term>Effect if unset:</term>
2876   <listitem>
2877    <para>
2878     Connections are served until a resource limit is reached.
2879    </para>
2880   </listitem>
2881  </varlistentry>
2882  <varlistentry>
2883   <term>Notes:</term>
2884   <listitem>
2885    <para>
2886     &my-app; creates one thread (or process) for every incoming client
2887     connection that isn't rejected based on the access control settings.
2888    </para>
2889    <para>
2890     If the system is powerful enough, &my-app; can theoretically deal with
2891     several hundred (or thousand) connections at the same time, but some
2892     operating systems enforce resource limits by shutting down offending
2893     processes and their default limits may be below the ones &my-app; would
2894     require under heavy load.
2895    </para>
2896    <para>
2897     Configuring &my-app; to enforce a connection limit below the thread
2898     or process limit used by the operating system makes sure this doesn't
2899     happen. Simply increasing the operating system's limit would work too,
2900     but if &my-app; isn't the only application running on the system,
2901     you may actually want to limit the resources used by &my-app;.
2902    </para>
2903    <para>
2904     If &my-app; is only used by a single trusted user, limiting the
2905     number of client connections is probably unnecessary. If there
2906     are multiple possibly untrusted users you probably still want to
2907     additionally use a packet filter to limit the maximal number of
2908     incoming connections per client. Otherwise a malicious user could
2909     intentionally create a high number of connections to prevent other
2910     users from using &my-app;.
2911    </para>
2912    <para>
2913     Obviously using this option only makes sense if you choose a limit
2914     below the one enforced by the operating system.
2915    </para>
2916   </listitem>
2917  </varlistentry>
2918  <varlistentry>
2919   <term>Examples:</term>
2920   <listitem>
2921    <para>
2922     max-client-connections 256
2923    </para>
2924   </listitem>
2925  </varlistentry>
2926 </variablelist>
2927 <![%config-file;[<literallayout>@@#max-client-connections 256</literallayout>]]>
2928 </sect3>
2929
2930
2931 <sect3 renderas="sect4" id="handle-as-empty-doc-returns-ok"><title>handle-as-empty-doc-returns-ok</title>
2932 <variablelist>
2933  <varlistentry>
2934   <term>Specifies:</term>
2935   <listitem>
2936    <para>
2937     The status code Privoxy returns for pages blocked with
2938     <!--  URL will only end up in the user manual so the relative link should work. -->
2939     <literal><ulink url="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">+handle-as-empty-document</ulink></literal>.
2940    </para>
2941   </listitem>
2942  </varlistentry>
2943  <varlistentry>
2944   <term>Type of value:</term>
2945   <listitem>
2946    <para>
2947     <replaceable>0 or 1</replaceable>
2948    </para>
2949   </listitem>
2950  </varlistentry>
2951  <varlistentry>
2952   <term>Default value:</term>
2953   <listitem>
2954    <para>0</para>
2955   </listitem>
2956  </varlistentry>
2957  <varlistentry>
2958   <term>Effect if unset:</term>
2959   <listitem>
2960    <para>
2961     Privoxy returns a status 403(forbidden) for all blocked pages.
2962    </para>
2963   </listitem>
2964  </varlistentry>
2965  <varlistentry>
2966   <term>Effect if set:</term>
2967   <listitem>
2968    <para>
2969     Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
2970     and a status 403(Forbidden) for all other blocked pages.
2971    </para>
2972   </listitem>
2973  </varlistentry>
2974  <varlistentry>
2975   <term>Notes:</term>
2976   <listitem>
2977    <para>
2978     This is a work-around for Firefox bug 492459:
2979     <quote>
2980     Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.
2981     </quote>
2982     (<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
2983         >https://bugzilla.mozilla.org/show_bug.cgi?id=492459</ulink>)
2984     As the bug has been fixed for quite some time this option should no longer
2985     be needed and will be removed in a future release. Please speak up if you
2986     have a reason why the option should be kept around.
2987    </para>
2988   </listitem>
2989  </varlistentry>
2990 </variablelist>
2991 <![%config-file;[<literallayout>@@#handle-as-empty-doc-returns-ok 1</literallayout>]]>
2992 </sect3>
2993
2994
2995 <sect3 renderas="sect4" id="enable-compression"><title>enable-compression</title>
2996 <variablelist>
2997  <varlistentry>
2998   <term>Specifies:</term>
2999   <listitem>
3000    <para>
3001     Whether or not buffered content is compressed before delivery.
3002    </para>
3003   </listitem>
3004  </varlistentry>
3005  <varlistentry>
3006   <term>Type of value:</term>
3007   <listitem>
3008    <para>
3009     <replaceable>0 or 1</replaceable>
3010    </para>
3011   </listitem>
3012  </varlistentry>
3013  <varlistentry>
3014   <term>Default value:</term>
3015   <listitem>
3016    <para>0</para>
3017   </listitem>
3018  </varlistentry>
3019  <varlistentry>
3020   <term>Effect if unset:</term>
3021   <listitem>
3022    <para>
3023     Privoxy does not compress buffered content.
3024    </para>
3025   </listitem>
3026  </varlistentry>
3027  <varlistentry>
3028   <term>Effect if set:</term>
3029   <listitem>
3030    <para>
3031     Privoxy compresses buffered content before delivering it to the client,
3032     provided the client supports it.
3033    </para>
3034   </listitem>
3035  </varlistentry>
3036  <varlistentry>
3037   <term>Notes:</term>
3038   <listitem>
3039    <para>
3040     This directive is only supported if Privoxy has been compiled with
3041     FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB.
3042    </para>
3043    <para>
3044     Compressing buffered content is mainly useful if Privoxy and the
3045     client are running on different systems. If they are running on the
3046     same system, enabling compression is likely to slow things down.
3047     If you didn't measure otherwise, you should assume that it does
3048     and keep this option disabled.
3049    </para>
3050    <para>
3051     Privoxy will not compress buffered content below a certain length.
3052    </para>
3053   </listitem>
3054  </varlistentry>
3055 </variablelist>
3056 <![%config-file;[<literallayout>@@#enable-compression 1</literallayout>]]>
3057 </sect3>
3058
3059
3060 <sect3 renderas="sect4" id="compression-level"><title>compression-level</title>
3061 <variablelist>
3062  <varlistentry>
3063   <term>Specifies:</term>
3064   <listitem>
3065    <para>
3066     The compression level that is passed to the zlib library when compressing buffered content.
3067    </para>
3068   </listitem>
3069  </varlistentry>
3070  <varlistentry>
3071   <term>Type of value:</term>
3072   <listitem>
3073    <para>
3074     <replaceable>Positive number ranging from 0 to 9.</replaceable>
3075    </para>
3076   </listitem>
3077  </varlistentry>
3078  <varlistentry>
3079   <term>Default value:</term>
3080   <listitem>
3081    <para>1</para>
3082   </listitem>
3083  </varlistentry>
3084  <varlistentry>
3085   <term>Notes:</term>
3086   <listitem>
3087    <para>
3088      Compressing the data more takes usually longer than compressing
3089      it less or not compressing it at all. Which level is best depends
3090      on the connection between Privoxy and the client. If you can't
3091      be bothered to benchmark it for yourself, you should stick with
3092      the default and keep compression disabled.
3093    </para>
3094    <para>
3095      If compression is disabled, the compression level is irrelevant.
3096    </para>
3097   </listitem>
3098  </varlistentry>
3099  <varlistentry>
3100   <term>Examples:</term>
3101   <listitem>
3102    <para>
3103     <screen>
3104     # Best speed (compared to the other levels)
3105     compression-level 1
3106     # Best compression
3107     compression-level 9
3108     # No compression. Only useful for testing as the added header
3109     # slightly increases the amount of data that has to be sent.
3110     # If your benchmark shows that using this compression level
3111     # is superior to using no compression at all, the benchmark
3112     # is likely to be flawed.
3113     compression-level 0
3114     </screen>
3115    </para>
3116   </listitem>
3117  </varlistentry>
3118 </variablelist>
3119 <![%config-file;[<literallayout>@@#compression-level 1</literallayout>]]>
3120 </sect3>
3121
3122
3123 </sect2>
3124
3125 <!--  ~  End section  ~  -->
3126
3127
3128 <!--   ~~~~~       New section      ~~~~~     -->
3129
3130 <sect2 id="windows-gui">
3131 <title>Windows GUI Options</title>
3132 <para>
3133  <application>Privoxy</application> has a number of options specific to the
3134  Windows GUI interface:
3135 </para>
3136
3137 <anchor id="activity-animation">
3138 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3139 <para>
3140  If <quote>activity-animation</quote> is set to 1, the
3141  <application>Privoxy</application> icon will animate when
3142  <quote>Privoxy</quote> is active. To turn off, set to 0.
3143 </para>
3144
3145 <![%config-file;[<literallayout>@@#activity-animation   1</literallayout>]]>
3146 <![%user-man;[
3147 <para>
3148  <literal>
3149   <msgtext>
3150    <literallayout>
3151   <emphasis>activity-animation   1</emphasis>
3152    </literallayout>
3153   </msgtext>
3154  </literal>
3155 </para>
3156 ]]>
3157
3158 <anchor id="log-messages">
3159 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3160 <para>
3161  If <quote>log-messages</quote> is set to 1,
3162  <application>Privoxy</application> will log messages to the console
3163  window:
3164 </para>
3165
3166 <![%config-file;[<literallayout>@@#log-messages   1</literallayout>]]>
3167 <![%user-man;[
3168 <para>
3169  <literal>
3170   <msgtext>
3171    <literallayout>
3172   <emphasis>log-messages       1</emphasis>
3173    </literallayout>
3174   </msgtext>
3175  </literal>
3176 </para>
3177 ]]>
3178
3179 <anchor id="log-buffer-size">
3180 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3181 <para>
3182  If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
3183  i.e. the amount of memory used for the log messages displayed in the
3184  console window, will be limited to <quote>log-max-lines</quote> (see below).
3185 </para>
3186
3187 <para>
3188  Warning: Setting this to 0 will result in the buffer to grow infinitely and
3189  eat up all your memory!
3190 </para>
3191
3192 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
3193 <![%user-man;[
3194 <para>
3195  <literal>
3196   <msgtext>
3197    <literallayout>
3198   <emphasis>log-buffer-size      1</emphasis>
3199    </literallayout>
3200   </msgtext>
3201  </literal>
3202 </para>
3203 ]]>
3204
3205 <anchor id="log-max-lines">
3206 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3207 <para>
3208  <application>log-max-lines</application> is the maximum number of lines held
3209  in the log buffer. See above.
3210 </para>
3211
3212 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
3213 <![%user-man;[
3214 <para>
3215  <literal>
3216   <msgtext>
3217    <literallayout>
3218   <emphasis>log-max-lines      200</emphasis>
3219    </literallayout>
3220   </msgtext>
3221  </literal>
3222 </para>
3223 ]]>
3224
3225 <anchor id="log-highlight-messages">
3226 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3227 <para>
3228  If <quote>log-highlight-messages</quote> is set to 1,
3229  <application>Privoxy</application> will highlight portions of the log
3230  messages with a bold-faced font:
3231 </para>
3232
3233 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
3234 <![%user-man;[
3235 <para>
3236  <literal>
3237   <msgtext>
3238    <literallayout>
3239   <emphasis>log-highlight-messages   1</emphasis>
3240    </literallayout>
3241   </msgtext>
3242  </literal>
3243 </para>
3244 ]]>
3245
3246 <anchor id="log-font-name">
3247 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3248 <para>
3249  The font used in the console window:
3250 </para>
3251
3252 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
3253 <![%user-man;[
3254 <para>
3255  <literal>
3256   <msgtext>
3257    <literallayout>
3258   <emphasis>log-font-name        Comic Sans MS</emphasis>
3259    </literallayout>
3260   </msgtext>
3261  </literal>
3262 </para>
3263 ]]>
3264
3265 <anchor id="log-font-size">
3266 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3267 <para>
3268  Font size used in the console window:
3269 </para>
3270
3271 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
3272 <![%user-man;[
3273 <para>
3274  <literal>
3275   <msgtext>
3276    <literallayout>
3277   <emphasis>log-font-size        8</emphasis>
3278    </literallayout>
3279   </msgtext>
3280  </literal>
3281 </para>
3282 ]]>
3283
3284 <anchor id="show-on-task-bar">
3285 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3286 <para>
3287  <quote>show-on-task-bar</quote> controls whether or not
3288  <application>Privoxy</application> will appear as a button on the Task bar
3289  when minimized:
3290 </para>
3291
3292 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
3293 <![%user-man;[
3294 <para>
3295  <literal>
3296   <msgtext>
3297    <literallayout>
3298   <emphasis>show-on-task-bar     0</emphasis>
3299    </literallayout>
3300   </msgtext>
3301  </literal>
3302 </para>
3303 ]]>
3304
3305 <anchor id="close-button-minimizes">
3306 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3307 <para>
3308  If <quote>close-button-minimizes</quote> is set to 1, the Windows close
3309  button will minimize <application>Privoxy</application> instead of closing
3310  the program (close with the exit option on the File menu).
3311 </para>
3312
3313 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
3314 <![%user-man;[
3315 <para>
3316  <literal>
3317   <msgtext>
3318    <literallayout>
3319   <emphasis>close-button-minimizes  1</emphasis>
3320    </literallayout>
3321   </msgtext>
3322  </literal>
3323 </para>
3324 ]]>
3325
3326 <anchor id="hide-console">
3327 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3328 <para>
3329  The <quote>hide-console</quote> option is specific to the MS-Win console
3330  version of <application>Privoxy</application>. If this option is used,
3331  <application>Privoxy</application> will disconnect from and hide the
3332  command console.
3333 </para>
3334
3335 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
3336 <![%user-man;[
3337 <para>
3338  <literal>
3339   <msgtext>
3340    <literallayout>
3341   #<emphasis>hide-console</emphasis>
3342    </literallayout>
3343   </msgtext>
3344  </literal>
3345 </para>
3346 ]]>
3347
3348 </sect2>
3349 </sect1>
3350
3351 <!-- end config content common to both outputs -->
3352
3353 <![%config-file;[
3354 <!-- These are dummy anchors to keep the processor quiet            -->
3355 <!-- when building config-file only (ie. they are used in u-m only) -->
3356 <sect1 label="">
3357 <title></title>
3358 <anchor id="filter">
3359 <anchor id="filter-file">
3360 <anchor id="regex">
3361 <anchor id="actions-file">
3362 <anchor id="af-patterns">
3363 </sect1>
3364 ]]>
3365
3366 <!-- eof p-config.sgml -->