X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fsource%2Freadme.sgml;h=3e563ee800667784aaaf164fa5d21a9eebf009e0;hb=0428133610c525457cb16f7ac6a54203a2743d6c;hp=394734b0716faa8af2568d23f03e2ef88199d5ee;hpb=06b307ad39589bc70359c517712f88ece66d7890;p=privoxy.git diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index 394734b0..3e563ee8 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -1,11 +1,11 @@ + - - + + @@ -16,23 +16,23 @@ File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $ Purpose : README for Privoxy - - $Id: readme.sgml,v 2.5 2006/07/18 14:48:51 david__schmidt Exp $ - Copyright (C) 2001 - 2006 Privoxy Developers + $Id: readme.sgml,v 2.45 2011/08/18 11:42:50 fabiankeil Exp $ + + Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/ See LICENSE. ======================================================================== - NOTE: Please read developer-manual/documentation.html before touching + NOTE: Please read developer-manual/documentation.html before touching 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 + Failure to abide by this rule will result in the revocation of your license to live a peaceful existence! ======================================================================== =================================================================== - READ: Document Note: This file generates the README in the top level - source directory. It is generated as only a plain text file. The - current markup is not suitable for other formats. Build from + READ: Document Note: This file generates the README in the top level + source directory. It is generated as only a plain text file. The + current markup is not suitable for other formats. Build from Makefile with 'make dok-readme'. =================================================================== @@ -40,21 +40,21 @@ ====================================================================== NOTE: The left margin spacing is *important* when using 'literallayout' - WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie + WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie the para tag forces a linebreak. Tags need to be carefully placed as a result - to avoid extra blank lines, etc. + to avoid extra blank lines, etc. ====================================================================== - For stable releases, change - - entity % p-not-stable "INCLUDE" - - to - - entity % p-not-stable "IGNORE" - + 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 + MUST be toggled in this case or you will get both text referencing stable and unstable versions. You only want one or the other! --> @@ -80,14 +80,14 @@ * * Purpose : README file to give a short intro. * - * Copyright : Written by and Copyright (C) 2001 - 2006 the SourceForge + * Copyright : Written by and Copyright (C) 2001-2011 the * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written - * by and Copyright (C) 1997 Anonymous Coders and + * by and Copyright (C) 1997 Anonymous Coders and * Junkbusters Corporation. http://www.junkbusters.com * - * This program is free software; you can redistribute it + * 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 @@ -102,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 * *********************************************************************/ @@ -127,60 +128,43 @@ IMPORTANT CHANGES - 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 bugs are fixed, and some existing features have been enhanced. See - ChangeLog for details. Upgrading from 3.0.0 is recommended. + November 2010, Privoxy 3.0.17 stable is released. - REALLY BIG NEWS! August 2002: The long-awaited, oft-delayed stable version - of Privoxy 3.0 is finally released! This is way behind schedule, but better - late than never. The developers all hope the wait was worth it. + This is mainly a bug-fix release for the previously released + Privoxy 3.0.16. - 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. + It contains fixes for two bugs that could cause connections to hang + under certain circumstances when keep-alive support was enabled, + until they timed out or where closed by the server. - 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. + As usual, there are also a bunch of minor improvements. + For details please see the "ChangeLog", the "What's New" section or + the "Upgrader's Notes" in the User Manual. + INSTALL - + See the INSTALL file in this directory, for installing from raw source, and the User Manual, for all other - installation types. + installation types. RUN - privoxy [——help] [——version] - [——no-daemon] [——pidfile PIDFILE] [——user - USER[.GROUP]] [——chroot] [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. @@ -188,15 +172,6 @@ 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. - - Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start - - - Or for SuSE: /etc/rc.d/privoxy start - - - Or Debian: /etc/init.d/privoxy start - @@ -206,7 +181,7 @@ '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 + 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 @@ -215,7 +190,7 @@ 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 + 127.0.0.1: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. @@ -234,10 +209,10 @@ DOCUMENTATION There should be documentation in the 'doc' subdirectory. In particular, see the + 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. + 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. All - documentation is posted on http://www.privoxy.org, in case you don't have it, + 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. @@ -269,7 +244,7 @@ - +