-Fix a number of broken links.
-Migrate the new Windows service command line options, and reference as
needed.
-Rebuild so that can be used with the new "user-manual" config capabilities.
-Etc.
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 2.16 2006/09/02 12:49:37 hal9 Exp $
+ $Id: user-manual.sgml,v 2.17 2006/09/05 13:25:12 david__schmidt Exp $
Copyright (C) 2001- 2006 Privoxy Developers <developers@privoxy.org>
See LICENSE.
</subscript>
</pubdate>
-<pubdate>$Id: user-manual.sgml,v 2.16 2006/09/02 12:49:37 hal9 Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 2.17 2006/09/05 13:25:12 david__schmidt Exp $</pubdate>
<!--
</para>
<para>
- Note: If you have a previous <application>Junkbuster</application> or
- <application>Privoxy</application> installation on your system, you
- will need to remove it. On some platforms, this may be done for you as part
- of their installation procedure. (See below for your platform). In any case
- <emphasis>be sure to backup your old configuration if it is valuable to
- you.</emphasis> See the <link linkend="upgradersnote">note to
- upgraders</link> section below.
+ Note:
+ On some platforms, the installer may remove previously installed versions, if
+ found. (See below for your platform). In any case <emphasis>be sure to backup
+ your old configuration if it is valuable to you.</emphasis> See the <link
+ linkend="upgradersnote">note to upgraders</link> section below.
</para>
<!-- ~~~~~ New section ~~~~~ -->
Also note that if you have a <application>Junkbuster</application> RPM installed
on your system, you need to remove it first, because the packages conflict.
Otherwise, RPM will try to remove <application>Junkbuster</application>
- automatically, before installing <application>Privoxy</application>.
+ automatically
if found, before installing <application>Privoxy</application>.
</para>
</sect3>
<para>
Just double-click the installer, which will guide you through
the installation process. You will find the configuration files
- in the same directory as you installed Privoxy in.
+ in the same directory as you installed <application>Privoxy</application> in.
</para>
+<para>
+ Version 3.0.4 introduces full <application>Windows</application> service
+ functionality. On Windows only, the <application>Privoxy</application>
+ program has two new command line arguments to install and uninstall
+ <application>Privoxy</application> as a <emphasis>service</emphasis>.
+</para>
+ <variablelist>
+ <varlistentry>
+ <term>Arguments:</term>
+ <listitem>
+ <para>
+ <replaceable class="parameter">--install</replaceable>[:<replaceable class="parameter">service_name</replaceable>]
+ </para>
+ <para>
+ <replaceable class="parameter">--uninstall</replaceable>[:<replaceable class="parameter">service_name</replaceable>]
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ After invoking <application>Privoxy</application> with
+ <command>--install</command>, you will need to bring up the
+ <application>Windows</application> service console to assign the user you
+ want <application>Privoxy</application> to run under, and whether or not you
+ want it to run whenever the system starts. You can start the
+ <application>Windows</application> services console with the following
+ command: <command>services.msc</command> If you do not take the manual step
+ of modifying <application>Privoxy's</application> service settings, it will
+ not start. Note too that you will need to give Privoxy a user account that
+ actually exists, or it will not be permitted to
+ write to its log and configuration files.
+</para>
+
</sect3>
<!-- ~~~~~ New section ~~~~~ -->
<listitem>
<para>
- <application>MS-Windows</application> versions can now be installed and
- started as a <emphasis>service</emphasis>.
+ <application>MS-Windows</application> versions can now be
+ <link
+ linkend="installation-pack-win">installed and
+ started as a <emphasis>Windows service</emphasis></link>.
</para>
</listitem>
+ <listitem>
+ <para>
+ <filename>config</filename> has two new options:
+ <link
+ linkend="enable-remote-http-toggle">enable-remote-http-toggle</link>,
+ and <link
+ linkend="forwarded-connect-retries">forwarded-connect-retries</link>.
+ </para>
+ <para>
+ And there is improved handling of the <link
+ linkend="user-manual">user-manual</link>
+ option, for placing documentation and help files on the local system.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Actions files problems and suggestions are now being directed to: <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=460288">http://sourceforge.net/tracker/?group_id=11118&atid=460288</ulink>.
+ Please use this to report such configuration related problems as missed
+ ads, sites that don't function properly due to one action or another,
+ innocent images being blocked, etc.
+ </para>
+ </listitem>
+
<listitem>
<para>
In addition, there are various bug fixes and significant enhancements, including
- error pages are no longer cached, better DNS error handling, and various logging
- improvements.
+ error pages should no longer be cached if the problem is fixed, better DNS
+ error handling, and various logging improvements.
</para>
</listitem>
configuration files. Save any important configuration files!
</para>
</listitem>
+ <listitem>
+ <para>
+ On the other hand, some installers may not overwrite any existing configuration
+ files, thinking you will want to do that. You may want to manually check
+ your saved files against the newer versions to see if the improvements have
+ merit, or whether there are new options that you may want to consider.
+ There are a number of new features, but most won't be available unless
+ these features are incorporated into your configuration somehow.
+ </para>
+ </listitem>
<listitem>
<para>
See the full documentation on
Set your browser to use <application>Privoxy</application> as HTTP and
HTTPS (SSL) proxy by setting the proxy configuration for address of
<literal>127.0.0.1</literal> and port <literal>8118</literal>.
- (<application>Junkbuster</application> and earlier versions of
- <application>Privoxy</application> used port 8000.) See the section <link
- linkend="startup">Starting <application>Privoxy</application></link> below
- for more details on this.
+ <emphasis>DO NOT</emphasis> activate proxying for <literal>FTP</literal> or
+ any protocols besides HTTP and HTTPS (SSL)! It won't work!
</para>
</listitem>
<listitem>
<para>
Please see the section <link linkend="contact">Contacting the
- Developers</link> on how to report bugs or problems with websites or to get
+ Developers</link> on how to report bugs, problems with websites or to get
help.
</para>
</listitem>
<sect2 id="start-windows">
<title>Windows</title>
<para>
-Click on the Privoxy Icon to start Privoxy. If no configuration file is
+Click on the Privoxy Icon to start <application>Privoxy</application>. If no configuration file is
specified on the command line, <application>Privoxy</application> will look
for a file named <filename>config.txt</filename>. Note that Windows will
automatically start Privoxy when the system starts if you chose that option
when installing.
</para>
<para>
-<!--
-New check this hal
--->
- Version 3.0.4 introduces full Windows service functionality.
+ <application>Privoxy</application> can run with full Windows service functionality.
On Windows only, the Privoxy program has two new command line arguments
- to install and uninstall Privoxy as a service.
- <variablelist>
- <varlistentry>
- <term>Arguments:</term>
- <listitem>
- <para>
- <replaceable class="parameter">--install</replaceable>[:<replaceable class="parameter">service_name</replaceable>]
- </para>
- </listitem>
- <listitem>
- <para>
- <replaceable class="parameter">--uninstall</replaceable>[:<replaceable class="parameter">service_name</replaceable>]
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
-<para>
- After invoking Privoxy with <command>--install</command>,
- you will need to bring up the Windows service console to assign the user you
- want Privoxy to run under, and whether or not you want it to run whenever the
- system starts. You can start the Windows services console with the following command:
- <command>services.msc</command> If you do not take the manual step of modifying
- Privoxy's service settings, it will not start. Note too that you will need to
- give Privoxy a user account that actually exists, or it will not be permitted to
- write its log files.
+ to install and uninstall Privoxy as a service. See the
+ <link linkend="installation-pack-win">Windows Installation
+ instructions</link> for details.
</para>
</sect2>
</itemizedlist>
</para>
+<para>
+ On <application>MS Windows</application> only there are two addition
+ options to allow <application>Privoxy</application> to install and
+ run as a <emphasis>service</emphasis>. See the
+<link linkend="installation-pack-win">Window Installation section</link>
+for details.
+</para>
+
</sect2>
</sect1>
</itemizedlist>
</para>
+<para>
+ The syntax of all configuration files has remained the same throughout the
+ 3.x series. There have been enhancements, but no changes that would preclude
+ the use of any configuration file from one version to the next.
+</para>
+
<para>
All files use the <quote><literal>#</literal></quote> character to denote a
comment (the rest of the line will be ignored) and understand line continuation
at <ulink url="http://www.pcre.org/man.txt">http://www.pcre.org/man.txt</ulink>.
You might also find the Perl man page on regular expressions (<literal>man perlre</literal>)
useful, which is available on-line at <ulink
- url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>.
+ url="http://perldoc.perl.org/perlre.html">http://perldoc.perl.org/perlre.html</ulink>.
</para>
<para>
<para>
If you are new to regular expressions, you might want to take a look at
the <link linkend="regex">Appendix on regular expressions</link>, and
- see the <ulink url="http://perldoc.com/perl5.6.1/pod/perl.html">Perl
+ see the <ulink url="http://perldoc.perl.org/perlre.html">Perl
manual</ulink> for
- <ulink url="http://perldoc.com/perl5.6.1/pod/perlop.html#s-PATTERN-REPLACEMENT-egimosx">the
+ <ulink url="http://perldoc.perl.org/perlop.html">the
<literal>s///</literal> operator's syntax</ulink> and <ulink
- url="http://perldoc.com/perl5.6.1/pod/perlre.html">Perl-style regular
+ url="http://perldoc.perl.org/perlre.html">Perl-style regular
expressions</ulink> in general.
The below examples might also help to get you started.
</para>
<para><simplelist>
<member>
- <emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
+ <emphasis>[ ]</emphasis> - Characters enclosed in brackets will be matched if
any of the enclosed characters are encountered. For instance, <quote>[0-9]</quote>
matches any numeric digit (zero through nine). As an example, we can combine
this with <quote>+</quote> to match any digit one of more times: <quote>[0-9]+</quote>.
<para><simplelist>
<member>
- <emphasis>()</emphasis> - parentheses are used to group a sub-expression,
+ <emphasis>( )</emphasis> - parentheses are used to group a sub-expression,
or multiple sub-expressions.
</member>
</simplelist></para>
</para>
<para>
- A now something a little more complex:
+ And now something a little more complex:
</para>
<para>
<para>
<emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
another path statement with forward slashes. Anything in the square brackets
- <quote>[]</quote> can be matched. This is using <quote>0-9</quote> as a
+ <quote>[ ]</quote> can be matched. This is using <quote>0-9</quote> as a
shorthand expression to mean any digit one through nine. It is the same as
saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
means one or more of the preceding expression must be included. The preceding
<para>
More reading on Perl Compatible Regular expressions:
- <ulink url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>
+ <ulink url="http://perldoc.perl.org/perlre.html">http://perldoc.perl.org/perlre.html</ulink>
</para>
<para>
<listitem>
<para>
<application>Privoxy</application> traps any request for its own internal CGI
- pages (e.g http://p.p/) and sends the CGI page back to the browser.
+ pages (e.g <ulink url="http://p.p/">http://p.p/</ulink>) and sends the CGI page back to the browser.
</para>
</listitem>
<listitem>
</listitem>
<listitem>
<para>
- As the browser receives the now (probably filtered) page content, it
+ As the browser receives the now (possibly filtered) page content, it
reads and then requests any URLs that may be embedded within the page
source, e.g. ad images, stylesheets, JavaScript, other HTML documents (e.g.
frames), sounds, etc. For each of these objects, the browser issues a new
<para>
Notice the only difference here to the previous listing, is to
<quote>fast-redirects</quote> and <quote>session-cookies-only</quote>,
- which are actived specifically for this site in our configuration,
+ which are activated specifically for this site in our configuration,
and thus show in the <quote>Final Results</quote>.
</para>
</para>
<para>
- One last example. Let's try <quote>http://www.rhapsodyk.net/adsl/HOWTO/</quote>.
+ One last example. Let's try <quote>http://www.example.net/adsl/HOWTO/</quote>.
This one is giving us problems. We are getting a blank page. Hmmm ...
</para>
<para>
<screen>
- Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
+ Matches for http://www.example.net/adsl/HOWTO/:
In file: default.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
+ Revision 2.17 2006/09/05 13:25:12 david__schmidt
+ Add Windows service invocation stuff (duplicated) in FAQ and in user manual under Windows startup. One probably ought to reference the other.
+
Revision 2.16 2006/09/02 12:49:37 hal9
Various small updates for new actions, filterfiles, etc.
HREF="filter-file.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
> <DIV
CLASS="TABLE"
><A
-NAME="AEN1803"
+NAME="AEN1912"
></A
><P
><B
><H2
CLASS="SECT2"
><A
-NAME="AEN1902"
+NAME="AEN2011"
></A
>8.1. Finding the Right Mix</H2
><P
><H2
CLASS="SECT2"
><A
-NAME="AEN1909"
+NAME="AEN2018"
></A
>8.2. How to Edit</H2
><P
><H3
CLASS="SECT3"
><A
-NAME="AEN1983"
+NAME="AEN2092"
></A
>8.4.1. The Domain Pattern</H3
><P
><H3
CLASS="SECT3"
><A
-NAME="AEN2045"
+NAME="AEN2154"
></A
>8.4.2. The Path Pattern</H3
><P
>man perlre</TT
>)
useful, which is available on-line at <A
-HREF="http://www.perldoc.com/perl5.6/pod/perlre.html"
+HREF="http://perldoc.perl.org/perlre.html"
TARGET="_top"
->http://www.perldoc.com/perl5.6/pod/perlre.html</A
+>http://perldoc.perl.org/perlre.html</A
>.</P
><P
> Note that the path pattern is automatically left-anchored at the <SPAN
><H3
CLASS="SECT3"
><A
-NAME="AEN3640"
+NAME="AEN3749"
></A
>8.5.36. Summary</H3
><P
><H3
CLASS="SECT3"
><A
-NAME="AEN3705"
+NAME="AEN3814"
></A
>8.7.1. default.action</H3
><P
><H3
CLASS="SECT3"
><A
-NAME="AEN3886"
+NAME="AEN3995"
></A
>8.7.2. user.action</H3
><P
HREF="seealso.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
CLASS="emphasis"
><I
CLASS="EMPHASIS"
->[]</I
+>[ ]</I
></SPAN
> - Characters enclosed in brackets will be matched if
any of the enclosed characters are encountered. For instance, <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
->()</I
+>( )</I
></SPAN
> - parentheses are used to group a sub-expression,
or multiple sub-expressions.
> in the path
somewhere.</P
><P
-> A now something a little more complex:</P
+> And now something a little more complex:</P
><P
> <SPAN
CLASS="emphasis"
another path statement with forward slashes. Anything in the square brackets
<SPAN
CLASS="QUOTE"
->"[]"</SPAN
+>"[ ]"</SPAN
> can be matched. This is using <SPAN
CLASS="QUOTE"
>"0-9"</SPAN
><P
> More reading on Perl Compatible Regular expressions:
<A
-HREF="http://www.perldoc.com/perl5.6/pod/perlre.html"
+HREF="http://perldoc.perl.org/perlre.html"
TARGET="_top"
->http://www.perldoc.com/perl5.6/pod/perlre.html</A
+>http://perldoc.perl.org/perlre.html</A
></P
><P
> For information on regular expression based substitutions and their applications
><H2
CLASS="SECT2"
><A
-NAME="AEN4670"
+NAME="AEN4783"
></A
>14.2. <SPAN
CLASS="APPLICATION"
Privoxy main page:
</P
><A
-NAME="AEN4685"
+NAME="AEN4798"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
editing of actions files:
</P
><A
-NAME="AEN4693"
+NAME="AEN4806"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
Show the source code version numbers:
</P
><A
-NAME="AEN4698"
+NAME="AEN4811"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
Show the browser's request headers:
</P
><A
-NAME="AEN4703"
+NAME="AEN4816"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
Show which actions apply to a URL and why:
</P
><A
-NAME="AEN4708"
+NAME="AEN4821"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
to run, but only as a pass-through proxy, with no actions taking place:
</P
><A
-NAME="AEN4714"
+NAME="AEN4827"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
> Short cuts. Turn off, then on:
</P
><A
-NAME="AEN4718"
+NAME="AEN4831"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
</P
></BLOCKQUOTE
><A
-NAME="AEN4721"
+NAME="AEN4834"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
CLASS="APPLICATION"
>Privoxy</SPAN
> traps any request for its own internal CGI
- pages (e.g http://p.p/) and sends the CGI page back to the browser.
+ pages (e.g <A
+HREF="http://p.p/"
+TARGET="_top"
+>http://p.p/</A
+>) and sends the CGI page back to the browser.
</P
></LI
><LI
></LI
><LI
><P
-> As the browser receives the now (probably filtered) page content, it
+> As the browser receives the now (possibly filtered) page content, it
reads and then requests any URLs that may be embedded within the page
source, e.g. ad images, stylesheets, JavaScript, other HTML documents (e.g.
frames), sounds, etc. For each of these objects, the browser issues a new
CLASS="QUOTE"
>"session-cookies-only"</SPAN
>,
- which are actived specifically for this site in our configuration,
+ which are activated specifically for this site in our configuration,
and thus show in the <SPAN
CLASS="QUOTE"
>"Final Results"</SPAN
><P
> One last example. Let's try <SPAN
CLASS="QUOTE"
->"http://www.rhapsodyk.net/adsl/HOWTO/"</SPAN
+>"http://www.example.net/adsl/HOWTO/"</SPAN
>.
This one is giving us problems. We are getting a blank page. Hmmm ...</P
><P
><TD
><PRE
CLASS="SCREEN"
-> Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
+> Matches for http://www.example.net/adsl/HOWTO/:
In file: default.action <SPAN
CLASS="GUIBUTTON"
HREF="actions-file.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
><H2
CLASS="SECT2"
><A
-NAME="CONF-LOG-LOC"
+NAME="LOCAL-SET-UP"
></A
->7.1. Configuration and Log File Locations</H2
-><P
-> <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> can (and normally does) use a number of
- other files for additional configuration, help and logging.
- This section of the configuration file tells <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->
- where to find those other files. </P
+>7.1. Local Set-up Documentation</H2
><P
-> The user running <SPAN
+> If you intend to operate <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
->, must have read
- permission for all configuration files, and write permission to any files
- that would be modified, such as log files and actions files.</P
+> for more users
+ than just yourself, it might be a good idea to let them know how to reach
+ you, what you block and why you do that, your policies, etc.
+ </P
><DIV
CLASS="SECT3"
><H4
CLASS="SECT3"
><A
-NAME="CONFDIR"
+NAME="USER-MANUAL"
></A
->7.1.1. confdir</H4
+>7.1.1. user-manual</H4
><P
></P
><DIV
>Specifies:</DT
><DD
><P
->The directory where the other configuration files are located</P
+> Location of the <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> User Manual.
+ </P
></DD
><DT
>Type of value:</DT
><DD
><P
->Path name</P
+>A fully qualified URI</P
></DD
><DT
>Default value:</DT
><DD
><P
->/etc/privoxy (Unix) <SPAN
+><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
->or</I
+>Unset</I
></SPAN
-> <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> installation dir (Windows) </P
+></P
></DD
><DT
>Effect if unset:</DT
><DD
><P
-><SPAN
-CLASS="emphasis"
+> <A
+HREF="http://www.privoxy.org/user-manual/"
+TARGET="_top"
+>http://www.privoxy.org/<TT
+CLASS="REPLACEABLE"
><I
-CLASS="EMPHASIS"
->Mandatory</I
-></SPAN
-></P
+>version</I
+></TT
+>/user-manual/</A
+>
+ will be used, where <TT
+CLASS="REPLACEABLE"
+><I
+>version</I
+></TT
+> is the <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> version.
+ </P
></DD
><DT
>Notes:</DT
><DD
><P
-> No trailing <SPAN
-CLASS="QUOTE"
->"<TT
-CLASS="LITERAL"
->/</TT
->"</SPAN
->, please
+> The User Manual URI is the single best source of information on
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>, 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. For multi-user setups, you could provide a copy on a local
+ webserver for all your users and use the corresponding URL here.
</P
><P
-> When development goes modular and multi-user, the blocker, filter, and
- per-user config will be stored in subdirectories of <SPAN
-CLASS="QUOTE"
->"confdir"</SPAN
->.
- For now, the configuration directory structure is flat, except for
- <TT
-CLASS="FILENAME"
->confdir/templates</TT
->, where the HTML templates for CGI
- output reside (e.g. <SPAN
-CLASS="APPLICATION"
->Privoxy's</SPAN
-> 404 error page).
+> Examples:
+ </P
+><P
+> The best all purpose solution is simply to put the full local
+ <TT
+CLASS="LITERAL"
+>PATH</TT
+> to where the <I
+CLASS="CITETITLE"
+>User Manual</I
+> is
+ located:
+ </P
+><P
+> <TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="90%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> user-manual /usr/share/doc/privoxy/user-manual</PRE
+></TD
+></TR
+></TABLE
+>
+ </P
+><P
+> The User Manual is then available to anyone with access to the proxy, by
+ following the built-in URL: <TT
+CLASS="LITERAL"
+>http://config.privoxy.org/user-manual/</TT
+>
+ (or the shortcut: <TT
+CLASS="LITERAL"
+>http://p.p/user-manual/</TT
+>).
+ </P
+><P
+> If the documentation is not on the local system, it can be accessed
+ from a remote server, as:
+ </P
+><P
+> <TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="90%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> user-manual http://example.com/privoxy/user-manual/</PRE
+></TD
+></TR
+></TABLE
+>
+ </P
+><DIV
+CLASS="WARNING"
+><P
+></P
+><TABLE
+CLASS="WARNING"
+BORDER="1"
+WIDTH="90%"
+><TR
+><TD
+ALIGN="CENTER"
+><B
+>Warning</B
+></TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+><P
+> If set, this option should be <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>the first option in the config
+ file</I
+></SPAN
+>, because it is used while the config file is being read
+ on start-up.
</P
+></TD
+></TR
+></TABLE
+></DIV
></DD
></DL
></DIV
><H4
CLASS="SECT3"
><A
-NAME="LOGDIR"
+NAME="TRUST-INFO-URL"
></A
->7.1.2. logdir</H4
+>7.1.2. trust-info-url</H4
><P
></P
><DIV
>Specifies:</DT
><DD
><P
-> The directory where all logging takes place (i.e. where <TT
-CLASS="FILENAME"
->logfile</TT
-> and
- <TT
-CLASS="FILENAME"
->jarfile</TT
-> are located)
+> A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
</P
></DD
><DT
>Type of value:</DT
><DD
><P
->Path name</P
+>URL</P
></DD
><DT
>Default value:</DT
><DD
><P
->/var/log/privoxy (Unix) <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->or</I
-></SPAN
-> <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> installation dir (Windows) </P
+>Two example URL are provided</P
></DD
><DT
>Effect if unset:</DT
><DD
><P
+> No links are displayed on the "untrusted" error page.
+ </P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> The value of this option only matters if the experimental trust mechanism has been
+ activated. (See <A
+HREF="config.html#TRUSTFILE"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
->Mandatory</I
+>trustfile</I
></SPAN
-></P
-></DD
-><DT
->Notes:</DT
-><DD
+></A
+> above.)
+ </P
><P
-> No trailing <SPAN
-CLASS="QUOTE"
->"<TT
-CLASS="LITERAL"
->/</TT
->"</SPAN
->, please
+> If you use the trust mechanism, it is a good idea to write up some on-line
+ documentation about your trust policy and to specify the URL(s) here.
+ Use multiple times for multiple URLs.
+ </P
+><P
+> The URL(s) should be added to the trustfile as well, so users don't end up
+ locked out from the information on why they were locked out in the first place!
</P
></DD
></DL
><H4
CLASS="SECT3"
><A
-NAME="ACTIONSFILE"
-></A
->7.1.3. actionsfile</H4
-><A
-NAME="DEFAULT.ACTION"
-></A
-><A
-NAME="STANDARD.ACTION"
-></A
-><A
-NAME="USER.ACTION"
+NAME="ADMIN-ADDRESS"
></A
+>7.1.3. admin-address</H4
><P
></P
><DIV
>Specifies:</DT
><DD
><P
-> The <A
-HREF="actions-file.html"
->actions file(s)</A
-> to use
+> An email address to reach the proxy administrator.
</P
></DD
><DT
>Type of value:</DT
><DD
><P
->File name, relative to <TT
-CLASS="LITERAL"
->confdir</TT
->, without the <TT
-CLASS="LITERAL"
->.action</TT
-> suffix</P
+>Email address</P
></DD
><DT
->Default values:</DT
+>Default value:</DT
><DD
><P
-></P
-><TABLE
-BORDER="0"
-><TBODY
-><TR
-><TD
-> <P
-CLASS="LITERALLAYOUT"
-> standard # Internal purposes, no editing recommended</P
->
- </TD
-></TR
-><TR
-><TD
-> <P
-CLASS="LITERALLAYOUT"
-> default # Main actions file</P
->
- </TD
-></TR
-><TR
-><TD
-> <P
-CLASS="LITERALLAYOUT"
-> user # User customizations</P
->
- </TD
-></TR
-></TBODY
-></TABLE
-><P
+><SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>Unset</I
+></SPAN
></P
></DD
><DT
>Effect if unset:</DT
><DD
><P
-> No actions are taken at all. Simple neutral proxying.
+> No email address is displayed on error pages and the CGI user interface.
</P
></DD
><DT
>Notes:</DT
><DD
><P
-> Multiple <TT
+> If both <TT
CLASS="LITERAL"
->actionsfile</TT
-> lines are permitted, and are in fact recommended!
- </P
-><P
->
- The default values include standard.action, which is used for internal
- purposes and should be loaded, default.action, which is the
- <SPAN
-CLASS="QUOTE"
->"main"</SPAN
-> actions file maintained by the developers, and
- <TT
-CLASS="FILENAME"
->user.action</TT
->, where you can make your personal additions.
- </P
-><P
->
- Actions files are where all the per site and per URL configuration is done for
- ad blocking, cookie management, privacy considerations, etc.
- There is no point in using <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> without at
- least one actions file.
+>admin-address</TT
+> and <TT
+CLASS="LITERAL"
+>proxy-info-url</TT
+>
+ are unset, the whole "Local Privoxy Support" box on all generated pages will
+ not be shown.
</P
></DD
></DL
><H4
CLASS="SECT3"
><A
-NAME="FILTERFILE"
-></A
->7.1.4. filterfile</H4
-><A
-NAME="DEFAULT.FILTER"
+NAME="PROXY-INFO-URL"
></A
+>7.1.4. proxy-info-url</H4
><P
></P
><DIV
>Specifies:</DT
><DD
><P
-> The <A
-HREF="filter-file.html"
->filter file(s)</A
-> to use
+> A URL to documentation about the local <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> setup,
+ configuration or policies.
</P
></DD
><DT
>Type of value:</DT
><DD
><P
->File name, relative to <TT
-CLASS="LITERAL"
->confdir</TT
-></P
+>URL</P
></DD
><DT
>Default value:</DT
><DD
><P
->default.filter (Unix) <SPAN
+><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
->or</I
+>Unset</I
></SPAN
-> default.filter.txt (Windows)</P
+></P
></DD
><DT
>Effect if unset:</DT
><DD
><P
-> No textual content filtering takes place, i.e. all
- <TT
-CLASS="LITERAL"
->+<A
-HREF="actions-file.html#FILTER"
->filter</A
->{<TT
-CLASS="REPLACEABLE"
-><I
->name</I
-></TT
->}</TT
->
- actions in the actions files are turned neutral.
+> No link to local documentation is displayed on error pages and the CGI user interface.
</P
></DD
><DT
>Notes:</DT
><DD
><P
-> Multiple <TT
-CLASS="LITERAL"
->filterfiles</TT
-> lines are permitted.
- </P
-><P
-> The <A
-HREF="filter-file.html"
->filter files</A
-> contain content modification
- rules that use <A
-HREF="appendix.html#REGEX"
->regular expressions</A
->. These rules permit
- powerful changes on the content of Web pages, and optionally the headers
- as well, e.g., you could disable your favorite JavaScript annoyances,
- re-write the actual displayed text, or just have some fun replacing
- <SPAN
-CLASS="QUOTE"
->"Microsoft"</SPAN
-> with <SPAN
-CLASS="QUOTE"
->"MicroSuck"</SPAN
-> wherever it appears
- on a Web page.
- </P
-><P
-> The
- <TT
+> If both <TT
CLASS="LITERAL"
->+<A
-HREF="actions-file.html#FILTER"
->filter</A
->{<TT
-CLASS="REPLACEABLE"
-><I
->name</I
-></TT
->}</TT
->
- actions rely on the relevant filter (<TT
-CLASS="REPLACEABLE"
-><I
->name</I
-></TT
->)
- to be defined in a filter file!
- </P
-><P
-> A pre-defined filter file called <TT
-CLASS="FILENAME"
->default.filter</TT
-> that contains
- a number of useful filters for common problems is included in the distribution.
- See the section on the <TT
+>admin-address</TT
+> and <TT
CLASS="LITERAL"
-><A
-HREF="actions-file.html#FILTER"
->filter</A
-></TT
+>proxy-info-url</TT
>
- action for a list.
+ are unset, the whole "Local Privoxy Support" box on all generated pages will
+ not be shown.
</P
><P
-> It is recommended to place any locally adapted filters into a separate
- file, such as <TT
-CLASS="FILENAME"
->user.filter</TT
->.
+> This URL shouldn't be blocked ;-)
</P
></DD
></DL
></DIV
></DIV
+></DIV
+><DIV
+CLASS="SECT2"
+><H2
+CLASS="SECT2"
+><A
+NAME="CONF-LOG-LOC"
+></A
+>7.2. Configuration and Log File Locations</H2
+><P
+> <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> can (and normally does) use a number of
+ other files for additional configuration, help and logging.
+ This section of the configuration file tells <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+ where to find those other files. </P
+><P
+> The user running <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>, must have read
+ permission for all configuration files, and write permission to any files
+ that would be modified, such as log files and actions files.</P
><DIV
CLASS="SECT3"
><H4
CLASS="SECT3"
><A
-NAME="LOGFILE"
+NAME="CONFDIR"
></A
->7.1.5. logfile</H4
+>7.2.1. confdir</H4
><P
></P
><DIV
>Specifies:</DT
><DD
><P
-> The log file to use
- </P
+>The directory where the other configuration files are located</P
></DD
><DT
>Type of value:</DT
><DD
><P
->File name, relative to <TT
-CLASS="LITERAL"
->logdir</TT
-></P
+>Path name</P
></DD
><DT
>Default value:</DT
><DD
><P
->logfile (Unix) <SPAN
+>/etc/privoxy (Unix) <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>or</I
></SPAN
-> privoxy.log (Windows)</P
+> <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> installation dir (Windows) </P
></DD
><DT
>Effect if unset:</DT
><DD
><P
-> No log file is used, all log messages go to the console (<TT
-CLASS="LITERAL"
->STDERR</TT
->).
- </P
+><SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>Mandatory</I
+></SPAN
+></P
></DD
><DT
>Notes:</DT
><DD
><P
-> The logfile is where all logging and error messages are written. The level
- of detail and number of messages are set with the <TT
+> No trailing <SPAN
+CLASS="QUOTE"
+>"<TT
CLASS="LITERAL"
->debug</TT
->
- option (see below). The logfile can be useful for tracking down a problem with
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> (e.g., it's not blocking an ad you
- think it should block) but in most cases you probably will never look at it.
+>/</TT
+>"</SPAN
+>, please
</P
><P
-> 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 <SPAN
+> When development goes modular and multi-user, the blocker, filter, and
+ per-user config will be stored in subdirectories of <SPAN
CLASS="QUOTE"
->"man cron"</SPAN
->). For Red Hat, a <B
-CLASS="COMMAND"
->logrotate</B
->
- script has been included.
+>"confdir"</SPAN
+>.
+ For now, the configuration directory structure is flat, except for
+ <TT
+CLASS="FILENAME"
+>confdir/templates</TT
+>, where the HTML templates for CGI
+ output reside (e.g. <SPAN
+CLASS="APPLICATION"
+>Privoxy's</SPAN
+> 404 error page).
</P
+></DD
+></DL
+></DIV
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="LOGDIR"
+></A
+>7.2.2. logdir</H4
><P
-> On SuSE Linux systems, you can place a line like <SPAN
-CLASS="QUOTE"
->"/var/log/privoxy.*
- +1024k 644 nobody.nogroup"</SPAN
-> in <TT
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+> The directory where all logging takes place (i.e. where <TT
CLASS="FILENAME"
->/etc/logfiles</TT
->, with
- the effect that cron.daily will automatically archive, gzip, and empty the
- log, when it exceeds 1M size.
+>logfile</TT
+> and
+ <TT
+CLASS="FILENAME"
+>jarfile</TT
+> are located)
</P
+></DD
+><DT
+>Type of value:</DT
+><DD
><P
-> Any log files must be writable by whatever user <SPAN
+>Path name</P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+>/var/log/privoxy (Unix) <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>or</I
+></SPAN
+> <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
->
- is being run as (default on UNIX, user id is <SPAN
+> installation dir (Windows) </P
+></DD
+><DT
+>Effect if unset:</DT
+><DD
+><P
+><SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>Mandatory</I
+></SPAN
+></P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> No trailing <SPAN
CLASS="QUOTE"
->"privoxy"</SPAN
->).
+>"<TT
+CLASS="LITERAL"
+>/</TT
+>"</SPAN
+>, please
</P
></DD
></DL
><H4
CLASS="SECT3"
><A
-NAME="JARFILE"
+NAME="ACTIONSFILE"
+></A
+>7.2.3. actionsfile</H4
+><A
+NAME="DEFAULT.ACTION"
+></A
+><A
+NAME="STANDARD.ACTION"
+></A
+><A
+NAME="USER.ACTION"
></A
->7.1.6. jarfile</H4
><P
></P
><DIV
>Specifies:</DT
><DD
><P
-> The file to store intercepted cookies in
+> The <A
+HREF="actions-file.html"
+>actions file(s)</A
+> to use
</P
></DD
><DT
><P
>File name, relative to <TT
CLASS="LITERAL"
->logdir</TT
-></P
+>confdir</TT
+>, without the <TT
+CLASS="LITERAL"
+>.action</TT
+> suffix</P
></DD
><DT
->Default value:</DT
+>Default values:</DT
><DD
><P
->jarfile (Unix) <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->or</I
-></SPAN
-> privoxy.jar (Windows)</P
+></P
+><TABLE
+BORDER="0"
+><TBODY
+><TR
+><TD
+> <P
+CLASS="LITERALLAYOUT"
+> standard # Internal purposes, no editing recommended</P
+>
+ </TD
+></TR
+><TR
+><TD
+> <P
+CLASS="LITERALLAYOUT"
+> default # Main actions file</P
+>
+ </TD
+></TR
+><TR
+><TD
+> <P
+CLASS="LITERALLAYOUT"
+> user # User customizations</P
+>
+ </TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
></DD
><DT
>Effect if unset:</DT
><DD
><P
-> Intercepted cookies are not stored at all.
+> No actions are taken at all. Simple neutral proxying.
</P
></DD
><DT
>Notes:</DT
><DD
><P
-> The jarfile may grow to ridiculous sizes over time.
+> Multiple <TT
+CLASS="LITERAL"
+>actionsfile</TT
+> lines are permitted, and are in fact recommended!
+ </P
+><P
+>
+ The default values include standard.action, which is used for internal
+ purposes and should be loaded, default.action, which is the
+ <SPAN
+CLASS="QUOTE"
+>"main"</SPAN
+> actions file maintained by the developers, and
+ <TT
+CLASS="FILENAME"
+>user.action</TT
+>, where you can make your personal additions.
+ </P
+><P
+>
+ Actions files are where all the per site and per URL configuration is done for
+ ad blocking, cookie management, privacy considerations, etc.
+ There is no point in using <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> without at
+ least one actions file.
</P
></DD
></DL
><H4
CLASS="SECT3"
><A
-NAME="TRUSTFILE"
+NAME="FILTERFILE"
+></A
+>7.2.4. filterfile</H4
+><A
+NAME="DEFAULT.FILTER"
></A
->7.1.7. trustfile</H4
><P
></P
><DIV
>Specifies:</DT
><DD
><P
-> The trust file to use
+> The <A
+HREF="filter-file.html"
+>filter file(s)</A
+> to use
</P
></DD
><DT
>Default value:</DT
><DD
><P
-><SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->Unset (commented out)</I
-></SPAN
->. When activated: trust (Unix) <SPAN
+>default.filter (Unix) <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>or</I
></SPAN
-> trust.txt (Windows)</P
+> default.filter.txt (Windows)</P
></DD
><DT
>Effect if unset:</DT
><DD
><P
-> The entire trust mechanism is turned off.
+> No textual content filtering takes place, i.e. all
+ <TT
+CLASS="LITERAL"
+>+<A
+HREF="actions-file.html#FILTER"
+>filter</A
+>{<TT
+CLASS="REPLACEABLE"
+><I
+>name</I
+></TT
+>}</TT
+>
+ actions in the actions files are turned neutral.
</P
></DD
><DT
>Notes:</DT
><DD
><P
-> The trust mechanism is an experimental feature for building white-lists and should
- be used with care. It is <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->NOT</I
-></SPAN
-> recommended for the casual user.
+> Multiple <TT
+CLASS="LITERAL"
+>filterfile</TT
+> lines are permitted.
</P
><P
-> If you specify a trust file, <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> will only allow
- access to sites that are specified in the trustfile. Sites can be listed
- in one of two ways:
+> The <A
+HREF="filter-file.html"
+>filter files</A
+> contain content modification
+ rules that use <A
+HREF="appendix.html#REGEX"
+>regular expressions</A
+>. These rules permit
+ powerful changes on the content of Web pages, and optionally the headers
+ as well, e.g., you could disable your favorite JavaScript annoyances,
+ re-write the actual displayed text, or just have some fun
+ playing buzzword bingo with web pages.
</P
><P
-> Prepending a <TT
-CLASS="LITERAL"
->~</TT
-> character limits access to this site
- only (and any sub-paths within this site), e.g.
+> The
<TT
CLASS="LITERAL"
->~www.example.com</TT
->.
- </P
-><P
-> Or, you can designate sites as <SPAN
-CLASS="emphasis"
+>+<A
+HREF="actions-file.html#FILTER"
+>filter</A
+>{<TT
+CLASS="REPLACEABLE"
><I
-CLASS="EMPHASIS"
->trusted referrers</I
-></SPAN
->, by
- prepending the name with a <TT
-CLASS="LITERAL"
->+</TT
-> character. The effect is that
- access to untrusted sites will be granted -- but only if a link from this
- trusted referrer was used. The link target will then be added to the
- <SPAN
-CLASS="QUOTE"
->"trustfile"</SPAN
-> so that future, direct accesses will be granted.
- Sites added via this mechanism do not become trusted referrers themselves
- (i.e. they are added with a <TT
-CLASS="LITERAL"
->~</TT
-> designation).
- </P
-><P
-> If you use the <TT
-CLASS="LITERAL"
->+</TT
-> operator in the trust file, it may grow
- considerably over time.
+>name</I
+></TT
+>}</TT
+>
+ actions rely on the relevant filter (<TT
+CLASS="REPLACEABLE"
+><I
+>name</I
+></TT
+>)
+ to be defined in a filter file!
</P
><P
-> It is recommended that <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> be compiled with
- the <TT
-CLASS="LITERAL"
->--disable-force</TT
->, <TT
-CLASS="LITERAL"
->--disable-toggle</TT
-> and
- <TT
+> A pre-defined filter file called <TT
+CLASS="FILENAME"
+>default.filter</TT
+> that contains
+ a number of useful filters for common problems is included in the distribution.
+ See the section on the <TT
CLASS="LITERAL"
-> --disable-editor</TT
-> options, if this feature is to be
- used.
+><A
+HREF="actions-file.html#FILTER"
+>filter</A
+></TT
+>
+ action for a list.
</P
><P
-> Possible applications include limiting Internet access for children.
+> It is recommended to place any locally adapted filters into a separate
+ file, such as <TT
+CLASS="FILENAME"
+>user.filter</TT
+>.
</P
></DD
></DL
></DIV
></DIV
-></DIV
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
-NAME="LOCAL-SET-UP"
-></A
->7.2. Local Set-up Documentation</H2
-><P
-> If you intend to operate <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> for more users
- than just yourself, it might be a good idea to let them know how to reach
- you, what you block and why you do that, your policies, etc.
- </P
><DIV
CLASS="SECT3"
><H4
CLASS="SECT3"
><A
-NAME="USER-MANUAL"
+NAME="LOGFILE"
></A
->7.2.1. user-manual</H4
+>7.2.5. logfile</H4
><P
></P
><DIV
>Specifies:</DT
><DD
><P
-> Location of the <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> User Manual.
+> The log file to use
</P
></DD
><DT
>Type of value:</DT
><DD
><P
->A fully qualified URI</P
+>File name, relative to <TT
+CLASS="LITERAL"
+>logdir</TT
+></P
></DD
><DT
>Default value:</DT
><DD
><P
-><SPAN
+>logfile (Unix) <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
->Unset</I
+>or</I
></SPAN
-></P
+> privoxy.log (Windows)</P
></DD
><DT
>Effect if unset:</DT
><DD
><P
-> <A
-HREF="http://www.privoxy.org/user-manual/"
-TARGET="_top"
->http://www.privoxy.org/<TT
-CLASS="REPLACEABLE"
-><I
->version</I
-></TT
->/user-manual/</A
->
- will be used, where <TT
-CLASS="REPLACEABLE"
-><I
->version</I
-></TT
-> is the <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> version.
+> No log file is used, all log messages go to the console (<TT
+CLASS="LITERAL"
+>STDERR</TT
+>).
</P
></DD
><DT
>Notes:</DT
><DD
><P
-> The User Manual URI 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. For multi-user setups, you could provide a copy on
- a local webserver for all your users and use the corresponding URL here.
+> The logfile is where all logging and error messages are written. The level
+ of detail and number of messages are set with the <TT
+CLASS="LITERAL"
+>debug</TT
+>
+ option (see below). The logfile can be useful for tracking down a problem with
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> (e.g., it's not blocking an ad you
+ think it should block) but in most cases you probably will never look at it.
</P
><P
-> Examples:
+> 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 <SPAN
+CLASS="QUOTE"
+>"man cron"</SPAN
+>). For Red Hat, a <B
+CLASS="COMMAND"
+>logrotate</B
+>
+ script has been included.
</P
><P
-> Unix, in local filesystem:
- </P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="90%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
-> user-manual file:///usr/share/doc/privoxy-3.0.4/user-manual/</PRE
-></TD
-></TR
-></TABLE
->
- </P
-><P
-> Windows, in local filesystem, <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->must</I
-></SPAN
-> use forward slash notation:
- </P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="90%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
-> user-manual file:/c:/some-dir/privoxy-3.0.4/user-manual/</PRE
-></TD
-></TR
-></TABLE
->
- </P
-><P
-> Windows, UNC notation (with forward slashes):
- </P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="90%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
-> user-manual file://///some-server/some-path/privoxy-3.0.4/user-manual/</PRE
-></TD
-></TR
-></TABLE
->
- </P
-><P
-> Any platform, on local webserver (called <SPAN
+> On SuSE Linux systems, you can place a line like <SPAN
CLASS="QUOTE"
->"local-webserver"</SPAN
->):
- </P
+>"/var/log/privoxy.*
+ +1024k 644 nobody.nogroup"</SPAN
+> in <TT
+CLASS="FILENAME"
+>/etc/logfiles</TT
+>, with
+ the effect that cron.daily will automatically archive, gzip, and empty the
+ log, when it exceeds 1M size.
+ </P
><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="90%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
-> user-manual http://local-webserver/privoxy-user-manual/</PRE
-></TD
-></TR
-></TABLE
+> Any log files must be writable by whatever user <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
>
- </P
-><DIV
-CLASS="WARNING"
-><P
-></P
-><TABLE
-CLASS="WARNING"
-BORDER="1"
-WIDTH="90%"
-><TR
-><TD
-ALIGN="CENTER"
-><B
->Warning</B
-></TD
-></TR
-><TR
-><TD
-ALIGN="LEFT"
-><P
-> If set, this option should be <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->the first option in the config
- file</I
-></SPAN
->, because it is used while the config file is being read.
+ is being run as (default on UNIX, user id is <SPAN
+CLASS="QUOTE"
+>"privoxy"</SPAN
+>).
</P
-></TD
-></TR
-></TABLE
-></DIV
></DD
></DL
></DIV
><H4
CLASS="SECT3"
><A
-NAME="TRUST-INFO-URL"
+NAME="JARFILE"
></A
->7.2.2. trust-info-url</H4
+>7.2.6. jarfile</H4
><P
></P
><DIV
>Specifies:</DT
><DD
><P
-> A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
+> The file to store intercepted cookies in
</P
></DD
><DT
>Type of value:</DT
><DD
><P
->URL</P
+>File name, relative to <TT
+CLASS="LITERAL"
+>logdir</TT
+></P
></DD
><DT
>Default value:</DT
><DD
><P
->Two example URL are provided</P
+>Unset (commented out). When activated: jarfile (Unix) <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>or</I
+></SPAN
+> privoxy.jar (Windows)</P
></DD
><DT
>Effect if unset:</DT
><DD
><P
-> No links are displayed on the "untrusted" error page.
+> Intercepted cookies are not stored in a dedicated log file.
</P
></DD
><DT
>Notes:</DT
><DD
><P
-> The value of this option only matters if the experimental trust mechanism has been
- activated. (See <A
-HREF="config.html#TRUSTFILE"
-><SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->trustfile</I
-></SPAN
-></A
-> above.)
- </P
-><P
-> If you use the trust mechanism, it is a good idea to write up some on-line
- documentation about your trust policy and to specify the URL(s) here.
- Use multiple times for multiple URLs.
+> The jarfile may grow to ridiculous sizes over time.
</P
><P
-> The URL(s) should be added to the trustfile as well, so users don't end up
- locked out from the information on why they were locked out in the first place!
+> If debug 8 (show header parsing) is enabled, cookies are
+ written to the logfile with the rest of the headers.
</P
></DD
></DL
><H4
CLASS="SECT3"
><A
-NAME="ADMIN-ADDRESS"
+NAME="TRUSTFILE"
></A
->7.2.3. admin-address</H4
+>7.2.7. trustfile</H4
><P
></P
><DIV
>Specifies:</DT
><DD
><P
-> An email address to reach the proxy administrator.
+> The trust file to use
</P
></DD
><DT
>Type of value:</DT
><DD
><P
->Email address</P
+>File name, relative to <TT
+CLASS="LITERAL"
+>confdir</TT
+></P
></DD
><DT
>Default value:</DT
CLASS="emphasis"
><I
CLASS="EMPHASIS"
->Unset</I
+>Unset (commented out)</I
></SPAN
-></P
+>. When activated: trust (Unix) <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>or</I
+></SPAN
+> trust.txt (Windows)</P
></DD
><DT
>Effect if unset:</DT
><DD
><P
-> No email address is displayed on error pages and the CGI user interface.
+> The entire trust mechanism is turned off.
</P
></DD
><DT
>Notes:</DT
><DD
><P
-> If both <TT
-CLASS="LITERAL"
->admin-address</TT
-> and <TT
-CLASS="LITERAL"
->proxy-info-url</TT
->
- are unset, the whole "Local Privoxy Support" box on all generated pages will
- not be shown.
- </P
-></DD
-></DL
-></DIV
-></DIV
-><DIV
-CLASS="SECT3"
-><H4
-CLASS="SECT3"
-><A
-NAME="PROXY-INFO-URL"
-></A
->7.2.4. proxy-info-url</H4
-><P
-></P
-><DIV
-CLASS="VARIABLELIST"
-><DL
-><DT
->Specifies:</DT
-><DD
+> The trust mechanism is an experimental feature for building white-lists and should
+ be used with care. It is <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>NOT</I
+></SPAN
+> recommended for the casual user.
+ </P
><P
-> A URL to documentation about the local <SPAN
+> If you specify a trust file, <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> setup,
- configuration or policies.
+> will only allow
+ access to sites that are specified in the trustfile. Sites can be listed
+ in one of two ways:
</P
-></DD
-><DT
->Type of value:</DT
-><DD
><P
->URL</P
-></DD
-><DT
->Default value:</DT
-><DD
+> Prepending a <TT
+CLASS="LITERAL"
+>~</TT
+> character limits access to this site
+ only (and any sub-paths within this site), e.g.
+ <TT
+CLASS="LITERAL"
+>~www.example.com</TT
+>.
+ </P
><P
-><SPAN
+> Or, you can designate sites as <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
->Unset</I
+>trusted referrers</I
></SPAN
-></P
-></DD
-><DT
->Effect if unset:</DT
-><DD
+>, by
+ prepending the name with a <TT
+CLASS="LITERAL"
+>+</TT
+> character. The effect is that
+ access to untrusted sites will be granted -- but only if a link from this
+ trusted referrer was used. The link target will then be added to the
+ <SPAN
+CLASS="QUOTE"
+>"trustfile"</SPAN
+> so that future, direct accesses will be granted.
+ Sites added via this mechanism do not become trusted referrers themselves
+ (i.e. they are added with a <TT
+CLASS="LITERAL"
+>~</TT
+> designation).
+ </P
><P
-> No link to local documentation is displayed on error pages and the CGI user interface.
+> If you use the <TT
+CLASS="LITERAL"
+>+</TT
+> operator in the trust file, it may grow
+ considerably over time.
</P
-></DD
-><DT
->Notes:</DT
-><DD
><P
-> If both <TT
+> It is recommended that <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> be compiled with
+ the <TT
CLASS="LITERAL"
->admin-address</TT
-> and <TT
+>--disable-force</TT
+>, <TT
CLASS="LITERAL"
->proxy-info-url</TT
->
- are unset, the whole "Local Privoxy Support" box on all generated pages will
- not be shown.
+>--disable-toggle</TT
+> and
+ <TT
+CLASS="LITERAL"
+> --disable-editor</TT
+> options, if this feature is to be
+ used.
</P
><P
-> This URL shouldn't be blocked ;-)
+> Possible applications include limiting Internet access for children.
</P
></DD
></DL
><H4
CLASS="SECT3"
><A
+NAME="ENABLE-REMOTE-HTTP-TOGGLE"
+></A
+>7.4.4. enable-remote-http-toggle</H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+> Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
+ </P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+>0 or 1</P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+>1</P
+></DD
+><DT
+>Effect if unset:</DT
+><DD
+><P
+> Privoxy ignores special HTTP headers.
+ </P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> When toggled on, the client can change <SPAN
+CLASS="APPLICATION"
+>Privoxy's</SPAN
+>
+ behaviour by setting special HTTP headers. Currently the only supported
+ special header is <SPAN
+CLASS="QUOTE"
+>"X-Filter: No"</SPAN
+>, to disable filtering for
+ the ongoing request, even if it is enabled in one of the action files.
+ </P
+><P
+> If you are using <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> in a
+ multi-user environment or with untrustworthy clients and want to
+ enforce filtering, you will have to disable this option,
+ otherwise you can ignore it.
+ </P
+></DD
+></DL
+></DIV
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
NAME="ENABLE-EDIT-ACTIONS"
></A
->7.4.4. enable-edit-actions</H4
+>7.4.5. enable-edit-actions</H4
><P
></P
><DIV
><A
NAME="ACLS"
></A
->7.4.5. ACLs: permit-access and deny-access</H4
+>7.4.6. ACLs: permit-access and deny-access</H4
><A
NAME="PERMIT-ACCESS"
></A
><A
NAME="BUFFER-LIMIT"
></A
->7.4.6. buffer-limit</H4
+>7.4.7. buffer-limit</H4
><P
></P
><DIV
></TD
></TR
></TABLE
+>
+ </P
+><P
+> To chain Privoxy and Tor, both running on the same system, you should use
+ the rule:
+ </P
+><P
+> <TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="90%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> forward-socks4 / 127.0.0.1:9050 .</PRE
+></TD
+></TR
+></TABLE
+>
+ </P
+><P
+> The public <SPAN
+CLASS="APPLICATION"
+>Tor</SPAN
+> network can't be used to reach your local network,
+ therefore it's a good idea to make some exceptions:
+ </P
+><P
+> <TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="90%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> forward 192.168.*.*/ .
+ forward 10.*.*.*/ .
+ forward 127.*.*.*/ .</PRE
+></TD
+></TR
+></TABLE
+>
+ </P
+><P
+> 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 network at all.
+ </P
+><P
+> If you also want to be able to reach servers in your local network by
+ using their names, you will need additional exceptions that look like
+ this:
+ </P
+><P
+> <TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="90%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> forward localhost/ .</PRE
+></TD
+></TR
+></TABLE
>
</P
></DD
></TABLE
> </P
></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="FORWARDED-CONNECT-RETRIES"
+></A
+>7.5.4. forwarded-connect-retries</H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+> How often Privoxy retries if a forwarded connection request fails.
+ </P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>Number of retries.</I
+></TT
+>
+ </P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+><SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>0</I
+></SPAN
+></P
+></DD
+><DT
+>Effect if unset:</DT
+><DD
+><P
+> Forwarded connections are treated like direct connections and no retry attempts are made.
+ </P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>forwarded-connect-retries</I
+></TT
+> is mainly interesting
+ for socks4a connections, where Privoxy can't detect why the connections failed.
+ The connection might have failed because of a DNS timeout in which case a retry makes sense,
+ but it might also have failed because the server doesn't exist or isn't reachable. In this
+ case the retry will just delay the appearance of Privoxy's error message.
+ </P
+><P
+> Only use this option, if you are getting many forwarding related error messages,
+ that go away when you try again manually. Start with a small value and check Privoxy's
+ logfile from time to time, to see how many retries are usually needed.
+ </P
+></DD
+><DT
+>Examples:</DT
+><DD
+><P
+> forwarded-connect-retries 1
+ </P
+></DD
+></DL
+></DIV
+></DIV
></DIV
><DIV
CLASS="SECT2"
HREF="config.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
><H2
CLASS="SECT2"
><A
-NAME="AEN724"
+NAME="AEN766"
></A
>6.1. Controlling <SPAN
CLASS="APPLICATION"
> <H2
CLASS="BRIDGEHEAD"
><A
-NAME="AEN733"
+NAME="AEN775"
></A
> Privoxy Menu</H2
><P
></UL
></P
><P
+> The syntax of all configuration files has remained the same throughout the
+ 3.x series. There have been enhancements, but no changes that would preclude
+ the use of any configuration file from one version to the next.</P
+><P
> All files use the <SPAN
CLASS="QUOTE"
>"<TT
HREF="copyright.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
HREF="seealso.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
><H2
CLASS="SECT2"
><A
-NAME="AEN4424"
+NAME="AEN4533"
></A
>12.1. License</H2
><P
HREF="templates.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
>Appendix on regular expressions</A
>, and
see the <A
-HREF="http://perldoc.com/perl5.6.1/pod/perl.html"
+HREF="http://perldoc.perl.org/perlre.html"
TARGET="_top"
>Perl
manual</A
> for
<A
-HREF="http://perldoc.com/perl5.6.1/pod/perlop.html#s-PATTERN-REPLACEMENT-egimosx"
+HREF="http://perldoc.perl.org/perlop.html"
TARGET="_top"
>the
<TT
>s///</TT
> operator's syntax</A
> and <A
-HREF="http://perldoc.com/perl5.6.1/pod/perlre.html"
+HREF="http://perldoc.perl.org/perlre.html"
TARGET="_top"
>Perl-style regular
expressions</A
><H2
CLASS="SECT2"
><A
-NAME="AEN4024"
+NAME="AEN4133"
></A
>9.1. Filter File Tutorial</H2
><P
HREF="introduction.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="ARTICLE"
BGCOLOR="#EEEEEE"
> <A
HREF="copyright.html"
>Copyright</A
-> © 2001 - 2004 by
+> © 2001 - 2006 by
<A
HREF="http://www.privoxy.org/"
TARGET="_top"
><BR></P
><P
CLASS="PUBDATE"
->$Id: user-manual.sgml,v 2.15 2006/08/30 11:15:22 hal9 Exp $<BR></P
+>$Id: user-manual.sgml,v 2.17 2006/09/05 13:25:12 david__schmidt Exp $<BR></P
><DIV
><DIV
CLASS="ABSTRACT"
><DL
><DT
>6.1. <A
-HREF="configuration.html#AEN724"
+HREF="configuration.html#AEN766"
>Controlling <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
><DL
><DT
>7.1. <A
-HREF="config.html#CONF-LOG-LOC"
->Configuration and Log File Locations</A
+HREF="config.html#LOCAL-SET-UP"
+>Local Set-up Documentation</A
></DT
><DD
><DL
><DT
>7.1.1. <A
-HREF="config.html#CONFDIR"
->confdir</A
+HREF="config.html#USER-MANUAL"
+>user-manual</A
></DT
><DT
>7.1.2. <A
-HREF="config.html#LOGDIR"
->logdir</A
+HREF="config.html#TRUST-INFO-URL"
+>trust-info-url</A
></DT
><DT
>7.1.3. <A
-HREF="config.html#ACTIONSFILE"
->actionsfile</A
+HREF="config.html#ADMIN-ADDRESS"
+>admin-address</A
></DT
><DT
>7.1.4. <A
-HREF="config.html#FILTERFILE"
->filterfile</A
-></DT
-><DT
->7.1.5. <A
-HREF="config.html#LOGFILE"
->logfile</A
-></DT
-><DT
->7.1.6. <A
-HREF="config.html#JARFILE"
->jarfile</A
-></DT
-><DT
->7.1.7. <A
-HREF="config.html#TRUSTFILE"
->trustfile</A
+HREF="config.html#PROXY-INFO-URL"
+>proxy-info-url</A
></DT
></DL
></DD
><DT
>7.2. <A
-HREF="config.html#LOCAL-SET-UP"
->Local Set-up Documentation</A
+HREF="config.html#CONF-LOG-LOC"
+>Configuration and Log File Locations</A
></DT
><DD
><DL
><DT
>7.2.1. <A
-HREF="config.html#USER-MANUAL"
->user-manual</A
+HREF="config.html#CONFDIR"
+>confdir</A
></DT
><DT
>7.2.2. <A
-HREF="config.html#TRUST-INFO-URL"
->trust-info-url</A
+HREF="config.html#LOGDIR"
+>logdir</A
></DT
><DT
>7.2.3. <A
-HREF="config.html#ADMIN-ADDRESS"
->admin-address</A
+HREF="config.html#ACTIONSFILE"
+>actionsfile</A
></DT
><DT
>7.2.4. <A
-HREF="config.html#PROXY-INFO-URL"
->proxy-info-url</A
+HREF="config.html#FILTERFILE"
+>filterfile</A
+></DT
+><DT
+>7.2.5. <A
+HREF="config.html#LOGFILE"
+>logfile</A
+></DT
+><DT
+>7.2.6. <A
+HREF="config.html#JARFILE"
+>jarfile</A
+></DT
+><DT
+>7.2.7. <A
+HREF="config.html#TRUSTFILE"
+>trustfile</A
></DT
></DL
></DD
></DT
><DT
>7.4.4. <A
+HREF="config.html#ENABLE-REMOTE-HTTP-TOGGLE"
+>enable-remote-http-toggle</A
+></DT
+><DT
+>7.4.5. <A
HREF="config.html#ENABLE-EDIT-ACTIONS"
>enable-edit-actions</A
></DT
><DT
HREF="config.html#ACLS"
>ACLs: permit-access and deny-access</A
></DT
><DT
HREF="config.html#BUFFER-LIMIT"
>buffer-limit</A
></DT
HREF="config.html#ADVANCED-FORWARDING-EXAMPLES"
>Advanced Forwarding Examples</A
></DT
+><DT
+>7.5.4. <A
+HREF="config.html#FORWARDED-CONNECT-RETRIES"
+>forwarded-connect-retries</A
+></DT
></DL
></DD
><DT
><DL
><DT
>8.1. <A
-HREF="actions-file.html#AEN1902"
+HREF="actions-file.html#AEN2011"
>Finding the Right Mix</A
></DT
><DT
>8.2. <A
-HREF="actions-file.html#AEN1909"
+HREF="actions-file.html#AEN2018"
>How to Edit</A
></DT
><DT
><DL
><DT
>8.4.1. <A
-HREF="actions-file.html#AEN1983"
+HREF="actions-file.html#AEN2092"
>The Domain Pattern</A
></DT
><DT
>8.4.2. <A
-HREF="actions-file.html#AEN2045"
+HREF="actions-file.html#AEN2154"
>The Path Pattern</A
></DT
></DL
></DT
><DT
>8.5.36. <A
-HREF="actions-file.html#AEN3640"
+HREF="actions-file.html#AEN3749"
>Summary</A
></DT
></DL
><DL
><DT
>8.7.1. <A
-HREF="actions-file.html#AEN3705"
+HREF="actions-file.html#AEN3814"
>default.action</A
></DT
><DT
>8.7.2. <A
-HREF="actions-file.html#AEN3886"
+HREF="actions-file.html#AEN3995"
>user.action</A
></DT
></DL
><DL
><DT
>9.1. <A
-HREF="filter-file.html#AEN4024"
+HREF="filter-file.html#AEN4133"
>Filter File Tutorial</A
></DT
><DT
><DL
><DT
>12.1. <A
-HREF="copyright.html#AEN4424"
+HREF="copyright.html#AEN4533"
>License</A
></DT
><DT
></DT
><DT
>14.2. <A
-HREF="appendix.html#AEN4670"
+HREF="appendix.html#AEN4783"
><SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
HREF="whatsnew.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
Page</A
>.</P
><P
-> Note: If you have a previous <SPAN
-CLASS="APPLICATION"
->Junkbuster</SPAN
-> or
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> installation on your system, you
- will need to remove it. On some platforms, this may be done for you as part
- of their installation procedure. (See below for your platform). In any case
- <SPAN
+> Note:
+ On some platforms, the installer may remove previously installed versions, if
+ found. (See below for your platform). In any case <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
->be sure to backup your old configuration if it is valuable to
- you.</I
+>be sure to backup
+ your old configuration if it is valuable to you.</I
></SPAN
> See the <A
HREF="whatsnew.html#UPGRADERSNOTE"
->note to
- upgraders</A
+>note to upgraders</A
> section below.</P
><DIV
CLASS="SECT2"
CLASS="APPLICATION"
>Junkbuster</SPAN
>
- automatically, before installing <SPAN
+ automatically if found, before installing <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
>.</P
><P
> Just double-click the installer, which will guide you through
the installation process. You will find the configuration files
- in the same directory as you installed Privoxy in. </P
+ in the same directory as you installed <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> in. </P
+><P
+> Version 3.0.4 introduces full <SPAN
+CLASS="APPLICATION"
+>Windows</SPAN
+> service
+ functionality. On Windows only, the <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+ program has two new command line arguments to install and uninstall
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> as a <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>service</I
+></SPAN
+>.</P
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Arguments:</DT
+><DD
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>--install</I
+></TT
+>[:<TT
+CLASS="REPLACEABLE"
+><I
+>service_name</I
+></TT
+>]
+ </P
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>--uninstall</I
+></TT
+>[:<TT
+CLASS="REPLACEABLE"
+><I
+>service_name</I
+></TT
+>]
+ </P
+></DD
+></DL
+></DIV
+><P
+> After invoking <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> with
+ <B
+CLASS="COMMAND"
+>--install</B
+>, you will need to bring up the
+ <SPAN
+CLASS="APPLICATION"
+>Windows</SPAN
+> service console to assign the user you
+ want <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> to run under, and whether or not you
+ want it to run whenever the system starts. You can start the
+ <SPAN
+CLASS="APPLICATION"
+>Windows</SPAN
+> services console with the following
+ command: <B
+CLASS="COMMAND"
+>services.msc</B
+> If you do not take the manual step
+ of modifying <SPAN
+CLASS="APPLICATION"
+>Privoxy's</SPAN
+> service settings, it will
+ not start. Note too that you will need to give Privoxy a user account that
+ actually exists, or it will not be permitted to
+ write to its log and configuration files.</P
></DIV
><DIV
CLASS="SECT3"
HREF="installation.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
HREF="startup.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
CLASS="LITERAL"
>8118</TT
>.
- (<SPAN
-CLASS="APPLICATION"
->Junkbuster</SPAN
-> and earlier versions of
<SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> used port 8000.) See the section <A
-HREF="startup.html"
->Starting <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-></A
-> below
- for more details on this.
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>DO NOT</I
+></SPAN
+> activate proxying for <TT
+CLASS="LITERAL"
+>FTP</TT
+> or
+ any protocols besides HTTP and HTTPS (SSL)! It won't work!
</P
></LI
><LI
HREF="contact.html"
>Contacting the
Developers</A
-> on how to report bugs or problems with websites or to get
+> on how to report bugs, problems with websites or to get
help.
</P
></LI
> <DIV
CLASS="FIGURE"
><A
-NAME="AEN520"
+NAME="AEN553"
></A
><P
><B
HREF="appendix.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
><TR
><TD
> <A
-HREF="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(window.open('http://www.privoxy.org/actions','Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"
+HREF="http://sourceforge.net/tracker/?group_id=11118&atid=460288"
TARGET="_top"
->http://www.privoxy.org/actions/</A
+>http://sourceforge.net/tracker/?group_id=11118&atid=460288</A
>, to submit <SPAN
CLASS="QUOTE"
>"misses"</SPAN
-> to the developers.
+> and other
+ configuration related suggestions to the developers.
</TD
></TR
></TBODY
><TR
><TD
> <A
-HREF="http://privacy.net/analyze/"
+HREF="http://privacy.net/"
TARGET="_top"
->http://privacy.net/analyze/</A
+>http://privacy.net/</A
>, a useful site
to check what information about you is leaked while you browse the web.
</TD
><TR
><TD
> <A
+HREF="http://tor.eff.org/"
+TARGET="_top"
+>http://tor.eff.org/</A
+>,
+ <SPAN
+CLASS="APPLICATION"
+>TOR</SPAN
+> can help anonymize web browsing,
+ web publishing, instant messaging, IRC, SSH, and other applications.
+ </TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
+>
+ <P
+></P
+><TABLE
+BORDER="0"
+><TBODY
+><TR
+><TD
+> <A
HREF="http://www.privoxy.org/developer-manual/"
TARGET="_top"
>http://www.privoxy.org/developer-manual/</A
HREF="configuration.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
> <DIV
CLASS="FIGURE"
><A
-NAME="AEN571"
+NAME="AEN604"
></A
><P
><B
></A
>5.4. Windows</H2
><P
->Click on the Privoxy Icon to start Privoxy. If no configuration file is
+>Click on the Privoxy Icon to start <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>. If no configuration file is
specified on the command line, <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
CLASS="FILENAME"
>config.txt</TT
>. Note that Windows will
- automatically start Privoxy upon booting you PC.</P
+ automatically start Privoxy when the system starts if you chose that option
+ when installing.</P
+><P
+> <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> can run with full Windows service functionality.
+ On Windows only, the Privoxy program has two new command line arguments
+ to install and uninstall Privoxy as a service. See the
+ <A
+HREF="installation.html#INSTALLATION-PACK-WIN"
+>Windows Installation
+ instructions</A
+> for details.</P
></DIV
><DIV
CLASS="SECT2"
></LI
></UL
></P
+><P
+> On <SPAN
+CLASS="APPLICATION"
+>MS Windows</SPAN
+> only there are two addition
+ options to allow <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> to install and
+ run as a <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>service</I
+></SPAN
+>. See the
+<A
+HREF="installation.html#INSTALLATION-PACK-WIN"
+>Window Installation section</A
+>
+for details.</P
></DIV
></DIV
><DIV
HREF="contact.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
HREF="quickstart.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
> <SPAN
CLASS="APPLICATION"
>MS-Windows</SPAN
-> versions can now be installed and
+> versions can now be
+ <A
+HREF="installation.html#INSTALLATION-PACK-WIN"
+>installed and
started as a <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
->service</I
+>Windows service</I
></SPAN
+></A
>.
</P
></LI
><LI
><P
+> <TT
+CLASS="FILENAME"
+>config</TT
+> has two new options:
+ <A
+HREF="config.html#ENABLE-REMOTE-HTTP-TOGGLE"
+>enable-remote-http-toggle</A
+>,
+ and <A
+HREF="config.html#FORWARDED-CONNECT-RETRIES"
+>forwarded-connect-retries</A
+>.
+ </P
+><P
+> And there is improved handling of the <A
+HREF="config.html#USER-MANUAL"
+>user-manual</A
+>
+ option, for placing documentation and help files on the local system.
+ </P
+></LI
+><LI
+><P
+> Actions files problems and suggestions are now being directed to: <A
+HREF="http://sourceforge.net/tracker/?group_id=11118&atid=460288"
+TARGET="_top"
+>http://sourceforge.net/tracker/?group_id=11118&atid=460288</A
+>.
+ Please use this to report such configuration related problems as missed
+ ads, sites that don't function properly due to one action or another,
+ innocent images being blocked, etc.
+ </P
+></LI
+><LI
+><P
> In addition, there are various bug fixes and significant enhancements, including
- error pages are no longer cached, better DNS error handling, and various logging
- improvements.
+ error pages should no longer be cached if the problem is fixed, better DNS
+ error handling, and various logging improvements.
</P
></LI
></UL
></LI
><LI
><P
+>
+ On the other hand, some installers may not overwrite any existing configuration
+ files, thinking you will want to do that. You may want to manually check
+ your saved files against the newer versions to see if the improvements have
+ merit, or whether there are new options that you may want to consider.
+ There are a number of new features, but most won't be available unless
+ these features are incorporated into your configuration somehow.
+ </P
+></LI
+><LI
+><P
> See the full documentation on
<TT
CLASS="LITERAL"
projects / privoxy.git / commitdiff