X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Freadme.sgml;h=a7a56d17732c62634425c626a33741b3302dab59;hp=cdf5dbe953b48c14ee6a8461f416cb8ec8a0eee3;hb=1e978c46c5b5b21a8a283a9d62069cfc300ea0d1;hpb=65583badb5665292c23515df41625ef96f209951 diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index cdf5dbe9..a7a56d17 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -1,10 +1,10 @@ + - + @@ -16,23 +16,23 @@ File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $ Purpose : README for Privoxy - - $Id: readme.sgml,v 2.11 2007/12/07 11:52:57 hal9 Exp $ - Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/ + $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'. =================================================================== @@ -40,21 +40,21 @@ ====================================================================== 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! --> @@ -80,14 +80,14 @@ * * Purpose : README file to give a short intro. * - * Copyright : Written by and Copyright (C) 2001-2007 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 @@ -102,8 +102,8 @@ * 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., - * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, + * or write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, * USA * *********************************************************************/ @@ -115,7 +115,7 @@ This README is included with - Privoxy &p-version;. See http://www.privoxy.org/ for more information. The current code maturity + Privoxy &p-version;. See https://www.privoxy.org/ for more information. The current code maturity level is &p-status;. @@ -126,45 +126,33 @@ -IMPORTANT CHANGES - - December 2007, Privoxy 3.0.7 beta is released. This is a significant upgrade - with many new and enhanced features, and many bugs fixed. - 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. - - - 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. - +CHANGES - 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. + 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. + INSTALL - + See the INSTALL file in this directory, for installing from raw source, and the User Manual, for all other - installation types. + installation types. RUN - privoxy [——help] [——version] - [——no-daemon] [——pidfile PIDFILE] [——user - USER[.GROUP]] [——chroot] [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 an explanation of each option, and + See the man page or User Manual for an explanation of each option, and other configuration and usage issues. @@ -172,12 +160,6 @@ 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 and Fedora based distributions: /etc/rc.d/init.d/privoxy start - - - Or Debian: /etc/init.d/privoxy start - @@ -191,12 +173,12 @@ /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: http://www.privoxy.org/user-manual/. + 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. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it + 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. @@ -215,10 +197,10 @@ DOCUMENTATION There should be documentation in the 'doc' subdirectory. In particular, see the + 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. + 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. All - documentation is posted on http://www.privoxy.org, in case you don't have it, + 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. @@ -244,13 +226,7 @@ - - - - - - - +