- Minor rewordings and fixes.
Purpose : Used with other docs and files only.
Purpose : Used with other docs and files only.
- $Id: p-config.sgml,v 2.20 2007/11/07 11:36:53 hal9 Exp $
+ $Id: p-config.sgml,v 2.21 2007/11/07 18:50:39 fabiankeil Exp $
Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
See LICENSE.
Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
See LICENSE.
Sample Configuration File for Privoxy v&p-version;
</title>
<para>
Sample Configuration File for Privoxy v&p-version;
</title>
<para>
- $Id: p-config.sgml,v 2.20 2007/11/07 11:36:53 hal9 Exp $
+ $Id: p-config.sgml,v 2.21 2007/11/07 18:50:39 fabiankeil Exp $
</para>
<para>
Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
</para>
<para>
Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
<listitem>
<para>
The value of this option only matters if the experimental trust mechanism has been
<listitem>
<para>
The value of this option only matters if the experimental trust mechanism has been
- activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> above.)
+ activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> below.)
</para>
<para>
If you use the trust mechanism, it is a good idea to write up some on-line
</para>
<para>
If you use the trust mechanism, it is a good idea to write up some on-line
<varlistentry>
<term>Specifies:</term>
<listitem>
<varlistentry>
<term>Specifies:</term>
<listitem>
- <para>The directory where the other configuration files are located</para>
+ <para>The directory where the other configuration files are located.</para>
</listitem>
</varlistentry>
<varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term>Notes:</term>
<listitem>
<para>
<term>Notes:</term>
<listitem>
<para>
- No trailing <quote><literal>/</literal></quote>, please
+ No trailing <quote><literal>/</literal></quote>, please.
</para>
<!--
This is really outdated and not likely to happen. HB 09/20/06
</para>
<!--
This is really outdated and not likely to happen. HB 09/20/06
<varlistentry>
<term>Specifies:</term>
<listitem>
<varlistentry>
<term>Specifies:</term>
<listitem>
- <para>An alternative directory where the templates are loaded from</para>
+ <para>An alternative directory where the templates are loaded from.</para>
</listitem>
</varlistentry>
<varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term>Notes:</term>
<listitem>
<para>
<term>Notes:</term>
<listitem>
<para>
- Privoxy's original templates are usually overwritten
- with each update. Use this option to relocate customized templates
- that should be kept. Note that template variables might change
- between updates and templates are not guaranteed to work with
+ <application>Privoxy's</application> original templates are usually
+ overwritten with each update. Use this option to relocate customized
+ templates that should be kept. As template variables might change
+ between updates, you shouldn't expect templates to work with
<application>Privoxy</application> releases other than the one
<application>Privoxy</application> releases other than the one
+ they were part of, though.
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
<term>Specifies:</term>
<listitem>
<para>
<term>Specifies:</term>
<listitem>
<para>
- The directory where all logging takes place (i.e. where <filename>logfile</filename> and
- <filename>jarfile</filename> are located)
+ The directory where all logging takes place
+ (i.e. where <filename>logfile</filename> and
+ <filename>jarfile</filename> are located).
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
<term>Notes:</term>
<listitem>
<para>
<term>Notes:</term>
<listitem>
<para>
- No trailing <quote><literal>/</literal></quote>, please
+ No trailing <quote><literal>/</literal></quote>, please.
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
</para>
<para>
Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
</para>
<para>
- The default values include standard.action, which is used for internal
- purposes and should be loaded, default.action, which is the
- <quote>main</quote> actions file maintained by the developers, and
+ The default values include <filename>standard.action</filename>, which is used
+ for internal purposes and should be loaded, <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>
<filename>user.action</filename>, where you can make your personal additions.
</para>
<para>
- Actions files are where all the per site and per URL configuration is done for
+ 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
least one actions file.
ad blocking, cookie management, privacy considerations, etc.
There is no point in using <application>Privoxy</application> without at
least one actions file.
<varlistentry>
<term>Default value:</term>
<listitem>
<varlistentry>
<term>Default value:</term>
<listitem>
- <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows)</para>
+ <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
</listitem>
</varlistentry>
<varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<varlistentry>
<term>Default value:</term>
<listitem>
<varlistentry>
<term>Default value:</term>
<listitem>
- <para><emphasis>Unset (commented out)</emphasis>. When activated: jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows)</para>
+ <para><emphasis>Unset (commented out)</emphasis>. When activated: jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows).</para>
</listitem>
</varlistentry>
<varlistentry>
</listitem>
</varlistentry>
<varlistentry>
a hell of an output (especially 16).
<!-- LOL -->
</para>
a hell of an output (especially 16).
<!-- LOL -->
</para>
<para>
The reporting of <emphasis>fatal</emphasis> errors (i.e. ones which causes
<application>Privoxy</application> to exit) is always on and cannot be disabled.
</para>
<para>
The reporting of <emphasis>fatal</emphasis> errors (i.e. ones which causes
<application>Privoxy</application> to exit) is always on and cannot be disabled.
</para>
+ It can be disabled by not logging at all (now the default)
+ and I doubt that any user would care about not being able
+ to disable it anyway.
+ fk 2007-11-09
+-->
<para>
If you want to use CLF (Common Log Format), you should set <quote>debug
512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
<para>
If you want to use CLF (Common Log Format), you should set <quote>debug
512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
<term>Specifies:</term>
<listitem>
<para>
<term>Specifies:</term>
<listitem>
<para>
- Whether to run only one server thread
+ Whether to run only one server thread.
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
<term>Notes:</term>
<listitem>
<para>
<term>Notes:</term>
<listitem>
<para>
- This option is only there for debugging purposes and you should never
- need to use it. <emphasis>It will drastically reduce performance.</emphasis>
+ This option is only there for debugging purposes.
+ <emphasis>It will drastically reduce performance.</emphasis>
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
</para>
<para>
As a lot of <application>Privoxy</application> users don't read
</para>
<para>
As a lot of <application>Privoxy</application> users don't read
- documentation, this feature has been disabled by default.
+ documentation, this feature is disabled by default.
</para>
<para>
Note that you must have compiled <application>Privoxy</application> with
</para>
<para>
Note that you must have compiled <application>Privoxy</application> with
side code (e.g Java) is also capable of using this feature.
</para>
<para>
side code (e.g Java) is also capable of using this feature.
</para>
<para>
- This option may be removed in future releases as it has been obsoleted
+ This option will be removed in future releases as it has been obsoleted
by the more general header taggers.
</para>
</listitem>
by the more general header taggers.
</para>
</listitem>
</para>
<para>
This option is <emphasis>not recommended</emphasis> for environments
</para>
<para>
This option is <emphasis>not recommended</emphasis> for environments
- with untrusted users and is therefore disabled by default.
+ with untrusted users and as a lot of <application>Privoxy</application>
+ users don't read documentation, this feature is disabled by default.
+ </para>
</para>
<para>
Note that malicious client side code (e.g Java) is also
</para>
<para>
Note that malicious client side code (e.g Java) is also
this options unless you understand the consequences and are
sure your browser is configured correctly.
</para>
this options unless you understand the consequences and are
sure your browser is configured correctly.
</para>
- <para>
- As a lot of <application>Privoxy</application> users don't read
- documentation, this feature has been disabled by default.
- </para>
<para>
Note that you must have compiled <application>Privoxy</application> with
support for this feature, otherwise this option has no effect.
<para>
Note that you must have compiled <application>Privoxy</application> with
support for this feature, otherwise this option has no effect.
- Please see the warnings in the FAQ that this proxy is not intended to be a substitute
- for a firewall or to encourage anyone to defer addressing basic security
- weaknesses.
+ Please see the warnings in the FAQ that <application>Privoxy</application>
+ is not intended to be a substitute for a firewall or to encourage anyone
+ to defer addressing basic security weaknesses.
</para>
<para>
Multiple ACL lines are OK.
</para>
<para>
Multiple ACL lines are OK.
- forward / caching-proxy.example-isp.net:8000
- forward .example-isp.net .
+ forward / caching-proxy.isp.example.net:8000
+ forward .isp.example.net .
</screen>
</para>
</listitem>
</screen>
</para>
</listitem>
- forward-socks4a / socks-gw.example.com:1080 www-cache.example-isp.net:8080
+ forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
forward .example.com .
</screen>
</para>
forward .example.com .
</screen>
</para>
- To chain Privoxy and Tor, both running on the same system, you should use
- the rule:
+ To chain Privoxy and Tor, both running on the same system, you would use
+ something like:
Unencrypted connections to systems in these address ranges will
be as (un)secure as the local network is, but the alternative is that you
can't reach the local network through <application>Privoxy</application>
Unencrypted connections to systems in these address ranges will
be as (un)secure as the local network is, but the alternative is that you
can't reach the local network through <application>Privoxy</application>
+ at all. Of course this may actually be desired and there is no reason
+ to make these exceptions if you aren't sure you need them.
</para>
<para>
If you also want to be able to reach servers in your local network by
</para>
<para>
If you also want to be able to reach servers in your local network by
- Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to
- isp-b.
net. Both run <application>Privoxy</application>. Their forwarding
+ Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
+ isp-b.
example.org. Both run <application>Privoxy</application>. Their forwarding
configuration can look like this:
</para>
configuration can look like this:
</para>
<para>
<screen>
forward / .
<para>
<screen>
forward / .
- forward .isp-b.net host-b:8118
+ forward .isp-b.example.net host-b:8118
<para>
<screen>
forward / .
<para>
<screen>
forward / .
- forward .isp-a.net host-a:8118
+ forward .isp-a.example.org host-a:8118
<para>
If you intend to chain <application>Privoxy</application> and
<para>
If you intend to chain <application>Privoxy</application> and
- <application>squid</application> locally, then chain as
+ <application>squid</application> locally, then chaining as
<literal>browser -> squid -> privoxy</literal> is the recommended way.
</para>
<literal>browser -> squid -> privoxy</literal> is the recommended way.
</para>
- You could just as well decide to only forward requests for Windows executables through
- a virus-scanning parent proxy, say, on <literal>antivir.example.com</literal>, port 8010:
+ You could just as well decide to only forward requests you suspect
+ of leading to Windows executables through a virus-scanning parent proxy,
+ say, on <literal>antivir.example.com</literal>, port 8010:
<para>
The <quote>hide-console</quote> option is specific to the MS-Win console
version of <application>Privoxy</application>. If this option is used,
<para>
The <quote>hide-console</quote> option is specific to the MS-Win console
version of <application>Privoxy</application>. If this option is used,
- <application>Privoxy</application> will disconnect from and hide the
+ <application>Privoxy</application> will disconnect from and hide the
projects / privoxy.git / commitdiff