Purpose : Used with other docs and files only.
- $Id: p-config.sgml,v 2.59 2010/01/11 13:45:04 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.97 2013/03/01 17:39:27 fabiankeil Exp $
- Copyright (C) 2001-2010 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/
See LICENSE.
========================================================================
- NOTE: Please read developer-manual/documentation.html before touching
+ NOTE: Please read developer-manual/documentation.html before touching
anything in this, or other Privoxy documentation.
========================================================================
-
- This file contains all the config file comments and options. It used to
+
+ This file contains all the config file comments and options. It used to
build both the user-manual config sections, and all of config (yes, the main
config file) itself.
- Rationale: This is broken up into two files since a file with a prolog
+ Rationale: This is broken up into two files since a file with a prolog
(DTD, etc) cannot be sourced as a secondary file. config.sgml is basically
a wrapper for this file.
IMPORTANT:
- OPTIONS: The actual options are included in this file and prefixed with
- '@@', and processed by the Makefile to strip the '@@'. Default options
- that should appear commented out should be listed as: '@@#OPTION'.
+ OPTIONS: The actual options are included in this file and prefixed with
+ '@@', and processed by the Makefile to strip the '@@'. Default options
+ that should appear commented out should be listed as: '@@#OPTION'.
Otherwise, as '@@OPTION'. Example:
@@listen-address 127.0.0.1:8118
- The Makefile does significant other processing too. The final results
- should be checked to make sure that the perl processing does not
+ The Makefile does significant other processing too. The final results
+ should be checked to make sure that the perl processing does not
fubar something!!! Makefile processing requires w3m, fmt (shell line
formatter), and perl.
-
+
This file is included into:
<title>The Main Configuration File</title>
<para>
- Again, the main configuration file is named <filename>config</filename> on
- Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
+ By default, the main configuration file is named <filename>config</filename>,
+ with the exception of Windows, where it is named <filename>config.txt</filename>.
Configuration lines consist of an initial keyword followed by a list of
values, all separated by whitespace (any number of spaces or tabs). For
example:
<para>
<literal>
- <msgtext>
+ <msgtext>
<literallayout>
<emphasis>confdir /etc/privoxy</emphasis></literallayout>
</msgtext>
- </literal>
+ </literal>
</para>
<para>
<sect1 id="config">
<title>
@@TITLE<!-- between the @@ is stripped by Makefile -->@@
- Sample Configuration File for Privoxy v&p-version;
+ Sample Configuration File for Privoxy &p-version;
</title>
<para>
- $Id: p-config.sgml,v 2.59 2010/01/11 13:45:04 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.97 2013/03/01 17:39:27 fabiankeil Exp $
</para>
<para>
-Copyright (C) 2001-2010 Privoxy Developers http://www.privoxy.org/
+Copyright (C) 2001-2013 Privoxy Developers http://www.privoxy.org/
</para>
<para>
</para>
<para>
Thus, by placing a # at the start of an existing configuration line,
- you can make it a comment and it will be treated as if it weren't there.
+ you can make it a comment and it will be treated as if it weren't there.
This is called "commenting out" an option and can be useful. Removing
the # again is called "uncommenting".
</para>
<term>Notes:</term>
<listitem>
<para>
- The User Manual URI is the single best source of information on
+ The User Manual URI is the single best source of information on
<application>Privoxy</application>, and is used for help links from some
of the internal CGI pages. The manual itself is normally packaged with the
binary distributions, so you probably want to set this to a locally
- installed copy.
+ installed copy.
</para>
<para>
Examples:
<para>
<screen> user-manual file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
</para>
- -->
+ -->
<para>
The best all purpose solution is simply to put the full local
<literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
(or the shortcut: <literal>http://p.p/user-manual/</literal>).
</para>
<para>
- If the documentation is not on the local system, it can be accessed
+ If the documentation is not on the local system, it can be accessed
from a remote server, as:
</para>
<para>
file</emphasis>, because it is used while the config file is being read
on start-up.
</para>
- </warning>
+ </warning>
]]>
<![%config-file;[
WARNING!!!
</para>
<blockquote>
- <para>
+ <para>
If set, this option should be the first option in the config
file, because it is used while the config file is being read.
</para>
<term>Specifies:</term>
<listitem>
<para>
- A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
+ A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
</para>
</listitem>
</varlistentry>
If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
are unset, the whole "Local Privoxy Support" box on all generated pages will
not be shown.
- </para>
+ </para>
</listitem>
</varlistentry>
</variablelist>
If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
are unset, the whole "Local Privoxy Support" box on all generated pages will
not be shown.
- </para>
+ </para>
<para>
This URL shouldn't be blocked ;-)
- </para>
+ </para>
</listitem>
</varlistentry>
</variablelist>
<application>Privoxy</application> can (and normally does) use a number of
other files for additional configuration, help and logging.
This section of the configuration file tells <application>Privoxy</application>
- where to find those other files.
+ where to find those other files.
</para>
<para>
<para>
No trailing <quote><literal>/</literal></quote>, please.
</para>
- <!--
+ <!--
This is really outdated and not likely to happen. HB 09/20/06
<para>
When development goes modular and multi-user, the blocker, filter, and
per-user config will be stored in subdirectories of <quote>confdir</quote>.
- For now, the configuration directory structure is flat, except for
- <filename>confdir/templates</filename>, where the HTML templates for CGI
- output reside (e.g. <application>Privoxy's</application> 404 error page).
+ For now, the configuration directory structure is flat, except for
+ <filename>confdir/templates</filename>, where the HTML templates for CGI
+ output reside (e.g. <application>Privoxy's</application> 404 error page).
</para>
- -->
+ -->
</listitem>
</varlistentry>
</variablelist>
<term>Effect if unset:</term>
<listitem>
<para>
- No actions are taken at all. More or less neutral proxying.
+ No actions are taken at all. More or less neutral proxying.
</para>
</listitem>
</varlistentry>
<para>
Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
</para>
- <para>
+ <para>
The default values are <filename>default.action</filename>, which is the
<quote>main</quote> actions file maintained by the developers, and
<filename>user.action</filename>, where you can make your personal additions.
</para>
- <para>
- Actions files contain all the per site and per URL configuration for
+ <para>
+ Actions files contain all the per site and per URL configuration for
ad blocking, cookie management, privacy considerations, etc.
- There is no point in using <application>Privoxy</application> without at
+ There is no point in using <application>Privoxy</application> without at
least one actions file.
</para>
<para>
rules that use <link linkend="regex">regular expressions</link>. These rules permit
powerful changes on the content of Web pages, and optionally the headers
as well, e.g., you could try to disable your favorite JavaScript annoyances,
- re-write the actual displayed text, or just have some fun
+ re-write the actual displayed text, or just have some fun
playing buzzword bingo with web pages.
</para>
<para>
</variablelist>
<![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
-<![%config-file;[<literallayout>@@#filterfile user.filter # User customizations</literallayout>]]>
+<![%config-file;[<literallayout>@@filterfile user.filter # User customizations</literallayout>]]>
</sect3>
<para>
Your logfile will grow indefinitely, and you will probably want to
periodically remove it. On Unix systems, you can do this with a cron job
- (see <quote>man cron</quote>). For Red Hat based Linux distributions, a
- <command>logrotate</command> script has been included.
- </para>
+ (see <quote>man cron</quote>).
+ </para>
<para>
Any log files must be writable by whatever user <application>Privoxy</application>
is being run as (on Unix, default user id is <quote>privoxy</quote>).
</para>
<para>
If you specify a trust file, <application>Privoxy</application> will only allow
- access to sites that are specified in the trustfile. Sites can be listed
+ access to sites that are specified in the trustfile. Sites can be listed
in one of two ways:
</para>
<para>
- Prepending a <literal>~</literal> character limits access to this site
- only (and any sub-paths within this site), e.g.
+ Prepending a <literal>~</literal> character limits access to this site
+ only (and any sub-paths within this site), e.g.
<literal>~www.example.com</literal> allows access to
- <literal>~www.example.com/features/news.html</literal>, etc.
+ <literal>~www.example.com/features/news.html</literal>, etc.
</para>
<para>
Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
made.
</para>
<para>
- If you use the <literal>+</literal> operator in the trust file, it may grow
+ If you use the <literal>+</literal> operator in the trust file, it may grow
considerably over time.
</para>
<para>
<para>
Possible applications include limiting Internet access for children.
</para>
-
+
</listitem>
</varlistentry>
</variablelist>
debug 2 # show each connection status
debug 4 # show I/O status
debug 8 # show header parsing
- debug 16 # log all data written to the network into the logfile
+ debug 16 # log all data written to the network
debug 32 # debug force feature
debug 64 # debug regular expression filters
debug 128 # debug redirects
debug 2048 # CGI user interface
debug 4096 # Startup banner and warnings.
debug 8192 # Non-fatal errors
+ debug 32768 # log all data read from the network
+ debug 65536 # Log the applying actions
</programlisting>
</para>
<para>
<term>Specifies:</term>
<listitem>
<para>
- The
IP address and TCP port on which <application>Privoxy</application> will
+ The address and TCP port on which <application>Privoxy</application> will
listen for client requests.
</para>
</listitem>
<term>Type of value:</term>
<listitem>
<para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
+ <para>[<replaceable class="parameter">Hostname</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
</listitem>
</varlistentry>
serve requests from other machines (e.g. on your local network) as well, you
will need to override the default.
</para>
+ <para>
+ You can use this statement multiple times to make
+ <application>Privoxy</application> listen on more ports or more
+ <abbrev>IP</abbrev> addresses. Suitable if your operating system does not
+ support sharing <abbrev>IPv6</abbrev> and <abbrev>IPv4</abbrev> protocols
+ on the same socket.
+ </para>
+ <para>
+ If a hostname is used instead of an IP address, <application>Privoxy</application>
+ will try to resolve it to an IP address and if there are multiple, use the first
+ one returned.
+ </para>
+ <para>
+ If the address for the hostname isn't already known on the system
+ (for example because it's in /etc/hostname), this may result in DNS
+ traffic.
+ </para>
+ <para>
+ If the specified address isn't available on the system, or if the
+ hostname can't be resolved, <application>Privoxy</application>
+ will fail to start.
+ </para>
<para>
IPv6 addresses containing colons have to be quoted by brackets.
+ They can only be used if <application>Privoxy</application> has
+ been compiled with IPv6 support. If you aren't sure if your version
+ supports it, have a look at
+ <literal>http://config.privoxy.org/show-status</literal>.
+ </para>
+ <para>
+ Some operating systems will prefer IPv6 to IPv4 addresses even if the
+ system has no IPv6 connectivity which is usually not expected by the user.
+ Some even rely on DNS to resolve localhost which mean the "localhost" address
+ used may not actually be local.
+ </para>
+ <para>
+ It is therefore recommended to explicitly configure the intended IP address
+ instead of relying on the operating system, unless there's a strong reason not to.
</para>
<para>
- If you leave out the IP address, <application>Privoxy</application> will
- bind to all IPv4 interfaces (addresses) on your machine and may become reachable
- from the Internet. In that case, consider using <link
- linkend="acls">access control lists</link> (ACL's, see below), and/or
- a firewall.
+ If you leave out the address, <application>Privoxy</application> will bind to all
+ IPv4 interfaces (addresses) on your machine and may become reachable from the
+ Internet and/or the local network. Be aware that some GNU/Linux distributions
+ modify that behaviour without updating the documentation. Check for non-standard
+ patches if your <application>Privoxy</application> version behaves differently.
+ </para>
+ <para>
+ If you configure <application>Privoxy</application> to be reachable from the
+ network, consider using <link linkend="acls">access control lists</link>
+ (ACL's, see below), and/or a firewall.
</para>
<para>
If you open <application>Privoxy</application> to untrusted users, you will
<quote>toggled off</quote> mode, i.e. mostly behave like a normal,
content-neutral proxy with both ad blocking and content filtering
disabled. See <literal>enable-remote-toggle</literal> below.
-<!--
- This is not really useful
- anymore, since toggling is much easier via <ulink
- url="http://config.privoxy.org/toggle">the web interface</ulink> than via
- editing the <filename>conf</filename> file.
-
- Remote toggling is now disabled by default. fk 2007-11-07)
--->
- </para>
- <para>
- The windows version will only display the toggle icon in the system tray
- if this option is present.
</para>
</listitem>
</varlistentry>
</para>
<para>
Note that you must have compiled <application>Privoxy</application> with
- support for this feature, otherwise this option has no effect.
+ support for this feature, otherwise this option has no effect.
</para>
</listitem>
</varlistentry>
</para>
<para>
Note that you must have compiled <application>Privoxy</application> with
- support for this feature, otherwise this option has no effect.
+ support for this feature, otherwise this option has no effect.
</para>
</listitem>
</varlistentry>
[<replaceable class="parameter">dst_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">dst_masklen</replaceable>]]
</para>
<para>
- Where <replaceable class="parameter">src_addr</replaceable> and
+ Where <replaceable class="parameter">src_addr</replaceable> and
<replaceable class="parameter">dst_addr</replaceable> are IPv4 addresses in dotted decimal notation or valid
DNS names, <replaceable class="parameter">port</replaceable> is a port
number, and <replaceable class="parameter">src_masklen</replaceable> and
<para>
Access controls are included at the request of ISPs and systems
administrators, and <emphasis>are not usually needed by individual users</emphasis>.
- For a typical home user, it will normally suffice to ensure that
+ For a typical home user, it will normally suffice to ensure that
<application>Privoxy</application> only listens on the localhost
(127.0.0.1) or internal (home) network address by means of the
<link linkend="listen-address"><emphasis>listen-address</emphasis></link>
- option.
+ option.
</para>
<para>
Please see the warnings in the FAQ that <application>Privoxy</application>
IP addresses, only the first one is used.
</para>
<para>
- Some systems allows IPv4 client to connect to IPv6 server socket.
- Then the client's IPv4 address will be translated by system into
+ Some systems allow IPv4 clients to connect to IPv6 server sockets.
+ Then the client's IPv4 address will be translated by the system into
IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4
mapped IPv6 address). <application>Privoxy</application> can handle it
and maps such ACL addresses automatically.
<listitem>
<para>
For content filtering, i.e. the <literal>+filter</literal> and
- <literal>+deanimate-gif</literal> actions, it is necessary that
+ <literal>+deanimate-gif</literal> actions, it is necessary that
<application>Privoxy</application> buffers the entire document body.
This can be potentially dangerous, since a server could just keep sending
data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
<replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
</para>
<para>
- where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
+ where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
denote <quote>all URLs</quote>.
<replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
</para>
<para>
<programlisting>
- foward / [2001:DB8::1]:8000
+ forward / [2001:DB8::1]:8000
</programlisting>
</para>
<para>
<!-- ~~~~~ New section ~~~~~ -->
<sect3 renderas="sect4" id="socks"><title>
-forward-socks4, forward-socks4a and forward-socks5</title>
+forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
<anchor id="forward-socks4">
<anchor id="forward-socks4a">
and <replaceable class="parameter">socks_proxy</replaceable>
are IP addresses in dotted decimal notation or valid DNS names
(<replaceable class="parameter">http_parent</replaceable>
- may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
+ may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
<replaceable class="parameter">port</replaceable> parameters are TCP ports,
i.e. integer values from 1 to 65535
</para>
<para>
With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
</para>
+ <para>
+ <literal>forward-socks5t</literal> works like vanilla <literal>forward-socks5</literal> but
+ lets &my-app; additionally use Tor-specific SOCKS extensions. Currently the only supported
+ SOCKS extension is optimistic data which can reduce the latency for the first request made
+ on a newly created connection.
+ </para>
<para>
<replaceable class="parameter">socks_proxy</replaceable> and
<replaceable class="parameter">http_parent</replaceable> can be a
forward-socks4 / socks-gw.example.com:1080 .
</screen>
</para>
-
+
<para>
- To chain Privoxy and Tor, both running on the same system, you would use
+ To chain Privoxy and Tor, both running on the same system, you would use
something like:
</para>
<para>
<sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
<para>
- If you have links to multiple ISPs that provide various special content
+ If you have links to multiple ISPs that provide various special content
only to their subscribers, you can configure multiple <application>Privoxies</application>
which have connections to the respective ISPs to act as forwarders to each other, so that
<emphasis>your</emphasis> users can see the internal content of all ISPs.
</para>
<para>
- If you intend to chain <application>Privoxy</application> and
- <application>squid</application> locally, then chaining as
- <literal>browser -> squid -> privoxy</literal> is the recommended way.
+ If you intend to chain <application>Privoxy</application> and
+ <application>squid</application> locally, then chaining as
+ <literal>browser -> squid -> privoxy</literal> is the recommended way.
</para>
<para>
<para>
<screen>
- # Define Privoxy as parent proxy (without ICP)
- cache_peer 127.0.0.1 parent 8118 7 no-query
+ # Define Privoxy as parent proxy (without ICP)
+ cache_peer 127.0.0.1 parent 8118 7 no-query
- # Define ACL for protocol FTP
- acl ftp proto FTP
+ # Define ACL for protocol FTP
+ acl ftp proto FTP
# Do not forward FTP requests to Privoxy
- always_direct allow ftp
+ always_direct allow ftp
# Forward all the rest to Privoxy
never_direct allow all</screen>
<para>
<screen>
forward / .
- forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
+ forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
</para>
</sect3>
<term>Specifies:</term>
<listitem>
<para>
- How often Privoxy retries if a forwarded connection request fails.
+ How often Privoxy retries if a forwarded connection request fails.
</para>
</listitem>
</varlistentry>
If you don't trust your clients and want to force them
to use <application>Privoxy</application>, enable this
option and configure your packet filter to redirect outgoing
- HTTP connections into <application>Privoxy</application>.
+ HTTP connections into <application>Privoxy</application>.
</para>
<para>
Make sure that <application>Privoxy's</application> own requests
This option has no effect if <application>Privoxy</application>
has been compiled without keep-alive support.
</para>
+ <para>
+ Note that a timeout of five seconds as used in the default
+ configuration file significantly decreases the number of
+ connections that will be reused. The value is used because
+ some browsers limit the number of connections they open to
+ a single host and apply the same limit to proxies. This can
+ result in a single website <quote>grabbing</quote> all the
+ connections the browser allows, which means connections to
+ other websites can't be opened until the connections currently
+ in use time out.
+ </para>
+ <para>
+ Several users have reported this as a Privoxy bug, so the
+ default value has been reduced. Consider increasing it to
+ 300 seconds or even more if you think your browser can handle
+ it. If your browser appears to be hanging, it probably can't.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
</listitem>
</varlistentry>
</variablelist>
-<![%config-file;[<literallayout>@@keep-alive-timeout 300</literallayout>]]>
+<![%config-file;[<literallayout>@@keep-alive-timeout 5</literallayout>]]>
+</sect3>
+
+
+<sect3 renderas="sect4" id="tolerate-pipelining"><title>tolerate-pipelining</title>
+<variablelist>
+ <varlistentry>
+ <term>Specifies:</term>
+ <listitem>
+ <para>
+ Whether or not pipelined requests should be served.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Type of value:</term>
+ <listitem>
+ <para>
+ <replaceable>0 or 1.</replaceable>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Default value:</term>
+ <listitem>
+ <para>None</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Effect if unset:</term>
+ <listitem>
+ <para>
+ If Privoxy receives more than one request at once, it terminates the
+ client connection after serving the first one.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Notes:</term>
+ <listitem>
+ <para>
+ &my-app; currently doesn't pipeline outgoing requests,
+ thus allowing pipelining on the client connection is not
+ guaranteed to improve the performance.
+ </para>
+ <para>
+ By default &my-app; tries to discourage clients from pipelining
+ by discarding aggressively pipelined requests, which forces the
+ client to resend them through a new connection.
+ </para>
+ <para>
+ This option lets &my-app; tolerate pipelining. Whether or not
+ that improves performance mainly depends on the client configuration.
+ </para>
+ <para>
+ If you are seeing problems with pages not properly loading,
+ disabling this option could work around the problem.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Examples:</term>
+ <listitem>
+ <para>
+ tolerate-pipelining 1
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+<![%config-file;[<literallayout>@@tolerate-pipelining 1</literallayout>]]>
</sect3>
<term>Notes:</term>
<listitem>
<para>
- For SOCKS requests the timeout currently doesn't start until
- the SOCKS server accepted the request. This will be fixed in
- the next release.
+ The default is quite high and you probably want to reduce it.
+ If you aren't using an occasionally slow proxy like Tor, reducing
+ it to a few seconds should be fine.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Default value:</term>
<listitem>
- <para>None</para>
+ <para>128</para>
</listitem>
</varlistentry>
<varlistentry>
Obviously using this option only makes sense if you choose a limit
below the one enforced by the operating system.
</para>
+ <para>
+ One most POSIX-compliant systems &my-app; can't properly deal with
+ more than FD_SETSIZE file descriptors at the same time and has to reject
+ connections if the limit is reached. This will likely change in a
+ future version, but currently this limit can't be increased without
+ recompiling &my-app; with a different FD_SETSIZE limit.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<sect3 renderas="sect4" id="handle-as-empty-doc-returns-ok"><title>handle-as-empty-doc-returns-ok</title>
<variablelist>
<varlistentry>
- <term>Note:</term>
+ <term>Specifies:</term>
+ <listitem>
+ <para>
+ The status code Privoxy returns for pages blocked with
+ <!-- URL will only end up in the user manual so the relative link should work. -->
+ <literal><ulink url="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">+handle-as-empty-document</ulink></literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Type of value:</term>
+ <listitem>
+ <para>
+ <replaceable>0 or 1</replaceable>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Default value:</term>
+ <listitem>
+ <para>0</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Effect if unset:</term>
+ <listitem>
+ <para>
+ Privoxy returns a status 403(forbidden) for all blocked pages.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Effect if set:</term>
+ <listitem>
+ <para>
+ Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
+ and a status 403(Forbidden) for all other blocked pages.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Notes:</term>
<listitem>
<para>
This is a work-around for Firefox bug 492459:
</quote>
(<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
>https://bugzilla.mozilla.org/show_bug.cgi?id=492459</ulink>)
+ As the bug has been fixed for quite some time this option should no longer
+ be needed and will be removed in a future release. Please speak up if you
+ have a reason why the option should be kept around.
</para>
</listitem>
</varlistentry>
+</variablelist>
+<![%config-file;[<literallayout>@@#handle-as-empty-doc-returns-ok 1</literallayout>]]>
+</sect3>
+
+
+<sect3 renderas="sect4" id="enable-compression"><title>enable-compression</title>
+<variablelist>
<varlistentry>
<term>Specifies:</term>
<listitem>
<para>
- The status code Privoxy returns for pages blocked with
- <!-- URL will only end up in the user manual so the relative link should work. -->
- <literal><ulink url="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">+handle-as-empty-document</ulink></literal>.
+ Whether or not buffered content is compressed before delivery.
</para>
</listitem>
</varlistentry>
<term>Effect if unset:</term>
<listitem>
<para>
- Privoxy returns a status 403(forbidden) for all blocked pages.
+ Privoxy does not compress buffered content.
</para>
</listitem>
</varlistentry>
<term>Effect if set:</term>
<listitem>
<para>
- Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
- and a status 403(Forbidden) for all other blocked pages.
+ Privoxy compresses buffered content before delivering it to the client,
+ provided the client supports it.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Notes:</term>
+ <listitem>
+ <para>
+ This directive is only supported if Privoxy has been compiled with
+ FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB.
+ </para>
+ <para>
+ Compressing buffered content is mainly useful if Privoxy and the
+ client are running on different systems. If they are running on the
+ same system, enabling compression is likely to slow things down.
+ If you didn't measure otherwise, you should assume that it does
+ and keep this option disabled.
+ </para>
+ <para>
+ Privoxy will not compress buffered content below a certain length.
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+<![%config-file;[<literallayout>@@#enable-compression 1</literallayout>]]>
+</sect3>
+
+
+<sect3 renderas="sect4" id="compression-level"><title>compression-level</title>
+<variablelist>
+ <varlistentry>
+ <term>Specifies:</term>
+ <listitem>
+ <para>
+ The compression level that is passed to the zlib library when compressing buffered content.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Type of value:</term>
+ <listitem>
+ <para>
+ <replaceable>Positive number ranging from 0 to 9.</replaceable>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Default value:</term>
+ <listitem>
+ <para>1</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Notes:</term>
+ <listitem>
+ <para>
+ Compressing the data more takes usually longer than compressing
+ it less or not compressing it at all. Which level is best depends
+ on the connection between Privoxy and the client. If you can't
+ be bothered to benchmark it for yourself, you should stick with
+ the default and keep compression disabled.
+ </para>
+ <para>
+ If compression is disabled, the compression level is irrelevant.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Examples:</term>
+ <listitem>
+ <para>
+ <screen>
+ # Best speed (compared to the other levels)
+ compression-level 1
+ # Best compression
+ compression-level 9
+ # No compression. Only useful for testing as the added header
+ # slightly increases the amount of data that has to be sent.
+ # If your benchmark shows that using this compression level
+ # is superior to using no compression at all, the benchmark
+ # is likely to be flawed.
+ compression-level 0
+ </screen>
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+<![%config-file;[<literallayout>@@#compression-level 1</literallayout>]]>
+</sect3>
+
+
+<sect3 renderas="sect4" id="client-header-order"><title>client-header-order</title>
+<variablelist>
+ <varlistentry>
+ <term>Specifies:</term>
+ <listitem>
+ <para>
+ The order in which client headers are sorted before forwarding them.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Type of value:</term>
+ <listitem>
+ <para>
+ <replaceable>Client header names delimited by spaces or tabs</replaceable>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Default value:</term>
+ <listitem>
+ <para>None</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Notes:</term>
+ <listitem>
+ <para>
+ By default &my-app; leaves the client headers in the order they
+ were sent by the client. Headers are modified in-place, new headers
+ are added at the end of the already existing headers.
+ </para>
+ <para>
+ The header order can be used to fingerprint client requests
+ independently of other headers like the User-Agent.
+ </para>
+ <para>
+ This directive allows to sort the headers differently to better
+ mimic a different User-Agent. Client headers will be emitted
+ in the order given, headers whose name isn't explicitly specified
+ are added at the end.
+ </para>
+ <para>
+ Note that sorting headers in an uncommon way will make fingerprinting
+ actually easier. Encrypted headers are not affected by this directive.
</para>
</listitem>
</varlistentry>
</variablelist>
-<![%config-file;[<literallayout>@@handle-as-empty-doc-returns-ok 1</literallayout>]]>
+<![%config-file;[<literallayout>@@#client-header-order Host \
+ User-Agent \
+ Accept \
+ Accept-Language \
+ Accept-Encoding \
+ Proxy-Connection \
+ Referer \
+ Cookie \
+ DNT \
+ If-Modified-Since \
+ Cache-Control \
+ Content-Length \
+ Content-Type
+</literallayout>]]>
</sect3>
<![%user-man;[
<para>
<literal>
- <msgtext>
+ <msgtext>
<literallayout>
<emphasis>activity-animation 1</emphasis>
</literallayout>
- </msgtext>
+ </msgtext>
</literal>
</para>
]]>
<![%config-file;[<para>@@</para>]]> <!-- for spacing -->
<para>
If <quote>log-messages</quote> is set to 1,
- <application>Privoxy</application> will log messages to the console
- window:
+ <application>Privoxy</application> copies log messages to the console
+ window.
+ The log detail depends on the <link linkend="debug">debug</link> directive.
</para>
<![%config-file;[<literallayout>@@#log-messages 1</literallayout>]]>
<![%user-man;[
<para>
<literal>
- <msgtext>
+ <msgtext>
<literallayout>
<emphasis>log-messages 1</emphasis>
</literallayout>
- </msgtext>
+ </msgtext>
</literal>
</para>
]]>
<anchor id="log-buffer-size">
<![%config-file;[<para>@@</para>]]> <!-- for spacing -->
-<para>
+<para>
If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
i.e. the amount of memory used for the log messages displayed in the
console window, will be limited to <quote>log-max-lines</quote> (see below).
<![%user-man;[
<para>
<literal>
- <msgtext>
+ <msgtext>
<literallayout>
<emphasis>log-buffer-size 1</emphasis>
</literallayout>
- </msgtext>
+ </msgtext>
</literal>
</para>
]]>
<![%user-man;[
<para>
<literal>
- <msgtext>
+ <msgtext>
<literallayout>
<emphasis>log-max-lines 200</emphasis>
</literallayout>
- </msgtext>
+ </msgtext>
</literal>
</para>
]]>
<![%user-man;[
<para>
<literal>
- <msgtext>
+ <msgtext>
<literallayout>
<emphasis>log-highlight-messages 1</emphasis>
</literallayout>
- </msgtext>
+ </msgtext>
</literal>
</para>
]]>
<![%user-man;[
<para>
<literal>
- <msgtext>
+ <msgtext>
<literallayout>
<emphasis>log-font-name Comic Sans MS</emphasis>
</literallayout>
- </msgtext>
+ </msgtext>
</literal>
</para>
]]>
<![%user-man;[
<para>
<literal>
- <msgtext>
+ <msgtext>
<literallayout>
<emphasis>log-font-size 8</emphasis>
</literallayout>
- </msgtext>
+ </msgtext>
</literal>
</para>
]]>
<anchor id="show-on-task-bar">
<![%config-file;[<para>@@</para>]]> <!-- for spacing -->
-<para>
+<para>
<quote>show-on-task-bar</quote> controls whether or not
<application>Privoxy</application> will appear as a button on the Task bar
when minimized:
<![%user-man;[
<para>
<literal>
- <msgtext>
+ <msgtext>
<literallayout>
<emphasis>show-on-task-bar 0</emphasis>
</literallayout>
- </msgtext>
+ </msgtext>
</literal>
</para>
]]>
<![%user-man;[
<para>
<literal>
- <msgtext>
+ <msgtext>
<literallayout>
<emphasis>close-button-minimizes 1</emphasis>
</literallayout>
- </msgtext>
+ </msgtext>
</literal>
</para>
]]>
<![%user-man;[
<para>
<literal>
- <msgtext>
+ <msgtext>
<literallayout>
#<emphasis>hide-console</emphasis>
</literallayout>
- </msgtext>
+ </msgtext>
</literal>
</para>
]]>
projects / privoxy.git / blobdiff