X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Freadme.sgml;h=e2343b2b8ecbc33b37633b9e293f3ae3f2e05928;hp=10a515ce0149a5112944f73225c3db59d62ff18e;hb=a54cb7d58d243d60158fe414d205d658e9e1a7a2;hpb=4fdfd8dbb0c06422dfc9e81fe721ecbd93c2fb10 diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index 10a515ce..e2343b2b 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -1,13 +1,13 @@ + - - - - + + + + @@ -17,20 +17,23 @@ Purpose : README for Privoxy - $Id: readme.sgml,v 1.2 2002/04/04 06:48:37 hal9 Exp $ + $Id: readme.sgml,v 2.25 2009/03/01 18:55:18 hal9 Exp $ - Written by and Copyright (C) 2001 the SourceForge - Privoxy team. http://www.privoxy.org/ + Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/ + See LICENSE. - Based on the Internet Junkbuster originally written - by and Copyright (C) 1997 Anonymous Coders and - Junkbusters Corporation. http://www.junkbusters.com + ======================================================================== + 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 + 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 - Makefile with 'make readme'. + Makefile with 'make dok-readme'. =================================================================== READ: @@ -39,7 +42,7 @@ NOTE: The left margin spacing is *important* when using 'literallayout' 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 @@ -51,12 +54,12 @@ entity % p-not-stable "IGNORE" in the DTD at the top. This will toggle various text 'off'. BOTH - MUST be toggled in this case. + MUST be toggled in this case or you will get both text referencing + stable and unstable versions. You only want one or the other! --> -
- + @@ -66,19 +69,18 @@ ]]> - + - /********************************************************************* * * 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 + * Copyright : Written by and Copyright (C) 2001-2009 the SourceForge * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written @@ -100,72 +102,82 @@ * 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 * *********************************************************************/ - - - + + + 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;. + + &p-intro; + +IMPORTANT CHANGES - - - IMPORTANT CHANGES ------------------- + March 2009, Privoxy 3.0.12 is released. - 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. + This is primarily a bug fix release. See the "ChangeLog", and the "What's + New" section and the "Upgrader's Notes" in the User + Manual for details. + - WARNING! If upgrading from earlier versions of this project via RPM packages, - the new package will delete any previously installed 'Junkbuster' packages. + February 2009, Privoxy 3.0.11 is released. - 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 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. - - - - INSTALL --------- + This is a stable release, and marks a departure for Privoxy development. - - - &buildsource; - - - - - RUN ----- + Previously, odd numbered releases were considered beta versions and + were only released at the end of the development cycle when the code + was already believed to be stable. Usually it was, so the stable release + contained pretty much the same code, but got a higher version number. + In the future we intend to release several snapshots between stable releases. + There will probably still be about two stable releases per year, + but hopefully about six snapshots instead of the two betas we have now. + The intentions is to make testing without CVS access easier. + + + + +INSTALL + + 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 @@ -173,35 +185,34 @@ See the man page or user-manual for a brief explanation of each option. 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 and Ubuntu: /etc/init.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 + 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 since Junkbuster v2.0.x. The - user-manual has a run down of configuration options, and examples: - http://www.privoxy.org/user-manual/. + 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 default.action file can be configured via the web interface accessed via + The actions list can be configured via the web interface accessed via http://p.p/, as well other options. ]]> + + +DOCUMENTATION - - - 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'. There - are several *.action files included, with varying levels of aggressiveness. - - - - Included documentation may vary according to platform and packager. + 'default.filter'. - - - CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS --------------------------------------------------------------- + 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. + + +CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS - &contacting; + &contacting; - - - - ------------------------------------------------------------------------- - ijbswa-developers@lists.sourceforge.net - - - - $Id: readme.sgml,v 1.2 2002/04/04 06:48:37 hal9 Exp $ - + + + + + + + + + + +