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