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