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.7">
   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.13 2007/12/09 17:42:02 hal9 Exp $
  21
  22  Copyright (C) 2001-2007 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-2007  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  Privoxy is being readied for the forthcoming stable release, 3.0.8. Please
 132  take the time to pass on any problems to the developers.
 133 </para>
 134 <para>
 135  December 2007, Privoxy 3.0.7 beta is released. This is a significant upgrade
 136  with many new and enhanced features, and many bugs fixed.
 137  See the "ChangeLog", and the "What's New" section and the "Upgrader's Notes"
 138  in <citetitle>the User Manual</citetitle> for details and specifics. There
 139  are changes related to configuration, so anyone upgrading and keeping their
 140  old configuration should read ahead first.
 141 </para>
 142 <para>
 143  NEWS! November 2006, Privoxy 3.0.6 stable is released. This is a significant
 144  upgrade with many new and enhanced features, and many bugs fixed.
 145 </para>
 146 <para>
 147  There was and will not be an official 3.0.4 release. This release cycle
 148  was used to gather our thoughts, play with some new ideas and refine
 149  some old ones. It will remain a development cycle with no actual release.
 150  3.0.5 is the fruit of these efforts.
 151 </para>
 152 </sect1>
 153
 154 <!--   ~~~~~       New section      ~~~~~     -->
 155 <sect1 id="install" ><title>INSTALL</title>
 156 <para>
 157  See the <filename>INSTALL</filename> file in this directory, for installing
 158  from raw source, and the <citetitle>User Manual</citetitle>, for all other
 159  installation types.
 160 </para>
 161 </sect1>
 162
 163 <!--   ~~~~~       New section      ~~~~~     -->
 164 <sect1 id="run"><title>RUN</title>
 165 <para>
 166  privoxy [--help] [--version]
 167  [--no-daemon] [--pidfile PIDFILE] [--user USER[.GROUP]] [--chroot]  [--pre-chroot-nslookup
 168  HOSTNAME ][config_file]
 169 </para>
 170 <para>
 171  See the man page or <citetitle>User Manual</citetitle> for an explanation of each option, and
 172  other configuration and usage issues.
 173 </para>
 174 <para>
 175  If no config_file is specified on the command line, Privoxy will look for a
 176  file named 'config' in the current directory (except Win32 which will look
 177  for 'config.txt'). If no config_file is found, Privoxy will fail to start.
 178 </para>
 179 <para>
 180  Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start
 181 </para>
 182 <para>
 183  Or Debian: /etc/init.d/privoxy start
 184 </para>
 185 </sect1>
 186
 187 <!--   ~~~~~       New section      ~~~~~     -->
 188 <sect1 id="configuration"><title>CONFIGURATION</title>
 189 <para>
 190  See: 'config', 'default.action', 'user.action', 'default.filter', and
 191  'user.filter'. 'user.action' and 'user.filter' are for personal and local
 192  configuration preferences. These are all well commented. Most of the magic is
 193  in '*.action' files. 'user.action' should be used for any actions
 194  customizations. On Unix-like systems, these files are typically installed in
 195  /etc/privoxy.  On Windows, then wherever the executable itself is installed.
 196  There are many significant changes and advances from earlier versions. The
 197  <citetitle>User Manual</citetitle> has an explanation of all configuration
 198  options, and examples: http://www.privoxy.org/user-manual/.
 199 </para>
 200 <para>
 201  Be sure to set your browser(s) for HTTP/HTTPS Proxy at &lt;IP&gt;:&lt;Port&gt;, or
 202  whatever you specify in the config file under 'listen-address'. DEFAULT is
 203  localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
 204  with FTP or other protocols for the simple reason it does not work.
 205 </para>
 206 <para>
 207  The actions list can be configured via the web interface accessed via
 208  http://p.p/, as well other options.
 209 </para>
 210 <![%p-not-stable;[
 211 <para>
 212  All configuration files are subject to unannounced changes during the
 213  development process.
 214 </para>
 215 ]]>
 216 </sect1>
 217
 218 <!--   ~~~~~       New section      ~~~~~     -->
 219 <sect1 id="documentation"><title>DOCUMENTATION</title>
 220 <para>
 221  There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
 222  may not be completed at this point]]>. In particular, see the
 223  <citetitle>User Manual</citetitle> there,
 224  the <citetitle>FAQ</citetitle>, and those interested in Privoxy development, should look at
 225  <citetitle>developer-manual</citetitle>.
 226 </para>
 227 <para>
 228  <![%p-not-stable;[
 229  The most up to date source of information on the current development version,
 230  may still be either comments in the source code, or the included
 231  configuration files. ]]>The source and configuration files are all well
 232  commented. The main configuration files are: 'config', 'default.action', and
 233  'default.filter'<![%p-not-stable;[ in the top-level source directory]]>.
 234 </para>
 235
 236 <para>
 237  Included documentation may vary according to platform and packager. All
 238  documentation is posted on http://www.privoxy.org, in case you don't have it,
 239  or can't find it.
 240 </para>
 241 </sect1>
 242
 243 <!--   ~~~~~       New section      ~~~~~     -->
 244 <sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
 245 <!-- Include contacting.sgml boilerplate: -->
 246   &contacting;
 247 <!-- end boilerplate -->
 248 </sect1>
 249
 250 <!-- <para> -->
 251 <!--  <LiteralLayout> -->
 252 <!--  ------------------------------------------------------------------------- -->
 253 <!--  ijbswa-developers@lists.sourceforge.net -->
 254 <!-- </LiteralLayout> -->
 255 <!-- </para> -->
 256 <!-- <para> -->
 257 <!--  $Id: readme.sgml,v 2.13 2007/12/09 17:42:02 hal9 Exp $ -->
 258 <!-- </para> -->
 259
 260 </article>