/*********************************************************************
*
- * 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 - 2004 the SourceForge
+ * Copyright : Written by and Copyright (C) 2001 - 2006 the SourceForge
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
*
*********************************************************************/
-This README is included with Privoxy 3.0.4-beta. The current code maturity
-level is "beta". Various changes and improvements are underway, and
-preparations are being made for an update of Privoxy. Please report any
-problems to the developers.
+This README is included with the development version of Privoxy 3.0.4. See
+http://www.privoxy.org/ for more information. The current code maturity level
+is "beta", but seems stable to us :).
-------------------------------------------------------------------------------
Privoxy is a web proxy with advanced filtering capabilities for protecting
-privacy, modifying web page content, managing cookies, controlling access, and
+privacy, modifying web page data, 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
1. IMPORTANT CHANGES
-MORE NEWS! January 2004, Privoxy 3.0.3 is released. This is the another
-maintenance release of Privoxy which fixes more bugs, further refines the
-configuration and works around some known third-party problems. See the
-ChangeLog for complete details. Upgrading from 3.0.2 is recommended.
+BIG NEWS! 2006, Privoxy 3.0.4 is released. This is a significant upgrade with
+many new and enhanced features, and many bugs fixed. There are fifteen new
+actions available, and several actions have enhanced capabilites. Multiple
+filter files are now supported as well. See the "What's New" section and the
+"Upgrader's Notes" in the User Manual for details and specifics.
+
+NEWS! January 2004, Privoxy 3.0.3 is released. This is the another maintenance
+release of Privoxy which fixes more bugs, further refines the configuration and
+works around some known third-party problems. See the ChangeLog for complete
+details. Upgrading from 3.0.2 is recommended.
NEWS! March 2003, Privoxy 3.0.2 is released. This is the first maintenance
release of Privoxy. There are no significant new features in this release. Some
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
-See the INSTALL file in this directory, for installing from source, and the
-User Manual, for other installation types.
+See the INSTALL file in this directory, for installing from raw source, and the
+User Manual, for all other installation types.
-------------------------------------------------------------------------------
4. CONFIGURATION
-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/.
+See: 'config', 'default.action', 'user.action', 'default.filter', and
+'user.filter'. 'user.action' and 'user.filter' are 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 from earlier versions. 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 <IP>:<Port>, 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.
+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.
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.
+
-------------------------------------------------------------------------------
5. DOCUMENTATION
-There should be documentation in the 'doc' subdirectory. In particular, see the
-User Manual there, the FAQ, and those interested in Privoxy development, should
-look at developer-manual.
+There should be documentation in the 'doc' subdirectory, but it may not be
+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 source and configuration files are all well commented. The main
-configuration files are: 'config', 'default.action', and 'default.filter'.
+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. 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,
6.1. Get Support
-For casual users, our support forum at SourceForge is probably best suited:
+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
-------------------------------------------------------------------------------
-6.2. Report Bugs
+6.2. Reporting Problems
+
+"Problems" for our purposes, come in two forms:
+
+ * Configuration issues, such as ads that slip through, or sites that don't
+ function properly due to one Privoxy "action" or another being turned "on".
+
+ * "Bugs" in the programming code that makes up Privoxy, such as that might
+ cause a crash.
+
+-------------------------------------------------------------------------------
+
+6.2.1. Reporting Ads or Other Configuration Problems
+
+Please send feedback on ads that slipped through, innocent images that were
+blocked, sites that don't work properly, and other configuration related
+problem of default.action file, to http://sourceforge.net/tracker/?group_id=
+11118&atid=460288, the Actions File Tracker.
+
+New, improved default.action files may 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.2.2. Reporting 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.
+and observe the additional hints at the top of the submit form. If already
+submitted, please feel free to add any info to the original report that might
+help solve the issue.
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.
+first. If unsure, try toggling off Privoxy, and see if the problem persists. 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, the bug may have 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.
+
+Please be sure to provide the following information:
+
+ * The exact Privoxy version of the proxy software (if you got the source from
+ CVS, please also give the date).
+
+ * The operating system and verions you run Privoxy on, (e.g. Windows XP).
+
+ * The name, platform, and version of the browser you were using (e.g.
+ Internet Explorer v5.5 for Mac).
+
+ * The URL where the problem occurred, or some way for us to duplicate the
+ problem (e.g. http://somesite.example.com?somethingelse=123).
+
+ * Whether your version of Privoxy is one supplied by the developers of
+ Privoxy via SourceForge, or somewhere else.
+
+ * Whether you are using Privoxy in tandem with another proxy such as TOR. If
+ so, please try disabling the other proxy.
+
+ * Whether you are using a personal firewall product. If so, does Privoxy work
+ without it?
+
+ * Any other pertinent information to help identify the problem such as config
+ or log file excerpts (yes, you should have log file entries for each action
+ taken).
+
+ * Please provide your SF login, or email address, in case we need to contact
+ you.
+
+The appendix of the user manual also has helpful information on understanding
+actions, and action debugging.
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
-6.5. Other
+6.4. 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
<!entity p-intro SYSTEM "privoxy.sgml">
<!entity contacting SYSTEM "contacting.sgml">
<!entity buildsource SYSTEM "buildsource.sgml">
-<!entity p-version "3.0.3">
-<!entity p-status "stable">
-<!entity % p-not-stable "IGNORE">
-<!entity % p-stable "INCLUDE">
+<!entity p-version "3.0.4">
+<!entity p-status "beta">
+<!entity % p-not-stable "INCLUDE">
+<!entity % p-stable "IGNORE">
<!entity % p-text "INCLUDE"> <!-- define we are a text only doc -->
<!entity % p-doc "IGNORE"> <!-- and never a text doc -->
<!entity % p-readme "INCLUDE"> <!-- all your README belong to us -->
Purpose : README for Privoxy
- $Id: readme.sgml,v 1.16.2.9 2004/01/30 14:09:59 oes Exp $
+ $Id: readme.sgml,v 2.5 2006/07/18 14:48:51 david__schmidt Exp $
- Copyright (C) 2001 - 2004 Privoxy Developers <developers@privoxy.org>
+ Copyright (C) 2001 - 2006 Privoxy Developers <developers@privoxy.org>
See LICENSE.
========================================================================
*
* Purpose : README file to give a short intro.
*
- * Copyright : Written by and Copyright (C) 2001 - 2004 the SourceForge
+ * Copyright : Written by and Copyright (C) 2001 - 2006 the SourceForge
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
<para>
<!-- include some conditional text -->
This README is included with <![%p-not-stable;[ the development version of]]>
- Privoxy &p-version;<![%p-not-stable;[, which will eventually become Privoxy v3.0 (and soon we
- hope!)]]>. See http://www.privoxy.org/ for more information. The current code maturity
- level is <quote>&p-status;</quote><![%p-not-stable;[, and seems stable to us :)]]>.
+ Privoxy &p-version;. See http://www.privoxy.org/ for more information. The current code maturity
+ level is <quote>&p-status;</quote><![%p-not-stable;[, but seems stable to us :)]]>.
</para>
</abstract>
</artheader>
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="importantchanges" ><title>IMPORTANT CHANGES</title>
<para>
- MORE NEWS! January 2004, Privoxy 3.0.3 is released. This is the another
+ BIG NEWS! 2006, Privoxy 3.0.4 is released. This is a significant upgrade
+ with many new and enhanced features, and many bugs fixed. There
+ are fifteen new actions available, and several actions have enhanced
+ capabilites. Multiple filter files are now supported as well. See the "What's
+ New" section and the "Upgrader's Notes" in <citetitle>the User
+ Manual</citetitle> for details and specifics.
+</para>
+<para>
+ NEWS! January 2004, Privoxy 3.0.3 is released. This is the another
maintenance release of Privoxy which fixes more bugs, further refines
the configuration and works around some known third-party problems. See the
ChangeLog for complete details. Upgrading from 3.0.2 is recommended.
ijbswa/Junkbuster to Privoxy. This is reflected in many of the included
files.
</para>
-<para>
- WARNING! If upgrading from earlier versions of this project via RPM packages,
- the new package will delete any previously installed 'Junkbuster' packages.
-</para>
<para>
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
<sect1 id="install" ><title>INSTALL</title>
<para>
See the <filename>INSTALL</filename> file in this directory, for installing
- from source, and the <citetitle>User Manual</citetitle>, for other
+ from raw source, and the <citetitle>User Manual</citetitle>, for all other
installation types.
</para>
</sect1>
USER[.GROUP]] [——chroot] [config_file]
</para>
<para>
- See the man page or User Manual for an explanation of each option, and
+ See the man page or <citetitle>User Manual</citetitle> for an explanation of each option, and
other configuration and usage issues.
</para>
<para>
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="configuration"><title>CONFIGURATION</title>
<para>
- 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/.
+ See: 'config', 'default.action', 'user.action', 'default.filter', and
+ 'user.filter'. 'user.action' and 'user.filter' are 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 from earlier versions. The
+ <citetitle>User Manual</citetitle> has an explanation of all configuration
+ options, and examples: http://www.privoxy.org/user-manual/.
</para>
<para>
Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or
<sect1 id="documentation"><title>DOCUMENTATION</title>
<para>
There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, 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 not be completed at this point]]>. In particular, see the
+ <citetitle>User Manual</citetitle> there,
+ the <citetitle>FAQ</citetitle>, and those interested in Privoxy development, should look at
+ <citetitle>developer-manual</citetitle>.
</para>
<para>
<
projects / privoxy.git / commitdiff