-
-
/*********************************************************************
- *
- * 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://www.privoxy.org/
- *
- * Based on the Internet Junkbuster originally written
- * by and Copyright (C) 1997 Anonymous Coders and
- * Junkbusters Corporation. http://www.junkbusters.com
- *
- * This program is free software; you can redistribute it
- * and/or modify it under the terms of the GNU General
- * Public License as published by the Free Software
- * Foundation; either version 2 of the License, or (at
- * your option) any later version.
- *
- * This program is distributed in the hope that it will
- * be useful, but WITHOUT ANY WARRANTY; without even the
- * implied warranty of MERCHANTABILITY or FITNESS FOR A
- * PARTICULAR PURPOSE. See the GNU General Public
- * License for more details.
- *
- * The GNU General Public License should be included with
- * this file. If not, you can view it at
- * http://www.gnu.org/copyleft/gpl.html
- * or write to the Free Software Foundation, Inc., 59
- * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
- *********************************************************************/
-
-
-This README is included with the development version of Privoxy 2.9.13, which
+ *
+ * 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://www.privoxy.org/
+ *
+ * Based on the Internet Junkbuster originally written
+ * by and Copyright (C) 1997 Anonymous Coders and
+ * Junkbusters Corporation. http://www.junkbusters.com
+ *
+ * This program is free software; you can redistribute it
+ * and/or modify it under the terms of the GNU General
+ * Public License as published by the Free Software
+ * Foundation; either version 2 of the License, or (at
+ * your option) any later version.
+ *
+ * This program is distributed in the hope that it will
+ * be useful, but WITHOUT ANY WARRANTY; without even the
+ * implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU General Public
+ * License for more details.
+ *
+ * The GNU General Public License should be included with
+ * this file. If not, you can view it at
+ * http://www.gnu.org/copyleft/gpl.html
+ * or write to the Free Software Foundation, Inc., 59
+ * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ *********************************************************************/
+
+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
+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
tastes. Privoxy has application for both stand-alone systems and multi-user
networks.
-Privoxy is based on the code of the Internet Junkbuster (tm). 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.
-
-Privoxy continues the Junkbuster tradition, but adds many refinements,
-enhancements and new features.
+Privoxy is based on Internet Junkbuster (tm).
- IMPORTANT CHANGES
+ IMPORTANT CHANGES
------------------
NEWS! As of 03/24/02, the name of this project has been changed from ijbswa/
change your browser if upgrading!!! And maybe firewall, etc.
- INSTALL
+ INSTALL
--------
-There are several ways to install Privoxy.
+To build Privoxy from source, autoheader, autoconf, GNU make (gmake), and, of
+course, a C compiler are required.
-To build Privoxy from source, autoconf and GNU make (gmake) are required.
-Source is available as gzipped tar archives. For this, first unpack the source:
+When building from a source tarball (either release version or nightly CVS
+tarball), first unpack the source:
- tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz]
- cd privoxy-2.9.13-beta
-
+ 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 the CVS package installed
-first. Note CVS source is development quality, and may not be stable, or well
+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
-
This will create a directory named current/, which will contain the source
tree.
autoheader
autoconf
- ./configure (--help to see options)
- make (the make from gnu, gmake for *BSD)
+ ./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)
-
+ 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:
+
+ make
-Redhat and SuSE src and binary RPMs can be built with "make redhat-dist" or "
-make suse-dist" from unpacked sources. You will need to run "autoconf;
-autoheader; ./configure" beforehand. *BSD will require gmake (from http://
-www.gnu.org). See the user-manual for OS/2 build instructions.
+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
-----
+ RUN
+----
privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
[.GROUP]] [config_file]
Or for SuSE: /etc/rc.d/privoxy start
- CONFIGURATION
---------------
+ CONFIGURATION
+--------------
-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
+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/.
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
+ 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.
may still be either comments in the source code, or the included configuration
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. There are several *.action files included, with
-varying levels of aggressiveness.
+the toplevel source directory.
Included documentation may vary according to platform and packager.
- CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
+ CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
--------------------------------------------------------------
-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.
-
- * Submit feature requests only through our Sourceforge feature request
- forum:
-
- http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
-
-
- * We will soon have an automated way to submit advertisements, incorrectly
- blocked images, popups and the like. Check back.
-
-
- * 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
-
-
-$Id: readme.sgml,v 1.4 2002/04/06 05:07:29 hal9 Exp $
+ -------------------------------------------------------------------------
+ ijbswa-developers@lists.sourceforge.net
+
+$Id: readme.sgml,v 1.12 2002/04/26 17:45:36 swa Exp $
+
projects / privoxy.git / blobdiff