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.16">
   8 <!entity p-status "UNRELEASED">
   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.32 2009/10/10 05:52:55 fabiankeil 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
  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  October 2009, Privoxy 3.0.15 beta is released.
 132 </para>
 133 <para>
 134  This is a bugfix-release for the previous betas which introduced IPv6
 135  support, improved keep-alive support and a bunch of minor improvements.
 136  See the "ChangeLog", and the "What's New" section and the
 137  "Upgrader's Notes" in <citetitle>the User Manual</citetitle> for details.
 138 </para>
 139
 140 <para>
 141  Depending on the feedback it will be either followed by yet another
 142  beta release, or by a stable release with the same feature set.
 143 </para>
 144 </sect1>
 145
 146 <!--   ~~~~~       New section      ~~~~~     -->
 147 <sect1 id="install" ><title>INSTALL</title>
 148 <para>
 149  See the <filename>INSTALL</filename> file in this directory, for installing
 150  from raw source, and the <citetitle>User Manual</citetitle>, for all other
 151  installation types.
 152 </para>
 153 </sect1>
 154
 155 <!--   ~~~~~       New section      ~~~~~     -->
 156 <sect1 id="run"><title>RUN</title>
 157 <para>
 158  privoxy [--help] [--version]
 159  [--no-daemon] [--pidfile PIDFILE] [--user USER[.GROUP]] [--chroot]  [--pre-chroot-nslookup
 160  HOSTNAME ][config_file]
 161 </para>
 162 <para>
 163  See the man page or <citetitle>User Manual</citetitle> for an explanation of each option, and
 164  other configuration and usage issues.
 165 </para>
 166 <para>
 167  If no config_file is specified on the command line, Privoxy will look for a
 168  file named 'config' in the current directory (except Win32 which will look
 169  for 'config.txt'). If no config_file is found, Privoxy will fail to start.
 170 </para>
 171 <para>
 172  Or Debian and Ubuntu: /etc/init.d/privoxy start
 173 </para>
 174 </sect1>
 175
 176 <!--   ~~~~~       New section      ~~~~~     -->
 177 <sect1 id="configuration"><title>CONFIGURATION</title>
 178 <para>
 179  See: 'config', 'default.action', 'user.action', 'default.filter', and
 180  'user.filter'. 'user.action' and 'user.filter' are for personal and local
 181  configuration preferences. These are all well commented. Most of the magic is
 182  in '*.action' files. 'user.action' should be used for any actions
 183  customizations. On Unix-like systems, these files are typically installed in
 184  /etc/privoxy.  On Windows, then wherever the executable itself is installed.
 185  There are many significant changes and advances from earlier versions. The
 186  <citetitle>User Manual</citetitle> has an explanation of all configuration
 187  options, and examples: http://www.privoxy.org/user-manual/.
 188 </para>
 189 <para>
 190  Be sure to set your browser(s) for HTTP/HTTPS Proxy at &lt;IP&gt;:&lt;Port&gt;, or
 191  whatever you specify in the config file under 'listen-address'. DEFAULT is
 192  localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
 193  with FTP or other protocols for the simple reason it does not work.
 194 </para>
 195 <para>
 196  The actions list can be configured via the web interface accessed via
 197  http://p.p/, as well other options.
 198 </para>
 199 <![%p-not-stable;[
 200 <para>
 201  All configuration files are subject to unannounced changes during the
 202  development process.
 203 </para>
 204 ]]>
 205 </sect1>
 206
 207 <!--   ~~~~~       New section      ~~~~~     -->
 208 <sect1 id="documentation"><title>DOCUMENTATION</title>
 209 <para>
 210  There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
 211  may not be completed at this point]]>. In particular, see the
 212  <citetitle>User Manual</citetitle> there,
 213  the <citetitle>FAQ</citetitle>, and those interested in Privoxy development, should look at
 214  <citetitle>developer-manual</citetitle>.
 215 </para>
 216 <para>
 217  <![%p-not-stable;[
 218  The most up to date source of information on the current development version,
 219  may still be either comments in the source code, or the included
 220  configuration files. ]]>The source and configuration files are all well
 221  commented. The main configuration files are: 'config', 'default.action', and
 222  'default.filter'<![%p-not-stable;[ in the top-level source directory]]>.
 223 </para>
 224
 225 <para>
 226  Included documentation may vary according to platform and packager. All
 227  documentation is posted on http://www.privoxy.org, in case you don't have it,
 228  or can't find it.
 229 </para>
 230 </sect1>
 231
 232 <!--   ~~~~~       New section      ~~~~~     -->
 233 <sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
 234 <!-- Include contacting.sgml boilerplate: -->
 235   &contacting;
 236 <!-- end boilerplate -->
 237 </sect1>
 238
 239 <!-- <para> -->
 240 <!--  <LiteralLayout> -->
 241 <!--  ------------------------------------------------------------------------- -->
 242 <!--  ijbswa-developers@lists.sourceforge.net -->
 243 <!-- </LiteralLayout> -->
 244 <!-- </para> -->
 245 <!-- <para> -->
 246 <!--  $Id: readme.sgml,v 2.32 2009/10/10 05:52:55 fabiankeil Exp $ -->
 247 <!-- </para> -->
 248
 249 </article>