projects / privoxy.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Added debian-dist and debian-upload targets. Also documented usage.
[privoxy.git] / doc / source / readme.sgml
diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml
index c795c1d..0970d42 100644 (file)
--- a/doc/source/readme.sgml
+++ b/doc/source/readme.sgml
@@ -1,35 +1,65 @@
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-<!entity % dummy "INCLUDE"> 
+<!entity % dummy "IGNORE"> 
 <!entity supported SYSTEM "supported.sgml">
 <!entity supported SYSTEM "supported.sgml">
-<!entity newfeatures SYSTEM "newfeatures.sgml">
 <!entity p-intro SYSTEM "privoxy.sgml">
 <!entity p-intro SYSTEM "privoxy.sgml">
-<!entity seealso SYSTEM "seealso.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-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     -->
 ]>
 <!--
  File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
 
  Purpose     :  README for Privoxy
                 
 ]>
 <!--
  File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
 
  Purpose     :  README for Privoxy
                 
- $Id: readme.sgml,v 1.0 2002/04/03 03:53:43 hal9 Exp $
+ $Id: readme.sgml,v 1.15 2002/05/05 17:35:32 hal9 Exp $
 
 
- Written by and Copyright (C) 2001 the SourceForge
- Privoxy team. http://www.privoxy.org/
+ Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
+ See LICENSE.
 
 
- Based on the Internet Junkbuster originally written
- 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 
+ 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 
  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:
+
+ ======================================================================
+ 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. 
+ ======================================================================
+
+ 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">
 <article id="index">
-
+<artheader>
 <![%dummy;[
  <para>
  <comment>
 <![%dummy;[
  <para>
  <comment>
@@ -39,15 +69,14 @@
  </comment>
  </para>
 ]]>
  </comment>
  </para>
 ]]>
-
+<abstract>
 <para>
  <literal>
   <msgtext>
    <literallayout>
 <para>
  <literal>
   <msgtext>
    <literallayout>
-
 /*********************************************************************
  *
 /*********************************************************************
  *
- * File        :  $Source: /cvsroot/ijbswa/current/README,v $
+ * File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
  *
  * Purpose     :  README file to give a short intro.
  *
  *
  * Purpose     :  README file to give a short intro.
  *
@@ -77,29 +106,27 @@
  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  *
  *********************************************************************/
  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  *
  *********************************************************************/
-   </literallayout>
-  </msgtext>
- </literal>
+</literallayout>
+</msgtext>
+</literal>
 </para>
 
 <para>
 </para>
 
 <para>
- This README is included with the development version of Privoxy, which will
- eventually become Privoxy v3.0 (and soon we hope!). See
- http://www.privoxy.org/. The current code level is BETA, and seems stable to
- us :)
+ <!-- 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.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>
 </para>
+</abstract>
+</artheader>
 
 
-<!--
- Include privoxy.sgml
--->
+<!-- Include privoxy.sgml boilerplate: -->
 &p-intro;
 &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
 <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
@@ -110,68 +137,28 @@
  the new package will delete any previously installed 'Junkbuster' packages.
 </para>
 <para>
  the new package will delete any previously installed 'Junkbuster' packages.
 </para>
 <para>
- IMPORTANT! READ! Configuration Change as of 3 Apr 2002: The default listening
+ IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
  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>
  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>
