X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Freadme.sgml;h=48c368b3ed09d229c227e3c15a92a3b7609349aa;hb=785ecb9887e87bb2ae9ec4e96a49deea0ae3e995;hp=112655cafd00a9f760aec14aab0e4394663970f1;hpb=0fe95c6387d3cd7173ad01a09acd06c111b189fe;p=privoxy.git diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index 112655ca..48c368b3 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -1,10 +1,10 @@ + - + @@ -17,15 +17,10 @@ Purpose : README for Privoxy - $Id: readme.sgml,v 1.6 2002/04/08 22:59:26 hal9 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.17 2008/02/05 00:47:12 hal9 Exp $ + Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/ + See LICENSE. ======================================================================== NOTE: Please read developer-manual/documentation.html before touching @@ -38,7 +33,7 @@ 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: @@ -63,9 +58,8 @@ stable and unstable versions. You only want one or the other! --> -
- + @@ -75,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-2008 the SourceForge * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written @@ -109,72 +102,83 @@ * 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 ------------------- + Privoxy is in development mode for the time being. Some of the current cvs + sources may not be well tested, and/or well documented. Current cvs is + suggested only for developers and adventuresome users. If you find any + problems, please report them on the appropriate SourceForge tracker, or the + developer's mailing list: ijbswa-developers@lists.sourceforge.net. Your help + will be appreciated! - 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. - - - - INSTALL --------- + 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. - - - &buildsource; - - - - - - RUN ----- + + + +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 @@ -182,35 +186,34 @@ 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 - - - 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. + 'default.filter'. - Included documentation may vary according to platform and packager. - - - - - - 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.6 2002/04/08 22:59:26 hal9 Exp $ - + + + + + + + + + + +