X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=README;h=0b8ac1ec658bc31840096978b27375842615a0bb;hp=d91b496d3f11c3fdbae986eff2ec57a1d904edf8;hb=56d03106907472899fa6e8933e81058744ce0fed;hpb=fd6aa6f49444e5dfd060964d9e5a4b9ff079a2ba diff --git a/README b/README index d91b496d..0b8ac1ec 100644 --- a/README +++ b/README @@ -1,11 +1,12 @@ + /********************************************************************* * - * 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 + * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and @@ -30,119 +31,139 @@ * Temple Place - Suite 330, Boston, MA 02111-1307, USA. * *********************************************************************/ + -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 2.9.14, 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 :). -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). IMPORTANT CHANGES ------------------ -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. +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. +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 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. +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 -------- -For tarball, first unpack: +To build Privoxy from source, autoheader, autoconf, GNU make (gmake), and, of +course, a C compiler 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 + + +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: + + 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 + - tar xzvf privoxy-2.9.13-beta-src.tar.gz - cd privoxy-2.9.13-beta +This will create a directory named current/, which will contain the source +tree. - 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) +Then, in either case, to build from unpacked tarball or CVS source: -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. + 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) + -Privoxy is also available via anonymous CVS: +If you have gnu make, you can have the first four steps automatically done for +you by just typing - cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current + make + -This will create a directory named 'current'. Then, 'cd current', and -then build as above. +in the freshly downloaded or unpacked source directory. + +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. + +For binary RPM installation, and other platforms, see the user-manual as well. 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 a brief explanation of each option. -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: /etc/rc.d/init.d/privoxy start + +Or for SuSE: /etc/rc.d/privoxy start CONFIGURATION --------------- +-------------- -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/. +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/. -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. +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. -The default.action file can be configured via the web interface accessed -via http://p.p/, as well other options. +The actions list 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. +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. +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. @@ -150,31 +171,51 @@ 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: +We value your feedback. However, to provide you with the best support, please +note: + + * 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. - * 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 + * Submit feature requests only through our Sourceforge feature request forum: -For any other issues, feel free to use the mailing lists: -http://sourceforge.net/mail/?group_id=11118 + 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. -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 + -------------------------------------------------------------------------- -ijbswa-developers@lists.sourceforge.net +$Id: readme.sgml,v 1.9 2002/04/24 04:04:12 hal9 Exp $ -$Id: README,v 1.19 2002/03/24 16:15:18 swa Exp $