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