bumped version
[privoxy.git] / doc / source / readme.sgml
index 10a515c..c9fe434 100644 (file)
@@ -1,13 +1,13 @@
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-<!entity % dummy "INCLUDE"> 
+<!entity % dummy "IGNORE"> 
 <!entity supported SYSTEM "supported.sgml">
 <!entity p-intro SYSTEM "privoxy.sgml">
 <!entity contacting SYSTEM "contacting.sgml">
 <!entity buildsource SYSTEM "buildsource.sgml">
-<!entity p-version "2.9.13">
-<!entity p-status "BETA">
-<!entity % p-not-stable "INCLUDE"> <!-- set to IGNORE for stable release -->
-<!entity % p-stable "IGNORE">      <!-- set INCLUDE for stable release   -->
+<!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-doc "IGNORE">         <!-- and never a text doc             -->
 <!entity % p-readme "INCLUDE">     <!-- all your README belong to us     -->
@@ -17,7 +17,7 @@
 
  Purpose     :  README for Privoxy
                 
- $Id: readme.sgml,v 1.2 2002/04/04 06:48:37 hal9 Exp $
+ $Id: readme.sgml,v 1.12 2002/04/26 17:45:36 swa Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  Privoxy team. http://www.privoxy.org/
  by and Copyright (C) 1997 Anonymous Coders and 
  Junkbusters Corporation.  http://www.junkbusters.com
 
+
+ ========================================================================
+ 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!
+ ========================================================================
+
  ===================================================================
  READ: Document Note: This file generates the README in the top level 
  source directory. It is generated as only a plain text file. The 
  current markup is not suitable for other formats. Build from 
- Makefile with 'make readme'.
+ Makefile with 'make dok-readme'.
  ===================================================================
 
  READ:
@@ -39,7 +47,7 @@
  NOTE: The left margin spacing is *important* when using 'literallayout'
  WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie 
  the para tag forces a linebreak. Tags need to be carefully placed as a result
- to avoid extra blank lines, etc.
+ to avoid extra blank lines, etc. 
  ======================================================================
 
  For stable releases, change 
@@ -51,7 +59,8 @@
   entity % p-not-stable "IGNORE" 
   
  in the DTD at the top. This will toggle various text 'off'. BOTH
- MUST be toggled in this case.
+ MUST be toggled in this case or you will get both text referencing 
+ stable and unstable versions. You only want one or the other!
 
 -->
 
@@ -71,7 +80,6 @@
  <literal>
   <msgtext>
    <literallayout>
-
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  *
  *********************************************************************/
-   </literallayout>
+</literallayout>
   </msgtext>
  </literal>
 </para>
   [--user USER[.GROUP]] [config_file]
 </para>
 <para>
-See the man page or user-manual for a brief explanation of each option.
+ See the man page or user-manual for a brief explanation of each option.
 </para>
 <para>
  If no config_file is specified on the command line, Privoxy will look for a
@@ -186,14 +194,14 @@ See the man page or user-manual for a brief explanation of each option.
 -------------- </LiteralLayout>
 </para>
 <para>
- See: 'config', 'default.action', and 'default.filter'. There are several
- actions files included. These are all well commented. Most of the magic is in
- '*.action', and there are several of these included with varying degrees of
- aggressiveness. On Unix-like systems, these files are installed in
- /etc/privoxy.  On Windows, then wherever the executable itself is installed.
There are many significant changes and advances since Junkbuster v2.0.x. The
- user-manual has a run down of configuration options, and examples:
- http://www.privoxy.org/user-manual/.
+ See: 'config', 'default.action', 'user.action', and 'default.filter'.
+ 'user.action' is for personal configuration. These are all well commented.
+ Most of the magic is in '*.action' files. 'user.action' should be 
+ used for any actions customizations. On Unix-like systems, these files
+ are installed in /etc/privoxy.  On Windows, then wherever the executable
itself is installed. There are many significant changes and advances since
+ Junkbuster v2.0.x. The user-manual has a run down of configuration options,
and examples: http://www.privoxy.org/user-manual/.
 </para>
 <para>
  Be sure to set your browser(s) for HTTP/HTTPS Proxy at &lt;IP&gt;:&lt;Port&gt;, or
@@ -201,7 +209,7 @@ See the man page or user-manual for a brief explanation of each option.
  localhost:8118.
 </para>
 <para>
- The default.action file can be configured via the web interface accessed via
+ The actions list can be configured via the web interface accessed via
  http://p.p/, as well other options.
 </para>
 <![%p-not-stable;[
@@ -227,8 +235,7 @@ See the man page or user-manual for a brief explanation of each option.
  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]]>. There
- are several *.action files included, with varying levels of aggressiveness.
+ 'default.filter'<![%p-not-stable;[ in the toplevel source directory]]>. 
 </para>
 
 <para>
@@ -242,18 +249,20 @@ See the man page or user-manual for a brief explanation of each option.
 --------------------------------------------------------------</LiteralLayout>
 </para>
 
+<!--  <sect1 id="none" label=""><title></title> -->
 <!-- Include contacting.sgml boilerplate: -->
- &contacting;
+<!--   &contacting; -->
 <!-- end boilerplate -->
+<!--  </sect1> -->
 
 <para>
  <LiteralLayout>
  -------------------------------------------------------------------------
  ijbswa-developers@lists.sourceforge.net
- </LiteralLayout>
+</LiteralLayout>
 </para>
 <para>
- $Id: readme.sgml,v 1.2 2002/04/04 06:48:37 hal9 Exp $
+ $Id: readme.sgml,v 1.12 2002/04/26 17:45:36 swa Exp $
 </para>
 
 </article>