From: hal9 <hal9@users.sourceforge.net>
Date: Thu, 5 Sep 2002 05:45:30 +0000 (+0000)
Subject: Syncing with 3.0. This should be it for doc sources. Not all builds tested
X-Git-Tag: v_3_1_archive_branchpoint~182
X-Git-Url: http://www.privoxy.org/gitweb/@default-cgi@/faq/%22https:/static/gitweb.js?a=commitdiff_plain;h=2d07f84175fe3b83bf3d5ba79058768e0d0ec0a4;p=privoxy.git
Syncing with 3.0. This should be it for doc sources. Not all builds tested
yet. No new content, just catching up.
---
diff --git a/doc/source/announce.sgml b/doc/source/announce.sgml
index c3e31416..4d262c91 100644
--- a/doc/source/announce.sgml
+++ b/doc/source/announce.sgml
@@ -19,7 +19,7 @@
Purpose : Announcement text
- $Id: announce.sgml,v 1.3 2002/06/05 00:31:55 hal9 Exp $
+ $Id: announce.sgml,v 1.1.2.2 2002/08/30 02:52:11 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -38,7 +38,7 @@
press release packages can contain both formats for those that might
prefer HTML ready announce text.
- This will probably require some hand editing before and after processing.
+ This may require a small bit of hand editing before processing.
The intention is to minimize this as much as possible.
To create: make announce
@@ -58,9 +58,15 @@
<para>
Announcing <application>Privoxy</application>
- v.&p-version;<![%p-not-stable;[-&p-status;]]>, and release candidate for
- v3.0 stable.
+ v.&p-version;<![%p-not-stable;[-&p-status;, and release candidate for
+ v3.0 stable]]>.
</para>
+<para>
+ <![%p-stable;[
+ This is the first stable release of Privoxy.
+ ]]>
+</para>
+
<!-- Include privoxy.sgml boilerplate: -->
&p-intro;
@@ -91,7 +97,7 @@
<para>
<literallayout>Download location:
- <ulink url="http://sourceforge.net/projects/ijbswa/">http://sourceforge.net/projects/ijbswa/</ulink>
+ <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">http://sourceforge.net/project/showfiles.php?group_id=11118</ulink>
</literallayout>
</para>
@@ -102,6 +108,6 @@
</para>
-<epigraph><attribution>Privoxy Developers</attribution><para></para></epigraph>
+<epigraph><attribution>Privoxy Developers <email>developers@privoxy.org</email></attribution><para></para></epigraph>
</article>
diff --git a/doc/source/authors.sgml b/doc/source/authors.sgml
index c6f3e6bf..d9df2320 100644
--- a/doc/source/authors.sgml
+++ b/doc/source/authors.sgml
@@ -3,7 +3,7 @@
Purpose : AUTHORS file for Privoxy
- $Id: authors.sgml,v 1.9 2002/06/05 00:31:55 hal9 Exp $
+ $Id: authors.sgml,v 1.8 2002/05/10 01:48:19 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
diff --git a/doc/source/buildsource.sgml b/doc/source/buildsource.sgml
index a4620b48..957d54b5 100644
--- a/doc/source/buildsource.sgml
+++ b/doc/source/buildsource.sgml
@@ -3,7 +3,7 @@
Purpose : Entity included in other project documents.
- $Id: buildsource.sgml,v 1.9 2002/05/10 01:48:19 hal9 Exp $
+ $Id: buildsource.sgml,v 1.9.2.1 2002/08/25 17:10:55 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -19,6 +19,7 @@
user-manual
README
+ INSTALL
-->
@@ -80,6 +81,14 @@
</screen>
</para>
+<warning>
+ <para>
+ The <quote>make install</quote> target is temporary quite broken! It is
+ recommended to use a binary package, or do a source build, and manually
+ install the components. Sorry.
+ </para>
+</warning>
+
<para>
If you have gnu make, you can have the first four steps
automatically done for you by just typing:
diff --git a/doc/source/config.sgml b/doc/source/config.sgml
index 173ac124..28920ae8 100644
--- a/doc/source/config.sgml
+++ b/doc/source/config.sgml
@@ -8,11 +8,11 @@
<!entity % config-file "IGNORE">
]>
<!--
- File : $Source: /cvsroot/ijbswa/current/doc/source/config.sgml,v $
+ File : $Source: /cvsroot/ijbswa/current/doc/source/Attic/config.sgml,v $
Purpose : config file generation
- $Id: config.sgml,v 1.3 2002/06/05 00:31:55 hal9 Exp $
+ $Id: config.sgml,v 1.1.2.1 2002/05/29 02:01:02 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
diff --git a/doc/source/license.sgml b/doc/source/license.sgml
index cce4886e..35899588 100644
--- a/doc/source/license.sgml
+++ b/doc/source/license.sgml
@@ -3,7 +3,7 @@
Purpose : Entity included in other project documents.
- $Id: license.sgml,v 1.3 2002/06/03 00:28:17 hal9 Exp $
+ $Id: license.sgml,v 1.2 2002/05/10 01:48:20 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -21,6 +21,7 @@
user-manual
developer-manual
faq
+ webserver/index.sgml
-->
diff --git a/doc/source/newfeatures.sgml b/doc/source/newfeatures.sgml
index d8e95531..9f1c209d 100644
--- a/doc/source/newfeatures.sgml
+++ b/doc/source/newfeatures.sgml
@@ -3,7 +3,7 @@
Purpose : Entity included in other project documents.
- $Id: newfeatures.sgml,v 1.11 2002/06/03 00:28:17 hal9 Exp $
+ $Id: newfeatures.sgml,v 1.10 2002/05/15 03:54:29 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -19,7 +19,6 @@
user-manual
faq
- announce.sgml
-->
<para>
diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index e1313b2e..e626a6f1 100644
--- a/doc/source/p-config.sgml
+++ b/doc/source/p-config.sgml
@@ -3,7 +3,7 @@
Purpose : Used with other docs and files only.
- $Id: p-config.sgml,v 1.2 2002/06/03 00:28:17 hal9 Exp $
+ $Id: p-config.sgml,v 1.1.2.8 2002/08/22 23:15:21 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -95,10 +95,10 @@
Sample Configuration File for Privoxy v&p-version;
</title>
<para>
-Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org
+ $Id: p-config.sgml,v 1.1.2.8 2002/08/22 23:15:21 hal9 Exp $
</para>
<para>
-$Id: p-config.sgml,v 1.2 2002/06/03 00:28:17 hal9 Exp $
+Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org
</para>
<para>
@@ -928,6 +928,7 @@ actionsfile
debug 256 # debug GIF de-animation
debug 512 # Common Log Format
debug 1024 # debug kill pop-ups
+ debug 2048 # CGI user interface
debug 4096 # Startup banner and warnings.
debug 8192 # Non-fatal errors
</programlisting>
@@ -958,7 +959,7 @@ actionsfile
<![%config-file;[<literallayout>@@debug 1 # show each GET/POST/CONNECT request</literallayout>]]>
<![%config-file;[<literallayout>@@debug 4096 # Startup banner and warnings</literallayout>]]>
-<![%config-file;[<literallayout>@@debug 8192 # Errors - *we highly recommended enabling this</literallayout>]]>
+<![%config-file;[<literallayout>@@debug 8192 # Errors - *we highly recommended enabling this*</literallayout>]]>
</sect3>
@@ -1507,17 +1508,17 @@ ACLs: permit-access and deny-access</title>
<term>Type of value:</term>
<listitem>
<para>
- <replaceable class="parameter">target_domain</replaceable>[:<replaceable class="parameter">port</replaceable>]
- <replaceable class="parameter">http_parent</replaceable>[/<replaceable class="parameter">port</replaceable>]
+ <replaceable class="parameter">target_pattern</replaceable>
+ <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
</para>
<para>
- Where <replaceable class="parameter">target_domain</replaceable> is a domain name pattern (see the
- chapter on domain matching in the <filename>default.action</filename> file),
- <replaceable class="parameter">http_parent</replaceable> is the address of the parent HTTP proxy
- as an IP addresses in dotted decimal notation or as a valid DNS name (or <quote>.</quote> to denote
- <quote>no forwarding</quote>, and the optional
- <replaceable class="parameter">port</replaceable> parameters are TCP ports, i.e. integer
- values from 1 to 64535
+ where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
+ that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
+ denote <quote>all URLs</quote>.
+ <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
+ is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
+ optionally followed by its listening port (default: 8080).
+ Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
</para>
</listitem>
</varlistentry>
@@ -1555,7 +1556,7 @@ ACLs: permit-access and deny-access</title>
</para>
<para>
<screen>
- forward .* anon-proxy.example.org:8080
+ forward / anon-proxy.example.org:8080
forward :443 .
</screen>
</para>
@@ -1565,7 +1566,7 @@ ACLs: permit-access and deny-access</title>
</para>
<para>
<screen>
- forward .*. caching-proxy.example-isp.net:8000
+ forward / caching-proxy.example-isp.net:8000
forward .example-isp.net .
</screen>
</para>
@@ -1594,13 +1595,14 @@ forward-socks4 and forward-socks4a</title>
<term>Type of value:</term>
<listitem>
<para>
- <replaceable class="parameter">target_domain</replaceable>[:<replaceable class="parameter">port</replaceable>]
- <replaceable class="parameter">socks_proxy</replaceable>[/<replaceable class="parameter">port</replaceable>]
- <replaceable class="parameter">http_parent</replaceable>[/<replaceable class="parameter">port</replaceable>]
+ <replaceable class="parameter">target_pattern</replaceable>
+ <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
+ <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
</para>
<para>
- Where <replaceable class="parameter">target_domain</replaceable> is a domain name pattern (see the
- chapter on domain matching in the <filename>default.action</filename> file),
+ where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
+ that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
+ denote <quote>all URLs</quote>.
<replaceable class="parameter">http_parent</replaceable> and <replaceable class="parameter">socks_proxy</replaceable>
are IP addresses in dotted decimal notation or valid DNS names (<replaceable class="parameter">http_parent</replaceable>
may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
@@ -1651,7 +1653,7 @@ forward-socks4 and forward-socks4a</title>
</para>
<para>
<screen>
- forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080
+ forward-socks4a / socks-gw.example.com:1080 www-cache.example-isp.net:8080
forward .example.com .
</screen>
</para>
@@ -1660,7 +1662,7 @@ forward-socks4 and forward-socks4a</title>
</para>
<para>
<screen>
- forward-socks4 .*. socks-gw.example.com:1080 .
+ forward-socks4 / socks-gw.example.com:1080 .
</screen>
</para>
</listitem>
@@ -1691,7 +1693,7 @@ forward-socks4 and forward-socks4a</title>
<para>
<screen>
- forward .*. .
+ forward / .
forward .isp-b.net host-b:8118
</screen>
</para>
@@ -1702,7 +1704,7 @@ forward-socks4 and forward-socks4a</title>
<para>
<screen>
- forward .*. .
+ forward / .
forward .isp-a.net host-a:8118
</screen>
</para>
@@ -1744,6 +1746,17 @@ forward-socks4 and forward-socks4a</title>
Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
</para>
+<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:
+</para>
+
+<para>
+ <screen>
+ forward / .
+ forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
+</para>
+
</sect3>
]]>
@@ -1978,14 +1991,15 @@ forward-socks4 and forward-socks4a</title>
<!-- end config content common to both outputs -->
<![%config-file;[
-<!-- These are dummy anchors to keep the processor quiet -->
-<!-- Needed for config-file only -->
+<!-- These are dummy anchors to keep the processor quiet -->
+<!-- when building config-file only (ie. they are used in u-m only) -->
<sect1 label="">
<title></title>
<anchor id="filter">
<anchor id="filter-file">
<anchor id="regex">
<anchor id="actions-file">
+<anchor id="af-patterns">
</sect1>
]]>
diff --git a/doc/source/privoxy-man-page.sgml b/doc/source/privoxy-man-page.sgml
index 800759c9..6f509cfb 100644
--- a/doc/source/privoxy-man-page.sgml
+++ b/doc/source/privoxy-man-page.sgml
@@ -5,7 +5,7 @@
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: privoxy-man-page.sgml,v 2.1 2002/07/29 22:08:41 jongfoster Exp $
+ $Id: privoxy-man-page.sgml,v 1.13.2.4 2002/08/26 16:26:58 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -79,13 +79,13 @@
<arg><option>--pidfile </option><replaceable class="parameter">pidfile</replaceable></arg>
<arg><option>--user </option><replaceable class="parameter">user[.group]</replaceable></arg>
<arg><replaceable class="parameter">configfile</replaceable></arg>
- <command>(UNIX)</command>
+ <command> (UNIX)</command>
</cmdsynopsis>
<cmdsynopsis>
<command>privoxy.exe</command>
<arg><replaceable class="parameter">configfile</replaceable></arg>
- <command>(Windows)</command>
+ <command> (Windows)</command>
</cmdsynopsis>
</refsynopsisdiv>
@@ -196,6 +196,7 @@
https: URLs will not be proxied. Note: <command>Privoxy</command> can only
proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
</para>
+
<para>
For other browsers, check the documentation.
</para>
@@ -385,12 +386,9 @@
<refsect1><title>Notes</title>
<![%p-not-stable;[
<para>
- This is a &p-status; version of <command>Privoxy</command>. Buyer beware! Do
- not use in production situations.]]>
-<![%p-beta;[ Not all features are well tested. </para>]]>
-<![%p-alpha;[ Various features may be partially implemented, and
-other stages of brokenness may well exist. Documentation may also be out of
-sync with current code.</para>]]>
+ This is a &p-status; version of <command>Privoxy</command>. Not
+ all features are well tested.
+</para>]]>
<para>
Please see the <citetitle>User Manual</citetitle> on how to contact the
developers for feature requests, reporting problems, and other questions.
diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml
index 2882344e..7af842f3 100644
--- a/doc/source/readme.sgml
+++ b/doc/source/readme.sgml
@@ -19,14 +19,16 @@
Purpose : README for Privoxy
- $Id: readme.sgml,v 1.19 2002/07/25 21:51:25 hal9 Exp $
+ $Id: readme.sgml,v 1.16.2.4 2002/08/25 17:12:20 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
========================================================================
NOTE: Please read developer-manual/documentation.html before touching
- anything in this, or other Privoxy documentation.
+ anything in this, or other Privoxy documentation. You have been warned!
+ Failure to abide by this rule will result in the revocation of your license
+ to live a peaceful existence!
========================================================================
===================================================================
@@ -45,6 +47,18 @@
to avoid extra blank lines, etc.
======================================================================
+ For stable releases, change
+
+ entity % p-not-stable "INCLUDE"
+
+ to
+
+ entity % p-not-stable "IGNORE"
+
+ in the DTD at the top. This will toggle various text 'off'. BOTH
+ MUST be toggled in this case or you will get both text referencing
+ stable and unstable versions. You only want one or the other!
+
-->
<article id="index">
<artheader>
@@ -102,13 +116,10 @@
<para>
<!-- include some conditional text -->
This README is included with <![%p-not-stable;[ the development version of]]>
- Privoxy &p-version;<![%p-not-stable;[, which will eventually become Privoxy v3.2]]><![%p-beta;[ (and soon we hope!)]]>.
- See http://www.privoxy.org/ for more information. The current code
- level is &p-status;<![%p-beta;[, but seems stable to us :)]]><![%p-alpha;[,
- and may break in mysterious ways :) There may be features only partially
- implemented, or worse, not functional. If you are interested in participating
- in Privoxy development, please see the Links at the bottom of this page]]>.
- </para>
+ Privoxy &p-version;<![%p-not-stable;[, which will eventually become Privoxy v3.0 (and soon we
+ hope!)]]>. See http://www.privoxy.org/ for more information. The current code
+ level is &p-status;<![%p-not-stable;[, and seems stable to us :)]]>.
+</para>
</abstract>
</artheader>
@@ -118,6 +129,11 @@
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="importantchanges" ><title>IMPORTANT CHANGES</title>
+<para>
+ REALLY BIG NEWS! August 2002: The long-awaited, oft-delayed stable version
+ of Privoxy 3.0 is finally released! This is way behind schedule, but better
+ late than never. The developers all hope the wait was worth it.
+</para>
<para>
NEWS! As of 03/24/02, the name of this project has been changed from
ijbswa/Junkbuster to Privoxy. This is reflected in many of the included
@@ -202,21 +218,23 @@
<sect1 id="documentation"><title>DOCUMENTATION</title>
<para>
There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
- may not be in sync with current code]]>. In particular, see the User Manual there,
+ is not completed at this point]]>. In particular, see the User Manual there,
the FAQ, and those interested in Privoxy development, should look at
developer-manual.
</para>
<para>
<![%p-not-stable;[
The most up to date source of information on the current development version,
- may be either comments in the source code, or the included
+ may still be either comments in the source code, or the included
configuration files. ]]>The source and configuration files are all well
commented. The main configuration files are: 'config', 'default.action', and
'default.filter'<![%p-not-stable;[ in the toplevel source directory]]>.
</para>
<para>
- Included documentation may vary according to platform and packager.
+ Included documentation may vary according to platform and packager. All
+ documentation is posted on http://www.privoxy.org, in case you don't have it,
+ or can't find it.
</para>
</sect1>
@@ -234,7 +252,7 @@
<!-- </LiteralLayout> -->
<!-- </para> -->
<!-- <para> -->
-<!-- $Id: readme.sgml,v 1.19 2002/07/25 21:51:25 hal9 Exp $ -->
+<!-- $Id: readme.sgml,v 1.16.2.4 2002/08/25 17:12:20 hal9 Exp $ -->
<!-- </para> -->
</article>
diff --git a/doc/source/supported.sgml b/doc/source/supported.sgml
index 947177d4..81dcc9fb 100644
--- a/doc/source/supported.sgml
+++ b/doc/source/supported.sgml
@@ -25,8 +25,8 @@
-->
<para>
At present, <application>Privoxy</application> is known to run on
- Windows(95, 98, ME, 2000, XP), Linux (RedHat, SuSE, Debian, Conectiva, Gentoo),
- Mac OSX, OS/2, AmigaOS, BeOS, FreeBSD, NetBSD, Solaris, and many more
+ Windows(95, 98, ME, 2000, XP), Linux (RedHat, SuSE, Debian, Conectiva, Gentoo,
+ Slackware), Mac OSX, OS/2, AmigaOS, BeOS, FreeBSD, NetBSD, Solaris, and more
flavors of Unix.
</para>
diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index 91b0b627..3ba2f006 100644
--- a/doc/source/user-manual.sgml
+++ b/doc/source/user-manual.sgml
@@ -32,7 +32,7 @@
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.128 2002/07/25 21:51:24 hal9 Exp $
+ $Id: user-manual.sgml,v 1.123.2.18 2002/08/22 23:47:58 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -47,18 +47,18 @@
<article id="index">
<artheader>
-<title>Privoxy User Manual</title>
+<title>Privoxy &p-version; User Manual</title>
<pubdate>
<subscript>
<!-- Completely the wrong markup, but very little is allowed -->
<!-- in this part of an article. FIXME -->
<link linkend="copyright">Copyright</link> &my-copy; 2001, 2002 by
- <ulink url="http://www.privoxy.org">Privoxy Developers</ulink>
+ <ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
</subscript>
</pubdate>
-<pubdate>$Id: user-manual.sgml,v 1.128 2002/07/25 21:51:24 hal9 Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.123.2.18 2002/08/22 23:47:58 hal9 Exp $</pubdate>
<!--
@@ -109,7 +109,7 @@ Hal.
<para>
You can find the latest version of the <citetitle>User Manual</citetitle> at <ulink
url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink>.
- Please see the <ulink url="contact.html">Contact section</ulink> on how to
+ Please see the <link linkend="contact">Contact section</link> on how to
contact the developers.
</para>
@@ -277,17 +277,32 @@ automatically start Privoxy in the boot process.
</sect3>
<!-- ~~~~~ New section ~~~~~ -->
-<sect3 id="installation-mac"><title>Max OSX</title>
-<para>
- Unzip the downloaded package (you can either double-click on the file
- in the finder, or on the desktop if you downloaded it there). Then,
- double-click on the package installer icon and follow the installation
- process.
- <application>Privoxy</application> will be installed in the subdirectory
- <literal>/Applications/Privoxy.app</literal>.
- <application>Privoxy</application> will set itself up to start
- automatically on system bring-up via
- <literal>/System/Library/StartupItems/Privoxy</literal>.
+<sect3 id="installation-mac"><title>Mac OSX</title>
+<para>
+ Unzip the downloaded file (you can either double-click on the file
+ from the finder, or from the desktop if you downloaded it there).
+ Then, double-click on the package installer icon named
+ <literal>Privoxy.pkg</literal>
+ and follow the installation process.
+ <application>Privoxy</application> will be installed in the folder
+ <literal>/Library/Privoxy</literal>.
+ It will start automatically whenever you start up. To prevent it from
+ starting automatically, remove or rename the folder
+ <literal>/Library/StartupItems/Privoxy</literal>.
+</para>
+<para>
+ To start Privoxy by hand, double-click on
+ <literal>StartPrivoxy.command</literal> in the
+ <literal>/Library/Privoxy</literal> folder.
+ Or, type this command in the Terminal:
+</para>
+<para>
+ <screen>
+ /Library/Privoxy/StartPrivoxy.command
+ </screen>
+</para>
+<para>
+ You will be prompted for the administrator password.
</para>
</sect3>
@@ -300,6 +315,28 @@ automatically start Privoxy in the boot process.
remove this directory.
</para>
</sect3>
+
+<!-- ~~~~~ New section ~~~~~ -->
+<sect3 id="installattion-gentoo"><title>Gentoo</title>
+<para>
+ Gentoo source packages (Ebuilds) for <application>Privoxy</application> are
+ contained in the Gentoo Portage Tree (they are not on the download page,
+ but there is a Gentoo section, where you can see when a new
+ <application>Privoxy</application> Version is added to the Portage Tree).
+</para>
+<para>
+ Before installing <application>Privoxy</application> under Gentoo just do
+ first <literal>emerge rsync</literal> to get the latest changes from the
+ Portage tree. With <literal>emerge privoxy</literal> you install the latest
+ version.
+</para>
+<para>
+ Configuration files are in <filename>/etc/privoxy</filename>, the
+ documentation is in <filename>/usr/share/doc/privoxy-&p-version;</filename>
+ and the Log directory is in <filename>/var/log/privoxy</filename>.
+</para>
+</sect3>
+
</sect2>
<!-- ~~~~~ New section ~~~~~ -->
@@ -325,6 +362,33 @@ automatically start Privoxy in the boot process.
<!-- end boilerplate -->
</sect2>
+<!-- ~~~~~ New section ~~~~~ -->
+<sect2 id="installation-keepupdated"><title>Keeping your Installation Up-to-Date</title>
+<para>
+ As user feedback comes in and development continues, we will make updated versions
+ of both the main <link linkend="actions-file">actions file</link> (as a <ulink
+ url="http://sourceforge.net/project/showfiles.php?group_id=11118&release_id=103670">separate
+ package</ulink>) and the software itself (including the actions file) available for
+ download.
+</para>
+
+<para>
+ If you wish to receive an email notification whenever we release updates of
+ <application>Privoxy</application> or the actions file, <ulink
+ url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce/">subscribe
+ to our announce mailing list</ulink>, ijbswa-announce@lists.sourceforge.net.
+</para>
+
+<para>
+ In order not to loose your personal changes and adjustments when updating
+ to the latest <literal>default.action</literal> file we <emphasis>strongly
+ recommend</emphasis> that you use <literal>user.action</literal> for your
+ customization of <application>Privoxy</application>. See the <link
+ linkend="actions-file">Chapter on actions files</link> for details.
+</para>
+
+</sect2>
+
</sect1>
@@ -928,16 +992,21 @@ Example Unix startup command:
</sect2>
<sect2 id="start-macosx">
-<title>MAX OSX</title>
+<title>Mac OSX</title>
<para>
During installation, <application>Privoxy</application> is configured to
- start automatically when the system restarts. You can start it manually
- through the Terminal with these commands:
+ start automatically when the system restarts. To start Privoxy by hand,
+ double-click on the <literal>StartPrivoxy.command</literal> icon in the
+ <literal>/Library/Privoxy</literal> folder. Or, type this command
+ in the Terminal:
</para>
<para>
<screen>
- cd /Applications/Privoxy.app
- ./privoxy</screen>
+ /Library/Privoxy/StartPrivoxy.command
+ </screen>
+</para>
+<para>
+ You will be prompted for the administrator password.
</para>
</sect2>
@@ -955,6 +1024,29 @@ Example Unix startup command:
</para>
</sect2>
+<sect2 id="start-gentoo">
+<title>Gentoo</title>
+<para>
+ A script is again used. It will use the file <filename>/etc/privoxy/config
+ </filename> as its main configuration file.
+</para>
+<para>
+ <screen>
+ /etc/init.d/privoxy start
+ </screen>
+</para>
+<para>
+ Note that <application>Privoxy</application> is not automatically started at
+ boot time by default. You can change this with the <literal>rc-update</literal>
+ command.
+</para>
+<para>
+ <screen>
+ rc-update add privoxy default
+ </screen>
+</para>
+</sect2>
+
<!--
<para>
@@ -1040,17 +1132,17 @@ must find a better place for this paragraph
</para>
<para>
- If the above paragraph sounds gibberish to you, you might want to <ulink
- url="actions-file.html#ACTIONSFILE">read more about the actions concept</ulink>
- or even dive deep into the <ulink url="appendix.html#ACTIONSANAT">Appendix
- on actions</ulink>.
+ If the above paragraph sounds gibberish to you, you might want to <link
+ linkend="actions-file">read more about the actions concept</link>
+ or even dive deep into the <link linkend="actionsanat">Appendix
+ on actions</link>.
</para>
<para>
If you can't get rid of the problem at all, think you've found a bug in
Privoxy, want to propose a new feature or smarter rules, please see the
- section <ulink url="contact.html"><quote>Contacting the
- Developers</quote></ulink> below.
+ section <link linkend="contact"><quote>Contacting the
+ Developers</quote></link> below.
</para>
-->
@@ -1182,6 +1274,9 @@ must find a better place for this paragraph
<member>
▪ <ulink url="http://config.privoxy.org/toggle">Toggle Privoxy on or off</ulink>
</member>
+ <member>
+ ▪ <ulink url="http://www.privoxy.org/&p-version;/user-manual/">Documentation</ulink>
+ </member>
</simplelist>
</msgtext>
</screen>
@@ -1362,8 +1457,8 @@ must find a better place for this paragraph
provide a base level of functionality for
<application>Privoxy's</application> array of features. So it is
a set of broad rules that should work reasonably well for users everywhere.
- This is the file that the developers are keeping updated, and making
- available to users.
+ This is the file that the developers are keeping updated, and <link
+ linkend="installation-keepupdated">making available to users</link>.
</para>
</listitem>
<listitem>
@@ -1481,9 +1576,9 @@ must find a better place for this paragraph
the same URL set the same action differently, the last match wins. If not,
the effects are aggregated. E.g. a URL might match a regular section with
a heading line of <literal>{
- +<ulink url="actions-file.html#HANDLE-AS-IMAGE">handle-as-image</ulink> }</literal>,
+ +<link linkend="handle-as-image">handle-as-image</link> }</literal>,
then later another one with just <literal>{
- +<ulink url="actions-file.html#BLOCK">block</ulink> }</literal>, resulting
+ +<link linkend="block">block</link> }</literal>, resulting
in <emphasis>both</emphasis> actions to apply.
</para>
@@ -2335,8 +2430,9 @@ problem-host.example.com</screen>
<term>Effect:</term>
<listitem>
<para>
- Text documents, including HTML and JavaScript, to which this action applies, are filtered on-the-fly
- through the specified regular expression based substitutions.
+ Text documents, including HTML and JavaScript, to which this action
+ applies, are filtered on-the-fly through the specified regular expression
+ based substitutions.
</para>
</listitem>
</varlistentry>
@@ -2426,6 +2522,14 @@ problem-host.example.com</screen>
<anchor id="filter-banners-by-size">
<screen>+filter{banners-by-size} # Kill banners based on their size for this page (<emphasis>very</emphasis> efficient!)</screen>
</para>
+ <para>
+ <anchor id="filter-banners-by-link">
+ <screen>+filter{banners-by-link} # Kill banners based on the link they are contained in (experimental)</screen>
+ </para>
+ <para>
+ <anchor id="filter-img-reorder">
+ <screen>+filter{img-reorder} # Reorder attributes in <img> tags to make the banners-by-* filters more effective</screen>
+ </para>
<para>
<anchor id="filter-content-cookies">
<screen>+filter{content-cookies} # Kill cookies that come sneaking in the HTML or JS content</screen>
@@ -2462,6 +2566,10 @@ problem-host.example.com</screen>
<anchor id="filter-crude-parental">
<screen>+filter{crude-parental} # Kill all web pages that contain the words "sex" or "warez"</screen>
</para>
+ <para>
+ <anchor id="filter-js-events">
+ <screen>+filter{js-events} # Kill all JS event bindings (<emphasis>Radically destructive!</emphasis> Only for extra nasty sites) </screen>
+ </para>
</listitem>
</varlistentry>
</variablelist>
@@ -3687,8 +3795,11 @@ shop = mercy-for-cookies -filter{popups} -kill-popups</screen>
-<link linkend="FILTER-FUN">filter{fun}</link> \
+<link linkend="FILTER-NIMDA">filter{nimda}</link> \
+<link linkend="FILTER-BANNERS-BY-SIZE">filter{banners-by-size}</link> \
+ -<link linkend="FILTER-BANNERS-BY-LINK">filter{banners-by-link}</link> \
+ -<link linkend="FILTER-IMG-REORDER">filter{img-reorder}</link> \
-<link linkend="FILTER-SHOCKWAVE-FLASH">filter{shockwave-flash}</link> \
-<link linkend="FILTER-CRUDE-PARENTAL">filter{crude-parental}</link> \
+ -<link linkend="FILTER-JS-EVENTS">filter{js-events}</link> \
-<link linkend="HANDLE-AS-IMAGE">handle-as-image</link> \
+<link linkend="HIDE-FORWARDED-FOR-HEADERS">hide-forwarded-for-headers</link> \
+<link linkend="HIDE-FROM-HEADER">hide-from-header{block}</link> \
@@ -4353,7 +4464,7 @@ s|(<script.*)document\.referrer(.*</script>)|$1"Not Your Business!"$2|U
<screen>
# The status bar is for displaying link targets, not pointless blahblah
#
-s/window\.status\s*=\s*['"].*?['"]/dUmMy=1/ig</screen>
+s/window\.status\s*=\s*(['"]).*?\1/dUmMy=1/ig</screen>
</para>
<para>
@@ -4362,7 +4473,10 @@ s/window\.status\s*=\s*['"].*?['"]/dUmMy=1/ig</screen>
or more whitespace</quote>. The <literal>?</literal> in <literal>.*?</literal>
makes this matching of arbitrary text ungreedy. (Note that the <literal>U</literal>
option is not set). The <literal>['"]</literal> construct means: <quote>a single
- <emphasis>or</emphasis> a double quote</quote>.
+ <emphasis>or</emphasis> a double quote</quote>. Finally, <literal>\1</literal> is
+ a backreference to the first parenthesis just like <literal>$1</literal> above,
+ with the difference that in the <emphasis>pattern</emphasis>, a backslash indicates
+ a backreference, whereas in the <emphasis>substitute</emphasis>, it's the dollar.
</para>
<para>
@@ -4378,7 +4492,7 @@ s/window\.status\s*=\s*['"].*?['"]/dUmMy=1/ig</screen>
<screen>
# Kill OnUnload popups. Yummy. Test: http://www.zdnet.com/zdsubs/yahoo/tree/yfs.html
#
-s/(<body .*)onunload(.*>)/$1never$2/iU</screen>
+s/(<body [^>]*)onunload(.*>)/$1never$2/iU</screen>
</para>
<para>
@@ -4389,7 +4503,11 @@ s/(<body .*)onunload(.*>)/$1never$2/iU</screen>
This job replaces the <quote>onunload</quote> attribute in
<quote><body></quote> tags with the dummy word <literal>never</literal>.
Note that the <literal>i</literal> option makes the pattern matching
- case-insensitive.
+ case-insensitive. Also note that ungreedy matching alone doesn't always guarantee
+ a minimal match: In the first parenthesis, we had to use <literal>[^>]*</literal>
+ instead of <literal>.*</literal> to prevent the match from exceeding the
+ <body> tag if it doesn't contain <quote>OnUnload</quote>, but the page's
+ content does.
</para>
<para>
@@ -4419,6 +4537,8 @@ s/microsoft(?!\.com)/MicroSuck/ig</screen>
#
s* industry[ -]leading \
| cutting[ -]edge \
+| customer[ -]focused \
+| market[ -]driven \
| award[ -]winning # Comments are OK, too! \
| high[ -]performance \
| solutions[ -]based \
@@ -4431,7 +4551,7 @@ s* industry[ -]leading \
<para>
The <literal>x</literal> option in this job turns on extended syntax, and allows for
- e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting.
+ e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting.
</para>
<para>
@@ -5005,7 +5125,7 @@ Requests</title>
<para>
Credit: The site which gave us the general idea for these bookmarklets is
- <ulink url="http://www.bookmarklets.com">www.bookmarklets.com</ulink>. They
+ <ulink url="http://www.bookmarklets.com/">www.bookmarklets.com</ulink>. They
have more information about bookmarklets.
</para>
@@ -5085,7 +5205,7 @@ Requests</title>
<para>
First, the server headers are read and processed to determine, among other
things, the MIME type (document type) and encoding. The headers are then
- filtered as deterimined by the
+ filtered as determined by the
<link linkend="CRUNCH-INCOMING-COOKIES"><quote>+crunch-incoming-cookies</quote></link>,
<link linkend="SESSION-COOKIES-ONLY"><quote>+session-cookies-only</quote></link>,
and <link linkend="DOWNGRADE-HTTP-VERSION"><quote>+downgrade-http-version</quote></link>
@@ -5159,7 +5279,7 @@ Requests</title>
One quick test to see if <application>Privoxy</application> is causing a problem
or not, is to disable it temporarily. This should be the first troubleshooting
step. See <link linkend="bookmarklets">the Bookmarklets</link> section on a quick
- and easy way to do this (be sure to flush caches afterward!). Looking at the
+ and easy way to do this (be sure to flush caches afterward!). Looking at the
logs is a good idea too.
</para>
@@ -5456,7 +5576,7 @@ In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibut
was. If you don't get this kind of match, then it means one of the default
rules in the first section is causing the problem. This would require some
guesswork, and maybe a little trial and error to isolate the offending rule.
- One likely cause would be one of the <quote>{+filter}</quote> actions. These
+ One likely cause would be one of the <quote>{+filter}</quote> actions. These
tend to be harder to troubleshoot. Try adding the URL for the site to one of
aliases that turn off <quote>+filter</quote>:
</para>
@@ -5533,19 +5653,49 @@ In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibut
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
- Revision 1.128 2002/07/25 21:51:24 hal9
- Warnings on non-HTTP traffic.
+ Revision 1.123.2.18 2002/08/22 23:47:58 hal9
+ Add 'Documentation' to Privoxy Menu shot in Configuration section to match
+ CGIs.
+
+ Revision 1.123.2.17 2002/08/18 01:13:05 hal9
+ Spell checked (only one typo this time!).
+
+ Revision 1.123.2.16 2002/08/09 19:20:54 david__schmidt
+ Update to Mac OSX startup script name
+
+ Revision 1.123.2.15 2002/08/07 17:32:11 oes
+ Converted some internal links from ulink to link for PDF creation; no content changed
+
+ Revision 1.123.2.14 2002/08/06 09:16:13 oes
+ Nits re: actions file download
+
+ Revision 1.123.2.13 2002/08/02 18:23:19 g_sauthoff
+ Just 2 small corrections to the Gentoo sections
+
+ Revision 1.123.2.12 2002/08/02 18:17:21 g_sauthoff
+ Added 2 Gentoo sections
+
+ Revision 1.123.2.11 2002/07/26 15:20:31 oes
+ - Added version info to title
+ - Added info on new filters
+ - Revised parts of the filter file tutorial
+ - Added info on where to get updated actions files
+
+ Revision 1.123.2.10 2002/07/25 21:42:29 hal9
+ Add brief notes on not proxying non-HTTP protocols.
+
+ Revision 1.123.2.9 2002/07/11 03:40:28 david__schmidt
+
+ Updated Mac OSX sections due to installation location change
- Revision 1.127 2002/06/09 16:37:31 hal9
- Sync with filtering clarifications in 3.0 branch.
+ Revision 1.123.2.8 2002/06/09 16:36:32 hal9
+ Clarifications on filtering and MIME. Hardcode 'latest release' in index.html.
- Revision 1.126 2002/06/05 00:31:55 hal9
- Mass commit for new entities, most significantly so docs can read version
- and code status info from tmp files, so perl is no longer used. Also, docs can
- differentiate on alpha -> beta -> stable now.
+ Revision 1.123.2.7 2002/06/09 00:29:34 hal9
+ Touch ups on filtering, in actions section and Anatomy.
- Revision 1.125 2002/06/03 00:28:17 hal9
- Sync with various changes from 3.0 branch. Add two new files for config stuff.
+ Revision 1.123.2.6 2002/06/06 23:11:03 hal9
+ Fix broken link. Linkchecked all docs.
Revision 1.123.2.5 2002/05/29 02:01:02 hal9
This is break out of the entire config section from u-m, so it can