2 File : $Source: /cvsroot/ijbswa/current/doc/source/p-config.sgml,v $
4 Purpose : Used with other docs and files only.
6 $Id: p-config.sgml,v 2.99 2013/03/07 14:10:34 fabiankeil Exp $
8 Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/
11 ========================================================================
12 NOTE: Please read developer-manual/documentation.html before touching
13 anything in this, or other Privoxy documentation.
14 ========================================================================
17 This file contains all the config file comments and options. It used to
18 build both the user-manual config sections, and all of config (yes, the main
21 Rationale: This is broken up into two files since a file with a prolog
22 (DTD, etc) cannot be sourced as a secondary file. config.sgml is basically
23 a wrapper for this file.
27 OPTIONS: The actual options are included in this file and prefixed with
28 '@@', and processed by the Makefile to strip the '@@'. Default options
29 that should appear commented out should be listed as: '@@#OPTION'.
30 Otherwise, as '@@OPTION'. Example:
32 @@listen-address 127.0.0.1:8118
34 The Makefile does significant other processing too. The final results
35 should be checked to make sure that the perl processing does not
36 fubar something!!! Makefile processing requires w3m, fmt (shell line
40 This file is included into:
43 config (the actual Privoxy config file)
48 <!-- This part only goes into user-manual -->
50 <title>The Main Configuration File</title>
53 By default, the main configuration file is named <filename>config</filename>,
54 with the exception of Windows, where it is named <filename>config.txt</filename>.
55 Configuration lines consist of an initial keyword followed by a list of
56 values, all separated by whitespace (any number of spaces or tabs). For
64 <emphasis>confdir /etc/privoxy</emphasis></literallayout>
70 Assigns the value <literal>/etc/privoxy</literal> to the option
71 <literal>confdir</literal> and thus indicates that the configuration
72 directory is named <quote>/etc/privoxy/</quote>.
76 All options in the config file except for <literal>confdir</literal> and
77 <literal>logdir</literal> are optional. Watch out in the below description
78 for what happens if you leave them unset.
82 The main config file controls all aspects of <application>Privoxy</application>'s
83 operation that are not location dependent (i.e. they apply universally, no matter
84 where you may be surfing). Like the filter and action files, the config file is
85 a plain text file and can be modified with a text editor like emacs, vim or
93 <!-- This part only goes into the config file -->
96 @@TITLE<!-- between the @@ is stripped by Makefile -->@@
97 Sample Configuration File for Privoxy &p-version;
100 $Id: p-config.sgml,v 2.99 2013/03/07 14:10:34 fabiankeil Exp $
103 Copyright (C) 2001-2013 Privoxy Developers http://www.privoxy.org/
108 #################################################################
113 II. FORMAT OF THE CONFIGURATION FILE #
115 1. LOCAL SET-UP DOCUMENTATION #
116 2. CONFIGURATION AND LOG FILE LOCATIONS #
118 4. ACCESS CONTROL AND SECURITY #
121 7. WINDOWS GUI OPTIONS #
123 #################################################################
127 <literallayout>I. INTRODUCTION
128 =============== <!-- fuck this madness --></literallayout>
131 This file holds Privoxy's main configuration. Privoxy detects
132 configuration changes automatically, so you don't have to restart it
133 unless you want to load a different configuration file.
136 The configuration will be reloaded with the first request after the
137 change was done, this request itself will still use the old configuration,
138 though. In other words: it takes two requests before you see the result of
139 your changes. Requests that are dropped due to ACL don't trigger reloads.
142 When starting Privoxy on Unix systems, give the location of this
143 file as last argument. On Windows systems, Privoxy will look for
144 this file with the name 'config.txt' in the current working directory
145 of the Privoxy process.
149 <literallayout><!-- funky spacing -->
151 II. FORMAT OF THE CONFIGURATION FILE
152 ====================================</literallayout>
155 Configuration lines consist of an initial keyword followed by a list
156 of values, all separated by whitespace (any number of spaces or
160 actionsfile default.action
163 Indicates that the actionsfile is named 'default.action'.
166 The '#' indicates a comment. Any part of a line following a '#' is
167 ignored, except if the '#' is preceded by a '\'.
170 Thus, by placing a # at the start of an existing configuration line,
171 you can make it a comment and it will be treated as if it weren't there.
172 This is called "commenting out" an option and can be useful. Removing
173 the # again is called "uncommenting".
176 Note that commenting out an option and leaving it at its default
177 are two completely different things! Most options behave very
178 differently when unset. See the "Effect if unset" explanation
179 in each option's description for details.
182 Long lines can be continued on the next line by using a `\' as
188 <!-- ************************************************ -->
189 <!-- The following is common to both outputs (mostly) -->
190 <!-- ************************************************ -->
194 <!-- ~~~~~ New section ~~~~~ -->
195 <sect2 id="local-set-up">
196 <title>Local Set-up Documentation</title>
199 If you intend to operate <application>Privoxy</application> for more users
200 than just yourself, it might be a good idea to let them know how to reach
201 you, what you block and why you do that, your policies, etc.
205 <!-- ~~~~~ New section ~~~~~ -->
206 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
209 <term>Specifies:</term>
212 Location of the <application>Privoxy</application> User Manual.
217 <term>Type of value:</term>
219 <para>A fully qualified URI</para>
223 <term>Default value:</term>
225 <para><emphasis>Unset</emphasis></para>
229 <term>Effect if unset:</term>
232 <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/<replaceable class="parameter">version</replaceable>/user-manual/</ulink>
233 will be used, where <replaceable class="parameter">version</replaceable> is the <application>Privoxy</application> version.
241 The User Manual URI is the single best source of information on
242 <application>Privoxy</application>, and is used for help links from some
243 of the internal CGI pages. The manual itself is normally packaged with the
244 binary distributions, so you probably want to set this to a locally
252 Unix, in local filesystem (may not work with all browsers):
255 <screen> user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
258 Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
261 <screen> user-manual file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
264 Windows, UNC notation (with forward slashes):
267 <screen> user-manual file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
271 The best all purpose solution is simply to put the full local
272 <literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
276 <screen> user-manual /usr/share/doc/privoxy/user-manual</screen>
279 The User Manual is then available to anyone with access to
280 <application>Privoxy</application>, by following the built-in URL:
281 <literal>http://config.privoxy.org/user-manual/</literal>
282 (or the shortcut: <literal>http://p.p/user-manual/</literal>).
285 If the documentation is not on the local system, it can be accessed
286 from a remote server, as:
289 <screen> user-manual http://example.com/privoxy/user-manual/</screen>
292 <!-- this gets hammered in conversion to config. Text repeated below. -->
295 If set, this option should be <emphasis>the first option in the config
296 file</emphasis>, because it is used while the config file is being read
309 If set, this option should be the first option in the config
310 file, because it is used while the config file is being read.
319 <![%config-file;[<literallayout>@@#user-manual http://www.privoxy.org/user-manual/</literallayout>]]>
323 <!-- ~~~~~ New section ~~~~~ -->
324 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
328 <term>Specifies:</term>
331 A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
336 <term>Type of value:</term>
342 <term>Default value:</term>
344 <para><emphasis>Unset</emphasis></para>
348 <term>Effect if unset:</term>
351 No links are displayed on the "untrusted" error page.
359 The value of this option only matters if the experimental trust mechanism has been
360 activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> below.)
363 If you use the trust mechanism, it is a good idea to write up some on-line
364 documentation about your trust policy and to specify the URL(s) here.
365 Use multiple times for multiple URLs.
368 The URL(s) should be added to the trustfile as well, so users don't end up
369 locked out from the information on why they were locked out in the first place!
375 <![%config-file;[<literallayout>@@#trust-info-url http://www.example.com/why_we_block.html</literallayout>]]>
376 <![%config-file;[<literallayout>@@#trust-info-url http://www.example.com/what_we_allow.html</literallayout>]]>
380 <!-- ~~~~~ New section ~~~~~ -->
381 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
385 <term>Specifies:</term>
388 An email address to reach the <application>Privoxy</application> administrator.
393 <term>Type of value:</term>
395 <para>Email address</para>
399 <term>Default value:</term>
401 <para><emphasis>Unset</emphasis></para>
405 <term>Effect if unset:</term>
408 No email address is displayed on error pages and the CGI user interface.
416 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
417 are unset, the whole "Local Privoxy Support" box on all generated pages will
424 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
428 <!-- ~~~~~ New section ~~~~~ -->
429 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
433 <term>Specifies:</term>
436 A URL to documentation about the local <application>Privoxy</application> setup,
437 configuration or policies.
442 <term>Type of value:</term>
448 <term>Default value:</term>
450 <para><emphasis>Unset</emphasis></para>
454 <term>Effect if unset:</term>
457 No link to local documentation is displayed on error pages and the CGI user interface.
465 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
466 are unset, the whole "Local Privoxy Support" box on all generated pages will
470 This URL shouldn't be blocked ;-)
476 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
480 <!-- ~ End section ~ -->
484 <!-- ~~~~~ New section ~~~~~ -->
486 <sect2 id="conf-log-loc">
487 <title>Configuration and Log File Locations</title>
490 <application>Privoxy</application> can (and normally does) use a number of
491 other files for additional configuration, help and logging.
492 This section of the configuration file tells <application>Privoxy</application>
493 where to find those other files.
497 The user running <application>Privoxy</application>, must have read
498 permission for all configuration files, and write permission to any files
499 that would be modified, such as log files and actions files.
503 <!-- ~~~~~ New section ~~~~~ -->
504 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
508 <term>Specifies:</term>
510 <para>The directory where the other configuration files are located.</para>
514 <term>Type of value:</term>
516 <para>Path name</para>
520 <term>Default value:</term>
522 <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
526 <term>Effect if unset:</term>
528 <para><emphasis>Mandatory</emphasis></para>
535 No trailing <quote><literal>/</literal></quote>, please.
538 This is really outdated and not likely to happen. HB 09/20/06
540 When development goes modular and multi-user, the blocker, filter, and
541 per-user config will be stored in subdirectories of <quote>confdir</quote>.
542 For now, the configuration directory structure is flat, except for
543 <filename>confdir/templates</filename>, where the HTML templates for CGI
544 output reside (e.g. <application>Privoxy's</application> 404 error page).
551 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
554 <!-- ~~~~~ New section ~~~~~ -->
555 <sect3 renderas="sect4" id="templdir"><title>templdir</title>
559 <term>Specifies:</term>
561 <para>An alternative directory where the templates are loaded from.</para>
565 <term>Type of value:</term>
567 <para>Path name</para>
571 <term>Default value:</term>
577 <term>Effect if unset:</term>
579 <para>The templates are assumed to be located in confdir/template.</para>
586 <application>Privoxy's</application> original templates are usually
587 overwritten with each update. Use this option to relocate customized
588 templates that should be kept. As template variables might change
589 between updates, you shouldn't expect templates to work with
590 <application>Privoxy</application> releases other than the one
591 they were part of, though.
597 <![%config-file;[<literallayout>@@#templdir .</literallayout>]]>
601 <!-- ~~~~~ New section ~~~~~ -->
602 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
606 <term>Specifies:</term>
609 The directory where all logging takes place
610 (i.e. where the <filename>logfile</filename> is located).
615 <term>Type of value:</term>
617 <para>Path name</para>
621 <term>Default value:</term>
623 <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
627 <term>Effect if unset:</term>
629 <para><emphasis>Mandatory</emphasis></para>
636 No trailing <quote><literal>/</literal></quote>, please.
642 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
646 <!-- ~~~~~ New section ~~~~~ -->
647 <sect3 renderas="sect4" id="actionsfile"><title>
650 <anchor id="default.action">
651 <anchor id="standard.action">
652 <anchor id="user.action">
653 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
656 <term>Specifies:</term>
659 The <link linkend="actions-file">actions file(s)</link> to use
664 <term>Type of value:</term>
666 <para>Complete file name, relative to <literal>confdir</literal></para>
670 <term>Default values:</term>
674 <msgtext><literallayout> match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout></msgtext>
677 <msgtext><literallayout> default.action # Main actions file</literallayout></msgtext>
680 <msgtext><literallayout> user.action # User customizations</literallayout></msgtext>
686 <term>Effect if unset:</term>
689 No actions are taken at all. More or less neutral proxying.
697 Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
700 The default values are <filename>default.action</filename>, which is the
701 <quote>main</quote> actions file maintained by the developers, and
702 <filename>user.action</filename>, where you can make your personal additions.
705 Actions files contain all the per site and per URL configuration for
706 ad blocking, cookie management, privacy considerations, etc.
707 There is no point in using <application>Privoxy</application> without at
708 least one actions file.
711 Note that since Privoxy 3.0.7, the complete filename, including the <quote>.action</quote>
712 extension has to be specified. The syntax change was necessary to be consistent
713 with the other file options and to allow previously forbidden characters.
719 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
720 <!-- html -> text conversion, blah -->
721 <![%config-file;[<literallayout>@@actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout>]]>
722 <![%config-file;[<literallayout>@@actionsfile default.action # Main actions file</literallayout>]]>
724 XXX: Like user.filter, user.action should probably be commented out
725 by default as not all packages install it into the default directory.
728 <![%config-file;[<literallayout>@@actionsfile user.action # User customizations</literallayout>]]>
731 <!-- ~~~~~ New section ~~~~~ -->
732 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
733 <anchor id="default.filter">
736 <term>Specifies:</term>
739 The <link linkend="filter-file">filter file(s)</link> to use
744 <term>Type of value:</term>
746 <para>File name, relative to <literal>confdir</literal></para>
750 <term>Default value:</term>
752 <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
756 <term>Effect if unset:</term>
759 No textual content filtering takes place, i.e. all
760 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
761 actions in the actions files are turned neutral.
769 Multiple <literal>filterfile</literal> lines are permitted.
772 The <link linkend="filter-file">filter files</link> contain content modification
773 rules that use <link linkend="regex">regular expressions</link>. These rules permit
774 powerful changes on the content of Web pages, and optionally the headers
775 as well, e.g., you could try to disable your favorite JavaScript annoyances,
776 re-write the actual displayed text, or just have some fun
777 playing buzzword bingo with web pages.
781 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
782 actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
783 to be defined in a filter file!
786 A pre-defined filter file called <filename>default.filter</filename> that contains
787 a number of useful filters for common problems is included in the distribution.
788 See the section on the <literal><link linkend="filter">filter</link></literal>
792 It is recommended to place any locally adapted filters into a separate
793 file, such as <filename>user.filter</filename>.
799 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
800 <![%config-file;[<literallayout>@@filterfile user.filter # User customizations</literallayout>]]>
804 <!-- ~~~~~ New section ~~~~~ -->
805 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
809 <term>Specifies:</term>
817 <term>Type of value:</term>
819 <para>File name, relative to <literal>logdir</literal></para>
823 <term>Default value:</term>
825 <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
829 <term>Effect if unset:</term>
832 No logfile is written.
840 The logfile is where all logging and error messages are written. The level
841 of detail and number of messages are set with the <literal>debug</literal>
842 option (see below). The logfile can be useful for tracking down a problem with
843 <application>Privoxy</application> (e.g., it's not blocking an ad you
844 think it should block) and it can help you to monitor what your browser
848 Depending on the debug options below, the logfile may be a privacy risk
849 if third parties can get access to it. As most users will never look
850 at it, <application>Privoxy</application> 3.0.7 and later only log fatal
854 For most troubleshooting purposes, you will have to change that,
855 please refer to the debugging section for details.
858 Your logfile will grow indefinitely, and you will probably want to
859 periodically remove it. On Unix systems, you can do this with a cron job
860 (see <quote>man cron</quote>).
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>).
870 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
874 <!-- ~~~~~ New section ~~~~~ -->
875 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
878 <term>Specifies:</term>
881 The name of the trust file to use
886 <term>Type of value:</term>
888 <para>File name, relative to <literal>confdir</literal></para>
892 <term>Default value:</term>
894 <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
898 <term>Effect if unset:</term>
901 The entire trust mechanism is disabled.
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.
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
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.
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
935 If you use the <literal>+</literal> operator in the trust file, it may grow
936 considerably over time.
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
945 Possible applications include limiting Internet access for children.
952 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
956 <!-- ~ End section ~ -->
958 <!-- ~~~~~ New section ~~~~~ -->
959 <sect2 id="debugging">
960 <title>Debugging</title>
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.
969 <sect3 renderas="sect4" id="debug"><title>debug</title>
973 <term>Specifies:</term>
976 Key values that determine what information gets logged.
981 <term>Type of value:</term>
983 <para>Integer values</para>
987 <term>Default value:</term>
989 <para>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</para>
993 <term>Effect if unset:</term>
996 Default value is used (see above).
1004 The available debug levels are:
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 debug 65536 # Log the applying actions
1027 To select multiple debug levels, you can either add them or use
1028 multiple <literal>debug</literal> lines.
1031 A debug level of 1 is informative because it will show you each request
1032 as it happens. <emphasis>1, 1024, 4096 and 8192 are recommended</emphasis>
1033 so that you will notice when things go wrong. The other levels are
1034 probably only of interest if you are hunting down a specific problem.
1035 They can produce a hell of an output (especially 16).
1039 &my-app; used to ship with the debug levels recommended above enabled by
1040 default, but due to privacy concerns 3.0.7 and later are configured to
1041 only log fatal errors.
1044 If you are used to the more verbose settings, simply enable the debug lines
1048 If you want to use pure CLF (Common Log Format), you should set <quote>debug
1049 512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1052 <application>Privoxy</application> has a hard-coded limit for the
1053 length of log messages. If it's reached, messages are logged truncated
1054 and marked with <quote>... [too long, truncated]</quote>.
1057 Please don't file any support requests without trying to reproduce
1058 the problem with increased debug level first. Once you read the log
1059 messages, you may even be able to solve the problem on your own.
1065 <![%config-file;[<literallayout>@@#debug 1 # Log the destination for each request &my-app; let through.</literallayout>]]>
1066 <![%config-file;[<literallayout>@@#debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
1067 <![%config-file;[<literallayout>@@#debug 4096 # Startup banner and warnings</literallayout>]]>
1068 <![%config-file;[<literallayout>@@#debug 8192 # Non-fatal errors</literallayout>]]>
1072 <!-- ~~~~~ New section ~~~~~ -->
1073 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1077 <term>Specifies:</term>
1080 Whether to run only one server thread.
1085 <term>Type of value:</term>
1087 <para><emphasis>None</emphasis></para>
1091 <term>Default value:</term>
1093 <para><emphasis>Unset</emphasis></para>
1097 <term>Effect if unset:</term>
1100 Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1101 serve multiple requests simultaneously.
1109 This option is only there for debugging purposes.
1110 <emphasis>It will drastically reduce performance.</emphasis>
1116 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1119 <!-- ~~~~~ New section ~~~~~ -->
1120 <sect3 renderas="sect4" id="hostname"><title>hostname</title>
1124 <term>Specifies:</term>
1127 The hostname shown on the CGI pages.
1132 <term>Type of value:</term>
1138 <term>Default value:</term>
1140 <para><emphasis>Unset</emphasis></para>
1144 <term>Effect if unset:</term>
1147 The hostname provided by the operating system is used.
1155 On some misconfigured systems resolving the hostname fails or
1156 takes too much time and slows Privoxy down. Setting a fixed hostname
1157 works around the problem.
1160 In other circumstances it might be desirable to show a hostname
1161 other than the one returned by the operating system. For example
1162 if the system has several different hostnames and you don't want
1163 to use the first one.
1166 Note that Privoxy does not validate the specified hostname value.
1172 <![%config-file;[<literallayout>@@#hostname hostname.example.org</literallayout>]]>
1177 <!-- ~ End section ~ -->
1180 <!-- ~~~~~ New section ~~~~~ -->
1181 <sect2 id="access-control">
1182 <title>Access Control and Security</title>
1185 This section of the config file controls the security-relevant aspects
1186 of <application>Privoxy</application>'s configuration.
1190 <!-- ~~~~~ New section ~~~~~ -->
1191 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1195 <term>Specifies:</term>
1198 The address and TCP port on which <application>Privoxy</application> will
1199 listen for client requests.
1204 <term>Type of value:</term>
1206 <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1207 <para>[<replaceable class="parameter">Hostname</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1212 <term>Default value:</term>
1214 <para>127.0.0.1:8118</para>
1218 <term>Effect if unset:</term>
1221 Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable and
1222 recommended for home users who run <application>Privoxy</application> on
1223 the same machine as their browser.
1231 You will need to configure your browser(s) to this proxy address and port.
1234 If you already have another service running on port 8118, or if you want to
1235 serve requests from other machines (e.g. on your local network) as well, you
1236 will need to override the default.
1239 You can use this statement multiple times to make
1240 <application>Privoxy</application> listen on more ports or more
1241 <abbrev>IP</abbrev> addresses. Suitable if your operating system does not
1242 support sharing <abbrev>IPv6</abbrev> and <abbrev>IPv4</abbrev> protocols
1246 If a hostname is used instead of an IP address, <application>Privoxy</application>
1247 will try to resolve it to an IP address and if there are multiple, use the first
1251 If the address for the hostname isn't already known on the system
1252 (for example because it's in /etc/hostname), this may result in DNS
1256 If the specified address isn't available on the system, or if the
1257 hostname can't be resolved, <application>Privoxy</application>
1261 IPv6 addresses containing colons have to be quoted by brackets.
1262 They can only be used if <application>Privoxy</application> has
1263 been compiled with IPv6 support. If you aren't sure if your version
1264 supports it, have a look at
1265 <literal>http://config.privoxy.org/show-status</literal>.
1268 Some operating systems will prefer IPv6 to IPv4 addresses even if the
1269 system has no IPv6 connectivity which is usually not expected by the user.
1270 Some even rely on DNS to resolve localhost which mean the "localhost" address
1271 used may not actually be local.
1274 It is therefore recommended to explicitly configure the intended IP address
1275 instead of relying on the operating system, unless there's a strong reason not to.
1278 If you leave out the address, <application>Privoxy</application> will bind to all
1279 IPv4 interfaces (addresses) on your machine and may become reachable from the
1280 Internet and/or the local network. Be aware that some GNU/Linux distributions
1281 modify that behaviour without updating the documentation. Check for non-standard
1282 patches if your <application>Privoxy</application> version behaves differently.
1285 If you configure <application>Privoxy</application> to be reachable from the
1286 network, consider using <link linkend="acls">access control lists</link>
1287 (ACL's, see below), and/or a firewall.
1290 If you open <application>Privoxy</application> to untrusted users, you will
1291 also want to make sure that the following actions are disabled: <literal><link
1292 linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1293 <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1298 <term>Example:</term>
1301 Suppose you are running <application>Privoxy</application> on
1302 a machine which has the address 192.168.0.1 on your local private network
1303 (192.168.0.0) and has another outside connection with a different address.
1304 You want it to serve requests from inside only:
1308 listen-address 192.168.0.1:8118
1312 Suppose you are running <application>Privoxy</application> on an
1313 IPv6-capable machine and you want it to listen on the IPv6 address
1314 of the loopback device:
1318 listen-address [::1]:8118
1325 <![%config-file;[<literallayout>@@listen-address 127.0.0.1:8118</literallayout>]]>
1329 <!-- ~~~~~ New section ~~~~~ -->
1330 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1334 <term>Specifies:</term>
1337 Initial state of "toggle" status
1342 <term>Type of value:</term>
1348 <term>Default value:</term>
1354 <term>Effect if unset:</term>
1357 Act as if toggled on
1365 If set to 0, <application>Privoxy</application> will start in
1366 <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1367 content-neutral proxy with both ad blocking and content filtering
1368 disabled. See <literal>enable-remote-toggle</literal> below.
1374 <![%config-file;[<literallayout>@@toggle 1</literallayout>]]>
1378 <!-- ~~~~~ New section ~~~~~ -->
1379 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1382 <term>Specifies:</term>
1385 Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1386 feature</ulink> may be used
1391 <term>Type of value:</term>
1397 <term>Default value:</term>
1403 <term>Effect if unset:</term>
1406 The web-based toggle feature is disabled.
1414 When toggled off, <application>Privoxy</application> mostly acts like a normal,
1415 content-neutral proxy, i.e. doesn't block ads or filter content.
1418 Access to the toggle feature can <emphasis>not</emphasis> be
1419 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1420 so that everybody who can access <application>Privoxy</application> (see
1421 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1422 toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1423 for multi-user environments with untrusted users.
1426 Note that malicious client side code (e.g Java) is also
1427 capable of using this option.
1430 As a lot of <application>Privoxy</application> users don't read
1431 documentation, this feature is disabled by default.
1434 Note that you must have compiled <application>Privoxy</application> with
1435 support for this feature, otherwise this option has no effect.
1441 <![%config-file;[<literallayout>@@enable-remote-toggle 0</literallayout>]]>
1445 <!-- ~~~~~ New section ~~~~~ -->
1446 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1449 <term>Specifies:</term>
1452 Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1457 <term>Type of value:</term>
1463 <term>Default value:</term>
1469 <term>Effect if unset:</term>
1472 Privoxy ignores special HTTP headers.
1480 When toggled on, the client can change <application>Privoxy's</application>
1481 behaviour by setting special HTTP headers. Currently the only supported
1482 special header is <quote>X-Filter: No</quote>, to disable filtering for
1483 the ongoing request, even if it is enabled in one of the action files.
1486 This feature is disabled by default. If you are using
1487 <application>Privoxy</application> in a environment with trusted clients,
1488 you may enable this feature at your discretion. Note that malicious client
1489 side code (e.g Java) is also capable of using this feature.
1492 This option will be removed in future releases as it has been obsoleted
1493 by the more general header taggers.
1499 <![%config-file;[<literallayout>@@enable-remote-http-toggle 0</literallayout>]]>
1503 <!-- ~~~~~ New section ~~~~~ -->
1504 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1507 <term>Specifies:</term>
1510 Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1511 file editor</ulink> may be used
1516 <term>Type of value:</term>
1522 <term>Default value:</term>
1528 <term>Effect if unset:</term>
1531 The web-based actions file editor is disabled.
1539 Access to the editor can <emphasis>not</emphasis> be
1540 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1541 so that everybody who can access <application>Privoxy</application> (see
1542 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1543 modify its configuration for all users.
1546 This option is <emphasis>not recommended</emphasis> for environments
1547 with untrusted users and as a lot of <application>Privoxy</application>
1548 users don't read documentation, this feature is disabled by default.
1551 Note that malicious client side code (e.g Java) is also
1552 capable of using the actions editor and you shouldn't enable
1553 this options unless you understand the consequences and are
1554 sure your browser is configured correctly.
1557 Note that you must have compiled <application>Privoxy</application> with
1558 support for this feature, otherwise this option has no effect.
1564 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1568 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1571 <term>Specifies:</term>
1574 Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1579 <term>Type of value:</term>
1582 <replaceable>0 or 1</replaceable>
1587 <term>Default value:</term>
1589 <para><emphasis>0</emphasis></para>
1593 <term>Effect if unset:</term>
1596 Blocks are not enforced.
1604 <application>Privoxy</application> is mainly used to block and filter
1605 requests as a service to the user, for example to block ads and other
1606 junk that clogs the pipes. <application>Privoxy's</application> configuration
1607 isn't perfect and sometimes innocent pages are blocked. In this situation it
1608 makes sense to allow the user to enforce the request and have
1609 <application>Privoxy</application> ignore the block.
1612 In the default configuration <application>Privoxy's</application>
1613 <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1614 link to adds a special string (the force prefix) to the request URL.
1615 If that link is used, <application>Privoxy</application> will
1616 detect the force prefix, remove it again and let the request pass.
1619 Of course <application>Privoxy</application> can also be used to enforce
1620 a network policy. In that case the user obviously should not be able to
1621 bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1622 option is for. If it's enabled, <application>Privoxy</application> hides
1623 the <quote>go there anyway</quote> link. If the user adds the force
1624 prefix by hand, it will not be accepted and the circumvention attempt
1630 <term>Examples:</term>
1638 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1642 <!-- ~~~~~ New section ~~~~~ -->
1643 <sect3 renderas="sect4" id="acls"><title>
1644 ACLs: permit-access and deny-access</title>
1645 <anchor id="permit-access">
1646 <anchor id="deny-access">
1650 <term>Specifies:</term>
1653 Who can access what.
1658 <term>Type of value:</term>
1661 <replaceable class="parameter">src_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">src_masklen</replaceable>]
1662 [<replaceable class="parameter">dst_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">dst_masklen</replaceable>]]
1665 Where <replaceable class="parameter">src_addr</replaceable> and
1666 <replaceable class="parameter">dst_addr</replaceable> are IPv4 addresses in dotted decimal notation or valid
1667 DNS names, <replaceable class="parameter">port</replaceable> is a port
1668 number, and <replaceable class="parameter">src_masklen</replaceable> and
1669 <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1670 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1671 destination part are optional.
1674 If your system implements
1675 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink>, then
1676 <replaceable class="parameter">src_addr</replaceable> and <replaceable
1677 class="parameter">dst_addr</replaceable> can be IPv6 addresses delimeted by
1678 brackets, <replaceable class="parameter">port</replaceable> can be a number
1679 or a service name, and
1680 <replaceable class="parameter">src_masklen</replaceable> and
1681 <replaceable class="parameter">dst_masklen</replaceable> can be a number
1687 <term>Default value:</term>
1689 <para><emphasis>Unset</emphasis></para>
1691 If no <replaceable class="parameter">port</replaceable> is specified,
1692 any port will match. If no <replaceable class="parameter">src_masklen</replaceable> or
1693 <replaceable class="parameter">src_masklen</replaceable> is given, the complete IP
1694 address has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1699 <term>Effect if unset:</term>
1702 Don't restrict access further than implied by <literal>listen-address</literal>
1710 Access controls are included at the request of ISPs and systems
1711 administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1712 For a typical home user, it will normally suffice to ensure that
1713 <application>Privoxy</application> only listens on the localhost
1714 (127.0.0.1) or internal (home) network address by means of the
1715 <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1719 Please see the warnings in the FAQ that <application>Privoxy</application>
1720 is not intended to be a substitute for a firewall or to encourage anyone
1721 to defer addressing basic security weaknesses.
1724 Multiple ACL lines are OK.
1725 If any ACLs are specified, <application>Privoxy</application> only talks
1726 to IP addresses that match at least one <literal>permit-access</literal> line
1727 and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1728 last match wins, with the default being <literal>deny-access</literal>.
1731 If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1732 for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1733 that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1734 of the ultimate target. This is necessary because it may be impossible for the local
1735 <application>Privoxy</application> to determine the IP address of the
1736 ultimate target (that's often what gateways are used for).
1739 You should prefer using IP addresses over DNS names, because the address lookups take
1740 time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1741 like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1742 IP addresses, only the first one is used.
1745 Some systems allow IPv4 clients to connect to IPv6 server sockets.
1746 Then the client's IPv4 address will be translated by the system into
1747 IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4
1748 mapped IPv6 address). <application>Privoxy</application> can handle it
1749 and maps such ACL addresses automatically.
1752 Denying access to particular sites by ACL may have undesired side effects
1753 if the site in question is hosted on a machine which also hosts other sites
1759 <term>Examples:</term>
1762 Explicitly define the default behavior if no ACL and
1763 <literal>listen-address</literal> are set: <quote>localhost</quote>
1764 is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1765 <emphasis>all</emphasis> destination addresses are OK:
1769 permit-access localhost
1773 Allow any host on the same class C subnet as www.privoxy.org access to
1774 nothing but www.example.com (or other domains hosted on the same system):
1778 permit-access www.privoxy.org/24 www.example.com/32
1782 Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1783 with the exception that 192.168.45.73 may not access the IP address behind
1784 www.dirty-stuff.example.com:
1788 permit-access 192.168.45.64/26
1789 deny-access 192.168.45.73 www.dirty-stuff.example.com
1793 Allow access from the IPv4 network 192.0.2.0/24 even if listening on
1794 an IPv6 wild card address (not supported on all platforms):
1798 permit-access 192.0.2.0/24
1802 This is equivalent to the following line even if listening on an
1803 IPv4 address (not supported on all platforms):
1807 permit-access [::ffff:192.0.2.0]/120
1816 <!-- ~~~~~ New section ~~~~~ -->
1817 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1821 <term>Specifies:</term>
1824 Maximum size of the buffer for content filtering.
1829 <term>Type of value:</term>
1831 <para>Size in Kbytes</para>
1835 <term>Default value:</term>
1841 <term>Effect if unset:</term>
1844 Use a 4MB (4096 KB) limit.
1852 For content filtering, i.e. the <literal>+filter</literal> and
1853 <literal>+deanimate-gif</literal> actions, it is necessary that
1854 <application>Privoxy</application> buffers the entire document body.
1855 This can be potentially dangerous, since a server could just keep sending
1856 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1860 When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1861 flushed to the client unfiltered and no further attempt to
1862 filter the rest of the document is made. Remember that there may be multiple threads
1863 running, which might require up to <literal>buffer-limit</literal> Kbytes
1864 <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1871 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1874 <!-- ~~~~~ New section ~~~~~ -->
1875 <sect3 renderas="sect4" id="enable-proxy-authentication-forwarding"><title>enable-proxy-authentication-forwarding</title>
1878 <term>Specifies:</term>
1881 Whether or not proxy authentication through &my-app; should work.
1886 <term>Type of value:</term>
1892 <term>Default value:</term>
1898 <term>Effect if unset:</term>
1901 Proxy authentication headers are removed.
1909 Privoxy itself does not support proxy authentication, but can
1910 allow clients to authenticate against Privoxy's parent proxy.
1913 By default Privoxy (3.0.21 and later) don't do that and remove
1914 Proxy-Authorization headers in requests and Proxy-Authenticate
1915 headers in responses to make it harder for malicious sites to
1916 trick inexperienced users into providing login information.
1919 If this option is enabled the headers are forwarded.
1922 Enabling this option is <emphasis>not recommended</emphasis> if there is
1923 no parent proxy that requires authentication or if the local network between
1924 Privoxy and the parent proxy isn't trustworthy. If proxy authentication is
1925 only required for some requests, it is recommended to use a client header filter
1926 to remove the authentication headers for requests where they aren't needed.
1932 <![%config-file;[<literallayout>@@enable-proxy-authentication-forwarding 0</literallayout>]]>
1937 <!-- ~ End section ~ -->
1940 <!-- ~~~~~ New section ~~~~~ -->
1942 <sect2 id="forwarding">
1943 <title>Forwarding</title>
1946 This feature allows routing of HTTP requests through a chain of
1950 Forwarding can be used to chain Privoxy with a caching proxy to speed
1951 up browsing. Using a parent proxy may also be necessary if the machine
1952 that <application>Privoxy</application> runs on has no direct Internet access.
1955 Note that parent proxies can severely decrease your privacy level.
1956 For example a parent proxy could add your IP address to the request
1957 headers and if it's a caching proxy it may add the <quote>Etag</quote>
1958 header to revalidation requests again, even though you configured Privoxy
1959 to remove it. It may also ignore Privoxy's header time randomization and use the
1960 original values which could be used by the server as cookie replacement
1961 to track your steps between visits.
1965 Also specified here are SOCKS proxies. <application>Privoxy</application>
1966 supports the SOCKS 4 and SOCKS 4A protocols.
1969 <sect3 renderas="sect4" id="forward"><title>forward</title>
1972 <term>Specifies:</term>
1975 To which parent HTTP proxy specific requests should be routed.
1980 <term>Type of value:</term>
1983 <replaceable class="parameter">target_pattern</replaceable>
1984 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1987 where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1988 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1989 denote <quote>all URLs</quote>.
1990 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1991 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1992 optionally followed by its listening port (default: 8000).
1993 Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1998 <term>Default value:</term>
2000 <para><emphasis>Unset</emphasis></para>
2004 <term>Effect if unset:</term>
2007 Don't use parent HTTP proxies.
2015 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2016 forwarded to another HTTP proxy but are made directly to the web servers.
2019 <replaceable class="parameter">http_parent</replaceable> can be a
2020 numerical IPv6 address (if
2021 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2022 implemented). To prevent clashes with the port delimiter, the whole IP
2023 address has to be put into brackets. On the other hand a <replaceable
2024 class="parameter">target_pattern</replaceable> containing an IPv6 address
2025 has to be put into angle brackets (normal brackets are reserved for
2026 regular expressions already).
2029 Multiple lines are OK, they are checked in sequence, and the last match wins.
2034 <term>Examples:</term>
2037 Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
2041 forward / parent-proxy.example.org:8080
2046 Everything goes to our example ISP's caching proxy, except for requests
2047 to that ISP's sites:
2051 forward / caching-proxy.isp.example.net:8000
2052 forward .isp.example.net .
2056 Parent proxy specified by an IPv6 address:
2060 forward / [2001:DB8::1]:8000
2064 Suppose your parent proxy doesn't support IPv6:
2068 forward / parent-proxy.example.org:8000
2069 forward ipv6-server.example.org .
2070 forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
2079 <!-- ~~~~~ New section ~~~~~ -->
2080 <sect3 renderas="sect4" id="socks"><title>
2081 forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
2082 <anchor id="forward-socks4">
2083 <anchor id="forward-socks4a">
2087 <term>Specifies:</term>
2090 Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2095 <term>Type of value:</term>
2098 <replaceable class="parameter">target_pattern</replaceable>
2099 <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
2100 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2103 where <replaceable class="parameter">target_pattern</replaceable> is a
2104 <link linkend="af-patterns">URL pattern</link> that specifies to which
2105 requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2106 denote <quote>all URLs</quote>. <replaceable class="parameter">http_parent</replaceable>
2107 and <replaceable class="parameter">socks_proxy</replaceable>
2108 are IP addresses in dotted decimal notation or valid DNS names
2109 (<replaceable class="parameter">http_parent</replaceable>
2110 may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
2111 <replaceable class="parameter">port</replaceable> parameters are TCP ports,
2112 i.e. integer values from 1 to 65535
2117 <term>Default value:</term>
2119 <para><emphasis>Unset</emphasis></para>
2123 <term>Effect if unset:</term>
2126 Don't use SOCKS proxies.
2134 Multiple lines are OK, they are checked in sequence, and the last match wins.
2137 The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
2138 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2139 server, while in SOCKS 4 it happens locally.
2142 With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
2145 <literal>forward-socks5t</literal> works like vanilla <literal>forward-socks5</literal> but
2146 lets &my-app; additionally use Tor-specific SOCKS extensions. Currently the only supported
2147 SOCKS extension is optimistic data which can reduce the latency for the first request made
2148 on a newly created connection.
2151 <replaceable class="parameter">socks_proxy</replaceable> and
2152 <replaceable class="parameter">http_parent</replaceable> can be a
2153 numerical IPv6 address (if
2154 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2155 implemented). To prevent clashes with the port delimiter, the whole IP
2156 address has to be put into brackets. On the other hand a <replaceable
2157 class="parameter">target_pattern</replaceable> containing an IPv6 address
2158 has to be put into angle brackets (normal brackets are reserved for
2159 regular expressions already).
2162 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2163 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2169 <term>Examples:</term>
2172 From the company example.com, direct connections are made to all
2173 <quote>internal</quote> domains, but everything outbound goes through
2174 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2179 forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
2180 forward .example.com .
2184 A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2188 forward-socks4 / socks-gw.example.com:1080 .
2193 To chain Privoxy and Tor, both running on the same system, you would use
2198 forward-socks5 / 127.0.0.1:9050 .
2203 The public <application>Tor</application> network can't be used to
2204 reach your local network, if you need to access local servers you
2205 therefore might want to make some exceptions:
2209 forward 192.168.*.*/ .
2211 forward 127.*.*.*/ .
2215 Unencrypted connections to systems in these address ranges will
2216 be as (un)secure as the local network is, but the alternative is that you
2217 can't reach the local network through <application>Privoxy</application>
2218 at all. Of course this may actually be desired and there is no reason
2219 to make these exceptions if you aren't sure you need them.
2222 If you also want to be able to reach servers in your local network by
2223 using their names, you will need additional exceptions that look like
2228 forward localhost/ .
2237 <![%user-man;[ <!-- not included in config due to length -->
2238 <!-- ~~~~~ New section ~~~~~ -->
2239 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2242 If you have links to multiple ISPs that provide various special content
2243 only to their subscribers, you can configure multiple <application>Privoxies</application>
2244 which have connections to the respective ISPs to act as forwarders to each other, so that
2245 <emphasis>your</emphasis> users can see the internal content of all ISPs.
2249 Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2250 isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2251 configuration can look like this:
2261 forward .isp-b.example.net host-b:8118
2272 forward .isp-a.example.org host-a:8118
2277 Now, your users can set their browser's proxy to use either
2278 host-a or host-b and be able to browse the internal content
2279 of both isp-a and isp-b.
2283 If you intend to chain <application>Privoxy</application> and
2284 <application>squid</application> locally, then chaining as
2285 <literal>browser -> squid -> privoxy</literal> is the recommended way.
2289 Assuming that <application>Privoxy</application> and <application>squid</application>
2290 run on the same box, your <application>squid</application> configuration could then look like this:
2295 # Define Privoxy as parent proxy (without ICP)
2296 cache_peer 127.0.0.1 parent 8118 7 no-query
2298 # Define ACL for protocol FTP
2301 # Do not forward FTP requests to Privoxy
2302 always_direct allow ftp
2304 # Forward all the rest to Privoxy
2305 never_direct allow all</screen>
2309 You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2310 Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2314 You could just as well decide to only forward requests you suspect
2315 of leading to Windows executables through a virus-scanning parent proxy,
2316 say, on <literal>antivir.example.com</literal>, port 8010:
2322 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
2328 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2331 <term>Specifies:</term>
2334 How often Privoxy retries if a forwarded connection request fails.
2339 <term>Type of value:</term>
2342 <replaceable class="parameter">Number of retries.</replaceable>
2347 <term>Default value:</term>
2349 <para><emphasis>0</emphasis></para>
2353 <term>Effect if unset:</term>
2356 Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2364 <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2365 for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2366 The connection might have failed because of a DNS timeout in which case a retry makes sense,
2367 but it might also have failed because the server doesn't exist or isn't reachable. In this
2368 case the retry will just delay the appearance of Privoxy's error message.
2371 Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2372 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2375 Only use this option, if you are getting lots of forwarding-related error messages
2376 that go away when you try again manually. Start with a small value and check Privoxy's
2377 logfile from time to time, to see how many retries are usually needed.
2382 <term>Examples:</term>
2385 forwarded-connect-retries 1
2390 <![%config-file;[<literallayout>@@forwarded-connect-retries 0</literallayout>]]>
2396 <title>Miscellaneous</title>
2398 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2401 <term>Specifies:</term>
2404 Whether intercepted requests should be treated as valid.
2409 <term>Type of value:</term>
2412 <replaceable>0 or 1</replaceable>
2417 <term>Default value:</term>
2419 <para><emphasis>0</emphasis></para>
2423 <term>Effect if unset:</term>
2426 Only proxy requests are accepted, intercepted requests are treated as invalid.
2434 If you don't trust your clients and want to force them
2435 to use <application>Privoxy</application>, enable this
2436 option and configure your packet filter to redirect outgoing
2437 HTTP connections into <application>Privoxy</application>.
2440 Make sure that <application>Privoxy's</application> own requests
2441 aren't redirected as well. Additionally take care that
2442 <application>Privoxy</application> can't intentionally connect
2443 to itself, otherwise you could run into redirection loops if
2444 <application>Privoxy's</application> listening port is reachable
2445 by the outside or an attacker has access to the pages you visit.
2450 <term>Examples:</term>
2453 accept-intercepted-requests 1
2458 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2461 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2464 <term>Specifies:</term>
2467 Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2472 <term>Type of value:</term>
2475 <replaceable>0 or 1</replaceable>
2480 <term>Default value:</term>
2482 <para><emphasis>0</emphasis></para>
2486 <term>Effect if unset:</term>
2489 <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2497 By default <application>Privoxy</application> ignores block or redirect actions
2498 for its CGI pages. Intercepting these requests can be useful in multi-user
2499 setups to implement fine-grained access control, but it can also render the complete
2500 web interface useless and make debugging problems painful if done without care.
2503 Don't enable this option unless you're sure that you really need it.
2508 <term>Examples:</term>
2511 allow-cgi-request-crunching 1
2516 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2519 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2522 <term>Specifies:</term>
2525 Whether the CGI interface should stay compatible with broken HTTP clients.
2530 <term>Type of value:</term>
2533 <replaceable>0 or 1</replaceable>
2538 <term>Default value:</term>
2540 <para><emphasis>0</emphasis></para>
2544 <term>Effect if unset:</term>
2547 The CGI form generate long GET URLs.
2555 <application>Privoxy's</application> CGI forms can lead to
2556 rather long URLs. This isn't a problem as far as the HTTP
2557 standard is concerned, but it can confuse clients with arbitrary
2558 URL length limitations.
2561 Enabling split-large-forms causes <application>Privoxy</application>
2562 to divide big forms into smaller ones to keep the URL length down.
2563 It makes editing a lot less convenient and you can no longer
2564 submit all changes at once, but at least it works around this
2568 If you don't notice any editing problems, there is no reason
2569 to enable this option, but if one of the submit buttons appears
2570 to be broken, you should give it a try.
2575 <term>Examples:</term>
2583 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2586 <sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
2589 <term>Specifies:</term>
2592 Number of seconds after which an open connection will no longer be reused.
2597 <term>Type of value:</term>
2600 <replaceable>Time in seconds.</replaceable>
2605 <term>Default value:</term>
2611 <term>Effect if unset:</term>
2614 Connections are not kept alive.
2622 This option allows clients to keep the connection to &my-app;
2623 alive. If the server supports it, &my-app; will keep
2624 the connection to the server alive as well. Under certain
2625 circumstances this may result in speed-ups.
2628 By default, &my-app; will close the connection to the server if
2629 the client connection gets closed, or if the specified timeout
2630 has been reached without a new request coming in. This behaviour
2631 can be changed with the <ulink
2632 url="#CONNECTION-SHARING">connection-sharing</ulink> option.
2635 This option has no effect if <application>Privoxy</application>
2636 has been compiled without keep-alive support.
2639 Note that a timeout of five seconds as used in the default
2640 configuration file significantly decreases the number of
2641 connections that will be reused. The value is used because
2642 some browsers limit the number of connections they open to
2643 a single host and apply the same limit to proxies. This can
2644 result in a single website <quote>grabbing</quote> all the
2645 connections the browser allows, which means connections to
2646 other websites can't be opened until the connections currently
2650 Several users have reported this as a Privoxy bug, so the
2651 default value has been reduced. Consider increasing it to
2652 300 seconds or even more if you think your browser can handle
2653 it. If your browser appears to be hanging, it probably can't.
2658 <term>Examples:</term>
2661 keep-alive-timeout 300
2666 <![%config-file;[<literallayout>@@keep-alive-timeout 5</literallayout>]]>
2670 <sect3 renderas="sect4" id="tolerate-pipelining"><title>tolerate-pipelining</title>
2673 <term>Specifies:</term>
2676 Whether or not pipelined requests should be served.
2681 <term>Type of value:</term>
2684 <replaceable>0 or 1.</replaceable>
2689 <term>Default value:</term>
2695 <term>Effect if unset:</term>
2698 If Privoxy receives more than one request at once, it terminates the
2699 client connection after serving the first one.
2707 &my-app; currently doesn't pipeline outgoing requests,
2708 thus allowing pipelining on the client connection is not
2709 guaranteed to improve the performance.
2712 By default &my-app; tries to discourage clients from pipelining
2713 by discarding aggressively pipelined requests, which forces the
2714 client to resend them through a new connection.
2717 This option lets &my-app; tolerate pipelining. Whether or not
2718 that improves performance mainly depends on the client configuration.
2721 If you are seeing problems with pages not properly loading,
2722 disabling this option could work around the problem.
2727 <term>Examples:</term>
2730 tolerate-pipelining 1
2735 <![%config-file;[<literallayout>@@tolerate-pipelining 1</literallayout>]]>
2739 <sect3 renderas="sect4" id="default-server-timeout"><title>default-server-timeout</title>
2742 <term>Specifies:</term>
2745 Assumed server-side keep-alive timeout if not specified by the server.
2750 <term>Type of value:</term>
2753 <replaceable>Time in seconds.</replaceable>
2758 <term>Default value:</term>
2764 <term>Effect if unset:</term>
2767 Connections for which the server didn't specify the keep-alive
2768 timeout are not reused.
2776 Enabling this option significantly increases the number of connections
2777 that are reused, provided the <ulink
2778 url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> option
2782 While it also increases the number of connections problems
2783 when &my-app; tries to reuse a connection that already has
2784 been closed on the server side, or is closed while &my-app;
2785 is trying to reuse it, this should only be a problem if it
2786 happens for the first request sent by the client. If it happens
2787 for requests on reused client connections, &my-app; will simply
2788 close the connection and the client is supposed to retry the
2789 request without bothering the user.
2792 Enabling this option is therefore only recommended if the
2794 url="#CONNECTION-SHARING">connection-sharing</ulink> option
2798 It is an error to specify a value larger than the <ulink
2799 url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> value.
2802 This option has no effect if <application>Privoxy</application>
2803 has been compiled without keep-alive support.
2808 <term>Examples:</term>
2811 default-server-timeout 60
2816 <![%config-file;[<literallayout>@@#default-server-timeout 60</literallayout>]]>
2820 <sect3 renderas="sect4" id="connection-sharing"><title>connection-sharing</title>
2823 <term>Specifies:</term>
2826 Whether or not outgoing connections that have been kept alive
2827 should be shared between different incoming connections.
2832 <term>Type of value:</term>
2835 <replaceable>0 or 1</replaceable>
2840 <term>Default value:</term>
2846 <term>Effect if unset:</term>
2849 Connections are not shared.
2857 This option has no effect if <application>Privoxy</application>
2858 has been compiled without keep-alive support, or if it's disabled.
2866 Note that reusing connections doesn't necessary cause speedups.
2867 There are also a few privacy implications you should be aware of.
2870 If this option is effective, outgoing connections are shared between
2871 clients (if there are more than one) and closing the browser that initiated
2872 the outgoing connection does no longer affect the connection between &my-app;
2873 and the server unless the client's request hasn't been completed yet.
2876 If the outgoing connection is idle, it will not be closed until either
2877 <application>Privoxy's</application> or the server's timeout is reached.
2878 While it's open, the server knows that the system running &my-app; is still
2882 If there are more than one client (maybe even belonging to multiple users),
2883 they will be able to reuse each others connections. This is potentially
2884 dangerous in case of authentication schemes like NTLM where only the
2885 connection is authenticated, instead of requiring authentication for
2889 If there is only a single client, and if said client can keep connections
2890 alive on its own, enabling this option has next to no effect. If the client
2891 doesn't support connection keep-alive, enabling this option may make sense
2892 as it allows &my-app; to keep outgoing connections alive even if the client
2893 itself doesn't support it.
2896 You should also be aware that enabling this option increases the likelihood
2897 of getting the "No server or forwarder data" error message, especially if you
2898 are using a slow connection to the Internet.
2901 This option should only be used by experienced users who
2902 understand the risks and can weight them against the benefits.
2907 <term>Examples:</term>
2910 connection-sharing 1
2915 <![%config-file;[<literallayout>@@#connection-sharing 1</literallayout>]]>
2919 <sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
2922 <term>Specifies:</term>
2925 Number of seconds after which a socket times out if
2926 no data is received.
2931 <term>Type of value:</term>
2934 <replaceable>Time in seconds.</replaceable>
2939 <term>Default value:</term>
2945 <term>Effect if unset:</term>
2948 A default value of 300 seconds is used.
2956 The default is quite high and you probably want to reduce it.
2957 If you aren't using an occasionally slow proxy like Tor, reducing
2958 it to a few seconds should be fine.
2963 <term>Examples:</term>
2971 <![%config-file;[<literallayout>@@socket-timeout 300</literallayout>]]>
2975 <sect3 renderas="sect4" id="max-client-connections"><title>max-client-connections</title>
2978 <term>Specifies:</term>
2981 Maximum number of client connections that will be served.
2986 <term>Type of value:</term>
2989 <replaceable>Positive number.</replaceable>
2994 <term>Default value:</term>
3000 <term>Effect if unset:</term>
3003 Connections are served until a resource limit is reached.
3011 &my-app; creates one thread (or process) for every incoming client
3012 connection that isn't rejected based on the access control settings.
3015 If the system is powerful enough, &my-app; can theoretically deal with
3016 several hundred (or thousand) connections at the same time, but some
3017 operating systems enforce resource limits by shutting down offending
3018 processes and their default limits may be below the ones &my-app; would
3019 require under heavy load.
3022 Configuring &my-app; to enforce a connection limit below the thread
3023 or process limit used by the operating system makes sure this doesn't
3024 happen. Simply increasing the operating system's limit would work too,
3025 but if &my-app; isn't the only application running on the system,
3026 you may actually want to limit the resources used by &my-app;.
3029 If &my-app; is only used by a single trusted user, limiting the
3030 number of client connections is probably unnecessary. If there
3031 are multiple possibly untrusted users you probably still want to
3032 additionally use a packet filter to limit the maximal number of
3033 incoming connections per client. Otherwise a malicious user could
3034 intentionally create a high number of connections to prevent other
3035 users from using &my-app;.
3038 Obviously using this option only makes sense if you choose a limit
3039 below the one enforced by the operating system.
3042 One most POSIX-compliant systems &my-app; can't properly deal with
3043 more than FD_SETSIZE file descriptors at the same time and has to reject
3044 connections if the limit is reached. This will likely change in a
3045 future version, but currently this limit can't be increased without
3046 recompiling &my-app; with a different FD_SETSIZE limit.
3051 <term>Examples:</term>
3054 max-client-connections 256
3059 <![%config-file;[<literallayout>@@#max-client-connections 256</literallayout>]]>
3063 <sect3 renderas="sect4" id="handle-as-empty-doc-returns-ok"><title>handle-as-empty-doc-returns-ok</title>
3066 <term>Specifies:</term>
3069 The status code Privoxy returns for pages blocked with
3070 <!-- URL will only end up in the user manual so the relative link should work. -->
3071 <literal><ulink url="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">+handle-as-empty-document</ulink></literal>.
3076 <term>Type of value:</term>
3079 <replaceable>0 or 1</replaceable>
3084 <term>Default value:</term>
3090 <term>Effect if unset:</term>
3093 Privoxy returns a status 403(forbidden) for all blocked pages.
3098 <term>Effect if set:</term>
3101 Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
3102 and a status 403(Forbidden) for all other blocked pages.
3110 This is a work-around for Firefox bug 492459:
3112 Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.
3114 (<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
3115 >https://bugzilla.mozilla.org/show_bug.cgi?id=492459</ulink>)
3116 As the bug has been fixed for quite some time this option should no longer
3117 be needed and will be removed in a future release. Please speak up if you
3118 have a reason why the option should be kept around.
3123 <![%config-file;[<literallayout>@@#handle-as-empty-doc-returns-ok 1</literallayout>]]>
3127 <sect3 renderas="sect4" id="enable-compression"><title>enable-compression</title>
3130 <term>Specifies:</term>
3133 Whether or not buffered content is compressed before delivery.
3138 <term>Type of value:</term>
3141 <replaceable>0 or 1</replaceable>
3146 <term>Default value:</term>
3152 <term>Effect if unset:</term>
3155 Privoxy does not compress buffered content.
3160 <term>Effect if set:</term>
3163 Privoxy compresses buffered content before delivering it to the client,
3164 provided the client supports it.
3172 This directive is only supported if Privoxy has been compiled with
3173 FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB.
3176 Compressing buffered content is mainly useful if Privoxy and the
3177 client are running on different systems. If they are running on the
3178 same system, enabling compression is likely to slow things down.
3179 If you didn't measure otherwise, you should assume that it does
3180 and keep this option disabled.
3183 Privoxy will not compress buffered content below a certain length.
3188 <![%config-file;[<literallayout>@@#enable-compression 1</literallayout>]]>
3192 <sect3 renderas="sect4" id="compression-level"><title>compression-level</title>
3195 <term>Specifies:</term>
3198 The compression level that is passed to the zlib library when compressing buffered content.
3203 <term>Type of value:</term>
3206 <replaceable>Positive number ranging from 0 to 9.</replaceable>
3211 <term>Default value:</term>
3220 Compressing the data more takes usually longer than compressing
3221 it less or not compressing it at all. Which level is best depends
3222 on the connection between Privoxy and the client. If you can't
3223 be bothered to benchmark it for yourself, you should stick with
3224 the default and keep compression disabled.
3227 If compression is disabled, the compression level is irrelevant.
3232 <term>Examples:</term>
3236 # Best speed (compared to the other levels)
3240 # No compression. Only useful for testing as the added header
3241 # slightly increases the amount of data that has to be sent.
3242 # If your benchmark shows that using this compression level
3243 # is superior to using no compression at all, the benchmark
3244 # is likely to be flawed.
3251 <![%config-file;[<literallayout>@@#compression-level 1</literallayout>]]>
3255 <sect3 renderas="sect4" id="client-header-order"><title>client-header-order</title>
3258 <term>Specifies:</term>
3261 The order in which client headers are sorted before forwarding them.
3266 <term>Type of value:</term>
3269 <replaceable>Client header names delimited by spaces or tabs</replaceable>
3274 <term>Default value:</term>
3283 By default &my-app; leaves the client headers in the order they
3284 were sent by the client. Headers are modified in-place, new headers
3285 are added at the end of the already existing headers.
3288 The header order can be used to fingerprint client requests
3289 independently of other headers like the User-Agent.
3292 This directive allows to sort the headers differently to better
3293 mimic a different User-Agent. Client headers will be emitted
3294 in the order given, headers whose name isn't explicitly specified
3295 are added at the end.
3298 Note that sorting headers in an uncommon way will make fingerprinting
3299 actually easier. Encrypted headers are not affected by this directive.
3304 <![%config-file;[<literallayout>@@#client-header-order Host \
3323 <!-- ~ End section ~ -->
3326 <!-- ~~~~~ New section ~~~~~ -->
3328 <sect2 id="windows-gui">
3329 <title>Windows GUI Options</title>
3331 <application>Privoxy</application> has a number of options specific to the
3332 Windows GUI interface:
3335 <anchor id="activity-animation">
3336 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3338 If <quote>activity-animation</quote> is set to 1, the
3339 <application>Privoxy</application> icon will animate when
3340 <quote>Privoxy</quote> is active. To turn off, set to 0.
3343 <![%config-file;[<literallayout>@@#activity-animation 1</literallayout>]]>
3349 <emphasis>activity-animation 1</emphasis>
3356 <anchor id="log-messages">
3357 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3359 If <quote>log-messages</quote> is set to 1,
3360 <application>Privoxy</application> copies log messages to the console
3362 The log detail depends on the <link linkend="debug">debug</link> directive.
3365 <![%config-file;[<literallayout>@@#log-messages 1</literallayout>]]>
3371 <emphasis>log-messages 1</emphasis>
3378 <anchor id="log-buffer-size">
3379 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3381 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
3382 i.e. the amount of memory used for the log messages displayed in the
3383 console window, will be limited to <quote>log-max-lines</quote> (see below).
3387 Warning: Setting this to 0 will result in the buffer to grow infinitely and
3388 eat up all your memory!
3391 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
3397 <emphasis>log-buffer-size 1</emphasis>
3404 <anchor id="log-max-lines">
3405 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3407 <application>log-max-lines</application> is the maximum number of lines held
3408 in the log buffer. See above.
3411 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
3417 <emphasis>log-max-lines 200</emphasis>
3424 <anchor id="log-highlight-messages">
3425 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3427 If <quote>log-highlight-messages</quote> is set to 1,
3428 <application>Privoxy</application> will highlight portions of the log
3429 messages with a bold-faced font:
3432 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
3438 <emphasis>log-highlight-messages 1</emphasis>
3445 <anchor id="log-font-name">
3446 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3448 The font used in the console window:
3451 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
3457 <emphasis>log-font-name Comic Sans MS</emphasis>
3464 <anchor id="log-font-size">
3465 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3467 Font size used in the console window:
3470 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
3476 <emphasis>log-font-size 8</emphasis>
3483 <anchor id="show-on-task-bar">
3484 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3486 <quote>show-on-task-bar</quote> controls whether or not
3487 <application>Privoxy</application> will appear as a button on the Task bar
3491 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
3497 <emphasis>show-on-task-bar 0</emphasis>
3504 <anchor id="close-button-minimizes">
3505 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3507 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
3508 button will minimize <application>Privoxy</application> instead of closing
3509 the program (close with the exit option on the File menu).
3512 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
3518 <emphasis>close-button-minimizes 1</emphasis>
3525 <anchor id="hide-console">
3526 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3528 The <quote>hide-console</quote> option is specific to the MS-Win console
3529 version of <application>Privoxy</application>. If this option is used,
3530 <application>Privoxy</application> will disconnect from and hide the
3534 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
3540 #<emphasis>hide-console</emphasis>
3550 <!-- end config content common to both outputs -->
3553 <!-- These are dummy anchors to keep the processor quiet -->
3554 <!-- when building config-file only (ie. they are used in u-m only) -->
3557 <anchor id="filter">
3558 <anchor id="filter-file">
3560 <anchor id="actions-file">
3561 <anchor id="af-patterns">
3565 <!-- eof p-config.sgml -->
projects / privoxy.git / blob