<!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-status "BETA">
-<!entity % p-not-stable "INCLUDE"> <!-- set to IGNORE for stable release -->
-<!entity % p-stable "IGNORE"> <!-- set INCLUDE for stable release -->
+<!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 -->
Purpose : README for Privoxy
- $Id: readme.sgml,v 1.1 2002/04/03 06:01:41 hal9 Exp $
+ $Id: readme.sgml,v 1.19 2002/07/25 21:51:25 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.
+ ========================================================================
===================================================================
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.
+ 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 % not-stable "IGNORE"
-
- in the DTD at the top. This will toggle various text 'off'. BOTH
- MUST be toggled in this case.
-
-->
-
<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>
<!-- 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>
+ Privoxy &p-version;<![%p-not-stable;[, which will eventually become Privoxy v3.2]]><![%p-beta;[ (and soon we hope!)]]>.
+ See http://www.privoxy.org/ for more information. The current code
+ level is &p-status;<![%p-beta;[, but seems stable to us :)]]><![%p-alpha;[,
+ and may break in mysterious ways :) There may be features only partially
+ implemented, or worse, not functional. If you are interested in participating
+ in Privoxy development, please see the Links at the bottom of this page]]>.
+ </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>
+ privoxy [——help] [——version]
+ [——no-daemon] [——pidfile PIDFILE] [——user
+ USER[.GROUP]] [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 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
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 based distributions: /etc/rc.d/init.d/privoxy start
</para>
<para>
Or for SuSE: /etc/rc.d/privoxy start
</para>
-
<para>
- <LiteralLayout>
-
- CONFIGURATION
--------------- </LiteralLayout>
+ Or Debian: /etc/init.d/privoxy start
</para>
+</sect1>
+
+<!-- ~~~~~ New section ~~~~~ -->
+<sect1 id="configuration"><title>CONFIGURATION</title>
<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 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 <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;[
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 not be in sync with current code]]>. 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
+ may 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.1 2002/04/03 06:01:41 hal9 Exp $
-</para>
+</sect1>
+
+<!-- <para> -->
+<!-- <LiteralLayout> -->
+<!-- ------------------------------------------------------------------------- -->
+<!-- ijbswa-developers@lists.sourceforge.net -->
+<!-- </LiteralLayout> -->
+<!-- </para> -->
+<!-- <para> -->
+<!-- $Id: readme.sgml,v 1.19 2002/07/25 21:51:25 hal9 Exp $ -->
+<!-- </para> -->
</article>
projects / privoxy.git / blobdiff