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.11">
   8 <!entity p-status "stable">
   9 <!entity % p-not-stable "IGNORE">
  10 <!entity % p-stable "INCLUDE">
  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.23 2009/02/16 03:22:01 hal9 Exp $
  21
  22  Copyright (C) 2001-2009 Privoxy Developers http://www.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-2009  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  February 2009, Privoxy 3.0.11 is released.
 132 </para>
 133 <para>
 134  As usual there are changes that effect the configuration. See the "ChangeLog",
 135  and the "What's New" section and the "Upgrader's Notes" in
 136  <citetitle>the User Manual</citetitle> for details and specifics.
 137 </para>
 138 <para>
 139  This is a stable release, and marks a departure for Privoxy development.
 140 </para>
 141 <para>
 142  Previously, odd numbered releases were considered beta versions and
 143  were only released at the end of the development cycle when the code
 144  was already believed to be stable. Usually it was, so the stable release
 145  contained pretty much the same code, but got a higher version number.
 146  In the future we intend to release several snapshots between stable releases.
 147  There will probably still be about two stable releases per year,
 148  but hopefully about six snapshots instead of the two betas we have now.
 149  The intentions is to make testing without CVS access easier.
 150 </para>
 151 </sect1>
 152
 153 <!--   ~~~~~       New section      ~~~~~     -->
 154 <sect1 id="install" ><title>INSTALL</title>
 155 <para>
 156  See the <filename>INSTALL</filename> file in this directory, for installing
 157  from raw source, and the <citetitle>User Manual</citetitle>, for all other
 158  installation types.
 159 </para>
 160 </sect1>
 161
 162 <!--   ~~~~~       New section      ~~~~~     -->
 163 <sect1 id="run"><title>RUN</title>
 164 <para>
 165  privoxy [--help] [--version]
 166  [--no-daemon] [--pidfile PIDFILE] [--user USER[.GROUP]] [--chroot]  [--pre-chroot-nslookup
 167  HOSTNAME ][config_file]
 168 </para>
 169 <para>
 170  See the man page or <citetitle>User Manual</citetitle> for an explanation of each option, and
 171  other configuration and usage issues.
 172 </para>
 173 <para>
 174  If no config_file is specified on the command line, Privoxy will look for a
 175  file named 'config' in the current directory (except Win32 which will look
 176  for 'config.txt'). If no config_file is found, Privoxy will fail to start.
 177 </para>
 178 <para>
 179  Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start
 180 </para>
 181 <para>
 182  Or Debian and Ubuntu: /etc/init.d/privoxy start
 183 </para>
 184 </sect1>
 185
 186 <!--   ~~~~~       New section      ~~~~~     -->
 187 <sect1 id="configuration"><title>CONFIGURATION</title>
 188 <para>
 189  See: 'config', 'default.action', 'user.action', 'default.filter', and
 190  'user.filter'. 'user.action' and 'user.filter' are for personal and local
 191  configuration preferences. These are all well commented. Most of the magic is
 192  in '*.action' files. 'user.action' should be used for any actions
 193  customizations. On Unix-like systems, these files are typically installed in
 194  /etc/privoxy.  On Windows, then wherever the executable itself is installed.
 195  There are many significant changes and advances from earlier versions. The
 196  <citetitle>User Manual</citetitle> has an explanation of all configuration
 197  options, and examples: http://www.privoxy.org/user-manual/.
 198 </para>
 199 <para>
 200  Be sure to set your browser(s) for HTTP/HTTPS Proxy at &lt;IP&gt;:&lt;Port&gt;, or
 201  whatever you specify in the config file under 'listen-address'. DEFAULT is
 202  localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
 203  with FTP or other protocols for the simple reason it does not work.
 204 </para>
 205 <para>
 206  The actions list can be configured via the web interface accessed via
 207  http://p.p/, as well other options.
 208 </para>
 209 <![%p-not-stable;[
 210 <para>
 211  All configuration files are subject to unannounced changes during the
 212  development process.
 213 </para>
 214 ]]>
 215 </sect1>
 216
 217 <!--   ~~~~~       New section      ~~~~~     -->
 218 <sect1 id="documentation"><title>DOCUMENTATION</title>
 219 <para>
 220  There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
 221  may not be completed at this point]]>. In particular, see the
 222  <citetitle>User Manual</citetitle> there,
 223  the <citetitle>FAQ</citetitle>, and those interested in Privoxy development, should look at
 224  <citetitle>developer-manual</citetitle>.
 225 </para>
 226 <para>
 227  <![%p-not-stable;[
 228  The most up to date source of information on the current development version,
 229  may still be either comments in the source code, or the included
 230  configuration files. ]]>The source and configuration files are all well
 231  commented. The main configuration files are: 'config', 'default.action', and
 232  'default.filter'<![%p-not-stable;[ in the top-level source directory]]>.
 233 </para>
 234
 235 <para>
 236  Included documentation may vary according to platform and packager. All
 237  documentation is posted on http://www.privoxy.org, in case you don't have it,
 238  or can't find it.
 239 </para>
 240 </sect1>
 241
 242 <!--   ~~~~~       New section      ~~~~~     -->
 243 <sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
 244 <!-- Include contacting.sgml boilerplate: -->
 245   &contacting;
 246 <!-- end boilerplate -->
 247 </sect1>
 248
 249 <!-- <para> -->
 250 <!--  <LiteralLayout> -->
 251 <!--  ------------------------------------------------------------------------- -->
 252 <!--  ijbswa-developers@lists.sourceforge.net -->
 253 <!-- </LiteralLayout> -->
 254 <!-- </para> -->
 255 <!-- <para> -->
 256 <!--  $Id: readme.sgml,v 2.23 2009/02/16 03:22:01 hal9 Exp $ -->
 257 <!-- </para> -->
 258
 259 </article>