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.86 2012/10/21 13:01:40 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 v&p-version;
100 $Id: p-config.sgml,v 2.86 2012/10/21 13:01:40 fabiankeil Exp $
103 Copyright (C) 2001-2011 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 #
120 6. WINDOWS GUI OPTIONS #
122 #################################################################
126 <literallayout>I. INTRODUCTION
127 =============== <!-- fuck this madness --></literallayout>
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.
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.
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.
148 <literallayout><!-- funky spacing -->
150 II. FORMAT OF THE CONFIGURATION FILE
151 ====================================</literallayout>
154 Configuration lines consist of an initial keyword followed by a list
155 of values, all separated by whitespace (any number of spaces or
159 actionsfile default.action
162 Indicates that the actionsfile is named 'default.action'.
165 The '#' indicates a comment. Any part of a line following a '#' is
166 ignored, except if the '#' is preceded by a '\'.
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".
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.
181 Long lines can be continued on the next line by using a `\' as
187 <!-- ************************************************ -->
188 <!-- The following is common to both outputs (mostly) -->
189 <!-- ************************************************ -->
193 <!-- ~~~~~ New section ~~~~~ -->
194 <sect2 id="local-set-up">
195 <title>Local Set-up Documentation</title>
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.
204 <!-- ~~~~~ New section ~~~~~ -->
205 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
208 <term>Specifies:</term>
211 Location of the <application>Privoxy</application> User Manual.
216 <term>Type of value:</term>
218 <para>A fully qualified URI</para>
222 <term>Default value:</term>
224 <para><emphasis>Unset</emphasis></para>
228 <term>Effect if unset:</term>
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.
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
251 Unix, in local filesystem (may not work with all browsers):
254 <screen> user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
257 Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
260 <screen> user-manual file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
263 Windows, UNC notation (with forward slashes):
266 <screen> user-manual file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
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
275 <screen> user-manual /usr/share/doc/privoxy/user-manual</screen>
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>).
284 If the documentation is not on the local system, it can be accessed
285 from a remote server, as:
288 <screen> user-manual http://example.com/privoxy/user-manual/</screen>
291 <!-- this gets hammered in conversion to config. Text repeated below. -->
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
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.
318 <![%config-file;[<literallayout>@@#user-manual http://www.privoxy.org/user-manual/</literallayout>]]>
322 <!-- ~~~~~ New section ~~~~~ -->
323 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
327 <term>Specifies:</term>
330 A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
335 <term>Type of value:</term>
341 <term>Default value:</term>
343 <para><emphasis>Unset</emphasis></para>
347 <term>Effect if unset:</term>
350 No links are displayed on the "untrusted" error page.
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.)
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.
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!
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>]]>
379 <!-- ~~~~~ New section ~~~~~ -->
380 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
384 <term>Specifies:</term>
387 An email address to reach the <application>Privoxy</application> administrator.
392 <term>Type of value:</term>
394 <para>Email address</para>
398 <term>Default value:</term>
400 <para><emphasis>Unset</emphasis></para>
404 <term>Effect if unset:</term>
407 No email address is displayed on error pages and the CGI user interface.
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
423 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
427 <!-- ~~~~~ New section ~~~~~ -->
428 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
432 <term>Specifies:</term>
435 A URL to documentation about the local <application>Privoxy</application> setup,
436 configuration or policies.
441 <term>Type of value:</term>
447 <term>Default value:</term>
449 <para><emphasis>Unset</emphasis></para>
453 <term>Effect if unset:</term>
456 No link to local documentation is displayed on error pages and the CGI user interface.
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
469 This URL shouldn't be blocked ;-)
475 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
479 <!-- ~ End section ~ -->
483 <!-- ~~~~~ New section ~~~~~ -->
485 <sect2 id="conf-log-loc">
486 <title>Configuration and Log File Locations</title>
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.
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.
502 <!-- ~~~~~ New section ~~~~~ -->
503 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
507 <term>Specifies:</term>
509 <para>The directory where the other configuration files are located.</para>
513 <term>Type of value:</term>
515 <para>Path name</para>
519 <term>Default value:</term>
521 <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
525 <term>Effect if unset:</term>
527 <para><emphasis>Mandatory</emphasis></para>
534 No trailing <quote><literal>/</literal></quote>, please.
537 This is really outdated and not likely to happen. HB 09/20/06
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).
550 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
553 <!-- ~~~~~ New section ~~~~~ -->
554 <sect3 renderas="sect4" id="templdir"><title>templdir</title>
558 <term>Specifies:</term>
560 <para>An alternative directory where the templates are loaded from.</para>
564 <term>Type of value:</term>
566 <para>Path name</para>
570 <term>Default value:</term>
576 <term>Effect if unset:</term>
578 <para>The templates are assumed to be located in confdir/template.</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.
596 <![%config-file;[<literallayout>@@#templdir .</literallayout>]]>
600 <!-- ~~~~~ New section ~~~~~ -->
601 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
605 <term>Specifies:</term>
608 The directory where all logging takes place
609 (i.e. where the <filename>logfile</filename> is located).
614 <term>Type of value:</term>
616 <para>Path name</para>
620 <term>Default value:</term>
622 <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
626 <term>Effect if unset:</term>
628 <para><emphasis>Mandatory</emphasis></para>
635 No trailing <quote><literal>/</literal></quote>, please.
641 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
645 <!-- ~~~~~ New section ~~~~~ -->
646 <sect3 renderas="sect4" id="actionsfile"><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. -->
655 <term>Specifies:</term>
658 The <link linkend="actions-file">actions file(s)</link> to use
663 <term>Type of value:</term>
665 <para>Complete file name, relative to <literal>confdir</literal></para>
669 <term>Default values:</term>
673 <msgtext><literallayout> match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout></msgtext>
676 <msgtext><literallayout> default.action # Main actions file</literallayout></msgtext>
679 <msgtext><literallayout> user.action # User customizations</literallayout></msgtext>
685 <term>Effect if unset:</term>
688 No actions are taken at all. More or less neutral proxying.
696 Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
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.
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.
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.
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>]]>
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.
727 <![%config-file;[<literallayout>@@actionsfile user.action # User customizations</literallayout>]]>
730 <!-- ~~~~~ New section ~~~~~ -->
731 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
732 <anchor id="default.filter">
735 <term>Specifies:</term>
738 The <link linkend="filter-file">filter file(s)</link> to use
743 <term>Type of value:</term>
745 <para>File name, relative to <literal>confdir</literal></para>
749 <term>Default value:</term>
751 <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
755 <term>Effect if unset:</term>
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.
768 Multiple <literal>filterfile</literal> lines are permitted.
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.
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!
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>
791 It is recommended to place any locally adapted filters into a separate
792 file, such as <filename>user.filter</filename>.
798 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
799 <![%config-file;[<literallayout>@@filterfile user.filter # User customizations</literallayout>]]>
803 <!-- ~~~~~ New section ~~~~~ -->
804 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
808 <term>Specifies:</term>
816 <term>Type of value:</term>
818 <para>File name, relative to <literal>logdir</literal></para>
822 <term>Default value:</term>
824 <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
828 <term>Effect if unset:</term>
831 No logfile is written.
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
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
853 For most troubleshooting purposes, you will have to change that,
854 please refer to the debugging section for details.
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>).
862 Any log files must be writable by whatever user <application>Privoxy</application>
863 is being run as (on Unix, default user id is <quote>privoxy</quote>).
869 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
873 <!-- ~~~~~ New section ~~~~~ -->
874 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
877 <term>Specifies:</term>
880 The name of the trust file to use
885 <term>Type of value:</term>
887 <para>File name, relative to <literal>confdir</literal></para>
891 <term>Default value:</term>
893 <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
897 <term>Effect if unset:</term>
900 The entire trust mechanism is disabled.
908 The trust mechanism is an experimental feature for building white-lists and should
909 be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
912 If you specify a trust file, <application>Privoxy</application> will only allow
913 access to sites that are specified in the trustfile. Sites can be listed
917 Prepending a <literal>~</literal> character limits access to this site
918 only (and any sub-paths within this site), e.g.
919 <literal>~www.example.com</literal> allows access to
920 <literal>~www.example.com/features/news.html</literal>, etc.
923 Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
924 prepending the name with a <literal>+</literal> character. The effect is that
925 access to untrusted sites will be granted -- but only if a link from this
926 trusted referrer was used to get there. The link target will then be added
927 to the <quote>trustfile</quote> so that future, direct accesses will be
928 granted. Sites added via this mechanism do not become trusted referrers
929 themselves (i.e. they are added with a <literal>~</literal> designation).
930 There is a limit of 512 such entries, after which new entries will not be
934 If you use the <literal>+</literal> operator in the trust file, it may grow
935 considerably over time.
938 It is recommended that <application>Privoxy</application> be compiled with
939 the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
940 <literal> --disable-editor</literal> options, if this feature is to be
944 Possible applications include limiting Internet access for children.
951 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
955 <!-- ~ End section ~ -->
957 <!-- ~~~~~ New section ~~~~~ -->
958 <sect2 id="debugging">
959 <title>Debugging</title>
962 These options are mainly useful when tracing a problem.
963 Note that you might also want to invoke
964 <application>Privoxy</application> with the <literal>--no-daemon</literal>
965 command line option when debugging.
968 <sect3 renderas="sect4" id="debug"><title>debug</title>
972 <term>Specifies:</term>
975 Key values that determine what information gets logged.
980 <term>Type of value:</term>
982 <para>Integer values</para>
986 <term>Default value:</term>
988 <para>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</para>
992 <term>Effect if unset:</term>
995 Default value is used (see above).
1003 The available debug levels are:
1007 debug 1 # Log the destination for each request &my-app; let through. See also debug 1024.
1008 debug 2 # show each connection status
1009 debug 4 # show I/O status
1010 debug 8 # show header parsing
1011 debug 16 # log all data written to the network
1012 debug 32 # debug force feature
1013 debug 64 # debug regular expression filters
1014 debug 128 # debug redirects
1015 debug 256 # debug GIF de-animation
1016 debug 512 # Common Log Format
1017 debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
1018 debug 2048 # CGI user interface
1019 debug 4096 # Startup banner and warnings.
1020 debug 8192 # Non-fatal errors
1021 debug 32768 # log all data read from the network
1022 debug 65536 # Log the applying actions
1026 To select multiple debug levels, you can either add them or use
1027 multiple <literal>debug</literal> lines.
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).
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.
1043 If you are used to the more verbose settings, simply enable the debug lines
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.
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>.
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.
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>]]>
1071 <!-- ~~~~~ New section ~~~~~ -->
1072 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1076 <term>Specifies:</term>
1079 Whether to run only one server thread.
1084 <term>Type of value:</term>
1086 <para><emphasis>None</emphasis></para>
1090 <term>Default value:</term>
1092 <para><emphasis>Unset</emphasis></para>
1096 <term>Effect if unset:</term>
1099 Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1100 serve multiple requests simultaneously.
1108 This option is only there for debugging purposes.
1109 <emphasis>It will drastically reduce performance.</emphasis>
1115 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1118 <!-- ~~~~~ New section ~~~~~ -->
1119 <sect3 renderas="sect4" id="hostname"><title>hostname</title>
1123 <term>Specifies:</term>
1126 The hostname shown on the CGI pages.
1131 <term>Type of value:</term>
1137 <term>Default value:</term>
1139 <para><emphasis>Unset</emphasis></para>
1143 <term>Effect if unset:</term>
1146 The hostname provided by the operating system is used.
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.
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.
1165 Note that Privoxy does not validate the specified hostname value.
1171 <![%config-file;[<literallayout>@@#hostname hostname.example.org</literallayout>]]>
1176 <!-- ~ End section ~ -->
1179 <!-- ~~~~~ New section ~~~~~ -->
1180 <sect2 id="access-control">
1181 <title>Access Control and Security</title>
1184 This section of the config file controls the security-relevant aspects
1185 of <application>Privoxy</application>'s configuration.
1189 <!-- ~~~~~ New section ~~~~~ -->
1190 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1194 <term>Specifies:</term>
1197 The address and TCP port on which <application>Privoxy</application> will
1198 listen for client requests.
1203 <term>Type of value:</term>
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>
1211 <term>Default value:</term>
1213 <para>127.0.0.1:8118</para>
1217 <term>Effect if unset:</term>
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.
1230 You will need to configure your browser(s) to this proxy address and port.
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.
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
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
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
1255 If the specified address isn't available on the system, or if the
1256 hostname can't be resolved, <application>Privoxy</application>
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>.
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.
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.
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.
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.
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>
1297 <term>Example:</term>
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:
1307 listen-address 192.168.0.1:8118
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:
1317 listen-address [::1]:8118
1324 <![%config-file;[<literallayout>@@listen-address 127.0.0.1:8118</literallayout>]]>
1328 <!-- ~~~~~ New section ~~~~~ -->
1329 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1333 <term>Specifies:</term>
1336 Initial state of "toggle" status
1341 <term>Type of value:</term>
1347 <term>Default value:</term>
1353 <term>Effect if unset:</term>
1356 Act as if toggled on
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.
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.
1374 Remote toggling is now disabled by default. fk 2007-11-07)
1378 The windows version will only display the toggle icon in the system tray
1379 if this option is present.
1385 <![%config-file;[<literallayout>@@toggle 1</literallayout>]]>
1389 <!-- ~~~~~ New section ~~~~~ -->
1390 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1393 <term>Specifies:</term>
1396 Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1397 feature</ulink> may be used
1402 <term>Type of value:</term>
1408 <term>Default value:</term>
1414 <term>Effect if unset:</term>
1417 The web-based toggle feature is disabled.
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.
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.
1437 Note that malicious client side code (e.g Java) is also
1438 capable of using this option.
1441 As a lot of <application>Privoxy</application> users don't read
1442 documentation, this feature is disabled by default.
1445 Note that you must have compiled <application>Privoxy</application> with
1446 support for this feature, otherwise this option has no effect.
1452 <![%config-file;[<literallayout>@@enable-remote-toggle 0</literallayout>]]>
1456 <!-- ~~~~~ New section ~~~~~ -->
1457 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1460 <term>Specifies:</term>
1463 Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1468 <term>Type of value:</term>
1474 <term>Default value:</term>
1480 <term>Effect if unset:</term>
1483 Privoxy ignores special HTTP headers.
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.
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.
1503 This option will be removed in future releases as it has been obsoleted
1504 by the more general header taggers.
1510 <![%config-file;[<literallayout>@@enable-remote-http-toggle 0</literallayout>]]>
1514 <!-- ~~~~~ New section ~~~~~ -->
1515 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1518 <term>Specifies:</term>
1521 Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1522 file editor</ulink> may be used
1527 <term>Type of value:</term>
1533 <term>Default value:</term>
1539 <term>Effect if unset:</term>
1542 The web-based actions file editor is disabled.
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.
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.
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.
1568 Note that you must have compiled <application>Privoxy</application> with
1569 support for this feature, otherwise this option has no effect.
1575 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1579 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1582 <term>Specifies:</term>
1585 Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1590 <term>Type of value:</term>
1593 <replaceable>0 or 1</replaceable>
1598 <term>Default value:</term>
1600 <para><emphasis>0</emphasis></para>
1604 <term>Effect if unset:</term>
1607 Blocks are not enforced.
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.
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.
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
1641 <term>Examples:</term>
1649 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
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">
1661 <term>Specifies:</term>
1664 Who can access what.
1669 <term>Type of value:</term>
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>]]
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.
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
1698 <term>Default value:</term>
1700 <para><emphasis>Unset</emphasis></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).
1710 <term>Effect if unset:</term>
1713 Don't restrict access further than implied by <literal>listen-address</literal>
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>
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.
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>.
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).
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.
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.
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
1770 <term>Examples:</term>
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:
1780 permit-access localhost
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):
1789 permit-access www.privoxy.org/24 www.example.com/32
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:
1799 permit-access 192.168.45.64/26
1800 deny-access 192.168.45.73 www.dirty-stuff.example.com
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):
1809 permit-access 192.0.2.0/24
1813 This is equivalent to the following line even if listening on an
1814 IPv4 address (not supported on all platforms):
1818 permit-access [::ffff:192.0.2.0]/120
1827 <!-- ~~~~~ New section ~~~~~ -->
1828 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1832 <term>Specifies:</term>
1835 Maximum size of the buffer for content filtering.
1840 <term>Type of value:</term>
1842 <para>Size in Kbytes</para>
1846 <term>Default value:</term>
1852 <term>Effect if unset:</term>
1855 Use a 4MB (4096 KB) limit.
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.
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>
1882 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1887 <!-- ~ End section ~ -->
1890 <!-- ~~~~~ New section ~~~~~ -->
1892 <sect2 id="forwarding">
1893 <title>Forwarding</title>
1896 This feature allows routing of HTTP requests through a chain of
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.
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.
1915 Also specified here are SOCKS proxies. <application>Privoxy</application>
1916 supports the SOCKS 4 and SOCKS 4A protocols.
1919 <sect3 renderas="sect4" id="forward"><title>forward</title>
1922 <term>Specifies:</term>
1925 To which parent HTTP proxy specific requests should be routed.
1930 <term>Type of value:</term>
1933 <replaceable class="parameter">target_pattern</replaceable>
1934 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
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>.
1948 <term>Default value:</term>
1950 <para><emphasis>Unset</emphasis></para>
1954 <term>Effect if unset:</term>
1957 Don't use parent HTTP proxies.
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.
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).
1979 Multiple lines are OK, they are checked in sequence, and the last match wins.
1984 <term>Examples:</term>
1987 Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
1991 forward / parent-proxy.example.org:8080
1996 Everything goes to our example ISP's caching proxy, except for requests
1997 to that ISP's sites:
2001 forward / caching-proxy.isp.example.net:8000
2002 forward .isp.example.net .
2006 Parent proxy specified by an IPv6 address:
2010 forward / [2001:DB8::1]:8000
2014 Suppose your parent proxy doesn't support IPv6:
2018 forward / parent-proxy.example.org:8000
2019 forward ipv6-server.example.org .
2020 forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
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">
2037 <term>Specifies:</term>
2040 Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2045 <term>Type of value:</term>
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>]
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
2067 <term>Default value:</term>
2069 <para><emphasis>Unset</emphasis></para>
2073 <term>Effect if unset:</term>
2076 Don't use SOCKS proxies.
2084 Multiple lines are OK, they are checked in sequence, and the last match wins.
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.
2092 With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
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).
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
2113 <term>Examples:</term>
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
2123 forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
2124 forward .example.com .
2128 A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2132 forward-socks4 / socks-gw.example.com:1080 .
2137 To chain Privoxy and Tor, both running on the same system, you would use
2142 forward-socks5 / 127.0.0.1:9050 .
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:
2153 forward 192.168.*.*/ .
2155 forward 127.*.*.*/ .
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.
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
2172 forward localhost/ .
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>
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.
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:
2205 forward .isp-b.example.net host-b:8118
2216 forward .isp-a.example.org host-a:8118
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.
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.
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:
2239 # Define Privoxy as parent proxy (without ICP)
2240 cache_peer 127.0.0.1 parent 8118 7 no-query
2242 # Define ACL for protocol FTP
2245 # Do not forward FTP requests to Privoxy
2246 always_direct allow ftp
2248 # Forward all the rest to Privoxy
2249 never_direct allow all</screen>
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>.
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:
2266 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
2272 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2275 <term>Specifies:</term>
2278 How often Privoxy retries if a forwarded connection request fails.
2283 <term>Type of value:</term>
2286 <replaceable class="parameter">Number of retries.</replaceable>
2291 <term>Default value:</term>
2293 <para><emphasis>0</emphasis></para>
2297 <term>Effect if unset:</term>
2300 Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
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.
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.
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.
2326 <term>Examples:</term>
2329 forwarded-connect-retries 1
2334 <![%config-file;[<literallayout>@@forwarded-connect-retries 0</literallayout>]]>
2340 <title>Miscellaneous</title>
2342 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2345 <term>Specifies:</term>
2348 Whether intercepted requests should be treated as valid.
2353 <term>Type of value:</term>
2356 <replaceable>0 or 1</replaceable>
2361 <term>Default value:</term>
2363 <para><emphasis>0</emphasis></para>
2367 <term>Effect if unset:</term>
2370 Only proxy requests are accepted, intercepted requests are treated as invalid.
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>.
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.
2394 <term>Examples:</term>
2397 accept-intercepted-requests 1
2402 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2405 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2408 <term>Specifies:</term>
2411 Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2416 <term>Type of value:</term>
2419 <replaceable>0 or 1</replaceable>
2424 <term>Default value:</term>
2426 <para><emphasis>0</emphasis></para>
2430 <term>Effect if unset:</term>
2433 <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
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.
2447 Don't enable this option unless you're sure that you really need it.
2452 <term>Examples:</term>
2455 allow-cgi-request-crunching 1
2460 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2463 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2466 <term>Specifies:</term>
2469 Whether the CGI interface should stay compatible with broken HTTP clients.
2474 <term>Type of value:</term>
2477 <replaceable>0 or 1</replaceable>
2482 <term>Default value:</term>
2484 <para><emphasis>0</emphasis></para>
2488 <term>Effect if unset:</term>
2491 The CGI form generate long GET URLs.
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.
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
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.
2519 <term>Examples:</term>
2527 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2530 <sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
2533 <term>Specifies:</term>
2536 Number of seconds after which an open connection will no longer be reused.
2541 <term>Type of value:</term>
2544 <replaceable>Time in seconds.</replaceable>
2549 <term>Default value:</term>
2555 <term>Effect if unset:</term>
2558 Connections are not kept alive.
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.
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.
2579 This option has no effect if <application>Privoxy</application>
2580 has been compiled without keep-alive support.
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
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 probably can't.
2602 <term>Examples:</term>
2605 keep-alive-timeout 300
2610 <![%config-file;[<literallayout>@@keep-alive-timeout 5</literallayout>]]>
2614 <sect3 renderas="sect4" id="tolerate-pipelining"><title>tolerate-pipelining</title>
2617 <term>Specifies:</term>
2620 Whether or not pipelined requests should be served.
2625 <term>Type of value:</term>
2628 <replaceable>0 or 1.</replaceable>
2633 <term>Default value:</term>
2639 <term>Effect if unset:</term>
2642 If Privoxy receives more than one request at once, it terminates the
2643 client connection after serving the first one.
2651 &my-app; currently doesn't pipeline outgoing requests,
2652 thus allowing pipelining on the client connection is not
2653 guaranteed to improve the performance.
2656 By default &my-app; tries to discourage clients from pipelining
2657 by discarding aggressively pipelined requests, which forces the
2658 client to resend them through a new connection.
2661 This option lets &my-app; tolerate pipelining. Whether or not
2662 that improves performance mainly depends on the client configuration.
2665 This options is new and should be considered experimental.
2670 <term>Examples:</term>
2673 tolerate-pipelining 1
2678 <![%config-file;[<literallayout>@@#tolerate-pipelining 1</literallayout>]]>
2682 <sect3 renderas="sect4" id="default-server-timeout"><title>default-server-timeout</title>
2685 <term>Specifies:</term>
2688 Assumed server-side keep-alive timeout if not specified by the server.
2693 <term>Type of value:</term>
2696 <replaceable>Time in seconds.</replaceable>
2701 <term>Default value:</term>
2707 <term>Effect if unset:</term>
2710 Connections for which the server didn't specify the keep-alive
2711 timeout are not reused.
2719 Enabling this option significantly increases the number of connections
2720 that are reused, provided the <ulink
2721 url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> option
2725 While it also increases the number of connections problems
2726 when &my-app; tries to reuse a connection that already has
2727 been closed on the server side, or is closed while &my-app;
2728 is trying to reuse it, this should only be a problem if it
2729 happens for the first request sent by the client. If it happens
2730 for requests on reused client connections, &my-app; will simply
2731 close the connection and the client is supposed to retry the
2732 request without bothering the user.
2735 Enabling this option is therefore only recommended if the
2737 url="#CONNECTION-SHARING">connection-sharing</ulink> option
2741 It is an error to specify a value larger than the <ulink
2742 url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> value.
2745 This option has no effect if <application>Privoxy</application>
2746 has been compiled without keep-alive support.
2751 <term>Examples:</term>
2754 default-server-timeout 60
2759 <![%config-file;[<literallayout>@@#default-server-timeout 60</literallayout>]]>
2763 <sect3 renderas="sect4" id="connection-sharing"><title>connection-sharing</title>
2766 <term>Specifies:</term>
2769 Whether or not outgoing connections that have been kept alive
2770 should be shared between different incoming connections.
2775 <term>Type of value:</term>
2778 <replaceable>0 or 1</replaceable>
2783 <term>Default value:</term>
2789 <term>Effect if unset:</term>
2792 Connections are not shared.
2800 This option has no effect if <application>Privoxy</application>
2801 has been compiled without keep-alive support, or if it's disabled.
2809 Note that reusing connections doesn't necessary cause speedups.
2810 There are also a few privacy implications you should be aware of.
2813 If this option is effective, outgoing connections are shared between
2814 clients (if there are more than one) and closing the browser that initiated
2815 the outgoing connection does no longer affect the connection between &my-app;
2816 and the server unless the client's request hasn't been completed yet.
2819 If the outgoing connection is idle, it will not be closed until either
2820 <application>Privoxy's</application> or the server's timeout is reached.
2821 While it's open, the server knows that the system running &my-app; is still
2825 If there are more than one client (maybe even belonging to multiple users),
2826 they will be able to reuse each others connections. This is potentially
2827 dangerous in case of authentication schemes like NTLM where only the
2828 connection is authenticated, instead of requiring authentication for
2832 If there is only a single client, and if said client can keep connections
2833 alive on its own, enabling this option has next to no effect. If the client
2834 doesn't support connection keep-alive, enabling this option may make sense
2835 as it allows &my-app; to keep outgoing connections alive even if the client
2836 itself doesn't support it.
2839 You should also be aware that enabling this option increases the likelihood
2840 of getting the "No server or forwarder data" error message, especially if you
2841 are using a slow connection to the Internet.
2844 This option should only be used by experienced users who
2845 understand the risks and can weight them against the benefits.
2850 <term>Examples:</term>
2853 connection-sharing 1
2858 <![%config-file;[<literallayout>@@#connection-sharing 1</literallayout>]]>
2862 <sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
2865 <term>Specifies:</term>
2868 Number of seconds after which a socket times out if
2869 no data is received.
2874 <term>Type of value:</term>
2877 <replaceable>Time in seconds.</replaceable>
2882 <term>Default value:</term>
2888 <term>Effect if unset:</term>
2891 A default value of 300 seconds is used.
2899 The default is quite high and you probably want to reduce it.
2900 If you aren't using an occasionally slow proxy like Tor, reducing
2901 it to a few seconds should be fine.
2906 <term>Examples:</term>
2914 <![%config-file;[<literallayout>@@socket-timeout 300</literallayout>]]>
2918 <sect3 renderas="sect4" id="max-client-connections"><title>max-client-connections</title>
2921 <term>Specifies:</term>
2924 Maximum number of client connections that will be served.
2929 <term>Type of value:</term>
2932 <replaceable>Positive number.</replaceable>
2937 <term>Default value:</term>
2943 <term>Effect if unset:</term>
2946 Connections are served until a resource limit is reached.
2954 &my-app; creates one thread (or process) for every incoming client
2955 connection that isn't rejected based on the access control settings.
2958 If the system is powerful enough, &my-app; can theoretically deal with
2959 several hundred (or thousand) connections at the same time, but some
2960 operating systems enforce resource limits by shutting down offending
2961 processes and their default limits may be below the ones &my-app; would
2962 require under heavy load.
2965 Configuring &my-app; to enforce a connection limit below the thread
2966 or process limit used by the operating system makes sure this doesn't
2967 happen. Simply increasing the operating system's limit would work too,
2968 but if &my-app; isn't the only application running on the system,
2969 you may actually want to limit the resources used by &my-app;.
2972 If &my-app; is only used by a single trusted user, limiting the
2973 number of client connections is probably unnecessary. If there
2974 are multiple possibly untrusted users you probably still want to
2975 additionally use a packet filter to limit the maximal number of
2976 incoming connections per client. Otherwise a malicious user could
2977 intentionally create a high number of connections to prevent other
2978 users from using &my-app;.
2981 Obviously using this option only makes sense if you choose a limit
2982 below the one enforced by the operating system.
2987 <term>Examples:</term>
2990 max-client-connections 256
2995 <![%config-file;[<literallayout>@@#max-client-connections 256</literallayout>]]>
2999 <sect3 renderas="sect4" id="handle-as-empty-doc-returns-ok"><title>handle-as-empty-doc-returns-ok</title>
3002 <term>Specifies:</term>
3005 The status code Privoxy returns for pages blocked with
3006 <!-- URL will only end up in the user manual so the relative link should work. -->
3007 <literal><ulink url="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">+handle-as-empty-document</ulink></literal>.
3012 <term>Type of value:</term>
3015 <replaceable>0 or 1</replaceable>
3020 <term>Default value:</term>
3026 <term>Effect if unset:</term>
3029 Privoxy returns a status 403(forbidden) for all blocked pages.
3034 <term>Effect if set:</term>
3037 Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
3038 and a status 403(Forbidden) for all other blocked pages.
3046 This is a work-around for Firefox bug 492459:
3048 Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.
3050 (<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
3051 >https://bugzilla.mozilla.org/show_bug.cgi?id=492459</ulink>)
3052 As the bug has been fixed for quite some time this option should no longer
3053 be needed and will be removed in a future release. Please speak up if you
3054 have a reason why the option should be kept around.
3059 <![%config-file;[<literallayout>@@#handle-as-empty-doc-returns-ok 1</literallayout>]]>
3063 <sect3 renderas="sect4" id="enable-compression"><title>enable-compression</title>
3066 <term>Specifies:</term>
3069 Whether or not buffered content is compressed before delivery.
3074 <term>Type of value:</term>
3077 <replaceable>0 or 1</replaceable>
3082 <term>Default value:</term>
3088 <term>Effect if unset:</term>
3091 Privoxy does not compress buffered content.
3096 <term>Effect if set:</term>
3099 Privoxy compresses buffered content before delivering it to the client,
3100 provided the client supports it.
3108 This directive is only supported if Privoxy has been compiled with
3109 FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB.
3112 Compressing buffered content is mainly useful if Privoxy and the
3113 client are running on different systems. If they are running on the
3114 same system, enabling compression is likely to slow things down.
3115 If you didn't measure otherwise, you should assume that it does
3116 and keep this option disabled.
3119 Privoxy will not compress buffered content below a certain length.
3124 <![%config-file;[<literallayout>@@#enable-compression 1</literallayout>]]>
3128 <sect3 renderas="sect4" id="compression-level"><title>compression-level</title>
3131 <term>Specifies:</term>
3134 The compression level that is passed to the zlib library when compressing buffered content.
3139 <term>Type of value:</term>
3142 <replaceable>Positive number ranging from 0 to 9.</replaceable>
3147 <term>Default value:</term>
3156 Compressing the data more takes usually longer than compressing
3157 it less or not compressing it at all. Which level is best depends
3158 on the connection between Privoxy and the client. If you can't
3159 be bothered to benchmark it for yourself, you should stick with
3160 the default and keep compression disabled.
3163 If compression is disabled, the compression level is irrelevant.
3168 <term>Examples:</term>
3172 # Best speed (compared to the other levels)
3176 # No compression. Only useful for testing as the added header
3177 # slightly increases the amount of data that has to be sent.
3178 # If your benchmark shows that using this compression level
3179 # is superior to using no compression at all, the benchmark
3180 # is likely to be flawed.
3187 <![%config-file;[<literallayout>@@#compression-level 1</literallayout>]]>
3191 <sect3 renderas="sect4" id="client-header-order"><title>client-header-order</title>
3194 <term>Specifies:</term>
3197 The order in which client headers are sorted before forwarding them.
3202 <term>Type of value:</term>
3205 <replaceable>Client header names delimited by spaces or tabs</replaceable>
3210 <term>Default value:</term>
3219 By default &my-app; leaves the client headers in the order they
3220 were sent by the client. Headers are modified in-place, new headers
3221 are added at the end of the already existing headers.
3224 The header order can be used to fingerprint client requests
3225 independently of other headers like the User-Agent.
3228 This directive allows to sort the headers differently to better
3229 mimic a different User-Agent. Client headers will be emitted
3230 in the order given, headers whose name isn't explicitly specified
3231 are added at the end.
3234 Note that sorting headers in an uncommon way will make fingerprinting
3235 actually easier. Encrypted headers are not affected by this directive.
3240 <![%config-file;[<literallayout>@@#client-header-order Host \
3245 # Proxy-Connection,\
3247 # If-Modified-Since \
3257 <!-- ~ End section ~ -->
3260 <!-- ~~~~~ New section ~~~~~ -->
3262 <sect2 id="windows-gui">
3263 <title>Windows GUI Options</title>
3265 <application>Privoxy</application> has a number of options specific to the
3266 Windows GUI interface:
3269 <anchor id="activity-animation">
3270 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3272 If <quote>activity-animation</quote> is set to 1, the
3273 <application>Privoxy</application> icon will animate when
3274 <quote>Privoxy</quote> is active. To turn off, set to 0.
3277 <![%config-file;[<literallayout>@@#activity-animation 1</literallayout>]]>
3283 <emphasis>activity-animation 1</emphasis>
3290 <anchor id="log-messages">
3291 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3293 If <quote>log-messages</quote> is set to 1,
3294 <application>Privoxy</application> copy log messages to the console
3296 The log detail depends on the <link linkend="debug">debug</link> directive.
3299 <![%config-file;[<literallayout>@@#log-messages 1</literallayout>]]>
3305 <emphasis>log-messages 1</emphasis>
3312 <anchor id="log-buffer-size">
3313 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3315 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
3316 i.e. the amount of memory used for the log messages displayed in the
3317 console window, will be limited to <quote>log-max-lines</quote> (see below).
3321 Warning: Setting this to 0 will result in the buffer to grow infinitely and
3322 eat up all your memory!
3325 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
3331 <emphasis>log-buffer-size 1</emphasis>
3338 <anchor id="log-max-lines">
3339 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3341 <application>log-max-lines</application> is the maximum number of lines held
3342 in the log buffer. See above.
3345 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
3351 <emphasis>log-max-lines 200</emphasis>
3358 <anchor id="log-highlight-messages">
3359 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3361 If <quote>log-highlight-messages</quote> is set to 1,
3362 <application>Privoxy</application> will highlight portions of the log
3363 messages with a bold-faced font:
3366 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
3372 <emphasis>log-highlight-messages 1</emphasis>
3379 <anchor id="log-font-name">
3380 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3382 The font used in the console window:
3385 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
3391 <emphasis>log-font-name Comic Sans MS</emphasis>
3398 <anchor id="log-font-size">
3399 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3401 Font size used in the console window:
3404 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
3410 <emphasis>log-font-size 8</emphasis>
3417 <anchor id="show-on-task-bar">
3418 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3420 <quote>show-on-task-bar</quote> controls whether or not
3421 <application>Privoxy</application> will appear as a button on the Task bar
3425 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
3431 <emphasis>show-on-task-bar 0</emphasis>
3438 <anchor id="close-button-minimizes">
3439 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3441 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
3442 button will minimize <application>Privoxy</application> instead of closing
3443 the program (close with the exit option on the File menu).
3446 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
3452 <emphasis>close-button-minimizes 1</emphasis>
3459 <anchor id="hide-console">
3460 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3462 The <quote>hide-console</quote> option is specific to the MS-Win console
3463 version of <application>Privoxy</application>. If this option is used,
3464 <application>Privoxy</application> will disconnect from and hide the
3468 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
3474 #<emphasis>hide-console</emphasis>
3484 <!-- end config content common to both outputs -->
3487 <!-- These are dummy anchors to keep the processor quiet -->
3488 <!-- when building config-file only (ie. they are used in u-m only) -->
3491 <anchor id="filter">
3492 <anchor id="filter-file">
3494 <anchor id="actions-file">
3495 <anchor id="af-patterns">
3499 <!-- eof p-config.sgml -->
projects / privoxy.git / blob