Bump SMGL entities for 3.0.29 stable
[privoxy.git] / doc / source / readme.sgml
index d665b05..ae87711 100644 (file)
@@ -1,10 +1,10 @@
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-<!entity % dummy "IGNORE"> 
+<!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 "3.0.11">
+<!entity p-version "3.0.29">
 <!entity p-status "stable">
 <!entity % p-not-stable "IGNORE">
 <!entity % p-stable "INCLUDE">
 <!entity % p-readme "INCLUDE">     <!-- all your README belong to us     -->
 ]>
 <!--
- File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
+ File        :  doc/source/readme.sgml
 
  Purpose     :  README for Privoxy
-                
- $Id: readme.sgml,v 2.21 2008/08/22 00:44:58 hal9 Exp $
 
- Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2018 Privoxy Developers https://www.privoxy.org/
  See LICENSE.
 
  ========================================================================
- NOTE: Please read developer-manual/documentation.html before touching 
+ 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 
+ 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 
+ 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 dok-readme'.
  ===================================================================
 
 
  ======================================================================
  NOTE: The left margin spacing is *important* when using 'literallayout'
- WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie 
+ 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 
-  entity % p-not-stable "INCLUDE" 
- to 
-  entity % p-not-stable "IGNORE" 
-  
+ 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 
+ MUST be toggled in this case or you will get both text referencing
  stable and unstable versions. You only want one or the other!
 
 -->
    <literallayout>
 /*********************************************************************
  *
- * File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
+ * File        :  doc/source/readme.sgml
  *
  * Purpose     :  README file to give a short intro.
  *
- * Copyright   :  Written by and Copyright (C) 2001-2008  the SourceForge
- *                Privoxy team. http://www.privoxy.org/
+ * Copyright   :  Written by and Copyright (C) 2001-2020 the
+ *                Privoxy team. https://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
- *                by and Copyright (C) 1997 Anonymous Coders and 
+ *                by and Copyright (C) 1997 Anonymous Coders and
  *                Junkbusters Corporation.  http://www.junkbusters.com
  *
- *                This program is free software; you can redistribute it 
+ *                This program is free software; you can redistribute it
  *                and/or modify it under the terms of the GNU General
  *                Public License as published by the Free Software
  *                Foundation; either version 2 of the License, or (at
  *                The GNU General Public License should be included with
  *                this file.  If not, you can view it at
  *                http://www.gnu.org/copyleft/gpl.html
- *                or write to the Free Software Foundation, Inc., 
- *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 
+ *                or write to the Free Software Foundation, Inc.,
+ *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  *                USA
  *
  *********************************************************************/
 <para>
  <!-- include some conditional text -->
  This README is included with <![%p-not-stable;[ the development version of]]>
- Privoxy &p-version;. See http://www.privoxy.org/ for more information. The current code maturity
+ Privoxy &p-version;. See https://www.privoxy.org/ for more information. The current code maturity
  level is <quote>&p-status;</quote><![%p-not-stable;[, but seems stable to us :)]]>.
 </para>
 </abstract>
 <!-- end boilerplate -->
 
 <!--   ~~~~~       New section      ~~~~~     -->
-<sect1 id="importantchanges" ><title>IMPORTANT CHANGES</title>
-<para>
-Privoxy development is between releases. The current sources are development
-quality. If you find problems please report them to the developers.
-</para>
-<para>
- August 2008, Privoxy 3.0.10 is released! There are not any major new
- features, but many improvements and refinements. As usual there are changes
- that effect the configuration. See the "ChangeLog", and the "What's New"
- section and the "Upgrader's Notes" in <citetitle>the User Manual</citetitle>
- for details and specifics. 
-</para>
-<para>
- June 2008, Privoxy 3.0.9 beta is released. There are no major new
- features, but many improvements and refinements. 
-</para>
+<sect1 id="changes" ><title>CHANGES</title>
 <para>
