X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Freadme.sgml;h=90a8a0e95fd848f6efd8823a2b6702029364df51;hp=c795c1d05383d47766ebed2de82ba0e786af344a;hb=ec4fc8c32f1367996ede49c3fc9f867fa5b0e79d;hpb=115bcb1c460222dd564456eb2659b431224e9129 diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index c795c1d0..90a8a0e9 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -1,35 +1,65 @@ + - - + + + + + + + + + ]> + READ: -
+ ====================================================================== + 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. + ====================================================================== + + 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 + stable and unstable versions. You only want one or the other! + +--> +
+ @@ -39,26 +69,25 @@ ]]> - + - /********************************************************************* * - * File : $Source: /cvsroot/ijbswa/current/README,v $ + * 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-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 @@ -73,233 +102,137 @@ * 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 the development version of Privoxy, which will - eventually become Privoxy v3.0 (and soon we hope!). See - http://www.privoxy.org/. The current code level is BETA, and seems stable to - us :) + + This README is included with + Privoxy &p-version;. See http://www.privoxy.org/ for more information. The current code maturity + level is &p-status;. + + - + &p-intro; + + +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 - 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 3 Apr 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 --------- - - - For tarball, first unpack: - - - - tar xzvf privoxy-2.9.13-beta-src.tar.gz - cd privoxy-2.9.13-beta - - - - autoheader - autoconf - ./configure (--help to see options) - gmake (the make from gnu) - su - make -n install (to see where all the files will go) - make install (to really install) - - - - Redhat and SuSE src and binary RPMs can be built with 'make redhat-dist' or - 'make suse-dist' (run ./configure first) from unpacked sources. BSD will - (probably?) require gmake (from http://gnu.org). See the user-manual for OS/2 - build instructions. - - - Privoxy is also available via anonymous CVS: + 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. - - cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current - - - This will create a directory named 'current'. Then, 'cd current', and then - build as above. - + + +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', 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. + 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 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. + All configuration files are subject to unannounced changes during the development process. +]]> + + +DOCUMENTATION - - - DOCUMENTATION --------------- - There is a growing amount of documentation in the 'doc' subdirectory, but it - is not completed at this point. In particular, see the user-manual there, the - faq, and developers should look at developer-manual. + 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. + - - - Included documentation may vary according to platform and packager. - - - - - - CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS --------------------------------------------------------------- - - - -We value your feedback. However, to provide you with the best support, -please note: - - - - * Use the support forum to get help: - http://sourceforge.net/tracker/?group_id=11118&atid=211118 - - - - - * Submit bugs only thru our bug forum: - http://sourceforge.net/tracker/?group_id=11118&atid=111118 - - - - Make sure that the bug has not already been submitted. Please try - to verify that it is a Privoxy bug, and not a browser or site - bug first. If you are using your own custom configuration, please - try the stock configs to see if the problem is a configuration - related bug. And if not using the latest development snapshot, - please try the latest one. Or even better, CVS sources. Please - be sure to include the Privoxy/Junkbuster version, platform, - browser, any pertinent log data, any other relevant details - (please be specific) and, if possible, some way to reproduce the - bug. - - - - * Submit feature requests only thru our feature request forum: - http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse - - - - - - For any other issues, feel free to use the mailing lists: - http://sourceforge.net/mail/?group_id=11118 - - - - - - Anyone interested in actively participating in development and related - discussions can join the appropriate mailing list here: - http://sourceforge.net/mail/?group_id=11118. Archives are available here - too. - - - - - ------------------------------------------------------------------------- - ijbswa-developers@lists.sourceforge.net - - - - $Id: readme.sgml,v 1.0 2002/03/31 02:03:36 hal9 Exp $ - + configuration files. ]]>The source and configuration files are all well + commented. The main configuration files are: 'config', 'default.action', and + '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, + or can't find it. + + + + +CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS + + &contacting; + + + + + + + + + + + +