X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Freadme.sgml;h=a7a56d17732c62634425c626a33741b3302dab59;hp=26228e6242083db7a759deac739e8fcb749c7257;hb=1e978c46c5b5b21a8a283a9d62069cfc300ea0d1;hpb=5a73e418fa170b0362734c9da5f4921cd413e5f5 diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index 26228e62..a7a56d17 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -1,10 +1,10 @@ + - + @@ -16,28 +16,23 @@ File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $ Purpose : README for Privoxy - - $Id: readme.sgml,v 1.9 2002/04/24 04:04:12 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.59 2016/05/22 12:42:11 fabiankeil Exp $ + Copyright (C) 2001-2011 Privoxy Developers https://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'. =================================================================== @@ -45,27 +40,26 @@ ====================================================================== 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! --> -
- + @@ -75,26 +69,25 @@ ]]> - + - /********************************************************************* * * 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 - * Privoxy team. http://www.privoxy.org/ + * Copyright : Written by and Copyright (C) 2001-2011 the + * Privoxy team. https://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 @@ -109,105 +102,84 @@ * 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 https://www.privoxy.org/ for more information. The current code maturity + level is &p-status;. + + &p-intro; + +CHANGES - - - IMPORTANT CHANGES ------------------- + For a list of changes in this release, please have a + look at the "ChangeLog", the "What's New" section or + the "Upgrader's Notes" in the User Manual. - - 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. - - - WARNING! If upgrading from earlier versions of this project via RPM packages, - the new package will delete any previously installed 'Junkbuster' packages. - - - 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. - - - - - INSTALL --------- - - - - &buildsource; - + + +INSTALL - - - RUN ----- + 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 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: /etc/rc.d/init.d/privoxy start - - - Or for SuSE: /etc/rc.d/privoxy start - - - - + - CONFIGURATION --------------- - + +CONFIGURATION - See: 'config', 'default.action', 'user.action', and 'default.filter'. - 'user.action' is for personal configuration. 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 a run down of 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: https://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. + 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. The actions list can be configured via the web interface accessed via @@ -219,16 +191,16 @@ development process. ]]> + + +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'. + '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 https://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.9 2002/04/24 04:04:12 hal9 Exp $ - + + +