X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Freadme.sgml;h=2acf495aa1bb0e0634cdc948948eae46b63e8fd8;hp=aa6c2f2581504c51c75db497042849863b516073;hb=34a6a841e529579e2be4457ea0d4cb1befbc840a;hpb=1ebaf56647ca9a7fdcc9c55a78cb740f31a6cd1d diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index aa6c2f25..2acf495a 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -1,11 +1,11 @@ + - - + + @@ -13,24 +13,24 @@ ]>
@@ -62,18 +74,18 @@ /********************************************************************* * - * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $ + * File : doc/source/readme.sgml * - * Purpose : README file to give a short intro. + * Purpose : Give a short intro about Privoxy. * - * Copyright : Written by and Copyright (C) 2001 the SourceForge - * Privoxy team. http://www.privoxy.org/ + * Copyright : Written by and Copyright (C) 2001-2020 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 @@ -88,8 +100,9 @@ * 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 * *********************************************************************/ @@ -100,9 +113,8 @@ 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;. @@ -112,39 +124,33 @@ -IMPORTANT CHANGES +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 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. + 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 - - &buildsource; - + + 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 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. @@ -152,33 +158,26 @@ 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 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 - 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/. + 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 @@ -196,9 +195,10 @@ 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. + 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. @@ -221,14 +223,4 @@ - - - - - - - - - -