X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=README;h=f27df8eae7d01cf7b07f5e52a2ecdb337315e467;hp=e4fb091b45a31f37f3520ebca227ac6ef8813cd0;hb=3186134c92fc0a088001a89d17abd5b3486baf2f;hpb=0365c0342275eacf37fb4c9b0721f2df9e709713 diff --git a/README b/README index e4fb091b..f27df8ea 100644 --- a/README +++ b/README @@ -5,7 +5,7 @@ * Purpose : README file to give a short intro. * * Copyright : Written by and Copyright (C) 2001 the SourceForge - * Privoxy team. http://ijbswa.sourceforge.net + * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and @@ -33,14 +33,15 @@ This README is included with the development version of Privoxy, which will eventually become Privoxy v3.0 (and soon we hope!). See -http://ijbswa.sourceforge.net. +http://www.privoxy.org/. The current code level is BETA, and seems +stable to us :) Privoxy is a web proxy with advanced filtering capabilities for protecting privacy, filtering web page content, managing cookies, controlling access, and removing ads, banners, pop-ups and other obnoxious Internet junk. Privoxy has a very flexible configuration and -can be customized to suit individual needs and tastes. Internet -Privoxy has application for both stand-alone systems and multi-user +can be customized to suit individual needs and tastes. Privoxy +has application for both stand-alone systems and multi-user networks. Privoxy is based on the code of the Internet Junkbuster. Junkbuster @@ -50,10 +51,18 @@ improvements, and started the SourceForge project to continue development. Several other developers are now contributing. - IMPORTANT CHANGE ------------------ + IMPORTANT CHANGES +------------------ -IMPORTANT! READ! Configuration Change as of 03/04/02: The default +NEWS! As of 03/24/02, the name of this project has been changed +from ijbswa/Junkbuster to Privoxy. This is reflected in many of the +included files. + +WARNING! If upgrading from earlier versions of this project via +RPM packages, the new package will delete any previously installed +'Junkbuster' packages. + +IMPORTANT! READ! Configuration Change as of 3 Apr 2002: The default listening port is now 8118 due to conflicts with port 8000 assignment. You will need to change your browser if upgrading!!! And maybe firewall, etc. @@ -64,8 +73,8 @@ firewall, etc. For tarball, first unpack: - tar xzvf ijb-2.9.11-beta-src.tar.gz - cd ijb-2.9.11-beta + tar xzvf privoxy-2.9.13-beta-src.tar.gz + cd privoxy-2.9.13-beta autoheader autoconf @@ -93,23 +102,29 @@ then build as above. ---- privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] - [--user USER] [config_file] + [--user USER[.GROUP]] [config_file] -Or for RedHat: /etc/rc.d/init.d/privoxy start -Or for SuSE: /etc/rc.d/privoxy start +See the man page or user-manual for a brief explanation of each option. + +If no config_file is specified on the command line, Privoxy will look for +a file named 'config' in the current directory (except Win32 which will look +for 'config.txt'). If no config_file is found, Privoxy will fail to start. -See the man page or user-manual for a brief explanation of each. +Or for Red Hat: /etc/rc.d/init.d/privoxy start +Or for SuSE: /etc/rc.d/privoxy start CONFIGURATION -------------- -See: 'config', 'ijb.action', and 're_filterfile'. These are all well -commented. On Unix-like systems, these files are installed in -/etc/privoxy. On Windows, then wherever the executable itself is -installed. There are many significant changes and advances since -v2.0.x. The user-manual has a run down of configuration options, and -examples: http://ijbswa.sourceforge.net/user-manual/. +See: 'config', 'default.action', and 'default.filter'. There are several +actions files included. These are all well commented. Most of the magic +is in '*.action', and there are several of these included with varying degrees +of aggressiveness. On Unix-like systems, these files are installed in +/etc/privoxy. On Windows, then wherever the executable itself is installed. +There are many significant changes and advances since Junkbuster v2.0.x. The +user-manual has a run down of configuration options, and examples: +http://www.privoxy.org/user-manual/. Be sure to set your browser(s) for HTTP/HTTPS Proxy at :, or whatever you specify in the config file under 'listen-address'. @@ -118,42 +133,48 @@ DEFAULT is localhost:8118. The default.action file can be configured via the web interface accessed via http://p.p/, as well other options. +All configuration files are subject to unannounced changes during the +development process. + DOCUMENTATION -------------- There is a growing amount of documentation in the 'doc' subdirectory, -but it is not finished at this point. In particular, see the -user-manual there, and developers should look at developer-manual. +but it is not completed at this point. In particular, see the +user-manual there, the faq, and developers should look at developer-manual. -The best source of information on the current development version, may -still be either comments in the source code, or the included -configuration files, which are all well commented. These are 'config', -'ijb.action', and 're_filterfile' in the toplevel source directory. - -Some legacy documentation may also be included only to give an idea of -what Privoxy can do under doc/obsolete/*. Much has changed since -these docs were written, so beware. +The most up to date source of information on the current development version, +may still be either comments in the source code, or the included configuration +files, which are all well commented. These are 'config', '*.action', and +'default.filter' in the toplevel source directory. Included documentation may vary according to platform and packager. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS ------ +-------------------------------------------------------------- We value your feedback. However, to provide you with the best support, please note: * Use the support forum to get help: http://sourceforge.net/tracker/?group_id=11118&atid=211118 + * Submit bugs only thru our bug forum: http://sourceforge.net/tracker/?group_id=11118&atid=111118 + Make sure that the bug has not already been submitted. Please try to verify that it is a Privoxy bug, and not a browser or site bug first. If you are using your own custom configuration, please try the stock configs to see if the problem is a configuration related bug. And if not using the latest development snapshot, - please try the latest one. Or even better, CVS sources. + please try the latest one. Or even better, CVS sources. Please + be sure to include the Privoxy/Junkbuster version, platform, + browser, any pertinent log data, any other relevant details + (please be specific) and, if possible, some way to reproduce the + bug. + * Submit feature requests only thru our feature request forum: http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse @@ -168,4 +189,4 @@ here too. ------------------------------------------------------------------------- ijbswa-developers@lists.sourceforge.net -$Id: README,v 1.18 2002/03/24 15:46:20 swa Exp $ +$Id: README,v 1.22 2002/03/27 01:06:40 hal9 Exp $