X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=README;h=705c989c23f2eafabc9490e7eebc04585ffd1047;hp=0b8ac1ec658bc31840096978b27375842615a0bb;hb=90dc294a65946dcea08f0dae6dbea251d8ca483c;hpb=56d03106907472899fa6e8933e81058744ce0fed diff --git a/README b/README index 0b8ac1ec..705c989c 100644 --- a/README +++ b/README @@ -1,4 +1,3 @@ - /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $ @@ -31,13 +30,28 @@ * Temple Place - Suite 330, Boston, MA 02111-1307, USA. * *********************************************************************/ - -This README is included with the development version of Privoxy 2.9.14, which +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 :). +------------------------------------------------------------------------------- + +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 @@ -47,9 +61,9 @@ networks. Privoxy is based on Internet Junkbuster (tm). +------------------------------------------------------------------------------- - IMPORTANT CHANGES ------------------- +1. IMPORTANT CHANGES 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. @@ -61,19 +75,18 @@ 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. +------------------------------------------------------------------------------- - INSTALL --------- +2. INSTALL -To build Privoxy from source, autoheader, autoconf, GNU make (gmake), and, of -course, a C compiler are required. +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: - tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz] - cd privoxy-2.9.14-beta - + tar xzvf privoxy-2.9.15-beta-src* [.tgz or .tar.gz] + cd privoxy-2.9.15-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 @@ -82,7 +95,6 @@ tested. To download CVS source: 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 - This will create a directory named current/, which will contain the source tree. @@ -96,13 +108,11 @@ Then, in either case, to build from unpacked tarball or CVS source: su make -n install # (to see where all the files will go) make install # (to really install) - If you have gnu make, you can have the first four steps automatically done for -you by just typing +you by just typing: make - in the freshly downloaded or unpacked source directory. @@ -112,9 +122,9 @@ etc, please consult the developer manual. For binary RPM installation, and other platforms, see the user-manual as well. +------------------------------------------------------------------------------- - RUN ----- +3. RUN privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER [.GROUP]] [config_file] @@ -129,17 +139,18 @@ Or for Red Hat: /etc/rc.d/init.d/privoxy start Or for SuSE: /etc/rc.d/privoxy start +------------------------------------------------------------------------------- - CONFIGURATION --------------- +4. CONFIGURATION -See: 'config', 'default.action', 'standard.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. 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/. +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/. 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: @@ -151,9 +162,9 @@ p.p/, as well other options. All configuration files are subject to unannounced changes during the development process. +------------------------------------------------------------------------------- - DOCUMENTATION --------------- +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 @@ -167,55 +178,67 @@ the toplevel source directory. Included documentation may vary according to platform and packager. +------------------------------------------------------------------------------- - CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS --------------------------------------------------------------- +6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS We value your feedback. However, to provide you with the best support, please -note: +note the following sections. - * Use the Sourceforge Support Forum to get help: - - http://sourceforge.net/tracker/?group_id=11118&atid=211118 - - - * Submit bugs only through our Sourceforge 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 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 through our Sourceforge feature request forum: - - http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse. - - - * 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. - - - * 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. - - ------------------------------------------------------------------------- - ijbswa-developers@lists.sourceforge.net +------------------------------------------------------------------------------- + +6.1. Get Support + +To get support, use the Sourceforge Support Forum: + + http://sourceforge.net/tracker/?group_id=11118&atid=211118 + +------------------------------------------------------------------------------- + +6.2. Report bugs + +To submit bugs, use the Sourceforge 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 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. + +------------------------------------------------------------------------------- + +6.3. Request new features + +To submit ideas on new features, use the Sourceforge feature request forum: + + http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse. + +------------------------------------------------------------------------------- + +6.4. Report ads or other filter 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. + +New, improved default.action files will occasionally be made available based on +your feedback. These will be announced on the ijbswa-announce list. + +------------------------------------------------------------------------------- + +6.5. Other + +For any other issues, feel free to use the mailing lists: + http://sourceforge.net/mail/?group_id=11118. -$Id: readme.sgml,v 1.9 2002/04/24 04:04:12 hal9 Exp $ +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.