<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!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 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     -->
]>
<!--
 File        :  $Source: /ds6/cvs/privoxy/doc/source/readme.sgml,v $

 Purpose     :  README for Privoxy
                
 $Id: readme.sgml,v 1.1.1.1 2003/05/23 11:17:06 lionel Exp $

 Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
 See LICENSE.

 ========================================================================
 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 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">
<artheader>
<![%dummy;[
 <para>
 <comment>
  This is here to keep vim syntax file from breaking :/
  If I knew enough to fix it, I would.
  PLEASE DO NOT REMOVE! HB: hal@foobox.net
 </comment>
 </para>
]]>
<abstract>
<para>
 <literal>
  <msgtext>
   <literallayout>
/*********************************************************************
 *
 * File        :  $Source: /ds6/cvs/privoxy/doc/source/readme.sgml,v $
 *
 * Purpose     :  README file to give a short intro.
 *
 * Copyright   :  Written by and Copyright (C) 2001,2002 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
 *
 *                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
 *                your option) any later version.
 *
 *                This program is distributed in the hope that it will
 *                be useful, but WITHOUT ANY WARRANTY; without even the
 *                implied warranty of MERCHANTABILITY or FITNESS FOR A
 *                PARTICULAR PURPOSE.  See the GNU General Public
 *                License for more details.
 *
 *                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., 59
 *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 *********************************************************************/
</literallayout>
</msgtext>
</literal>
</para>

<para>
 <!-- include some conditional text -->
 This README is included with <![%p-not-stable;[ the development version of]]>
 Privoxy &p-version;<![%p-not-stable;[, which will someday become Privoxy
 v3.2]]>. See http://www.privoxy.org/ for more information. The current code
 level is technically &p-status;<![%p-not-stable;[, but is not yet
 significantly different from the 3.0.0 stable branch at this time.]]>.
</para>
</abstract>
</artheader>

<!-- Include privoxy.sgml boilerplate: -->
&p-intro;
<!-- end boilerplate -->

<!--   ~~~~~       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
 files. 
</para>
<para>
 WARNING! If upgrading from earlier versions of this project via RPM packages,
 the new package will delete any previously installed 'Junkbuster' packages.
</para>
<para>
 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>
</sect1>

<!--   ~~~~~       New section      ~~~~~     -->
<sect1 id="install" ><title>INSTALL</title>
<!-- Install instructions are now in INSTALL -->
<para>
 See the INSTALL file in this directory, for installing from source, and 
 the User Manual, for other installation types.
</para>
</sect1>

<!--   ~~~~~       New section      ~~~~~     -->
<sect1 id="run"><title>RUN</title>
<para>
 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 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
 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 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 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. 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
 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>
]]>
</sect1>

<!--   ~~~~~       New section      ~~~~~     -->
<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
 developer-manual. 
</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
 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. All 
 documentation is posted on http://www.privoxy.org, in case you don't have it, 
 or can't find it.
</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.1.1.1 2003/05/23 11:17:06 lionel Exp $ -->
<!-- </para> -->

</article>
