From: Fabian Keil Date: Wed, 7 Nov 2007 18:50:39 +0000 (+0000) Subject: - Use the name of "the proxy" more often. X-Git-Tag: v_3_0_7~81 X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=commitdiff_plain;h=573c8a27abc6c8df5bfd7ea90b5e4dcbac33151f - Use the name of "the proxy" more often. - Mark some obsolete features as such. - Split some paragraphs. - Add some more commentary for the recently disabled features. - Change the Tor instructions a bit, most importantly fixing the forward line. --- diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml index 53d0629f..b25860fe 100644 --- a/doc/source/p-config.sgml +++ b/doc/source/p-config.sgml @@ -3,7 +3,7 @@ Purpose : Used with other docs and files only. - $Id: p-config.sgml,v 2.19 2007/11/04 21:17:31 hal9 Exp $ + $Id: p-config.sgml,v 2.20 2007/11/07 11:36:53 hal9 Exp $ Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/ See LICENSE. @@ -95,7 +95,7 @@ Sample Configuration File for Privoxy v&p-version; - $Id: p-config.sgml,v 2.19 2007/11/04 21:17:31 hal9 Exp $ + $Id: p-config.sgml,v 2.20 2007/11/07 11:36:53 hal9 Exp $ Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/ @@ -269,12 +269,13 @@ II. FORMAT OF THE CONFIGURATION FILE PATH to where the User Manual is located: - +   user-manual  /usr/share/doc/privoxy/user-manual - The User Manual is then available to anyone with access to the proxy, by - following the built-in URL: http://config.privoxy.org/user-manual/ + The User Manual is then available to anyone with access to + Privoxy, by following the built-in URL: + http://config.privoxy.org/user-manual/ (or the shortcut: http://p.p/user-manual/). @@ -381,7 +382,7 @@ II. FORMAT OF THE CONFIGURATION FILE Specifies: - An email address to reach the proxy administrator. + An email address to reach the Privoxy administrator. @@ -408,7 +409,7 @@ II. FORMAT OF THE CONFIGURATION FILE Notes: - + If both admin-address and proxy-info-url are unset, the whole "Local Privoxy Support" box on all generated pages will not be shown. @@ -581,8 +582,10 @@ II. FORMAT OF THE CONFIGURATION FILE Privoxy's original templates are usually overwritten with each update. Use this option to relocate customized templates - that should be kept. Note that you might be missing new features - if you use outdated templates. + that should be kept. Note that template variables might change + between updates and templates are not guaranteed to work with + Privoxy releases other than the one + they were part of. @@ -715,6 +718,11 @@ actionsfile @@actionsfile standard.action # Internal purpose, recommended]]> @@actionsfile default.action # Main actions file]]> + @@actionsfile user.action # User customizations]]> @@ -762,7 +770,7 @@ actionsfile The filter files contain content modification rules that use regular expressions. These rules permit powerful changes on the content of Web pages, and optionally the headers - as well, e.g., you could disable your favorite JavaScript annoyances, + as well, e.g., you could try to disable your favorite JavaScript annoyances, re-write the actual displayed text, or just have some fun playing buzzword bingo with web pages. @@ -819,7 +827,7 @@ actionsfile Effect if unset: - No log file is used, all log messages go to the console (STDERR). + Logging is disabled unless --no-daemon mode is used. @@ -838,9 +846,19 @@ actionsfile of detail and number of messages are set with the debug option (see below). The logfile can be useful for tracking down a problem with Privoxy (e.g., it's not blocking an ad you - think it should block) but in most cases you probably will never look at - it. For this reason, it is disabled by default. For troubleshooting - purposes, you will have to explicitly enable it. + think it should block) and it can help you to monitor what your browser + is doing. + + + Many users will never look at it, however, and it's a privacy risk + if third parties can get access to it. It is therefore disabled by + default in Privoxy 3.0.7 and later. + + + For troubleshooting purposes, you will have to explicitly enable it. + Please don't file any support requests without trying to reproduce + the problem with logging enabled first. Once you read the log messages, + you may even be able to solve the problem on your own. Your logfile will grow indefinitely, and you will probably want to @@ -848,15 +866,22 @@ actionsfile (see man cron). For Red Hat based Linux distributions, a logrotate script has been included. + Any log files must be writable by whatever user Privoxy - is being run as (default on UNIX, user id is privoxy). + is being run as (on Unix, default user id is privoxy). @@ -906,7 +931,10 @@ actionsfile If debug 8 (show header parsing) is enabled, cookies are - written to the logfile with the rest of the headers. + also written to the logfile with the rest of the headers. + Therefore this option isn't very useful and may be removed + in future releases. Please report to the developers if you + are still using it. @@ -1139,7 +1167,7 @@ actionsfile Notes: - This option is only there for debug purposes and you should never + This option is only there for debugging purposes and you should never need to use it. It will drastically reduce performance. @@ -1223,7 +1251,6 @@ actionsfile also want to make sure that the following actions are disabled: enable-edit-actions and enable-remote-toggle - options! @@ -1287,11 +1314,16 @@ actionsfile If set to 0, Privoxy will start in toggled off mode, i.e. mostly behave like a normal, - content-neutral proxy where all ad blocking, filtering, etc are disabled. See - enable-remote-toggle below. This is not really useful + content-neutral proxy with both ad blocking and content filtering + disabled. See enable-remote-toggle below. + The windows version will only display the toggle icon in the system tray @@ -1342,8 +1374,7 @@ actionsfile When toggled off, Privoxy mostly acts like a normal, - content-neutral proxy, i.e. it acts as if none of the actions applied to - any URL. + content-neutral proxy, i.e. doesn't block ads or filter content. Access to the toggle feature can not be @@ -1351,11 +1382,15 @@ actionsfile so that everybody who can access Privoxy (see ACLs and listen-address above) can toggle it for all users. So this option is not recommended - for multi-user environments with untrusted users. Because of - the obvious security implications, this feature is off by default. - Note that malicious client side code (e.g Java) is also potentially - capable of changing Privoxy's intended - behavior. + for multi-user environments with untrusted users. + + + Note that malicious client side code (e.g Java) is also + capable of using this option. + + + As a lot of Privoxy users don't read + documentation, this feature has been disabled by default. Note that you must have compiled Privoxy with @@ -1413,8 +1448,11 @@ actionsfile This feature is disabled by default. If you are using Privoxy in a environment with trusted clients, you may enable this feature at your discretion. Note that malicious client - side code (e.g Java) is also potentially capable of changing - Privoxy's intended behavior. + side code (e.g Java) is also capable of using this feature. + + + This option may be removed in future releases as it has been obsoleted + by the more general header taggers. @@ -1464,11 +1502,21 @@ actionsfile controlled separately by ACLs or HTTP authentication, so that everybody who can access Privoxy (see ACLs and listen-address above) can - modify its configuration for all users. This option is not - recommended for multi-user environments with untrusted users - and is therefore disabled by default. Note that malicious client side code - (e.g Java) is also potentially capable of changing - Privoxy's intended behavior. + modify its configuration for all users. + + + This option is not recommended for environments + with untrusted users and is therefore disabled by default. + + + Note that malicious client side code (e.g Java) is also + capable of using the actions editor and you shouldn't enable + this options unless you understand the consequences and are + sure your browser is configured correctly. + + + As a lot of Privoxy users don't read + documentation, this feature has been disabled by default. Note that you must have compiled Privoxy with @@ -1957,13 +2005,14 @@ forward-socks4 and forward-socks4a - forward-socks4 / 127.0.0.1:9050 . + forward-socks4a / 127.0.0.1:9050 . - The public Tor network can't be used to reach your local network, - therefore it's a good idea to make some exceptions: + The public Tor network can't be used to + reach your local network, if you need to access local servers you + therefore might want to make some exceptions: @@ -1975,7 +2024,8 @@ forward-socks4 and forward-socks4a Unencrypted connections to systems in these address ranges will be as (un)secure as the local network is, but the alternative is that you - can't reach the network at all. + can't reach the local network through Privoxy + at all. If you also want to be able to reach servers in your local network by @@ -2130,7 +2180,7 @@ forward-socks4 and forward-socks4a that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method. - Only use this option, if you are getting many forwarding related error messages, + Only use this option, if you are getting lots of forwarding-related error messages that go away when you try again manually. Start with a small value and check Privoxy's logfile from time to time, to see how many retries are usually needed.