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