Syncing with 3.0. Added support to nbsp entity (needed for man page).
[privoxy.git] / doc / source / readme.sgml
index 2aef615..7af842f 100644 (file)
@@ -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     -->
 
  Purpose     :  README for Privoxy
                 
- $Id: readme.sgml,v 1.14 2002/05/05 13:46:59 swa Exp $
-
- Written by and Copyright (C) 2001 the SourceForge
- Privoxy team. http://www.privoxy.org/
-
- Based on the Internet Junkbuster originally written
- by and Copyright (C) 1997 Anonymous Coders and 
- Junkbusters Corporation.  http://www.junkbusters.com
+ $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 
 
 <!--   ~~~~~       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
  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 an explanation of each option, and 
+ other configuration and usage issues.
 </para>
 <para>
  If no config_file is specified on the command line, Privoxy will look for a
  for 'config.txt'). If no config_file is found, Privoxy will fail to start.
 </para>
 <para>
- Or for Red Hat: /etc/rc.d/init.d/privoxy start
+ Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
 </para>
 <para>
  Or for SuSE:   /etc/rc.d/privoxy start
 </para>
+<para>
+ Or Debian: /etc/init.d/privoxy start
+</para>
 </sect1>
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="configuration"><title>CONFIGURATION</title>
 <para>
  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/.
+ 'user.action' is for personal and local configuration preferences. 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 an explanation of
+ all 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
  whatever you specify in the config file under 'listen-address'. DEFAULT is
- localhost:8118.
+ localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it 
+ with FTP or other protocols for the simple reason it does not work.
 </para>
 <para>
  The actions list can be configured via the web interface accessed via
 <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,
- the faq, and those interested in Privoxy development, should look at
+ 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>
 </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>
 
 <!-- </LiteralLayout> -->
 <!-- </para> -->
 <!-- <para> -->
-<!--  $Id: readme.sgml,v 1.14 2002/05/05 13:46:59 swa Exp $ -->
+<!--  $Id: readme.sgml,v 1.16.2.4 2002/08/25 17:12:20 hal9 Exp $ -->
 <!-- </para> -->
 
 </article>