X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=README;h=e7a95367f70c349ea491cbba39c0e7059dc61c47;hp=705c989c23f2eafabc9490e7eebc04585ffd1047;hb=114c72fda4a6df07cd8a067a8fbafacaa3730c71;hpb=46d89e0b6fed51b9b8a618ab1024c8b03ca23023 diff --git a/README b/README index 705c989c..e7a95367 100644 --- a/README +++ b/README @@ -4,7 +4,7 @@ * * Purpose : README file to give a short intro. * - * Copyright : Written by and Copyright (C) 2001 the SourceForge + * Copyright : Written by and Copyright (C) 2001,2002 the SourceForge * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written @@ -31,27 +31,13 @@ * *********************************************************************/ -This README is included with the development version of Privoxy 2.9.15, which -will eventually become Privoxy v3.0 (and soon we hope!). See http:// -www.privoxy.org/ for more information. The current code level is beta, and -seems stable to us :). +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.. ------------------------------------------------------------------------------- -Table of Contents -1. IMPORTANT CHANGES -2. INSTALL -3. RUN -4. CONFIGURATION -5. DOCUMENTATION -6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS - - 6.1. Get Support - 6.2. Report bugs - 6.3. Request new features - 6.4. Report ads or other filter problems - 6.5. Other - 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 @@ -65,6 +51,10 @@ 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. @@ -85,8 +75,8 @@ compiler like gcc are required. When building from a source tarball (either release version or nightly CVS tarball), first unpack the source: - tar xzvf privoxy-2.9.15-beta-src* [.tgz or .tar.gz] - cd privoxy-2.9.15-beta + tar xzvf privoxy-3.1.1-beta-src* [.tgz or .tar.gz] + cd privoxy-3.1.1-beta 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 @@ -109,6 +99,14 @@ Then, in either case, to build from unpacked tarball or CVS source: make -n install # (to see where all the files will go) make install # (to really install) ++-----------------------------------------------------------------------------+ +| 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. | ++-----------------------------------------------------------------------------+ + If you have gnu make, you can have the first four steps automatically done for you by just typing: @@ -129,32 +127,36 @@ For binary RPM installation, and other platforms, see the user-manual as well. privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER [.GROUP]] [config_file] -See the man page or user-manual for a brief explanation of each option. +See the man page or User Manual for an explanation of each option, and other +configuration and usage issues. 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. -Or for Red Hat: /etc/rc.d/init.d/privoxy start +Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start Or for SuSE: /etc/rc.d/privoxy start +Or Debian: /etc/init.d/privoxy start + ------------------------------------------------------------------------------- 4. CONFIGURATION See: 'config', 'default.action', 'user.action', and 'default.filter'. -'user.action' is for personal configuration. 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 a run down of configuration options, and examples: http:// -www.privoxy.org/user-manual/. +'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. +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. The actions list can be configured via the web interface accessed via http:// p.p/, as well other options. @@ -167,7 +169,7 @@ 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 +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, @@ -176,69 +178,78 @@ 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. +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. However, to provide you with the best support, please -note the following sections. +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 -To get support, use the Sourceforge Support Forum: +For casual users, our support forum at SourceForge is probably best suited: +http://sourceforge.net/tracker/?group_id=11118&atid=211118 - 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 +6.2. Report Bugs -To submit bugs, use the Sourceforge Bug Forum: +Please report all bugs only through our bug tracker: http://sourceforge.net/ +tracker/?group_id=11118&atid=111118. - 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. -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 be -sure to include the Privoxy version, platform, browser, any pertinent log data, -any other relevant details (please be specific) and, if possible, some way to -reproduce the bug. +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 +------------------------------------------------------------------------------- -To submit ideas on new features, use the Sourceforge feature request forum: +6.3. Request New Features - http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse. +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 filter problems +6.4. Report Ads or Other Actions-Related Problems -You can also send feedback on websites that Privoxy has problems with. Please -bookmark the following link: "Privoxy - Submit Filter Feedback". Once you surf -to a page with problems, use the bookmark to send us feedback. We will look -into the issue as soon as possible. +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. +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: - - http://sourceforge.net/mail/?group_id=11118. - -Anyone interested in actively participating in development and related -discussions can also join the appropriate mailing list. Archives are available, -too. See the page on Sourceforge. +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.