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 newfeatures SYSTEM "newfeatures.sgml">
   5 <!entity p-intro SYSTEM "privoxy.sgml">
   6 <!entity seealso SYSTEM "seealso.sgml">
   7 ]>
   8 <!--
   9  File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
  10
  11  Purpose     :  README for Privoxy
  12
  13  $Id: readme.sgml,v 1.0 2002/04/03 03:53:43 hal9 Exp $
  14
  15  Written by and Copyright (C) 2001 the SourceForge
  16  Privoxy team. http://www.privoxy.org/
  17
  18  Based on the Internet Junkbuster originally written
  19  by and Copyright (C) 1997 Anonymous Coders and
  20  Junkbusters Corporation.  http://www.junkbusters.com
  21
  22  ===================================================================
  23  READ: Document note: This file generates the README in the top level
  24  source directory. It is generated as only a plain text file. The
  25  current markup is not suitable for other formats. Build from
  26  Makefile with 'make readme'.
  27  ===================================================================
  28
  29 -->
  30
  31 <article id="index">
  32
  33 <![%dummy;[
  34  <para>
  35  <comment>
  36   This is here to keep vim syntax file from breaking :/
  37   If I knew enough to fix it, I would.
  38   PLEASE DO NOT REMOVE! HB: hal@foobox.net
  39  </comment>
  40  </para>
  41 ]]>
  42
  43 <para>
  44  <literal>
  45   <msgtext>
  46    <literallayout>
  47
  48 /*********************************************************************
  49  *
  50  * File        :  $Source: /cvsroot/ijbswa/current/README,v $
  51  *
  52  * Purpose     :  README file to give a short intro.
  53  *
  54  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
  55  *                Privoxy team. http://www.privoxy.org/
  56  *
  57  *                Based on the Internet Junkbuster originally written
  58  *                by and Copyright (C) 1997 Anonymous Coders and
  59  *                Junkbusters Corporation.  http://www.junkbusters.com
  60  *
  61  *                This program is free software; you can redistribute it
  62  *                and/or modify it under the terms of the GNU General
  63  *                Public License as published by the Free Software
  64  *                Foundation; either version 2 of the License, or (at
  65  *                your option) any later version.
  66  *
  67  *                This program is distributed in the hope that it will
  68  *                be useful, but WITHOUT ANY WARRANTY; without even the
  69  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  70  *                PARTICULAR PURPOSE.  See the GNU General Public
  71  *                License for more details.
  72  *
  73  *                The GNU General Public License should be included with
  74  *                this file.  If not, you can view it at
  75  *                http://www.gnu.org/copyleft/gpl.html
  76  *                or write to the Free Software Foundation, Inc., 59
  77  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  78  *
  79  *********************************************************************/
  80    </literallayout>
  81   </msgtext>
  82  </literal>
  83 </para>
  84
  85 <para>
  86  This README is included with the development version of Privoxy, which will
  87  eventually become Privoxy v3.0 (and soon we hope!). See
  88  http://www.privoxy.org/. The current code level is BETA, and seems stable to
  89  us :)
  90 </para>
  91
  92 <!--
  93  Include privoxy.sgml
  94 -->
  95 &p-intro;
  96
  97 <para>
  98  <LiteralLayout>
  99
 100  IMPORTANT CHANGES
 101 ------------------</LiteralLayout>
 102 </para>
 103 <para>
 104  NEWS! As of 03/24/02, the name of this project has been changed from
 105  ijbswa/Junkbuster to Privoxy. This is reflected in many of the included
 106  files.
 107 </para>
 108 <para>
 109  WARNING! If upgrading from earlier versions of this project via RPM packages,
 110  the new package will delete any previously installed 'Junkbuster' packages.
 111 </para>
 112 <para>
 113  IMPORTANT! READ! Configuration Change as of 3 Apr 2002: The default listening
 114  port is now 8118 due to conflicts with port 8000 assignment. You will need to
 115  change your browser if upgrading!!! And maybe firewall, etc.
 116 </para>
 117
 118 <para>
 119  <LiteralLayout>
 120
 121  INSTALL
 122 --------</LiteralLayout>
 123 </para>
 124 <para>
 125  For tarball, first unpack:
 126 </para>
 127
 128 <programlisting>
 129  tar xzvf privoxy-2.9.13-beta-src.tar.gz
 130  cd privoxy-2.9.13-beta
 131 </programlisting>
 132
 133 <programlisting>
 134  autoheader
 135  autoconf
 136  ./configure    (--help to see options)
 137  gmake          (the make from gnu)
 138  su
 139  make -n install        (to see where all the files will go)
 140  make install           (to really install)
 141 </programlisting>
 142
 143 <para>
 144  Redhat and SuSE src and binary RPMs can be built with 'make redhat-dist' or
 145  'make suse-dist' (run ./configure first) from unpacked sources. BSD will
 146  (probably?) require gmake (from http://gnu.org). See the user-manual for OS/2
 147  build instructions.
 148 </para>
 149 <para>
 150  Privoxy is also available via anonymous CVS:
 151 </para>
 152
 153 <programlisting>
 154  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
 155  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
 156 </programlisting>
 157 <para>
 158  This will create a directory named 'current'. Then, 'cd current', and then
 159  build as above.
 160 </para>
 161
 162 <para>
 163  <LiteralLayout>
 164
 165  RUN
 166 ---- </LiteralLayout>
 167 </para>
 168
 169 <para>
 170  privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE]
 171   [--user USER[.GROUP]] [config_file]
 172 </para>
 173 <para>
 174 See the man page or user-manual for a brief explanation of each option.
 175 </para>
 176 <para>
 177  If no config_file is specified on the command line, Privoxy will look for a
 178  file named 'config' in the current directory (except Win32 which will look
 179  for 'config.txt'). If no config_file is found, Privoxy will fail to start.
 180 </para>
 181 <para>
 182  Or for Red Hat: /etc/rc.d/init.d/privoxy start
 183 </para>
 184 <para>
 185  Or for SuSE:   /etc/rc.d/privoxy start
 186 </para>
 187
 188 <para>
 189  <LiteralLayout>
 190
 191  CONFIGURATION
 192 -------------- </LiteralLayout>
 193 </para>
 194 <para>
 195  See: 'config', 'default.action', and 'default.filter'. There are several
 196  actions files included. These are all well commented. Most of the magic is in
 197  '*.action', and there are several of these included with varying degrees of
 198  aggressiveness. On Unix-like systems, these files are installed in
 199  /etc/privoxy.  On Windows, then wherever the executable itself is installed.
 200  There are many significant changes and advances since Junkbuster v2.0.x. The
 201  user-manual has a run down of configuration options, and examples:
 202  http://www.privoxy.org/user-manual/.
 203 </para>
 204 <para>
 205  Be sure to set your browser(s) for HTTP/HTTPS Proxy at &lt;IP&gt;:&lt;Port&gt;, or
 206  whatever you specify in the config file under 'listen-address'. DEFAULT is
 207  localhost:8118.
 208 </para>
 209 <para>
 210  The default.action file can be configured via the web interface accessed via
 211  http://p.p/, as well other options.
 212 </para>
 213 <para>
 214  All configuration files are subject to unannounced changes during the
 215  development process.
 216 </para>
 217
 218 <para>
 219  <LiteralLayout>
 220
 221  DOCUMENTATION
 222 --------------</LiteralLayout>
 223  There is a growing amount of documentation in the 'doc' subdirectory, but it
 224  is not completed at this point. In particular, see the user-manual there, the
 225  faq, and developers should look at developer-manual.
 226 </para>
 227 <para>
 228  The most up to date source of information on the current development version,
 229  may still be either comments in the source code, or the included
 230  configuration files, which are all well commented. These are 'config',
 231  '*.action', and 'default.filter' in the toplevel source directory.
 232 </para>
 233
 234 <para>
 235  Included documentation may vary according to platform and packager.
 236 </para>
 237
 238 <para>
 239  <LiteralLayout>
 240
 241  CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 242 --------------------------------------------------------------</LiteralLayout>
 243 </para>
 244
 245 <para>
 246 We value your feedback. However, to provide you with the best support,
 247 please note:
 248 </para>
 249 <para>
 250  <LiteralLayout>
 251  * Use the support forum to get help:
 252    http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118
 253   </LiteralLayout>
 254 </para>
 255 <Para>
 256  <LiteralLayout>
 257  * Submit bugs only thru our bug forum:
 258    http://sourceforge.net/tracker/?group_id=11118&#38;atid=111118
 259  </LiteralLayout>
 260 </Para>
 261 <para>
 262    Make sure that the bug has not already been submitted. Please try
 263    to verify that it is a Privoxy bug, and not a browser or site
 264    bug first. If you are using your own custom configuration, please
 265    try the stock configs to see if the problem is a configuration
 266    related bug. And if not using the latest development snapshot,
 267    please try the latest one. Or even better, CVS sources. Please
 268    be sure to include the Privoxy/Junkbuster version, platform,
 269    browser, any pertinent log data, any other relevant details
 270    (please be specific) and, if possible, some way to reproduce the
 271    bug.
 272 </para>
 273 <para>
 274  <LiteralLayout>
 275  * Submit feature requests only thru our feature request forum:
 276    http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118&#38;func=browse
 277  </LiteralLayout>
 278 </para>
 279
 280 <para>
 281  <LiteralLayout>
 282  For any other issues, feel free to use the mailing lists:
 283  http://sourceforge.net/mail/?group_id=11118
 284  </LiteralLayout>
 285 </para>
 286
 287 <para>
 288  <LiteralLayout>
 289  Anyone interested in actively participating in development and related
 290  discussions can join the appropriate mailing list here:
 291  http://sourceforge.net/mail/?group_id=11118. Archives are available here
 292  too.
 293  </LiteralLayout>
 294 </para>
 295 <para>
 296  <LiteralLayout>
 297  -------------------------------------------------------------------------
 298  ijbswa-developers@lists.sourceforge.net
 299  </LiteralLayout>
 300 </para>
 301 <para>
 302  $Id: readme.sgml,v 1.0 2002/03/31 02:03:36 hal9 Exp $
 303 </para>
 304
 305 </article>