X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Freadme.sgml;h=8c45a45214431fe9f550782b6b0fd3ec75c73b34;hp=46cf428a3b6b24ed267c79f0428d72a77f16283b;hb=dfdf0dc9e5024fd99ab304356b4209704e2ed4ad;hpb=4755c62ad98c26bebd21d2c649689300809a7d76 diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index 46cf428a..8c45a452 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -4,12 +4,10 @@ - - - - - - + + + + @@ -19,14 +17,16 @@ Purpose : README for Privoxy - $Id: readme.sgml,v 1.17 2002/06/03 00:28:17 hal9 Exp $ + $Id: readme.sgml,v 2.19 2008/06/21 13:43:06 fabiankeil Exp $ - Copyright (C) 2001, 2002 Privoxy Developers + Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/ See LICENSE. ======================================================================== NOTE: Please read developer-manual/documentation.html before touching - anything in this, or other Privoxy documentation. + anything in this, or other Privoxy documentation. You have been warned! + Failure to abide by this rule will result in the revocation of your license + to live a peaceful existence! ======================================================================== =================================================================== @@ -45,6 +45,18 @@ to avoid extra blank lines, etc. ====================================================================== + For stable releases, change + + entity % p-not-stable "INCLUDE" + + to + + entity % p-not-stable "IGNORE" + + in the DTD at the top. This will toggle various text 'off'. BOTH + MUST be toggled in this case or you will get both text referencing + stable and unstable versions. You only want one or the other! + -->
@@ -68,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 @@ -90,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 * *********************************************************************/ @@ -102,12 +115,9 @@ 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;. + @@ -118,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. + August 2008, Privoxy 3.0.10 is released! There are not any major new + features, but many improvements and refinements. As usual there are changes + that effect the configuration. See the "ChangeLog", and the "What's New" + section and the "Upgrader's Notes" in the User Manual + for details and specifics. + + + June 2008, Privoxy 3.0.9 beta is released. There are no major new + features, but many improvements and refinements. - WARNING! If upgrading from earlier versions of this project via RPM packages, - the new package will delete any previously installed 'Junkbuster' packages. + 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. - 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. + December 2007, Privoxy 3.0.7 is released. This is a beta release in + preparation for the forthcoming 3.0.8 release. 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 an explanation of each option, and + See the man page or User Manual for an explanation of each option, and other configuration and usage issues. @@ -157,32 +179,31 @@ for 'config.txt'). If no config_file is found, Privoxy will fail to start. - Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start - - - Or for SuSE: /etc/rc.d/privoxy start + Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start - Or Debian: /etc/init.d/privoxy start + Or Debian and Ubuntu: /etc/init.d/privoxy start 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 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 @@ -200,21 +221,24 @@ 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. @@ -232,7 +256,7 @@ - +