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