-<para>
- For tarball, first unpack:
-</para>
-
-<programlisting>
- tar xzvf privoxy-2.9.13-beta-src.tar.gz
- cd privoxy-2.9.13-beta
-</programlisting>
-
-<programlisting>
- autoheader
- autoconf
- ./configure   (--help to see options)
- gmake         (the make from gnu) 
- su 
- make -n install       (to see where all the files will go)
- make install          (to really install)
-</programlisting>
-
-<para>
- Redhat and SuSE src and binary RPMs can be built with 'make redhat-dist' or
- 'make suse-dist' (run ./configure first) from unpacked sources. BSD will
- (probably?) require gmake (from http://gnu.org). See the user-manual for OS/2
- build instructions.
-</para>
-<para>
- Privoxy is also available via anonymous CVS:
-</para>
-
-<programlisting>
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
-</programlisting>
-<para>
- This will create a directory named 'current'. Then, 'cd current', and then
- build as above.
-</para>
-
-<para>
- <LiteralLayout>
-
- RUN
----- </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>
 <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>
 </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
 </para>
 <para>
  If no config_file is specified on the command line, Privoxy will look for a
@@ -184,22 +171,19 @@ See the man page or user-manual for a brief explanation of each option.
 <para>
  Or for SuSE:   /etc/rc.d/privoxy start
 </para>
 <para>
  Or for SuSE:   /etc/rc.d/privoxy start
 </para>
+</sect1>
 
 
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="configuration"><title>CONFIGURATION</title>
 <para>
 <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
 </para>
 <para>
  Be sure to set your browser(s) for HTTP/HTTPS Proxy at &lt;IP&gt;:&lt;Port&gt;, or
@@ -207,99 +191,54 @@ See the man page or user-manual for a brief explanation of each option.
  localhost:8118.
 </para>
 <para>
  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>
  http://p.p/, as well other options.
 </para>
+<![%p-not-stable;[
 <para>
  All configuration files are subject to unannounced changes during the
  development process.
 </para>
 <para>
  All configuration files are subject to unannounced changes during the
  development process.
 </para>
+]]>
+</sect1>
 
 
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="documentation"><title>DOCUMENTATION</title>
 <para>
 <para>
- <LiteralLayout>
-
- DOCUMENTATION
---------------</LiteralLayout>
- There is a growing amount of documentation in the 'doc' subdirectory, but it
- is not completed at this point. In particular, see the user-manual there, the
- faq, and developers should look at developer-manual.
+ 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
+ developer-manual. 
 </para>
 <para>
 </para>
 <para>
+ <![%p-not-stable;[
  The most up to date source of information on the current development version,
  may still be either comments in the source code, or the included
  The most up to date source of information on the current development version,
  may still be either comments in the source code, or the included
- configuration files, which are all well commented. These are 'config',
- '*.action', and 'default.filter' in the toplevel source directory.
+ 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]]>. 
 </para>
 
 <para>
  Included documentation may vary according to platform and packager.
 </para>
 </para>
 
 <para>
  Included documentation may vary according to platform and packager.
 </para>
-
-<para>
- <LiteralLayout>
-
- CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
---------------------------------------------------------------</LiteralLayout>
-</para>
-
-<para>
-We value your feedback. However, to provide you with the best support,
-please note:
-</para>
-<para>
- <LiteralLayout>
- * Use the support forum to get help:
-   http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118
-  </LiteralLayout>
-</para>
-<Para>
- <LiteralLayout>
- * Submit bugs only thru our bug forum:
-   http://sourceforge.net/tracker/?group_id=11118&#38;atid=111118 
- </LiteralLayout>
-</Para>
-<para>
-   Make sure that the bug has not already been submitted. Please try
-   to verify that it is a Privoxy bug, and not a browser or site
-   bug first. If you are using your own custom configuration, please
-   try the stock configs to see if the problem is a configuration
-   related bug. And if not using the latest development snapshot,
-   please try the latest one. Or even better, CVS sources. Please 
-   be sure to include the Privoxy/Junkbuster version, platform, 
-   browser, any pertinent log data, any other relevant details 
-   (please be specific) and, if possible, some way to reproduce the 
-   bug.
-</para>
-<para>
- <LiteralLayout>
- * Submit feature requests only thru our feature request forum:
-   http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118&#38;func=browse
- </LiteralLayout>
-</para>
-
-<para>
- <LiteralLayout>
- For any other issues, feel free to use the mailing lists:
- http://sourceforge.net/mail/?group_id=11118 
- </LiteralLayout>
-</para>
-
-<para>   
- <LiteralLayout>
- Anyone interested in actively participating in development and related
- discussions can join the appropriate mailing list here:
- http://sourceforge.net/mail/?group_id=11118. Archives are available here
- too.
- </LiteralLayout>
-</para>
-<para>
- <LiteralLayout>
- -------------------------------------------------------------------------
- ijbswa-developers@lists.sourceforge.net
- </LiteralLayout>
-</para>
-<para>
- $Id: readme.sgml,v 1.0 2002/03/31 02:03:36 hal9 Exp $
-</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
+<!-- Include contacting.sgml boilerplate: -->
+  &contacting;
+<!-- end boilerplate -->
+</sect1>
+
+<!-- <para> -->
+<!--  <LiteralLayout> -->
+<!--  ------------------------------------------------------------------------- -->
+<!--  ijbswa-developers@lists.sourceforge.net -->
+<!-- </LiteralLayout> -->
+<!-- </para> -->
+<!-- <para> -->
+<!--  $Id: readme.sgml,v 1.15 2002/05/05 17:35:32 hal9 Exp $ -->
+<!-- </para> -->
 
 </article>
 
 </article>
The official Privoxy git repository