X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=README;h=e7a95367f70c349ea491cbba39c0e7059dc61c47;hp=d91b496d3f11c3fdbae986eff2ec57a1d904edf8;hb=116bd937eb14cbc008aabfbfacf7e4fae45f458c;hpb=fd6aa6f49444e5dfd060964d9e5a4b9ff079a2ba diff --git a/README b/README index d91b496d..e7a95367 100644 --- a/README +++ b/README @@ -1,11 +1,11 @@ /********************************************************************* * - * File : $Source: /cvsroot/ijbswa/current/README,v $ + * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $ * * Purpose : README file to give a short intro. * - * Copyright : Written by and Copyright (C) 2001 the SourceForge - * Privoxy team. http://ijbswa.sourceforge.net + * Copyright : Written by and Copyright (C) 2001,2002 the SourceForge + * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and @@ -31,150 +31,225 @@ * *********************************************************************/ -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. +This README is included with the development version of Privoxy 3.1.1, which +will someday become Privoxy v3.2. See http://www.privoxy.org/ for more +information. The current code level is technically alpha, but is not yet +significantly different from the 3.0.0 stable branch at this time.. -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 +------------------------------------------------------------------------------- + +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. Privoxy has application for both stand-alone systems and multi-user networks. -Privoxy is based on the code of the Internet Junkbuster. Junkbuster -was originally written by JunkBusters Corporation, and was released as -free open-source software under the GNU GPL. Stefan Waldherr made many -improvements, and started the SourceForge project to continue -development. Several other developers are now contributing. +Privoxy is based on Internet Junkbuster (tm). + +------------------------------------------------------------------------------- + +1. IMPORTANT CHANGES + +REALLY BIG NEWS! August 2002: The long-awaited, oft-delayed stable version of +Privoxy 3.0 is finally released! This is way behind schedule, but better late +than never. The developers all hope the wait was worth it. + +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 17 Mar 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. + +------------------------------------------------------------------------------- + +2. INSTALL + +To build Privoxy from source, autoconf, GNU make (gmake), and, of course, a C +compiler like gcc are required. +When building from a source tarball (either release version or nightly CVS +tarball), first unpack the source: - IMPORTANT CHANGES ------------------- + tar xzvf privoxy-3.1.1-beta-src* [.tgz or .tar.gz] + cd privoxy-3.1.1-beta -NEWS! As of 03/24/02, the name of this project has been changed -from Junkbuster to Privoxy. This is reflected in many of the -included files. +For retrieving the current CVS sources, you'll need CVS installed. Note that +sources from CVS are development quality, and may not be stable, or well +tested. To download CVS source: -WARNING! If upgrading from earlier versions of this project via -RPM packages, the new package will delete any previously installed -'Junkbuster' packages. + cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login + cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current + cd current -IMPORTANT! READ! Configuration Change as of 03/04/02: 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. +This will create a directory named current/, which will contain the source +tree. +Then, in either case, to build from unpacked tarball or CVS source: - INSTALL --------- + autoheader + autoconf + ./configure # (--help to see options) + make # (the make from gnu, gmake for *BSD) + su + make -n install # (to see where all the files will go) + make install # (to really install) -For tarball, first unpack: ++-----------------------------------------------------------------------------+ +| Warning | +|-----------------------------------------------------------------------------| +|The "make install" target is temporary quite broken! It is recommended to use| +|a binary package, or do a source build, and manually install the components. | +|Sorry. | ++-----------------------------------------------------------------------------+ - tar xzvf privoxy-2.9.13-beta-src.tar.gz - cd privoxy-2.9.13-beta +If you have gnu make, you can have the first four steps automatically done for +you by just typing: - autoheader - autoconf - ./configure (--help to see options) - gmake (the make from gnu) - su - make -n install (to see where all the files will go) - make install (to really install) + make -Redhat and SuSE src and binary RPMs can be built with 'make -redhat-dist' or 'make suse-dist' (run ./configure first) from unpacked -sources. BSD will (probably?) require gmake (from http://gnu.org). See -the user-manual for OS/2 build instructions. +in the freshly downloaded or unpacked source directory. -Privoxy is also available via anonymous CVS: +For more detailed instructions on how to build Redhat and SuSE RPMs, Windows +self-extracting installers, building on platforms with special requirements +etc, please consult the developer manual. - cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current +For binary RPM installation, and other platforms, see the user-manual as well. -This will create a directory named 'current'. Then, 'cd current', and -then build as above. +------------------------------------------------------------------------------- +3. RUN - RUN ----- +privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER +[.GROUP]] [config_file] -privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] - [--user USER] [config_file] +See the man page or User Manual for an explanation of each option, and other +configuration and usage issues. -Or for RedHat: /etc/rc.d/init.d/privoxy start -Or for SuSE: /etc/rc.d/privoxy start +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 based distributions: /etc/rc.d/init.d/privoxy start +Or for SuSE: /etc/rc.d/privoxy start - CONFIGURATION --------------- +Or Debian: /etc/init.d/privoxy start -See: 'config', '*.action', and 'default.filter'. 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://ijbswa.sourceforge.net/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'. -DEFAULT is localhost:8118. +4. CONFIGURATION -The default.action file can be configured via the web interface accessed -via http://p.p/, as well other options. +See: 'config', 'default.action', 'user.action', and 'default.filter'. +'user.action' is for personal and local configuration preferences. These are +all well commented. Most of the magic is in '*.action' files. 'user.action' +should be used for any actions customizations. 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 an explanation of all 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'. DEFAULT is localhost: +8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it +with FTP or other protocols for the simple reason it does not work. - DOCUMENTATION --------------- +The actions list can be configured via the web interface accessed via http:// +p.p/, as well other options. -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. +All configuration files are subject to unannounced changes during the +development process. + +------------------------------------------------------------------------------- + +5. DOCUMENTATION + +There should be documentation in the 'doc' subdirectory, but it is not +completed at this point. In particular, see the User Manual there, the FAQ, and +those interested in Privoxy development, should look at developer-manual. 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. - -Some legacy Junkbuster 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. - -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. - * Submit feature requests only thru our feature request forum: - http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse - -For any other issues, feel free to use the mailing lists: -http://sourceforge.net/mail/?group_id=11118 - -Anyone interested in actively participating in development and related -discussions can join the appropriate mailing list here: -http://sourceforge.net/mail/?group_id=11118. Archives are available -here too. - -------------------------------------------------------------------------- -ijbswa-developers@lists.sourceforge.net - -$Id: README,v 1.19 2002/03/24 16:15:18 swa Exp $ +files. The source and configuration files are all well commented. The main +configuration files are: 'config', 'default.action', and 'default.filter' in +the toplevel source directory. + +Included documentation may vary according to platform and packager. All +documentation is posted on http://www.privoxy.org, in case you don't have it, +or can't find it. + +------------------------------------------------------------------------------- + +6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS + +We value your feedback. In fact, we rely on it to improve Privoxy and its +configuration. However, please note the following hints, so we can provide you +with the best support: + +------------------------------------------------------------------------------- + +6.1. Get Support + +For casual users, our support forum at SourceForge is probably best suited: +http://sourceforge.net/tracker/?group_id=11118&atid=211118 + +All users are of course welcome to discuss their issues on the users mailing +list, where the developers also hang around. + +------------------------------------------------------------------------------- + +6.2. Report Bugs + +Please report all bugs only through our bug tracker: http://sourceforge.net/ +tracker/?group_id=11118&atid=111118. + +Before doing so, please make sure that the bug has not already been submitted +and observe the additional hints at the top of the submit form. + +Please try to verify that it is a Privoxy bug, and not a browser or site bug +first. If unsure, try toggling off Privoxy, and see if the problem persists. +The appendix of the user manual also has helpful information on action +debugging. If you are using your own custom configuration, please try the stock +configs to see if the problem is configuration related. + +If not using the latest version, chances are that the bug has been found and +fixed in the meantime. We would appreciate if you could take the time to +upgrade to the latest version (or even the latest CVS snapshot) and verify your +bug, but this is not required for reporting. + +------------------------------------------------------------------------------- + +6.3. Request New Features + +You are welcome to submit ideas on new features or other proposals for +improvement through our feature request tracker at http://sourceforge.net/ +tracker/?atid=361118&group_id=11118. + +------------------------------------------------------------------------------- + +6.4. Report Ads or Other Actions-Related Problems + +Please send feedback on ads that slipped through, innocent images that were +blocked, and any other problems relating to the default.action file through our +actions feedback mechanism located at http://www.privoxy.org/actions/. On this +page, you will also find a bookmark which will take you back there from any +troubled site and even pre-fill the form! + +New, improved default.action files will occasionally be made available based on +your feedback. These will be announced on the ijbswa-announce list and +available from our the files section of our project page. + +------------------------------------------------------------------------------- + +6.5. Other + +For any other issues, feel free to use the mailing lists. Technically +interested users and people who wish to contribute to the project are also +welcome on the developers list! You can find an overview of all Privoxy-related +mailing lists, including list archives, at: http://sourceforge.net/mail/? +group_id=11118. +