doc/source/readme.sgml

   1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
   2 <!entity % dummy "IGNORE">
   3 <!entity supported SYSTEM "supported.sgml">
   4 <!entity p-intro SYSTEM "privoxy.sgml">
   5 <!entity contacting SYSTEM "contacting.sgml">
   6 <!entity buildsource SYSTEM "buildsource.sgml">
   7 <!entity p-version "3.0.4">
   8 <!entity p-status "beta">
   9 <!entity % p-not-stable "INCLUDE">
  10 <!entity % p-stable "IGNORE">
  11 <!entity % p-text "INCLUDE">       <!-- define we are a text only doc    -->
  12 <!entity % p-doc "IGNORE">         <!-- and never a text doc             -->
  13 <!entity % p-readme "INCLUDE">     <!-- all your README belong to us     -->
  14 ]>
  15 <!--
  16  File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
  17
  18  Purpose     :  README for Privoxy
  19
  20  $Id: readme.sgml,v 2.6 2006/09/03 14:49:12 hal9 Exp $
  21
  22  Copyright (C) 2001 - 2006 Privoxy Developers <developers@privoxy.org>
  23  See LICENSE.
  24
  25  ========================================================================
  26  NOTE: Please read developer-manual/documentation.html before touching
  27  anything in this, or other Privoxy documentation. You have been warned!
  28  Failure to abide by this rule will result in the revocation of your license
  29  to live a peaceful existence!
  30  ========================================================================
  31
  32  ===================================================================
  33  READ: Document Note: This file generates the README in the top level
  34  source directory. It is generated as only a plain text file. The
  35  current markup is not suitable for other formats. Build from
  36  Makefile with 'make dok-readme'.
  37  ===================================================================
  38
  39  READ:
  40
  41  ======================================================================
  42  NOTE: The left margin spacing is *important* when using 'literallayout'
  43  WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie
  44  the para tag forces a linebreak. Tags need to be carefully placed as a result
  45  to avoid extra blank lines, etc.
  46  ======================================================================
  47
  48  For stable releases, change
  49
  50   entity % p-not-stable "INCLUDE"
  51
  52  to
  53
  54   entity % p-not-stable "IGNORE"
  55
  56  in the DTD at the top. This will toggle various text 'off'. BOTH
  57  MUST be toggled in this case or you will get both text referencing
  58  stable and unstable versions. You only want one or the other!
  59
  60 -->
  61 <article id="index">
  62 <artheader>
  63 <![%dummy;[
  64  <para>
  65  <comment>
  66   This is here to keep vim syntax file from breaking :/
  67   If I knew enough to fix it, I would.
  68   PLEASE DO NOT REMOVE! HB: hal@foobox.net
  69  </comment>
  70  </para>
  71 ]]>
  72 <abstract>
  73 <para>
  74  <literal>
  75   <msgtext>
  76    <literallayout>
  77 /*********************************************************************
  78  *
  79  * File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
  80  *
  81  * Purpose     :  README file to give a short intro.
  82  *
  83  * Copyright   :  Written by and Copyright (C) 2001 - 2006  the SourceForge
  84  *                Privoxy team. http://www.privoxy.org/
  85  *
  86  *                Based on the Internet Junkbuster originally written
  87  *                by and Copyright (C) 1997 Anonymous Coders and
  88  *                Junkbusters Corporation.  http://www.junkbusters.com
  89  *
  90  *                This program is free software; you can redistribute it
  91  *                and/or modify it under the terms of the GNU General
  92  *                Public License as published by the Free Software
  93  *                Foundation; either version 2 of the License, or (at
  94  *                your option) any later version.
  95  *
  96  *                This program is distributed in the hope that it will
  97  *                be useful, but WITHOUT ANY WARRANTY; without even the
  98  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  99  *                PARTICULAR PURPOSE.  See the GNU General Public
 100  *                License for more details.
 101  *
 102  *                The GNU General Public License should be included with
 103  *                this file.  If not, you can view it at
 104  *                http://www.gnu.org/copyleft/gpl.html
 105  *                or write to the Free Software Foundation, Inc.,
 106  *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
 107  *                USA
 108  *
 109  *********************************************************************/
 110 </literallayout>
 111 </msgtext>
 112 </literal>
 113 </para>
 114
 115 <para>
 116  <!-- include some conditional text -->
 117  This README is included with <![%p-not-stable;[ the development version of]]>
 118  Privoxy &p-version;. See http://www.privoxy.org/ for more information. The current code maturity
 119  level is <quote>&p-status;</quote><![%p-not-stable;[, but seems stable to us :)]]>.
 120 </para>
 121 </abstract>
 122 </artheader>
 123
 124 <!-- Include privoxy.sgml boilerplate: -->
 125 &p-intro;
 126 <!-- end boilerplate -->
 127
 128 <!--   ~~~~~       New section      ~~~~~     -->
 129 <sect1 id="importantchanges" ><title>IMPORTANT CHANGES</title>
 130 <para>
 131  BIG NEWS! 2006, Privoxy 3.0.4 is released. This is a significant upgrade
 132  with many new and enhanced features, and many bugs fixed. There
 133  are fifteen new actions available, and several actions have enhanced
 134  capabilities. Multiple filter files are now supported as well. See the "What's
 135  New" section and the "Upgrader's Notes" in <citetitle>the User
 136  Manual</citetitle> for details and specifics.
 137 </para>
 138 <para>
 139  NEWS! January 2004, Privoxy 3.0.3 is released. This is the another
 140  maintenance release of Privoxy which fixes more bugs, further refines
 141  the configuration and works around some known third-party problems. See the
 142  ChangeLog for complete details. Upgrading from 3.0.2 is recommended.
 143 </para>
 144 <para>
 145  NEWS! March 2003, Privoxy 3.0.2 is released. This is the first maintenance
 146  release of Privoxy. There are no significant new features in this release.
 147  Some bugs are fixed, and some existing features have been enhanced. See
 148  ChangeLog for details. Upgrading from 3.0.0 is recommended.
 149 </para>
 150 <para>
 151  REALLY BIG NEWS! August 2002: The long-awaited, oft-delayed  stable version
 152  of Privoxy 3.0 is finally released! This is way behind schedule, but better
 153  late than never. The developers all hope the wait was worth it.
 154 </para>
 155 <para>
 156  NEWS! As of 03/24/02, the name of this project has been changed from
 157  ijbswa/Junkbuster to Privoxy. This is reflected in many of the included
 158  files.
 159 </para>
 160 <para>
 161  IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
 162  port is now 8118 due to conflicts with port 8000 assignment. You will need to
 163  change your browser if upgrading!!! And maybe firewall, etc.
 164 </para>
 165 </sect1>
 166
 167 <!--   ~~~~~       New section      ~~~~~     -->
 168 <sect1 id="install" ><title>INSTALL</title>
 169 <para>
 170  See the <filename>INSTALL</filename> file in this directory, for installing
 171  from raw source, and the <citetitle>User Manual</citetitle>, for all other
 172  installation types.
 173 </para>
 174 </sect1>
 175
 176 <!--   ~~~~~       New section      ~~~~~     -->
 177 <sect1 id="run"><title>RUN</title>
 178 <para>
 179  privoxy [&mdash;&mdash;help] [&mdash;&mdash;version]
 180  [&mdash;&mdash;no-daemon] [&mdash;&mdash;pidfile PIDFILE] [&mdash;&mdash;user
 181  USER[.GROUP]] [&mdash;&mdash;chroot] [config_file]
 182 </para>
 183 <para>
 184  See the man page or <citetitle>User Manual</citetitle> for an explanation of each option, and
 185  other configuration and usage issues.
 186 </para>
 187 <para>
 188  If no config_file is specified on the command line, Privoxy will look for a
 189  file named 'config' in the current directory (except Win32 which will look
 190  for 'config.txt'). If no config_file is found, Privoxy will fail to start.
 191 </para>
 192 <para>
 193  Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
 194 </para>
 195 <para>
 196  Or for SuSE:   /etc/rc.d/privoxy start
 197 </para>
 198 <para>
 199  Or Debian: /etc/init.d/privoxy start
 200 </para>
 201 </sect1>
 202
 203 <!--   ~~~~~       New section      ~~~~~     -->
 204 <sect1 id="configuration"><title>CONFIGURATION</title>
 205 <para>
 206  See: 'config', 'default.action', 'user.action', 'default.filter', and
 207  'user.filter'. 'user.action' and 'user.filter' are for personal and local
 208  configuration preferences. These are all well commented. Most of the magic is
 209  in '*.action' files. 'user.action' should be used for any actions
 210  customizations. On Unix-like systems, these files are installed in
 211  /etc/privoxy.  On Windows, then wherever the executable itself is installed.
 212  There are many significant changes and advances from earlier versions. The
 213  <citetitle>User Manual</citetitle> has an explanation of all configuration
 214  options, and examples: http://www.privoxy.org/user-manual/.
 215 </para>
 216 <para>
 217  Be sure to set your browser(s) for HTTP/HTTPS Proxy at &lt;IP&gt;:&lt;Port&gt;, or
 218  whatever you specify in the config file under 'listen-address'. DEFAULT is
 219  localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
 220  with FTP or other protocols for the simple reason it does not work.
 221 </para>
 222 <para>
 223  The actions list can be configured via the web interface accessed via
 224  http://p.p/, as well other options.
 225 </para>
 226 <![%p-not-stable;[
 227 <para>
 228  All configuration files are subject to unannounced changes during the
 229  development process.
 230 </para>
 231 ]]>
 232 </sect1>
 233
 234 <!--   ~~~~~       New section      ~~~~~     -->
 235 <sect1 id="documentation"><title>DOCUMENTATION</title>
 236 <para>
 237  There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
 238  may not be completed at this point]]>. In particular, see the
 239  <citetitle>User Manual</citetitle> there,
 240  the <citetitle>FAQ</citetitle>, and those interested in Privoxy development, should look at
 241  <citetitle>developer-manual</citetitle>.
 242 </para>
 243 <para>
 244  <![%p-not-stable;[
 245  The most up to date source of information on the current development version,
 246  may still be either comments in the source code, or the included
 247  configuration files. ]]>The source and configuration files are all well
 248  commented. The main configuration files are: 'config', 'default.action', and
 249  'default.filter'<![%p-not-stable;[ in the top-level source directory]]>.
 250 </para>
 251
 252 <para>
 253  Included documentation may vary according to platform and packager. All
 254  documentation is posted on http://www.privoxy.org, in case you don't have it,
 255  or can't find it.
 256 </para>
 257 </sect1>
 258
 259 <!--   ~~~~~       New section      ~~~~~     -->
 260 <sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
 261 <!-- Include contacting.sgml boilerplate: -->
 262   &contacting;
 263 <!-- end boilerplate -->
 264 </sect1>
 265
 266 <!-- <para> -->
 267 <!--  <LiteralLayout> -->
 268 <!--  ------------------------------------------------------------------------- -->
 269 <!--  ijbswa-developers@lists.sourceforge.net -->
 270 <!-- </LiteralLayout> -->
 271 <!-- </para> -->
 272 <!-- <para> -->
 273 <!--  $Id: readme.sgml,v 2.6 2006/09/03 14:49:12 hal9 Exp $ -->
 274 <!-- </para> -->
 275
 276 </article>