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