From: jongfoster <jongfoster@users.sourceforge.net>
Date: Mon, 29 Jul 2002 22:08:48 +0000 (+0000)
Subject: Doh! reversing my previous commit.
X-Git-Tag: v_3_1_archive_branchpoint~218
X-Git-Url: http://www.privoxy.org/gitweb/@default-cgi@/faq/%22https:/%22javascript:back()/@default-cgi@edit-actions-remove-url?a=commitdiff_plain;h=e70110618027c7cb90164df41ae9b5fefb6ef5ac;p=privoxy.git
Doh! reversing my previous commit.
---
diff --git a/doc/source/announce.sgml b/doc/source/announce.sgml
index a861baa9..c3e31416 100644
--- a/doc/source/announce.sgml
+++ b/doc/source/announce.sgml
@@ -5,9 +5,9 @@
<!entity contacting SYSTEM "../contacting.sgml">
<!entity history SYSTEM "../history.sgml">
<!entity newfeatures SYSTEM "../newfeatures.sgml">
-<!entity p-version "2.9.15">
-<!entity p-status "beta">
-<!entity % p-not-stable "INCLUDE">
+<!entity p-version SYSTEM "doc_version.tmp">
+<!entity p-status SYSTEM "doc_status.tmp">
+<!entity % p-not-stable "IGNORE">
<!entity % p-stable "IGNORE">
<!entity % p-supp-userman "IGNORE">
<!entity % p-text "INCLUDE"> <!-- define we are a text only doc -->
@@ -19,7 +19,7 @@
Purpose : Announcement text
- $Id: announce.sgml,v 1.1.2.1 2002/05/27 22:03:51 hal9 Exp $
+ $Id: announce.sgml,v 1.3 2002/06/05 00:31:55 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 may require a small bit of hand editing before processing.
+ This will probably require some hand editing before and after processing.
The intention is to minimize this as much as possible.
To create: make announce
diff --git a/doc/source/authors.sgml b/doc/source/authors.sgml
index c2a1ba39..c6f3e6bf 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.8 2002/05/10 01:48:19 hal9 Exp $
+ $Id: authors.sgml,v 1.9 2002/06/05 00:31:55 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
@@ -26,9 +26,9 @@
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!entity % dummy "IGNORE">
<!entity authors SYSTEM "p-authors.sgml">
-<!entity p-version "2.9.15">
-<!entity p-status "beta">
-<!entity % p-not-stable "INCLUDE">
+<!entity p-version SYSTEM "doc_version.tmp">
+<!entity p-status SYSTEM "doc_status.tmp">
+<!entity % p-not-stable "IGNORE">
<!entity % p-stable "IGNORE">
<!entity % p-text "INCLUDE"> <!-- define we are a text only doc -->
<!entity % p-authors-formal "INCLUDE"> <!-- include additional text, etc -->
diff --git a/doc/source/config.sgml b/doc/source/config.sgml
index 1b6de2dc..173ac124 100644
--- a/doc/source/config.sgml
+++ b/doc/source/config.sgml
@@ -1,9 +1,9 @@
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
<!entity % dummy "IGNORE">
<!entity config SYSTEM "p-config.sgml">
-<!entity p-version "2.9.15">
-<!entity p-status "beta">
-<!entity % p-not-stable "INCLUDE">
+<!entity p-version SYSTEM "doc_version.tmp">
+<!entity p-status SYSTEM "doc_status.tmp">
+<!entity % p-not-stable "IGNORE">
<!entity % user-man "IGNORE">
<!entity % config-file "IGNORE">
]>
@@ -12,7 +12,7 @@
Purpose : config file generation
- $Id: config.sgml,v 1.1.2.1 2002/05/29 02:01:02 hal9 Exp $
+ $Id: config.sgml,v 1.3 2002/06/05 00:31:55 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
diff --git a/doc/source/contacting.sgml b/doc/source/contacting.sgml
index 98bc8a9c..ff60f4b1 100644
--- a/doc/source/contacting.sgml
+++ b/doc/source/contacting.sgml
@@ -3,7 +3,7 @@
Purpose : Entity included in other project documents.
- $Id: contacting.sgml,v 1.15.2.2 2002/07/26 15:21:33 oes Exp $
+ $Id: contacting.sgml,v 1.16 2002/06/03 00:28:16 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -19,6 +19,7 @@
README
user-manual
webserver/index.sgml
+ privoxy-index.html
announce.sgml
-->
@@ -105,9 +106,7 @@
New, improved <filename>default.action</filename> files will occasionally be made
available based on your feedback. These will be announced on the <ulink
url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce">ijbswa-announce</ulink>
- list and available from our the <ulink
- url="http://sourceforge.net/project/showfiles.php?group_id=11118">files section</ulink> of
- our <ulink url="http://sf.net/projects/ijbswa/">project page</ulink>.
+ list and available from our <ulink url="http://sf.net/projects/ijbswa/">project page</ulink>.
</para>
</sect2>
diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml
index cb1aa08d..8b36ac43 100644
--- a/doc/source/developer-manual.sgml
+++ b/doc/source/developer-manual.sgml
@@ -8,9 +8,9 @@
<!entity contacting SYSTEM "contacting.sgml">
<!entity copyright SYSTEM "copyright.sgml">
<!entity license SYSTEM "license.sgml">
-<!entity p-version "2.9.15">
-<!entity p-status "beta">
-<!entity % p-not-stable "INCLUDE">
+<!entity p-version SYSTEM "doc_version.tmp">
+<!entity p-status SYSTEM "doc_status.tmp">
+<!entity % p-not-stable "IGNORE">
<!entity % p-stable "IGNORE">
<!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
<!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
@@ -23,16 +23,14 @@
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: developer-manual.sgml,v 1.46.2.4 2002/05/29 00:30:59 mal0rd Exp $
+ $Id: developer-manual.sgml,v 1.50 2002/06/05 00:31:55 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. You have been warned!
- Failure to abide by this rule will result in the revocation of your license
- to live a peaceful existence!
+ anything in this, or other Privoxy documentation.
========================================================================
-->
@@ -50,7 +48,7 @@
</pubdate>
- <pubdate>$Id: developer-manual.sgml,v 1.46.2.4 2002/05/29 00:30:59 mal0rd Exp $</pubdate>
+ <pubdate>$Id: developer-manual.sgml,v 1.50 2002/06/05 00:31:55 hal9 Exp $</pubdate>
<!--
@@ -69,7 +67,7 @@ Hal.
-->
- <abstract>
+<abstract>
<![%dummy;[
<para>
@@ -249,14 +247,29 @@ Hal.
<ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
course this, the <citetitle>developer-manual</citetitle> in this format.
The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>
- <citetitle>privoxy.1</citetitle> (man page) files are also now maintained
- as Docbook SGML. The finished files are all in the top-level source
- directory are generated files! Also, <filename>index.html</filename>, the
- <application>Privoxy</application> home page, is maintained as SGML.
+ <citetitle>privoxy.1</citetitle> (man page), and
+ <citetitle>config</citetitle> files are also now maintained as Docbook
+ SGML. These files, when built, in the top-level source directory are
+ generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
+ variation on this file, <filename>privoxy-index.html</filename>,
+ meant for inclusion with doc packages), are maintained as SGML as well.
<emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
contact someone involved in the documentation (at present Stefan and
Hal).
</para>
+ <para>
+ <filename>config</filename> requires some special handling. The reason it
+ is maintained this way is so that the extensive comments in the file
+ mirror those in <citetitle>user-manual</citetitle>. But the conversion
+ process requires going from SGML to HTML to text to special formatting
+ required for the embedded comments. Some of this does not survive so
+ well. Especially some of the examples that are longer than 80 characters.
+ The build process for this file outputs to <filename>config.new</filename>,
+ which should be reviewed for errors and mis-formatting. Once satisfied
+ that it is correct, then it should be hand copied to
+ <filename>config</filename>.
+
+ </para>
<para>
Other, less formal documents (e.g. <filename>LICENSE</filename>,
<filename>INSTALL</filename>) are maintained as plain text files in the
@@ -1727,7 +1740,7 @@ static void unload_re_filterfile( void *f ) { ... }</programlisting>
<para><emphasis>Example for file comments:</emphasis></para>
<programlisting>
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.46.2.4 2002/05/29 00:30:59 mal0rd Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.50 2002/06/05 00:31:55 hal9 Exp $";
/*********************************************************************
*
* File : $S<!-- Break CVS Substitution -->ource$
@@ -1787,7 +1800,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
<programlisting>
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.46.2.4 2002/05/29 00:30:59 mal0rd Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.50 2002/06/05 00:31:55 hal9 Exp $"
/*********************************************************************
*
* File : $S<!-- Break CVS Substitution -->ource$
@@ -2822,13 +2835,21 @@ at sourceforge. Three simple steps:
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: developer-manual.sgml,v $
- Revision 1.46.2.4 2002/05/29 00:30:59 mal0rd
+ Revision 1.50 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.49 2002/06/03 00:28:16 hal9
+ Sync with various changes from 3.0 branch. Add two new files for config stuff.
+
+ Revision 1.51 2002/05/29 00:30:59 mal0rd
Fixed a little formatting. Clarified debian section.
- Revision 1.46.2.3 2002/05/28 04:32:45 hal9
+ Revision 1.50 2002/05/28 04:32:45 hal9
Change hints on bundling index.html to privoxy-index.html
- Revision 1.46.2.2 2002/05/26 17:04:24 hal9
+ Revision 1.49 2002/05/26 17:04:24 hal9
-Spellcheck, very minor edits, and sync across branches
Revision 1.48 2002/05/26 12:48:31 roro
diff --git a/doc/source/faq.sgml b/doc/source/faq.sgml
index 29a8e714..a9d49d01 100644
--- a/doc/source/faq.sgml
+++ b/doc/source/faq.sgml
@@ -8,9 +8,9 @@
<!entity history SYSTEM "history.sgml">
<!entity copyright SYSTEM "copyright.sgml">
<!entity license SYSTEM "license.sgml">
-<!entity p-version "2.9.16">
-<!entity p-status "beta">
-<!entity % p-not-stable "INCLUDE">
+<!entity p-version SYSTEM "doc_version.tmp">
+<!entity p-status SYSTEM "doc_status.tmp">
+<!entity % p-not-stable "IGNORE">
<!entity % p-stable "IGNORE">
<!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
<!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
@@ -24,7 +24,7 @@
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: faq.sgml,v 1.61.2.5 2002/07/26 15:22:58 oes Exp $
+ $Id: faq.sgml,v 1.65 2002/07/25 21:51:24 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -50,9 +50,7 @@
========================================================================
NOTE: Please read developer-manual/documentation.html before touching
- 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!
+ anything in this, or other Privoxy documentation.
========================================================================
@@ -72,7 +70,7 @@
</subscript>
</pubdate>
-<pubdate>$Id: faq.sgml,v 1.61.2.5 2002/07/26 15:22:58 oes Exp $</pubdate>
+<pubdate>$Id: faq.sgml,v 1.65 2002/07/25 21:51:24 hal9 Exp $</pubdate>
<!--
@@ -489,23 +487,6 @@ All the ads are there. What's wrong?</title>
<sect1 id="configuration"><title>Configuration</title>
-<sect2 renderas="sect3" id="getupdates"><title>Where can I get updated Actions Files?</title>
- <para>
- Based on your feedback and the continuing development, updated actions files will be
- made available on the <ulink
- url="http://sourceforge.net/project/showfiles.php?group_id=11118">files section</ulink> of
- our <ulink url="http://sf.net/projects/ijbswa/">project page</ulink>.
- </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>
-
-</sect2>
-
<sect2 renderas="sect3" id="newconfig"><title>Can I use my old config files?</title>
<para>
The syntax, number, and purpose of configuration files has substantially
@@ -692,7 +673,7 @@ the differences?</title>
<row>
<entry>Pop-up killing</entry>
<entry>no</entry>
- <entry>yes</entry>
+ <entry>no</entry>
<entry>yes</entry>
</row>
@@ -731,21 +712,6 @@ the differences?</title>
<entry>yes</entry>
</row>
-<row>
- <entry>Image tag reordering</entry>
- <entry>no</entry>
- <entry>no</entry>
- <entry>yes</entry>
-</row>
-
-<row>
- <entry>Ad-filtering by link</entry>
- <entry>no</entry>
- <entry>no</entry>
- <entry>yes</entry>
-</row>
-
-
</tbody>
</tgroup>
</table>
@@ -792,7 +758,7 @@ with a browser? Does that not raise security issues?</title>
<sect2 renderas="sect3">
-<title id="filterfile">What is the <filename>default.filter</filename> file? What is a <quote>filter</quote>?</title>
+<title id="filterfile">What is the <filename>default.filter</filename> file?</title>
<para>
The <ulink url="../user-manual/filter-file.html"><filename>default.filter</filename></ulink>
file is where <emphasis>filters</emphasis> are defined, which can be used to modify or
@@ -813,6 +779,7 @@ with a browser? Does that not raise security issues?</title>
requires some expertise in both regular expressions and HTML/HTTP.
</para>
+
<para>
Presently, there is no GUI editor option for this part of the configuration,
but you can disable/enable the various pre-defined filters of the included
@@ -1106,7 +1073,6 @@ delays in page requests compared to the old Junkbuster. What's wrong?</title>
</para>
<para>
Filtering is automatically disabled for inappropriate MIME types.
-
</para>
</sect2>
@@ -1400,6 +1366,7 @@ secure is it? Do I need to take any special precautions?</title>
</sect2>
+
<sect2 renderas="sect3" id="turnoff">
<title>How can I temporarily disable <application>Privoxy</application>?</title>
<para>
@@ -1424,6 +1391,7 @@ out of the picture?</title>
</para>
</sect2>
+
<sect2 renderas="sect3" id="seealso">
<title>Where can I find more information about <application>Privoxy</application>
and related issues?</title>
@@ -1694,21 +1662,19 @@ FIXME: Commented out until we have something to put here. HB 03/18/02.
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: faq.sgml,v $
-Revision 1.61.2.5 2002/07/26 15:22:58 oes
-- Updated to reflect changes in standard.action
-- Added info on where to get updated actions files
-
-Revision 1.61.2.4 2002/07/25 21:42:29 hal9
-Add brief notes on not proxying non-HTTP protocols.
+Revision 1.65 2002/07/25 21:51:24 hal9
+Warnings on non-HTTP traffic.
-Revision 1.61.2.3 2002/06/09 16:36:33 hal9
-Clarifications on filtering and MIME. Hardcode 'latest release' in index.html.
+Revision 1.64 2002/06/09 16:37:31 hal9
+Sync with filtering clarifications in 3.0 branch.
-Revision 1.61.2.2 2002/06/06 02:51:34 hal9
-Fix typo in URL http:/config.privoxy.org
+Revision 1.63 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.61.2.1 2002/06/05 23:10:43 hal9
-Add new FAQ re: DUN/IE. Change release date from May to June :)
+Revision 1.62 2002/06/03 00:28:16 hal9
+Sync with various changes from 3.0 branch. Add two new files for config stuff.
Revision 1.61 2002/05/25 12:37:25 hal9
Various minor changes and edits.
diff --git a/doc/source/history.sgml b/doc/source/history.sgml
index 002f8792..5d88e873 100644
--- a/doc/source/history.sgml
+++ b/doc/source/history.sgml
@@ -3,7 +3,7 @@
Purpose : Entity included in other project documents.
- $Id: history.sgml,v 1.7.2.1 2002/06/05 23:10:43 hal9 Exp $
+ $Id: history.sgml,v 1.8 2002/06/03 00:28:17 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -20,7 +20,6 @@
user-manual
developer-manual
faq
- webserver/index.sgml
-->
@@ -67,6 +66,6 @@
<para>
The result of this is <application>Privoxy</application>, whose first
- stable release, 3.0, is due in June 2002.
+ stable release, 3.0, is due in May 2002.
</para>
diff --git a/doc/source/license.sgml b/doc/source/license.sgml
index 35899588..cce4886e 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.2 2002/05/10 01:48:20 hal9 Exp $
+ $Id: license.sgml,v 1.3 2002/06/03 00:28:17 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -21,7 +21,6 @@
user-manual
developer-manual
faq
- webserver/index.sgml
-->
diff --git a/doc/source/newfeatures.sgml b/doc/source/newfeatures.sgml
index 9f1c209d..d8e95531 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.10 2002/05/15 03:54:29 hal9 Exp $
+ $Id: newfeatures.sgml,v 1.11 2002/06/03 00:28:17 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -19,6 +19,7 @@
user-manual
faq
+ announce.sgml
-->
<para>
diff --git a/doc/source/p-authors.sgml b/doc/source/p-authors.sgml
index 356a1e73..18b0d1a1 100644
--- a/doc/source/p-authors.sgml
+++ b/doc/source/p-authors.sgml
@@ -3,7 +3,7 @@
Purpose : Entity included in other project documents.
- $Id: p-authors.sgml,v 1.8.2.2 2002/05/27 22:02:47 hal9 Exp $
+ $Id: p-authors.sgml,v 1.10 2002/06/03 00:28:17 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -46,6 +46,7 @@
<literallayout>
]]>
Rodrigo Barbosa (RPM specfiles)
+ Moritz Barsnick
Hal Burgiss (docs)
Alexander Lazic
Gábor Lipták
diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index 617dd0b8..e1313b2e 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.1.2.3 2002/05/31 02:56:25 hal9 Exp $
+ $Id: p-config.sgml,v 1.2 2002/06/03 00:28:17 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -98,7 +98,7 @@
Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org
</para>
<para>
-$Id: p-config.sgml,v 1.1.2.3 2002/05/31 02:56:25 hal9 Exp $
+$Id: p-config.sgml,v 1.2 2002/06/03 00:28:17 hal9 Exp $
</para>
<para>
diff --git a/doc/source/privoxy-man-page.sgml b/doc/source/privoxy-man-page.sgml
index a38bf138..dc21a872 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 1.13.2.2 2002/07/25 21:49:52 hal9 Exp $
+ $Id: privoxy-man-page.sgml,v 1.17 2002/07/25 21:51:25 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -42,10 +42,12 @@
<!entity copyright SYSTEM "copyright.sgml">
<!entity license SYSTEM "license.sgml">
<!entity authors SYSTEM "p-authors.sgml">
-<!entity p-version "2.9.15">
-<!entity p-status "beta">
-<!entity % p-not-stable "INCLUDE">
+<!entity p-version SYSTEM "doc_version.tmp">
+<!entity p-status SYSTEM "doc_status.tmp">
+<!entity % p-not-stable "IGNORE">
<!entity % p-stable "IGNORE">
+<!entity % p-alpha "IGNORE">
+<!entity % p-beta "IGNORE">
<!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
<!entity % p-authors-formal "IGNORE"> <!-- exclude additional formating -->
<!entity my-copy "(C)"> <!-- db2man barfs on copyright symbol -->
@@ -194,8 +196,6 @@
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>
<para>
For other browsers, check the documentation.
</para>
@@ -385,9 +385,12 @@
<refsect1><title>Notes</title>
<![%p-not-stable;[
<para>
- This is a &p-status; version of <command>Privoxy</command>. Not
- all features are well tested.
-</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>]]>
<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 751f7e0f..2882344e 100644
--- a/doc/source/readme.sgml
+++ b/doc/source/readme.sgml
@@ -4,10 +4,12 @@
<!entity p-intro SYSTEM "privoxy.sgml">
<!entity contacting SYSTEM "contacting.sgml">
<!entity buildsource SYSTEM "buildsource.sgml">
-<!entity p-version "2.9.15">
-<!entity p-status "beta">
-<!entity % p-not-stable "INCLUDE">
+<!entity p-version SYSTEM "doc_version.tmp">
+<!entity p-status SYSTEM "doc_status.tmp">
<!entity % p-stable "IGNORE">
+<!entity % p-not-stable "IGNORE"> <!-- beta or alpha -->
+<!entity % p-alpha "IGNORE">
+<!entity % p-beta "IGNORE">
<!entity % p-text "INCLUDE"> <!-- define we are a text only doc -->
<!entity % p-doc "IGNORE"> <!-- and never a text doc -->
<!entity % p-readme "INCLUDE"> <!-- all your README belong to us -->
@@ -17,16 +19,14 @@
Purpose : README for Privoxy
- $Id: readme.sgml,v 1.16.2.2 2002/07/25 21:49:52 hal9 Exp $
+ $Id: readme.sgml,v 1.19 2002/07/25 21:51:25 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. You have been warned!
- Failure to abide by this rule will result in the revocation of your license
- to live a peaceful existence!
+ anything in this, or other Privoxy documentation.
========================================================================
===================================================================
@@ -45,18 +45,6 @@
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>
@@ -114,10 +102,13 @@
<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.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>
+ 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>
</abstract>
</artheader>
@@ -211,14 +202,14 @@
<sect1 id="documentation"><title>DOCUMENTATION</title>
<para>
There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
- is not completed at this point]]>. In particular, see the User Manual there,
+ may not be in sync with current code]]>. 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 still be either comments in the source code, or the included
+ may 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]]>.
@@ -243,7 +234,7 @@
<!-- </LiteralLayout> -->
<!-- </para> -->
<!-- <para> -->
-<!-- $Id: readme.sgml,v 1.16.2.2 2002/07/25 21:49:52 hal9 Exp $ -->
+<!-- $Id: readme.sgml,v 1.19 2002/07/25 21:51:25 hal9 Exp $ -->
<!-- </para> -->
</article>
diff --git a/doc/source/supported.sgml b/doc/source/supported.sgml
index 01430d1e..221eef02 100644
--- a/doc/source/supported.sgml
+++ b/doc/source/supported.sgml
@@ -3,7 +3,7 @@
Purpose : Entity included in other project documents.
- $Id: supported.sgml,v 1.10.2.1 2002/05/26 17:04:25 hal9 Exp $
+ $Id: supported.sgml,v 1.11 2002/06/03 00:28:17 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -20,6 +20,7 @@
user-manual
faq
newfeatures
+ announce
-->
<para>
diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index 12e9f33e..91b0b627 100644
--- a/doc/source/user-manual.sgml
+++ b/doc/source/user-manual.sgml
@@ -11,10 +11,10 @@
<!entity license SYSTEM "license.sgml">
<!entity p-authors SYSTEM "p-authors.sgml">
<!entity config SYSTEM "p-config.sgml">
-<!entity p-version "2.9.16">
-<!entity p-status "beta">
+<!entity p-version SYSTEM "doc_version.tmp">
+<!entity p-status SYSTEM "doc_status.tmp">
<!entity % p-authors-formal "INCLUDE"> <!-- include additional text, etc -->
-<!entity % p-not-stable "INCLUDE">
+<!entity % p-not-stable "IGNORE">
<!entity % p-stable "IGNORE">
<!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
<!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
@@ -32,7 +32,7 @@
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.123.2.11 2002/07/26 15:20:31 oes Exp $
+ $Id: user-manual.sgml,v 1.128 2002/07/25 21:51:24 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -47,18 +47,18 @@
<article id="index">
<artheader>
-<title>Privoxy &p-version; User Manual</title>
+<title>Privoxy 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.123.2.11 2002/07/26 15:20:31 oes Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.128 2002/07/25 21:51:24 hal9 Exp $</pubdate>
<!--
@@ -277,24 +277,17 @@ automatically start Privoxy in the boot process.
</sect3>
<!-- ~~~~~ New section ~~~~~ -->
-<sect3 id="installation-mac"><title>Mac OSX</title>
+<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). The
- Privoxy.pkg package should appear after unzipping. Then,
- double-click on that Privoxy.pkg package installer icon and follow
- the installation process.
- <application>Privoxy</application> will be installed in the folder
- <literal>/Library/Privoxy</literal>.
- It will run automatically whenever you start up. To prevent it from
- running automatically, remove or rename the folder
- <literal>/Library/StartupItems/Privoxy</literal>.
-</para>
-<para>
- To run Privoxy by hand, double-click on
- <literal>RunPrivoxy.command</literal>.
- To run Privoxy from Terminal, execute
- <literal>/Library/Privoxy/RunPrivoxy.command</literal>.
+ 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>.
</para>
</sect3>
@@ -332,37 +325,6 @@ 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 software and the main <link linkend="actions-file">actions file</link>
- (<literal>default.action</literal>) 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>
- Both can be downloaded from the <ulink
- url="http://sourceforge.net/project/showfiles.php?group_id=11118">files
- section</ulink> on <ulink url="http://sourceforge.net/">SourceForge</ulink>.
-</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>
@@ -966,23 +928,16 @@ Example Unix startup command:
</sect2>
<sect2 id="start-macosx">
-<title>Mac OSX</title>
+<title>MAX OSX</title>
<para>
During installation, <application>Privoxy</application> is configured to
- start automatically when the system restarts. To run Privoxy by hand,
- double-click on the <literal>RunPrivoxy.command</literal> icon in the
- <literal>/Library/Privoxy</literal> folder. Or, type this command
- in the Terminal:
+ start automatically when the system restarts. You can start it manually
+ through the Terminal with these commands:
</para>
<para>
<screen>
- /Library/Privoxy/RunPrivoxy.command
- </screen>
-</para>
-<para>
- If you are not logged in as an administrator, you will be asked for the
- administrator password when starting <application>Privoxy</application>
- by hand.
+ cd /Applications/Privoxy.app
+ ./privoxy</screen>
</para>
</sect2>
@@ -1407,8 +1362,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 <link
- linkend="installation-keepupdated">making available to users</link>.
+ This is the file that the developers are keeping updated, and making
+ available to users.
</para>
</listitem>
<listitem>
@@ -2380,9 +2335,8 @@ 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>
@@ -2472,14 +2426,6 @@ 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>
@@ -2516,10 +2462,6 @@ 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>
@@ -3745,11 +3687,8 @@ 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> \
@@ -4414,7 +4353,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*(['"]).*?\1/dUmMy=1/ig</screen>
+s/window\.status\s*=\s*['"].*?['"]/dUmMy=1/ig</screen>
</para>
<para>
@@ -4423,10 +4362,7 @@ s/window\.status\s*=\s*(['"]).*?\1/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>. 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.
+ <emphasis>or</emphasis> a double quote</quote>.
</para>
<para>
@@ -4442,7 +4378,7 @@ s/window\.status\s*=\s*(['"]).*?\1/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>
@@ -4453,11 +4389,7 @@ 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. 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.
+ case-insensitive.
</para>
<para>
@@ -4487,8 +4419,6 @@ 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 \
@@ -4501,7 +4431,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>
@@ -5229,7 +5159,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>
@@ -5526,7 +5456,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>
@@ -5603,27 +5533,19 @@ 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.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.128 2002/07/25 21:51:24 hal9
+ Warnings on non-HTTP traffic.
- 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.127 2002/06/09 16:37:31 hal9
+ Sync with filtering clarifications in 3.0 branch.
- Revision 1.123.2.7 2002/06/09 00:29:34 hal9
- Touch ups on filtering, in actions section and Anatomy.
+ 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.6 2002/06/06 23:11:03 hal9
- Fix broken link. Linkchecked all docs.
+ 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.5 2002/05/29 02:01:02 hal9
This is break out of the entire config section from u-m, so it can
diff --git a/doc/source/webserver/index.sgml b/doc/source/webserver/index.sgml
index 7b9baf72..99d95951 100644
--- a/doc/source/webserver/index.sgml
+++ b/doc/source/webserver/index.sgml
@@ -5,9 +5,9 @@
<!entity history SYSTEM "history.sgml">
<!entity copyright SYSTEM "copyright.sgml">
<!entity license SYSTEM "license.sgml">
-<!entity p-version "2.9.16">
-<!entity p-status "beta">
-<!entity % p-not-stable "INCLUDE">
+<!entity p-version SYSTEM "doc_version.tmp">
+<!entity p-status SYSTEM "doc_status.tmp">
+<!entity % p-not-stable "IGNORE">
<!entity % p-stable "IGNORE">
<!entity my-copy "©"> <!-- kludge for docbook2man -->
<!entity % p-homepage "IGNORE"> <!-- toggle for webserver index.html -->
@@ -20,7 +20,7 @@
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: index.sgml,v 1.16.2.6 2002/07/26 15:22:15 oes Exp $
+ $Id: index.sgml,v 1.22 2002/06/09 18:59:44 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
@@ -36,7 +36,7 @@
perl.
Generates: index.html, for webserver home page.
- privoxy-index.html, for packaging with docs
+ And privoxy-index.html, for packaging with docs.
-->
@@ -75,10 +75,12 @@
<![%p-homepage;[
<para>
- The most recent release is &p-version; (&p-status;).
+ <!-- FIXME: Temporarily hard coding this. HB. -->
+ The most recent release is 2.9.14 (&p-status;).
</para>
]]>
+
</abstract>
</artheader>
@@ -244,14 +246,19 @@
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: index.sgml,v $
- Revision 1.16.2.6 2002/07/26 15:22:15 oes
- Most recent release now inserted automatically (again)
-
- Revision 1.16.2.5 2002/06/09 18:59:16 hal9
+ Revision 1.22 2002/06/09 18:59:44 hal9
Correct typo.
- Revision 1.16.2.4 2002/06/09 16:36:33 hal9
- Clarifications on filtering and MIME. Hardcode 'latest release' in index.html.
+ Revision 1.21 2002/06/09 16:37:31 hal9
+ Sync with filtering clarifications in 3.0 branch.
+
+ Revision 1.20 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.19 2002/06/03 00:28:17 hal9
+ Sync with various changes from 3.0 branch. Add two new files for config stuff.
Revision 1.16.2.3 2002/05/28 02:31:38 hal9
New file, privoxy-index.html, for bundling with documentation. Built from