X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Freadme.sgml;h=689fa16ddd3197d1ba69abe6e1c94bd8147343ca;hb=c54228f0ef0172341cfe4f9acb7e955fa1e269b7;hp=2aef6159d40a9a9988cf02ca64935570633482a3;hpb=6feb375819705405e747f86fd9775133095b07c6;p=privoxy.git
diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml
index 2aef6159..689fa16d 100644
--- a/doc/source/readme.sgml
+++ b/doc/source/readme.sgml
@@ -4,10 +4,10 @@
-
-
-
-
+
+
+
+
@@ -17,15 +17,10 @@
Purpose : README for Privoxy
- $Id: readme.sgml,v 1.14 2002/05/05 13:46:59 swa Exp $
-
- 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
+ $Id: readme.sgml,v 2.15 2008/01/17 01:49:51 hal9 Exp $
+ Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/
+ See LICENSE.
========================================================================
NOTE: Please read developer-manual/documentation.html before touching
@@ -85,7 +80,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-2008 the SourceForge
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
@@ -107,8 +102,9 @@
* 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.
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+ * USA
*
*********************************************************************/
@@ -119,9 +115,8 @@
This README is included with
- Privoxy &p-version;. See http://www.privoxy.org/ for more information. The current code
- level is &p-status;.
+ Privoxy &p-version;. See http://www.privoxy.org/ for more information. The current code maturity
+ level is &p-status;
.
@@ -133,37 +128,49 @@
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.
+ NEWS! January 2008, Privoxy 3.0.8 stable is released. This is a significant
+ upgrade with many new and enhanced features, and many bugs fixed. All Privoxy
+ users are encouraged to upgrade. See the "ChangeLog", and the "What's New"
+ section and the "Upgrader's Notes" in the User Manual
+ for details and specifics. There are changes related to configuration, so
+ anyone upgrading and keeping their old configuration should read ahead
+ first.
- WARNING! If upgrading from earlier versions of this project via RPM packages,
- the new package will delete any previously installed 'Junkbuster' packages.
+ December 2007, Privoxy 3.0.7 is released. This is a beta release in
+ preparation for the forthcoming 3.0.8 release.
- 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.
+ NEWS! November 2006, Privoxy 3.0.6 stable is released. This is a significant
+ upgrade with many new and enhanced features, and many bugs fixed.
+
+
+ There was and will not be an official 3.0.4 release. This release cycle
+ was used to gather our thoughts, play with some new ideas and refine
+ some old ones. It will remain a development cycle with no actual release.
+ 3.0.5 is the fruit of these efforts.
INSTALL
-
- &buildsource;
-
+
+ See the INSTALL file in this directory, for installing
+ from raw source, and the User Manual, for all other
+ installation types.
+
RUN
- privoxy [——help] [——version]
- [——no-daemon] [——pidfile PIDFILE] [——user
- USER[.GROUP]] [config_file]
+ privoxy [--help] [--version]
+ [--no-daemon] [--pidfile PIDFILE] [--user USER[.GROUP]] [--chroot] [--pre-chroot-nslookup
+ HOSTNAME ][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
@@ -171,29 +178,31 @@
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 and Fedora based distributions: /etc/rc.d/init.d/privoxy start
- Or for SuSE: /etc/rc.d/privoxy start
+ Or Debian: /etc/init.d/privoxy start
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/.
+ 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 typically 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.
+ 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
@@ -211,9 +220,10 @@
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.
+ 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'.
+ 'default.filter'.
- 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.
@@ -243,7 +255,7 @@
-
+