X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fsource%2Freadme.sgml;h=2882344e6e77b68183c07279e27a0b9911e21bac;hb=e70110618027c7cb90164df41ae9b5fefb6ef5ac;hp=91a2a98e68bad93f916f754a6996febdb7cfb300;hpb=d7cc11956d778be9da159f012e80733d2d082706;p=privoxy.git diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index 91a2a98e..2882344e 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -1,13 +1,15 @@ + - - - - + + + + + + @@ -17,20 +19,21 @@ Purpose : README for Privoxy - $Id: readme.sgml,v 1.1 2002/04/03 06:01:41 hal9 Exp $ + $Id: readme.sgml,v 1.19 2002/07/25 21:51:25 hal9 Exp $ - Written by and Copyright (C) 2001 the SourceForge - Privoxy team. http://www.privoxy.org/ + Copyright (C) 2001, 2002 Privoxy Developers + 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. + ======================================================================== =================================================================== 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: @@ -38,24 +41,13 @@ ====================================================================== 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. + the para tag forces a linebreak. Tags need to be carefully placed as a result + to avoid extra blank lines, etc. ====================================================================== - For stable releases, change - - entity % p-not-stable "INCLUDE" - - to - - entity % not-stable "IGNORE" - - in the DTD at the top. This will toggle various text 'off'. BOTH - MUST be toggled in this case. - --> -
- + @@ -65,12 +57,11 @@ ]]> - + - /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $ @@ -103,29 +94,30 @@ * Temple Place - Suite 330, Boston, MA 02111-1307, 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 + level is &p-status;. + + + &p-intro; - - - - IMPORTANT CHANGES ------------------- - + +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 @@ -140,31 +132,25 @@ port is now 8118 due to conflicts with port 8000 assignment. You will need to change your browser if upgrading!!! And maybe firewall, etc. + - - - - INSTALL --------- - - + +INSTALL &buildsource; + + +RUN - - - RUN ----- + privoxy [——help] [——version] + [——no-daemon] [——pidfile PIDFILE] [——user + USER[.GROUP]] [config_file] - - privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] - [--user USER[.GROUP]] [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 @@ -172,35 +158,36 @@ 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 based distributions: /etc/rc.d/init.d/privoxy start Or for SuSE: /etc/rc.d/privoxy start - - - - CONFIGURATION --------------- + Or Debian: /etc/init.d/privoxy start + + + +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 - /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', 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/. 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 + may not be in sync with current code]]>. 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 --------------------------------------------------------------- - - + +CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS - &contacting; + &contacting; - - - - ------------------------------------------------------------------------- - ijbswa-developers@lists.sourceforge.net - - - - $Id: readme.sgml,v 1.1 2002/04/03 06:01:41 hal9 Exp $ - + + + + + + + + + + +