-Fix numbering in CONTACT section (was label="")
[privoxy.git] / doc / source / readme.sgml
index 6a3236e..2aef615 100644 (file)
@@ -1,10 +1,10 @@
 <!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-version "2.9.15">
 <!entity p-status "beta">
 <!entity % p-not-stable "INCLUDE">
 <!entity % p-stable "IGNORE">
@@ -17,7 +17,7 @@
 
  Purpose     :  README for Privoxy
                 
- $Id: readme.sgml,v 1.4 2002/04/06 05:07:29 hal9 Exp $
+ $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/
@@ -38,7 +38,7 @@
  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:
@@ -63,9 +63,8 @@
  stable and unstable versions. You only want one or the other!
 
 -->
-
 <article id="index">
-
+<artheader>
 <![%dummy;[
  <para>
  <comment>
  </comment>
  </para>
 ]]>
-
+<abstract>
 <para>
  <literal>
   <msgtext>
    <literallayout>
-
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  *
  *********************************************************************/
-   </literallayout>
-  </msgtext>
- </literal>
+</literallayout>
+</msgtext>
+</literal>
 </para>
 
 <para>
  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>
 
 <!-- Include privoxy.sgml boilerplate: -->
 &p-intro;
 <!-- end boilerplate -->
 
-<para>
- <LiteralLayout>
-
- IMPORTANT CHANGES
-------------------</LiteralLayout>
-</para>
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="importantchanges" ><title>IMPORTANT CHANGES</title>
 <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
  port is now 8118 due to conflicts with port 8000 assignment. You will need to
  change your browser if upgrading!!! And maybe firewall, etc.
 </para>
+</sect1>
 
-<para>
- <LiteralLayout>
-
- INSTALL
---------</LiteralLayout>
-</para>
-
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="install" ><title>INSTALL</title>
 <!-- include buildsource.sgml boilerplate: -->
  &buildsource;
 <!-- end boilderplate -->
+</sect1>
 
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="run"><title>RUN</title>
 <para>
- <LiteralLayout>
-
- RUN
----- </LiteralLayout>
-</para>
-
-<para>
- privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] 
-  [--user USER[.GROUP]] [config_file]
+ privoxy [&mdash;&mdash;help] [&mdash;&mdash;version]
+ [&mdash;&mdash;no-daemon] [&mdash;&mdash;pidfile PIDFILE] [&mdash;&mdash;user
+ USER[.GROUP]] [config_file]
 </para>
 <para>
  See the man page or user-manual for a brief explanation of each option.
 <para>
  Or for SuSE:   /etc/rc.d/privoxy start
 </para>
+</sect1>
 
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="configuration"><title>CONFIGURATION</title>
 <para>
- <LiteralLayout>
-
- CONFIGURATION
--------------- </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
  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;[
  development process.
 </para>
 ]]>
+</sect1>
 
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="documentation"><title>DOCUMENTATION</title>
 <para>
- <LiteralLayout>
-
- DOCUMENTATION
---------------</LiteralLayout>
  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
  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>
  Included documentation may vary according to platform and packager.
 </para>
+</sect1>
 
-<para>
- <LiteralLayout>
-
- CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
---------------------------------------------------------------</LiteralLayout>
-</para>
-
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
 <!-- Include contacting.sgml boilerplate: -->
- &contacting;
 &contacting;
 <!-- end boilerplate -->
-
-<para>
- <LiteralLayout>
- -------------------------------------------------------------------------
- ijbswa-developers@lists.sourceforge.net
- </LiteralLayout>
-</para>
-<para>
- $Id: readme.sgml,v 1.4 2002/04/06 05:07:29 hal9 Exp $
-</para>
+</sect1>
+
+<!-- <para> -->
+<!--  <LiteralLayout> -->
+<!--  ------------------------------------------------------------------------- -->
+<!--  ijbswa-developers@lists.sourceforge.net -->
+<!-- </LiteralLayout> -->
+<!-- </para> -->
+<!-- <para> -->
+<!--  $Id: readme.sgml,v 1.14 2002/05/05 13:46:59 swa Exp $ -->
+<!-- </para> -->
 
 </article>