- NEWS! January 2008, Privoxy 3.0.8 stable is released. This is a significant
- upgrade with many new and enhanced features, and many bugs fixed. All Privoxy
- users are encouraged to upgrade. See the "ChangeLog", and the "What's New"
- section and the "Upgrader's Notes" in <citetitle>the User Manual</citetitle>
- for details and specifics. There are changes related to configuration, so
- anyone upgrading and keeping their old configuration should read ahead
- first.
-</para>
-<para>
-  December 2007, Privoxy 3.0.7 is released. This is a beta release in
-  preparation for the forthcoming 3.0.8 release.
+ For a list of changes in this release, please have a
+ look at the "ChangeLog", the "What's New" section or
+ the "Upgrader's Notes" in <citetitle>the User Manual</citetitle>.
 </para>
+
 </sect1>
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="install" ><title>INSTALL</title>
-<para> 
+<para>
  See the <filename>INSTALL</filename> file in this directory, for installing
  from raw source, and the <citetitle>User Manual</citetitle>, for all other
- installation types. 
+ installation types.
 </para>
 </sect1>
 
@@ -174,7 +150,7 @@ quality. If you find problems please report them to the developers.
  HOSTNAME ][config_file]
 </para>
 <para>
- See the man page or <citetitle>User Manual</citetitle> for an explanation of each option, and 
+ See the man page or <citetitle>User Manual</citetitle> for an explanation of each option, and
  other configuration and usage issues.
 </para>
 <para>
@@ -182,12 +158,6 @@ quality. If you find problems please report them to the developers.
  file named 'config' in the current directory (except Win32 which will look
  for 'config.txt'). If no config_file is found, Privoxy will fail to start.
 </para>
-<para>
- Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start
-</para>
-<para>
- Or Debian and Ubuntu: /etc/init.d/privoxy start
-</para>
 </sect1>
 
 <!--   ~~~~~       New section      ~~~~~     -->
@@ -201,12 +171,12 @@ quality. If you find problems please report them to the developers.
  /etc/privoxy.  On Windows, then wherever the executable itself is installed.
  There are many significant changes and advances from earlier versions. The
  <citetitle>User Manual</citetitle> has an explanation of all configuration
- options, and examples: http://www.privoxy.org/user-manual/.
+ options, and examples: https://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. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it 
+ 127.0.0.1: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>
@@ -225,10 +195,10 @@ quality. If you find problems please report them to the developers.
 <sect1 id="documentation"><title>DOCUMENTATION</title>
 <para>
  There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
- may not be completed at this point]]>. In particular, see the 
+ may not be completed at this point]]>. In particular, see the
  <citetitle>User Manual</citetitle> there,
  the <citetitle>FAQ</citetitle>, and those interested in Privoxy development, should look at
- <citetitle>developer-manual</citetitle>. 
+ <citetitle>developer-manual</citetitle>.
 </para>
 <para>
  <![%p-not-stable;[
@@ -236,12 +206,12 @@ quality. If you find problems please report them to the developers.
  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 top-level source directory]]>. 
+ 'default.filter'<![%p-not-stable;[ in the top-level source directory]]>.
 </para>
 
 <para>
- 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, 
+ Included documentation may vary according to platform and packager. All
+ documentation is posted on https://www.privoxy.org, in case you don't have it,
  or can't find it.
 </para>
 </sect1>
@@ -253,14 +223,4 @@ quality. If you find problems please report them to the developers.
 <!-- end boilerplate -->
 </sect1>
 
-<!-- <para> -->
-<!--  <LiteralLayout> -->
-<!--  ------------------------------------------------------------------------- -->
-<!--  ijbswa-developers@lists.sourceforge.net -->
-<!-- </LiteralLayout> -->
-<!-- </para> -->
-<!-- <para> -->
-<!--  $Id: readme.sgml,v 2.21 2008/08/22 00:44:58 hal9 Exp $ -->
-<!-- </para> -->
-
 </article>