<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-<!entity % dummy "INCLUDE">
+<!entity % dummy "IGNORE">
<!entity supported SYSTEM "supported.sgml">
-<!entity newfeatures SYSTEM "newfeatures.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 "3.0.14">
+<!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
- $Id: readme.sgml,v 1.0 2002/04/03 03:53:43 hal9 Exp $
+ $Id: readme.sgml,v 2.29 2009/07/18 16:00:17 fabiankeil Exp $
- Written by and Copyright (C) 2001 the SourceForge
- Privoxy team. http://www.privoxy.org/
+ Copyright (C) 2001-2009 Privoxy Developers http://www.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
- 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">
-
+<artheader>
<![%dummy;[
<para>
<comment>
</comment>
</para>
]]>
-
+<abstract>
<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.
*
- * Copyright : Written by and Copyright (C) 2001 the SourceForge
+ * Copyright : Written by and Copyright (C) 2001-2009 the SourceForge
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
* 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.
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+ * USA
*
*********************************************************************/
- </literallayout>
- </msgtext>
- </literal>
+</literallayout>
+</msgtext>
+</literal>
</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;. See http://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>
+</artheader>
-<!--
- Include privoxy.sgml
--->
+<!-- Include privoxy.sgml boilerplate: -->
&p-intro;
+<!-- end boilerplate -->
+<!-- ~~~~~ New section ~~~~~ -->
+<sect1 id="importantchanges" ><title>IMPORTANT CHANGES</title>
<para>
- <LiteralLayout>
-
- IMPORTANT CHANGES
-------------------</LiteralLayout>
+ July 2009, Privoxy 3.0.14 beta is released.
</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 3 Apr 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.
+ This is a bugfix-release for the previous beta which introduced IPv6
+ support, improved keep-alive support and a bunch of minor improvements.
+ See the "ChangeLog", and the "What's New" section and the
+ "Upgrader's Notes" in <citetitle>the User Manual</citetitle> for details.
</para>
<para>
- <LiteralLayout>
-
- INSTALL
---------</LiteralLayout>
-</para>
-<para>
- For tarball, first unpack:
+ Depending on the feedback it will be either followed by yet another
+ beta release, or by a stable release with the same feature set.
</para>
+</sect1>
-<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.
+<!-- ~~~~~ New section ~~~~~ -->
+<sect1 id="install" ><title>INSTALL</title>
+<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.
</para>
+</sect1>
+<!-- ~~~~~ New section ~~~~~ -->
+<sect1 id="run"><title>RUN</title>
<para>
- <LiteralLayout>
-
- RUN
----- </LiteralLayout>
+ privoxy [--help] [--version]
+ [--no-daemon] [--pidfile PIDFILE] [--user USER[.GROUP]] [--chroot] [--pre-chroot-nslookup
+ HOSTNAME ][config_file]
</para>
-
<para>
- privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE]
- [--user 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 <citetitle>User Manual</citetitle> 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 and Fedora based distributions: /etc/rc.d/init.d/privoxy start
</para>
<para>
- Or for SuSE: /etc/rc.d/privoxy start
+ Or Debian and Ubuntu: /etc/init.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
+ See: 'config', 'default.action', 'user.action', 'default.filter', and
+ 'user.filter'. 'user.action' and 'user.filter' are 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 typically 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/.
+ 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/.
</para>
<para>
Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, 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 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;[
<para>
All configuration files are subject to unannounced changes during the
development process.
</para>
+]]>
+</sect1>
+<!-- ~~~~~ New section ~~~~~ -->
+<sect1 id="documentation"><title>DOCUMENTATION</title>
<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
+ 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>.
</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, which are all well commented. These are 'config',
- '*.action', and 'default.filter' in the toplevel source directory.
-</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&atid=211118
- </LiteralLayout>
-</para>
-<Para>
- <LiteralLayout>
- * Submit bugs only thru our bug forum:
- http://sourceforge.net/tracker/?group_id=11118&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&group_id=11118&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>
+ 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]]>.
+</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 2.29 2009/07/18 16:00:17 fabiankeil Exp $ -->
+<!-- </para> -->
</article>