This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.99 2002/04/28 16:59:05 swa Exp $
+ $Id: user-manual.sgml,v 1.100 2002/04/29 03:05:55 hal9 Exp $
Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://www.privoxy.org/
<artheader>
<title>Privoxy User Manual</title>
-<pubdate>$Id: user-manual.sgml,v 1.99 2002/04/28 16:59:05 swa Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.100 2002/04/29 03:05:55 hal9 Exp $</pubdate>
<authorgroup>
<author>
where to find those other files.
</para>
+<para>
+ The user running Privoxy, must have read permission for all
+ configuration files, and write permission to any files that would
+ be modified, such as log files.
+</para>
+
+<sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
+<variablelist>
+ <varlistentry>
+ <term>Specifies:</term>
+ <listitem>
+ <para>
+ Location of the <application>Privoxy</application> User Manual.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Type of value:</term>
+ <listitem>
+ <para>A fully qualified URI</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Default value:</term>
+ <listitem>
+ <para><ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Effect if unset:</term>
+ <listitem>
+ <para>
+ The default will be used.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Notes:</term>
+ <listitem>
+ <para>
+ The User Manual is used for help hints from some of the internal CGI pages.
+ It is normally packaged with the binary distributions, and would make more
+ sense to have this pointed at a locally installed copy.
+ </para>
+ <para>
+ A more useful example (Unix):
+ </para>
+ <para>
+ <emphasis>user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/</emphasis>
+ </para>
+ <warning>
+ <para>
+ If this option is defined, it must come first! It is needed before the rest of
+ <filename>config</filename> is read.
+ </para>
+ </warning>
+ </listitem>
+ </varlistentry>
+</variablelist>
+</sect3>
<sect3 renderas="sect4" id="confdir"><title>confdir</title>
the effect that cron.daily will automatically archive, gzip, and empty the
log, when it exceeds 1M size.
</para>
+ <para>
+ Any log files must be writable by whatever user <application>Privoxy</application>
+ is being run as (default on UNIX, user id is <quote>privoxy</quote>).
+ </para>
</listitem>
</varlistentry>
</variablelist>
</variablelist>
</sect3>
-<sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- Location of the <application>Privoxy</application> User Manual.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>A fully qualified URI</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para><ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- The default will be used.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- The User Manual is used for help hints from some of the internal CGI pages.
- It is normally packaged with the binary distributions, and would make more
- sense to have this pointed at a locally installed copy.
- </para>
- <para>
- A more useful example (Unix):
- </para>
- <para>
- <emphasis>user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/</emphasis>
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect3>
-
</sect2>
<!-- ~ End section ~ -->
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
+ Revision 1.100 2002/04/29 03:05:55 hal9
+ Add clarification on differences of new actions files.
+
Revision 1.99 2002/04/28 16:59:05 swa
more structure in starting section
8.1. Configuration and Log File Locations
- 8.1.1. confdir
- 8.1.2. logdir
- 8.1.3. actionsfile
- 8.1.4. filterfile
- 8.1.5. logfile
- 8.1.6. jarfile
- 8.1.7. trustfile
- 8.1.8. user-manual
+ 8.1.1. user-manual
+ 8.1.2. confdir
+ 8.1.3. logdir
+ 8.1.4. actionsfile
+ 8.1.5. filterfile
+ 8.1.6. logfile
+ 8.1.7. jarfile
+ 8.1.8. trustfile
8.2. Local Set-up Documentation
without Internet access. You will see the following section:
Privoxy Menu
- ?? View & change the current configuration
- ?? View the source code version numbers
- ?? View the request headers.
- ?? Look up which actions apply to a URL and why
- ?? Toggle Privoxy on or off
+ ? View & change the current configuration
+ ? View the source code version numbers
+ ? View the request headers.
+ ? Look up which actions apply to a URL and why
+ ? Toggle Privoxy on or off
This should be self-explanatory. Note the first item leads to an editor for the
configuration, help and logging. This section of the configuration file tells
Privoxy where to find those other files.
+The user running Privoxy, must have read permission for all configuration
+files, and write permission to any files that would be modified, such as log
+files.
+
+-------------------------------------------------------------------------------
+
+8.1.1. user-manual
+
+Specifies:
+
+ Location of the Privoxy User Manual.
+
+Type of value:
+
+ A fully qualified URI
+
+Default value:
+
+ http://www.privoxy.org/user-manual/
+
+Effect if unset:
+
+ The default will be used.
+
+Notes:
+
+ The User Manual is used for help hints from some of the internal CGI pages.
+ It is normally packaged with the binary distributions, and would make more
+ sense to have this pointed at a locally installed copy.
+
+ A more useful example (Unix):
+
+ user-manual file:///usr/share/doc/privoxy-2.9.14/user-manual/
+
+ +-----------------------------------------------------------------+
+ | Warning |
+ |-----------------------------------------------------------------|
+ |If this option is defined, it must come first! It is needed |
+ |before the rest of config is read. |
+ +-----------------------------------------------------------------+
+
-------------------------------------------------------------------------------
-8.1.1. confdir
+8.1.2. confdir
Specifies:
-------------------------------------------------------------------------------
-8.1.2. logdir
+8.1.3. logdir
Specifies:
-------------------------------------------------------------------------------
-8.1.3. actionsfile
+8.1.4. actionsfile
Specifies:
-------------------------------------------------------------------------------
-8.1.4. filterfile
+8.1.5. filterfile
Specifies:
-------------------------------------------------------------------------------
-8.1.5. logfile
+8.1.6. logfile
Specifies:
644 nobody.nogroup" in /etc/logfiles, with the effect that cron.daily will
automatically archive, gzip, and empty the log, when it exceeds 1M size.
+ Any log files must be writable by whatever user Privoxy is being run as
+ (default on UNIX, user id is "privoxy").
+
-------------------------------------------------------------------------------
-8.1.6. jarfile
+8.1.7. jarfile
Specifies:
-------------------------------------------------------------------------------
-8.1.7. trustfile
+8.1.8. trustfile
Specifies:
-------------------------------------------------------------------------------
-8.1.8. user-manual
-
-Specifies:
-
- Location of the Privoxy User Manual.
-
-Type of value:
-
- A fully qualified URI
-
-Default value:
-
- http://www.privoxy.org/user-manual/
-
-Effect if unset:
-
- The default will be used.
-
-Notes:
-
- The User Manual is used for help hints from some of the internal CGI pages.
- It is normally packaged with the binary distributions, and would make more
- sense to have this pointed at a locally installed copy.
-
- A more useful example (Unix):
-
- user-manual file:///usr/share/doc/privoxy-2.9.14/user-manual/
-
--------------------------------------------------------------------------------
-
8.2. Local Set-up Documentation
If you intend to operate Privoxy for more users that just yourself, it might be
And finally we pull it all together in the bottom section and summarize how
Privoxy is applying all its "actions" to "google.com":
- Final results:
+ Final results:
-add-header -block +deanimate-gifs{last} -downgrade-http-version -fast-redirects
-filter{popups} -filter{fun} -filter{shockwave-flash} -filter{crude-parental}
+filter{html-annoyances} +filter{js-annoyances} +filter{content-cookies}
Now another example, "ad.doubleclick.net":
- { +block +handle-as-image }
+ { +block +handle-as-image }
.ad.doubleclick.net
{ +block +handle-as-image }
One last example. Let's try "http://www.rhapsodyk.net/adsl/HOWTO/". This one is
giving us problems. We are getting a blank page. Hmmm...
- Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
+ Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
{ -add-header -block +deanimate-gifs -downgrade-http-version +fast-redirects
+filter{html-annoyances} +filter{js-annoyances} +filter{kill-popups}
explicitly does not block ("{-block}") paths with "adsl". There are various
ways to handle such exceptions. Example:
- { -block }
+ { -block }
/adsl
Now the page displays ;-) Be sure to flush your browser's caches when making
But now what about a situation where we get no explicit matches like we did
with:
- { +block +handle-as-image }
+ { +block +handle-as-image }
/ads
That actually was very telling and pointed us quickly to where the problem was.
cause would be one of the "{+filter}" actions. Try adding the URL for the site
to one of aliases that turn off "+filter":
- {shop}
+ {shop}
.quietpc.com
.worldpay.com # for quietpc.com
.jungle.com
"{shop}" is an "alias" that expands to "{ -filter -session-cookies-only }". Or
you could do your own exception to negate filtering:
- {-filter}
+ {-filter}
.forbes.com
This would probably be most appropriately put in user.action, for local site