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