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