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 "2.9.20">
   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 1.16.2.2 2002/07/25 21:49:52 hal9 Exp $
  21
  22  Copyright (C) 2001, 2002 Privoxy Developers <developers@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 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., 59
 106  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 107  *
 108  *********************************************************************/
 109 </literallayout>
 110 </msgtext>
 111 </literal>
 112 </para>
 113
 114 <para>
 115  <!-- include some conditional text -->
 116  This README is included with <![%p-not-stable;[ the development version of]]>
 117  Privoxy &p-version;<![%p-not-stable;[, which will eventually become Privoxy v3.0 (and soon we
 118  hope!)]]>. See http://www.privoxy.org/ for more information. The current code
 119  level is &p-status;<![%p-not-stable;[, and 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 <![%p-stable;[
 131 <para>
 132  REALLY BIG NEWS! The long-awaited, oft-delayed  stable version
 133  of Privoxy 3.0 is finally released! This is way behind schedule,
 134  but better late than never. The developers all hope the wait was worth it.
 135 </para>
 136 ]]>
 137 <para>
 138  NEWS! As of 03/24/02, the name of this project has been changed from
 139  ijbswa/Junkbuster to Privoxy. This is reflected in many of the included
 140  files.
 141 </para>
 142 <para>
 143  WARNING! If upgrading from earlier versions of this project via RPM packages,
 144  the new package will delete any previously installed 'Junkbuster' packages.
 145 </para>
 146 <para>
 147  IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
 148  port is now 8118 due to conflicts with port 8000 assignment. You will need to
 149  change your browser if upgrading!!! And maybe firewall, etc.
 150 </para>
 151 </sect1>
 152
 153 <!--   ~~~~~       New section      ~~~~~     -->
 154 <sect1 id="install" ><title>INSTALL</title>
 155 <!-- include buildsource.sgml boilerplate: -->
 156  &buildsource;
 157 <!-- end boilderplate -->
 158 </sect1>
 159
 160 <!--   ~~~~~       New section      ~~~~~     -->
 161 <sect1 id="run"><title>RUN</title>
 162 <para>
 163  privoxy [&mdash;&mdash;help] [&mdash;&mdash;version]
 164  [&mdash;&mdash;no-daemon] [&mdash;&mdash;pidfile PIDFILE] [&mdash;&mdash;user
 165  USER[.GROUP]] [config_file]
 166 </para>
 167 <para>
 168  See the man page or User Manual for an explanation of each option, and
 169  other configuration and usage issues.
 170 </para>
 171 <para>
 172  If no config_file is specified on the command line, Privoxy will look for a
 173  file named 'config' in the current directory (except Win32 which will look
 174  for 'config.txt'). If no config_file is found, Privoxy will fail to start.
 175 </para>
 176 <para>
 177  Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
 178 </para>
 179 <para>
 180  Or for SuSE:   /etc/rc.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', and 'default.filter'.
 191  'user.action' is for personal and local configuration preferences. These are
 192  all well commented. Most of the magic is in '*.action' files. 'user.action'
 193  should be used for any actions customizations. On Unix-like systems, these
 194  files are installed in /etc/privoxy.  On Windows, then wherever the
 195  executable itself is installed. There are many significant changes and
 196  advances since Junkbuster v2.0.x. The User Manual has an explanation of
 197  all configuration options, and examples: http://www.privoxy.org/user-manual/.
 198 </para>
 199 <para>
 200  Be sure to set your browser(s) for HTTP/HTTPS Proxy at &lt;IP&gt;:&lt;Port&gt;, or
 201  whatever you specify in the config file under 'listen-address'. DEFAULT is
 202  localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
 203  with FTP or other protocols for the simple reason it does not work.
 204 </para>
 205 <para>
 206  The actions list can be configured via the web interface accessed via
 207  http://p.p/, as well other options.
 208 </para>
 209 <![%p-not-stable;[
 210 <para>
 211  All configuration files are subject to unannounced changes during the
 212  development process.
 213 </para>
 214 ]]>
 215 </sect1>
 216
 217 <!--   ~~~~~       New section      ~~~~~     -->
 218 <sect1 id="documentation"><title>DOCUMENTATION</title>
 219 <para>
 220  There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
 221  is not completed at this point]]>. In particular, see the User Manual there,
 222  the FAQ, and those interested in Privoxy development, should look at
 223  developer-manual.
 224 </para>
 225 <para>
 226  <![%p-not-stable;[
 227  The most up to date source of information on the current development version,
 228  may still be either comments in the source code, or the included
 229  configuration files. ]]>The source and configuration files are all well
 230  commented. The main configuration files are: 'config', 'default.action', and
 231  'default.filter'<![%p-not-stable;[ in the toplevel source directory]]>.
 232 </para>
 233
 234 <para>
 235  Included documentation may vary according to platform and packager. All
 236  documentation is posted on http://www.privoxy.org, in case you don't have it,
 237  or can't find it.
 238 </para>
 239 </sect1>
 240
 241 <!--   ~~~~~       New section      ~~~~~     -->
 242 <sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
 243 <!-- Include contacting.sgml boilerplate: -->
 244   &contacting;
 245 <!-- end boilerplate -->
 246 </sect1>
 247
 248 <!-- <para> -->
 249 <!--  <LiteralLayout> -->
 250 <!--  ------------------------------------------------------------------------- -->
 251 <!--  ijbswa-developers@lists.sourceforge.net -->
 252 <!-- </LiteralLayout> -->
 253 <!-- </para> -->
 254 <!-- <para> -->
 255 <!--  $Id: readme.sgml,v 1.16.2.2 2002/07/25 21:49:52 hal9 Exp $ -->
 256 <!-- </para> -->
 257
 258 </article>