doc/source/readme.sgml

   1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
   2 <!entity % dummy "INCLUDE">
   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.13">
   8 <!entity p-status "BETA">
   9 <!entity % p-not-stable "INCLUDE"> <!-- set to IGNORE for stable release -->
  10 <!entity % p-stable "IGNORE">      <!-- set INCLUDE for stable release   -->
  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.2 2002/04/04 06:48:37 hal9 Exp $
  21
  22  Written by and Copyright (C) 2001 the SourceForge
  23  Privoxy team. http://www.privoxy.org/
  24
  25  Based on the Internet Junkbuster originally written
  26  by and Copyright (C) 1997 Anonymous Coders and
  27  Junkbusters Corporation.  http://www.junkbusters.com
  28
  29  ===================================================================
  30  READ: Document Note: This file generates the README in the top level
  31  source directory. It is generated as only a plain text file. The
  32  current markup is not suitable for other formats. Build from
  33  Makefile with 'make readme'.
  34  ===================================================================
  35
  36  READ:
  37
  38  ======================================================================
  39  NOTE: The left margin spacing is *important* when using 'literallayout'
  40  WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie
  41  the para tag forces a linebreak. Tags need to be carefully placed as a result
  42  to avoid extra blank lines, etc.
  43  ======================================================================
  44
  45  For stable releases, change
  46
  47   entity % p-not-stable "INCLUDE"
  48
  49  to
  50
  51   entity % p-not-stable "IGNORE"
  52
  53  in the DTD at the top. This will toggle various text 'off'. BOTH
  54  MUST be toggled in this case.
  55
  56 -->
  57
  58 <article id="index">
  59
  60 <![%dummy;[
  61  <para>
  62  <comment>
  63   This is here to keep vim syntax file from breaking :/
  64   If I knew enough to fix it, I would.
  65   PLEASE DO NOT REMOVE! HB: hal@foobox.net
  66  </comment>
  67  </para>
  68 ]]>
  69
  70 <para>
  71  <literal>
  72   <msgtext>
  73    <literallayout>
  74
  75 /*********************************************************************
  76  *
  77  * File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
  78  *
  79  * Purpose     :  README file to give a short intro.
  80  *
  81  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
  82  *                Privoxy team. http://www.privoxy.org/
  83  *
  84  *                Based on the Internet Junkbuster originally written
  85  *                by and Copyright (C) 1997 Anonymous Coders and
  86  *                Junkbusters Corporation.  http://www.junkbusters.com
  87  *
  88  *                This program is free software; you can redistribute it
  89  *                and/or modify it under the terms of the GNU General
  90  *                Public License as published by the Free Software
  91  *                Foundation; either version 2 of the License, or (at
  92  *                your option) any later version.
  93  *
  94  *                This program is distributed in the hope that it will
  95  *                be useful, but WITHOUT ANY WARRANTY; without even the
  96  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  97  *                PARTICULAR PURPOSE.  See the GNU General Public
  98  *                License for more details.
  99  *
 100  *                The GNU General Public License should be included with
 101  *                this file.  If not, you can view it at
 102  *                http://www.gnu.org/copyleft/gpl.html
 103  *                or write to the Free Software Foundation, Inc., 59
 104  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 105  *
 106  *********************************************************************/
 107    </literallayout>
 108   </msgtext>
 109  </literal>
 110 </para>
 111
 112 <para>
 113  <!-- include some conditional text -->
 114  This README is included with <![%p-not-stable;[ the development version of]]>
 115  Privoxy &p-version;<![%p-not-stable;[, which will eventually become Privoxy v3.0 (and soon we
 116  hope!)]]>. See http://www.privoxy.org/ for more information. The current code
 117  level is &p-status;<![%p-not-stable;[, and seems stable to us :)]]>.
 118 </para>
 119
 120 <!-- Include privoxy.sgml boilerplate: -->
 121 &p-intro;
 122 <!-- end boilerplate -->
 123
 124 <para>
 125  <LiteralLayout>
 126
 127  IMPORTANT CHANGES
 128 ------------------</LiteralLayout>
 129 </para>
 130 <para>
 131  NEWS! As of 03/24/02, the name of this project has been changed from
 132  ijbswa/Junkbuster to Privoxy. This is reflected in many of the included
 133  files.
 134 </para>
 135 <para>
 136  WARNING! If upgrading from earlier versions of this project via RPM packages,
 137  the new package will delete any previously installed 'Junkbuster' packages.
 138 </para>
 139 <para>
 140  IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
 141  port is now 8118 due to conflicts with port 8000 assignment. You will need to
 142  change your browser if upgrading!!! And maybe firewall, etc.
 143 </para>
 144
 145 <para>
 146  <LiteralLayout>
 147
 148  INSTALL
 149 --------</LiteralLayout>
 150 </para>
 151
 152 <!-- include buildsource.sgml boilerplate: -->
 153  &buildsource;
 154 <!-- end boilderplate -->
 155
 156 <para>
 157  <LiteralLayout>
 158
 159  RUN
 160 ---- </LiteralLayout>
 161 </para>
 162
 163 <para>
 164  privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE]
 165   [--user USER[.GROUP]] [config_file]
 166 </para>
 167 <para>
 168 See the man page or user-manual for a brief explanation of each option.
 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 <para>
 176  Or for Red Hat: /etc/rc.d/init.d/privoxy start
 177 </para>
 178 <para>
 179  Or for SuSE:   /etc/rc.d/privoxy start
 180 </para>
 181
 182 <para>
 183  <LiteralLayout>
 184
 185  CONFIGURATION
 186 -------------- </LiteralLayout>
 187 </para>
 188 <para>
 189  See: 'config', 'default.action', and 'default.filter'. There are several
 190  actions files included. These are all well commented. Most of the magic is in
 191  '*.action', and there are several of these included with varying degrees of
 192  aggressiveness. On Unix-like systems, these files are installed in
 193  /etc/privoxy.  On Windows, then wherever the executable itself is installed.
 194  There are many significant changes and advances since Junkbuster v2.0.x. The
 195  user-manual has a run down of configuration options, and examples:
 196  http://www.privoxy.org/user-manual/.
 197 </para>
 198 <para>
 199  Be sure to set your browser(s) for HTTP/HTTPS Proxy at &lt;IP&gt;:&lt;Port&gt;, or
 200  whatever you specify in the config file under 'listen-address'. DEFAULT is
 201  localhost:8118.
 202 </para>
 203 <para>
 204  The default.action file can be configured via the web interface accessed via
 205  http://p.p/, as well other options.
 206 </para>
 207 <![%p-not-stable;[
 208 <para>
 209  All configuration files are subject to unannounced changes during the
 210  development process.
 211 </para>
 212 ]]>
 213
 214 <para>
 215  <LiteralLayout>
 216
 217  DOCUMENTATION
 218 --------------</LiteralLayout>
 219  There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
 220  is not completed at this point]]>. In particular, see the user-manual there,
 221  the faq, and those interested in Privoxy development, should look at
 222  developer-manual.
 223 </para>
 224 <para>
 225  <![%p-not-stable;[
 226  The most up to date source of information on the current development version,
 227  may still be either comments in the source code, or the included
 228  configuration files. ]]>The source and configuration files are all well
 229  commented. The main configuration files are: 'config', 'default.action', and
 230  'default.filter'<![%p-not-stable;[ in the toplevel source directory]]>. There
 231  are several *.action files included, with varying levels of aggressiveness.
 232 </para>
 233
 234 <para>
 235  Included documentation may vary according to platform and packager.
 236 </para>
 237
 238 <para>
 239  <LiteralLayout>
 240
 241  CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 242 --------------------------------------------------------------</LiteralLayout>
 243 </para>
 244
 245 <!-- Include contacting.sgml boilerplate: -->
 246  &contacting;
 247 <!-- end boilerplate -->
 248
 249 <para>
 250  <LiteralLayout>
 251  -------------------------------------------------------------------------
 252  ijbswa-developers@lists.sourceforge.net
 253  </LiteralLayout>
 254 </para>
 255 <para>
 256  $Id: readme.sgml,v 1.2 2002/04/04 06:48:37 hal9 Exp $
 257 </para>
 258
 259 </article>