README

   1
   2 /*********************************************************************
   3  *
   4  * File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
   5  *
   6  * Purpose     :  README file to give a short intro.
   7  *
   8  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
   9  *                Privoxy team. http://www.privoxy.org/
  10  *
  11  *                Based on the Internet Junkbuster originally written
  12  *                by and Copyright (C) 1997 Anonymous Coders and
  13  *                Junkbusters Corporation.  http://www.junkbusters.com
  14  *
  15  *                This program is free software; you can redistribute it
  16  *                and/or modify it under the terms of the GNU General
  17  *                Public License as published by the Free Software
  18  *                Foundation; either version 2 of the License, or (at
  19  *                your option) any later version.
  20  *
  21  *                This program is distributed in the hope that it will
  22  *                be useful, but WITHOUT ANY WARRANTY; without even the
  23  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  24  *                PARTICULAR PURPOSE.  See the GNU General Public
  25  *                License for more details.
  26  *
  27  *                The GNU General Public License should be included with
  28  *                this file.  If not, you can view it at
  29  *                http://www.gnu.org/copyleft/gpl.html
  30  *                or write to the Free Software Foundation, Inc., 59
  31  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  32  *
  33  *********************************************************************/
  34
  35
  36 This README is included with the development version of Privoxy 2.9.14, which
  37 will eventually become Privoxy v3.0 (and soon we hope!). See http://
  38 www.privoxy.org/ for more information. The current code level is beta, and
  39 seems stable to us :).
  40
  41 Privoxy is a web proxy with advanced filtering capabilities for protecting
  42 privacy, filtering web page content, managing cookies, controlling access, and
  43 removing ads, banners, pop-ups and other obnoxious Internet junk. Privoxy has a
  44 very flexible configuration and can be customized to suit individual needs and
  45 tastes. Privoxy has application for both stand-alone systems and multi-user
  46 networks.
  47
  48 Privoxy is based on Internet Junkbuster (tm).
  49
  50
  51  IMPORTANT CHANGES
  52 ------------------
  53
  54 NEWS! As of 03/24/02, the name of this project has been changed from ijbswa/
  55 Junkbuster to Privoxy. This is reflected in many of the included files.
  56
  57 WARNING! If upgrading from earlier versions of this project via RPM packages,
  58 the new package will delete any previously installed 'Junkbuster' packages.
  59
  60 IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
  61 port is now 8118 due to conflicts with port 8000 assignment. You will need to
  62 change your browser if upgrading!!! And maybe firewall, etc.
  63
  64
  65  INSTALL
  66 --------
  67
  68 To build Privoxy from source, autoheader, autoconf, GNU make (gmake), and, of
  69 course, a C compiler are required.
  70
  71 When building from a source tarball (either release version or nightly CVS
  72 tarball), first unpack the source:
  73
  74  tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz]
  75  cd privoxy-2.9.14-beta
  76
  77
  78 For retrieving the current CVS sources, you'll need CVS installed. Note that
  79 sources from CVS are development quality, and may not be stable, or well
  80 tested. To download CVS source:
  81
  82   cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
  83   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
  84   cd current
  85
  86
  87 This will create a directory named current/, which will contain the source
  88 tree.
  89
  90 Then, in either case, to build from unpacked tarball or CVS source:
  91
  92  autoheader
  93  autoconf
  94  ./configure      # (--help to see options)
  95  make             # (the make from gnu, gmake for *BSD)
  96  su
  97  make -n install  # (to see where all the files will go)
  98  make install     # (to really install)
  99
 100
 101 If you have gnu make, you can have the first four steps automatically done for
 102 you by just typing
 103
 104   make
 105
 106
 107 in the freshly downloaded or unpacked source directory.
 108
 109 For more detailed instructions on how to build Redhat and SuSE RPMs, Windows
 110 self-extracting installers, building on platforms with special requirements
 111 etc, please consult the developer manual.
 112
 113 For binary RPM installation, and other platforms, see the user-manual as well.
 114
 115
 116  RUN
 117 ----
 118
 119 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
 120 [.GROUP]] [config_file]
 121
 122 See the man page or user-manual for a brief explanation of each option.
 123
 124 If no config_file is specified on the command line, Privoxy will look for a
 125 file named 'config' in the current directory (except Win32 which will look for
 126 'config.txt'). If no config_file is found, Privoxy will fail to start.
 127
 128 Or for Red Hat: /etc/rc.d/init.d/privoxy start
 129
 130 Or for SuSE: /etc/rc.d/privoxy start
 131
 132
 133  CONFIGURATION
 134 --------------
 135
 136 See: 'config', 'default.action', 'standard.action', 'user.action', and
 137 'default.filter'. 'user.action' is for personal configuration. These are all
 138 well commented. Most of the magic is in '*.action' files. On Unix-like systems,
 139 these files are installed in /etc/privoxy. On Windows, then wherever the
 140 executable itself is installed. There are many significant changes and advances
 141 since Junkbuster v2.0.x. The user-manual has a run down of configuration
 142 options, and examples: http://www.privoxy.org/user-manual/.
 143
 144 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
 145 you specify in the config file under 'listen-address'. DEFAULT is localhost:
 146 8118.
 147
 148 The actions list can be configured via the web interface accessed via http://
 149 p.p/, as well other options.
 150
 151 All configuration files are subject to unannounced changes during the
 152 development process.
 153
 154
 155  DOCUMENTATION
 156 --------------
 157
 158 There should be documentation in the 'doc' subdirectory, but it is not
 159 completed at this point. In particular, see the user-manual there, the faq, and
 160 those interested in Privoxy development, should look at developer-manual.
 161
 162 The most up to date source of information on the current development version,
 163 may still be either comments in the source code, or the included configuration
 164 files. The source and configuration files are all well commented. The main
 165 configuration files are: 'config', 'default.action', and 'default.filter' in
 166 the toplevel source directory.
 167
 168 Included documentation may vary according to platform and packager.
 169
 170
 171  CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 172 --------------------------------------------------------------
 173
 174 We value your feedback. However, to provide you with the best support, please
 175 note:
 176
 177   * Use the Sourceforge Support Forum to get help:
 178
 179         http://sourceforge.net/tracker/?group_id=11118&atid=211118
 180
 181
 182   * Submit bugs only through our Sourceforge Bug Forum:
 183
 184         http://sourceforge.net/tracker/?group_id=11118&atid=111118.
 185
 186
 187     Make sure that the bug has not already been submitted. Please try to verify
 188     that it is a Privoxy bug, and not a browser or site bug first. If you are
 189     using your own custom configuration, please try the stock configs to see if
 190     the problem is a configuration related bug. And if not using the latest
 191     development snapshot, please try the latest one. Or even better, CVS
 192     sources. Please be sure to include the Privoxy/Junkbuster version,
 193     platform, browser, any pertinent log data, any other relevant details
 194     (please be specific) and, if possible, some way to reproduce the bug.
 195
 196   * Submit feature requests only through our Sourceforge feature request forum:
 197
 198         http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
 199
 200
 201   * You can also send feedback on websites that Privoxy has problems with. Please bookmark
 202     the following link: "Privoxy - Submit Filter Feedback"
 203     . Once you surf to a page with problems, use the
 204     bookmark to send us feedback. We will look into the issue as soon as possible.
 205
 206
 207   * For any other issues, feel free to use the mailing lists:
 208
 209         http://sourceforge.net/mail/?group_id=11118.
 210
 211
 212     Anyone interested in actively participating in development and related
 213     discussions can also join the appropriate mailing list. Archives are
 214     available, too.
 215
 216  -------------------------------------------------------------------------
 217  ijbswa-developers@lists.sourceforge.net
 218
 219
 220 $Id: readme.sgml,v 1.9 2002/04/24 04:04:12 hal9 Exp $
 221