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