<!entity contacting SYSTEM "../contacting.sgml">
<!entity history SYSTEM "../history.sgml">
<!entity newfeatures SYSTEM "../newfeatures.sgml">
-<!entity p-version SYSTEM "doc_version.tmp">
-<!entity p-status SYSTEM "doc_status.tmp">
-<!entity % p-not-stable "IGNORE">
+<!entity p-version "2.9.15">
+<!entity p-status "beta">
+<!entity % p-not-stable "INCLUDE">
<!entity % p-stable "IGNORE">
<!entity % p-supp-userman "IGNORE">
<!entity % p-text "INCLUDE"> <!-- define we are a text only doc -->
Purpose : Announcement text
- $Id: announce.sgml,v 1.2 2002/06/03 00:28:16 hal9 Exp $
+ $Id: announce.sgml,v 1.1.2.1 2002/05/27 22:03:51 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
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
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!entity % dummy "IGNORE">
<!entity authors SYSTEM "p-authors.sgml">
-<!entity p-version SYSTEM "doc_version.tmp">
-<!entity p-status SYSTEM "doc_status.tmp">
-<!entity % p-not-stable "IGNORE">
+<!entity p-version "2.9.15">
+<!entity p-status "beta">
+<!entity % p-not-stable "INCLUDE">
<!entity % p-stable "IGNORE">
<!entity % p-text "INCLUDE"> <!-- define we are a text only doc -->
<!entity % p-authors-formal "INCLUDE"> <!-- include additional text, etc -->
Purpose : Entity included in other project documents.
- $Id: buildsource.sgml,v 1.8 2002/05/03 17:41:41 oes Exp $
+ $Id: buildsource.sgml,v 1.9 2002/05/10 01:48:19 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
<!entity % dummy "IGNORE">
<!entity config SYSTEM "p-config.sgml">
-<!entity p-version SYSTEM "doc_version.tmp">
-<!entity p-status SYSTEM "doc_status.tmp">
-<!entity % p-not-stable "IGNORE">
+<!entity p-version "2.9.15">
+<!entity p-status "beta">
+<!entity % p-not-stable "INCLUDE">
<!entity % user-man "IGNORE">
<!entity % config-file "IGNORE">
]>
Purpose : config file generation
- $Id: config.sgml,v 1.2 2002/06/03 00:28:16 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.
Purpose : Entity included in other project documents.
- $Id: contacting.sgml,v 1.15 2002/05/26 17:04:24 hal9 Exp $
+ $Id: contacting.sgml,v 1.15.2.2 2002/07/26 15:21:33 oes Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
README
user-manual
webserver/index.sgml
- privoxy-index.html
announce.sgml
-->
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 <ulink url="http://sf.net/projects/ijbswa/">project page</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>.
</para>
</sect2>
Purpose : Entity included in other project documents.
- $Id: copyright.sgml,v 1.6 2002/05/07 00:37:31 hal9 Exp $
+ $Id: copyright.sgml,v 1.7 2002/05/10 01:48:19 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
<!entity contacting SYSTEM "contacting.sgml">
<!entity copyright SYSTEM "copyright.sgml">
<!entity license SYSTEM "license.sgml">
-<!entity p-version SYSTEM "doc_version.tmp">
-<!entity p-status SYSTEM "doc_status.tmp">
-<!entity % p-not-stable "IGNORE">
+<!entity p-version "2.9.15">
+<!entity p-status "beta">
+<!entity % p-not-stable "INCLUDE">
<!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 -->
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: developer-manual.sgml,v 1.49 2002/06/03 00:28:16 hal9 Exp $
+ $Id: developer-manual.sgml,v 1.46.2.4 2002/05/29 00:30:59 mal0rd 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!
========================================================================
-->
</pubdate>
- <pubdate>$Id: developer-manual.sgml,v 1.49 2002/06/03 00:28:16 hal9 Exp $</pubdate>
+ <pubdate>$Id: developer-manual.sgml,v 1.46.2.4 2002/05/29 00:30:59 mal0rd Exp $</pubdate>
<!--
-->
-<abstract>
<![%dummy;[
<para>
<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), 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.
+ <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.
<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
<para><emphasis>Example for file comments:</emphasis></para>
<programlisting>
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.49 2002/06/03 00:28:16 hal9 Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.46.2.4 2002/05/29 00:30:59 mal0rd Exp $";
/*********************************************************************
*
* File : $S<!-- Break CVS Substitution -->ource$
<programlisting>
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.49 2002/06/03 00:28:16 hal9 Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.46.2.4 2002/05/29 00:30:59 mal0rd Exp $"
/*********************************************************************
*
* File : $S<!-- Break CVS Substitution -->ource$
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: developer-manual.sgml,v $
- 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
+ Revision 1.46.2.4 2002/05/29 00:30:59 mal0rd
Fixed a little formatting. Clarified debian section.
- Revision 1.50 2002/05/28 04:32:45 hal9
+ Revision 1.46.2.3 2002/05/28 04:32:45 hal9
Change hints on bundling index.html to privoxy-index.html
- Revision 1.49 2002/05/26 17:04:24 hal9
+ Revision 1.46.2.2 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
<!entity history SYSTEM "history.sgml">
<!entity copyright SYSTEM "copyright.sgml">
<!entity license SYSTEM "license.sgml">
-<!entity p-version SYSTEM "doc_version.tmp">
-<!entity p-status SYSTEM "doc_status.tmp">
-<!entity % p-not-stable "IGNORE">
+<!entity p-version "2.9.16">
+<!entity p-status "beta">
+<!entity % p-not-stable "INCLUDE">
<!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 -->
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: faq.sgml,v 1.64 2002/06/09 16:37:31 hal9 Exp $
+ $Id: faq.sgml,v 1.61.2.5 2002/07/26 15:22:58 oes 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!
========================================================================
</subscript>
</pubdate>
-<pubdate>$Id: faq.sgml,v 1.64 2002/06/09 16:37:31 hal9 Exp $</pubdate>
+<pubdate>$Id: faq.sgml,v 1.61.2.5 2002/07/26 15:22:58 oes Exp $</pubdate>
<!--
<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
<row>
<entry>Pop-up killing</entry>
<entry>no</entry>
- <entry>no</entry>
+ <entry>yes</entry>
<entry>yes</entry>
</row>
<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>
<sect2 renderas="sect3">
-<title id="filterfile">What is the <filename>default.filter</filename> file?</title>
+<title id="filterfile">What is the <filename>default.filter</filename> file? What is a <quote>filter</quote>?</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
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
</para>
<para>
Filtering is automatically disabled for inappropriate MIME types.
+
</para>
</sect2>
</sect2>
-
<sect2 renderas="sect3" id="turnoff">
<title>How can I temporarily disable <application>Privoxy</application>?</title>
<para>
</para>
</sect2>
-
<sect2 renderas="sect3" id="seealso">
<title>Where can I find more information about <application>Privoxy</application>
and related issues?</title>
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: faq.sgml,v $
-Revision 1.64 2002/06/09 16:37:31 hal9
-Sync with filtering clarifications in 3.0 branch.
+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.61.2.3 2002/06/09 16:36:33 hal9
+Clarifications on filtering and MIME. Hardcode 'latest release' in index.html.
-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.2 2002/06/06 02:51:34 hal9
+Fix typo in URL http:/config.privoxy.org
-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.2.1 2002/06/05 23:10:43 hal9
+Add new FAQ re: DUN/IE. Change release date from May to June :)
Revision 1.61 2002/05/25 12:37:25 hal9
Various minor changes and edits.
Purpose : Entity included in other project documents.
- $Id: history.sgml,v 1.7 2002/05/17 13:47:33 oes Exp $
+ $Id: history.sgml,v 1.7.2.1 2002/06/05 23:10:43 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
user-manual
developer-manual
faq
+ webserver/index.sgml
-->
<para>
The result of this is <application>Privoxy</application>, whose first
- stable release, 3.0, is due in May 2002.
+ stable release, 3.0, is due in June 2002.
</para>
user-manual
developer-manual
faq
+ webserver/index.sgml
-->
user-manual
faq
- announce.sgml
-->
<para>
Purpose : Entity included in other project documents.
- $Id: p-authors.sgml,v 1.9 2002/05/27 22:02:47 hal9 Exp $
+ $Id: p-authors.sgml,v 1.8.2.2 2002/05/27 22:02:47 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
<literallayout>
]]>
Rodrigo Barbosa (RPM specfiles)
- Moritz Barsnick
Hal Burgiss (docs)
Alexander Lazic
Gábor Lipták
<!--
- File : $Source: /cvsroot/ijbswa/current/doc/source/Attic/p-config.sgml,v $
+ File : $Source: /cvsroot/ijbswa/current/doc/source/p-config.sgml,v $
Purpose : Used with other docs and files only.
- $Id: p-config.sgml,v 1.1 2002/05/31 02:56:25 hal9 Exp $
+ $Id: p-config.sgml,v 1.1.2.3 2002/05/31 02:56:25 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: privoxy-man-page.sgml,v 1.16 2002/06/05 00:31:55 hal9 Exp $
+ $Id: privoxy-man-page.sgml,v 1.13.2.2 2002/07/25 21:49:52 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
<!entity copyright SYSTEM "copyright.sgml">
<!entity license SYSTEM "license.sgml">
<!entity authors SYSTEM "p-authors.sgml">
-<!entity p-version SYSTEM "doc_version.tmp">
-<!entity p-status SYSTEM "doc_status.tmp">
-<!entity % p-not-stable "IGNORE">
+<!entity p-version "2.9.15">
+<!entity p-status "beta">
+<!entity % p-not-stable "INCLUDE">
<!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 -->
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>
<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.
Purpose : Entity included in other project documents.
- $Id: privoxy.sgml,v 1.6 2002/04/15 23:31:42 oes Exp $
+ $Id: privoxy.sgml,v 1.7 2002/05/10 01:48:20 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
<!entity p-intro SYSTEM "privoxy.sgml">
<!entity contacting SYSTEM "contacting.sgml">
<!entity buildsource SYSTEM "buildsource.sgml">
-<!entity p-version SYSTEM "doc_version.tmp">
-<!entity p-status SYSTEM "doc_status.tmp">
+<!entity p-version "2.9.15">
+<!entity p-status "beta">
+<!entity % p-not-stable "INCLUDE">
<!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 -->
Purpose : README for Privoxy
- $Id: readme.sgml,v 1.18 2002/06/05 00:31:55 hal9 Exp $
+ $Id: readme.sgml,v 1.16.2.2 2002/07/25 21:49:52 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!
========================================================================
===================================================================
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>
<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>
<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]]>.
<!-- </LiteralLayout> -->
<!-- </para> -->
<!-- <para> -->
-<!-- $Id: readme.sgml,v 1.18 2002/06/05 00:31:55 hal9 Exp $ -->
+<!-- $Id: readme.sgml,v 1.16.2.2 2002/07/25 21:49:52 hal9 Exp $ -->
<!-- </para> -->
</article>
<!--
- File : $Source: /cvsroot/ijbswa//current/doc/source/seealso.sgml,v $
+ File : $Source: /cvsroot/ijbswa/current/doc/source/seealso.sgml,v $
Purpose : Entity included in other project documents.
- $Id: seealso.sgml,v 1.8 2002/05/17 13:49:30 oes Exp $
+ $Id: seealso.sgml,v 1.9 2002/05/17 14:16:26 oes Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
Purpose : Entity included in other project documents.
- $Id: supported.sgml,v 1.10 2002/05/26 17:04:25 hal9 Exp $
+ $Id: supported.sgml,v 1.10.2.1 2002/05/26 17:04:25 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
user-manual
faq
newfeatures
- announce
-->
<para>
<!entity license SYSTEM "license.sgml">
<!entity p-authors SYSTEM "p-authors.sgml">
<!entity config SYSTEM "p-config.sgml">
-<!entity p-version SYSTEM "doc_version.tmp">
-<!entity p-status SYSTEM "doc_status.tmp">
+<!entity p-version "2.9.16">
+<!entity p-status "beta">
<!entity % p-authors-formal "INCLUDE"> <!-- include additional text, etc -->
-<!entity % p-not-stable "IGNORE">
+<!entity % p-not-stable "INCLUDE">
<!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 -->
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.127 2002/06/09 16:37:31 hal9 Exp $
+ $Id: user-manual.sgml,v 1.123.2.11 2002/07/26 15:20:31 oes Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
<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.127 2002/06/09 16:37:31 hal9 Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.123.2.11 2002/07/26 15:20:31 oes Exp $</pubdate>
<!--
</sect3>
<!-- ~~~~~ New section ~~~~~ -->
-<sect3 id="installation-mac"><title>Max OSX</title>
+<sect3 id="installation-mac"><title>Mac 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>.
+ 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>.
</para>
</sect3>
&buildsource;
<!-- 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>
<!-- ~ End section ~ -->
</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 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:
</para>
<para>
<screen>
- cd /Applications/Privoxy.app
- ./privoxy</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.
</para>
</sect2>
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>
<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>
<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>
<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>
-<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> \
<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>
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>
<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>
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>
#
s* industry[ -]leading \
| cutting[ -]edge \
+| customer[ -]focused \
+| market[ -]driven \
| award[ -]winning # Comments are OK, too! \
| high[ -]performance \
| solutions[ -]based \
<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>
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>
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>
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
- Revision 1.127 2002/06/09 16:37:31 hal9
- Sync with filtering clarifications in 3.0 branch.
+ 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.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
<!entity history SYSTEM "history.sgml">
<!entity copyright SYSTEM "copyright.sgml">
<!entity license SYSTEM "license.sgml">
-<!entity p-version SYSTEM "doc_version.tmp">
-<!entity p-status SYSTEM "doc_status.tmp">
-<!entity % p-not-stable "IGNORE">
+<!entity p-version "2.9.16">
+<!entity p-status "beta">
+<!entity % p-not-stable "INCLUDE">
<!entity % p-stable "IGNORE">
<!entity my-copy "©"> <!-- kludge for docbook2man -->
<!entity % p-homepage "IGNORE"> <!-- toggle for webserver index.html -->
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: index.sgml,v 1.21 2002/06/09 16:37:31 hal9 Exp $
+ $Id: index.sgml,v 1.16.2.6 2002/07/26 15:22:15 oes Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
perl.
Generates: index.html, for webserver home page.
- And privoxy-index.html, for packaging with docs.
+ privoxy-index.html, for packaging with docs
-->
<![%p-homepage;[
<para>
- <!-- FIXME: Temporarily hard coding this. HB. -->
- The most recent release is 2.9.14 (&p-status;).
+ The most recent release is &p-version; (&p-status;).
</para>
]]>
-
</abstract>
</artheader>
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: index.sgml,v $
- Revision 1.21 2002/06/09 16:37:31 hal9
- Sync with filtering clarifications in 3.0 branch.
+ Revision 1.16.2.6 2002/07/26 15:22:15 oes
+ Most recent release now inserted automatically (again)
- 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.16.2.5 2002/06/09 18:59:16 hal9
+ Correct typo.
- 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.4 2002/06/09 16:36:33 hal9
+ Clarifications on filtering and MIME. Hardcode 'latest release' in index.html.
Revision 1.16.2.3 2002/05/28 02:31:38 hal9
New file, privoxy-index.html, for bundling with documentation. Built from
projects / privoxy.git / commitdiff