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