X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fp-config.sgml;h=3e6042152d6aa58275ad6f4ac9d6bc119126c3eb;hb=5f09f1da56cc5c58c5fbb4b63e3338ad9d069e2f;hp=b2c49b86dd3d16a60faccf820fb55ff911d54177;hpb=46efa6f8fea119c9671cd61aa2e29b2a3f2ad75c;p=privoxy.git diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml index b2c49b86..3e604215 100644 --- a/doc/source/p-config.sgml +++ b/doc/source/p-config.sgml @@ -3,39 +3,39 @@ Purpose : Used with other docs and files only. - $Id: p-config.sgml,v 2.35 2009/01/13 16:44:32 fabiankeil Exp $ + $Id: p-config.sgml,v 2.87 2012/10/21 13:02:01 fabiankeil Exp $ - Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/ + Copyright (C) 2001-2011 Privoxy Developers http://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. ======================================================================== - - This file contains all the config file comments and options. It used to + + This file contains all the config file comments and options. It used to build both the user-manual config sections, and all of config (yes, the main config file) itself. - Rationale: This is broken up into two files since a file with a prolog + Rationale: This is broken up into two files since a file with a prolog (DTD, etc) cannot be sourced as a secondary file. config.sgml is basically a wrapper for this file. IMPORTANT: - OPTIONS: The actual options are included in this file and prefixed with - '@@', and processed by the Makefile to strip the '@@'. Default options - that should appear commented out should be listed as: '@@#OPTION'. + OPTIONS: The actual options are included in this file and prefixed with + '@@', and processed by the Makefile to strip the '@@'. Default options + that should appear commented out should be listed as: '@@#OPTION'. Otherwise, as '@@OPTION'. Example: @@listen-address 127.0.0.1:8118 - The Makefile does significant other processing too. The final results - should be checked to make sure that the perl processing does not + The Makefile does significant other processing too. The final results + should be checked to make sure that the perl processing does not fubar something!!! Makefile processing requires w3m, fmt (shell line formatter), and perl. - + This file is included into: @@ -50,8 +50,8 @@ The Main Configuration File - Again, the main configuration file is named config on - Linux/Unix/BSD and OS/2, and config.txt on Windows. + By default, the main configuration file is named config, + with the exception of Windows, where it is named config.txt. Configuration lines consist of an initial keyword followed by a list of values, all separated by whitespace (any number of spaces or tabs). For example: @@ -59,11 +59,11 @@ - + confdir /etc/privoxy - + @@ -81,7 +81,9 @@ The main config file controls all aspects of Privoxy's operation that are not location dependent (i.e. they apply universally, no matter - where you may be surfing). + where you may be surfing). Like the filter and action files, the config file is + a plain text file and can be modified with a text editor like emacs, vim or + notepad.exe. ]]> @@ -95,10 +97,10 @@ Sample Configuration File for Privoxy v&p-version; - $Id: p-config.sgml,v 2.35 2009/01/13 16:44:32 fabiankeil Exp $ + $Id: p-config.sgml,v 2.87 2012/10/21 13:02:01 fabiankeil Exp $ -Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/ +Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/ @@ -165,7 +167,7 @@ II. FORMAT OF THE CONFIGURATION FILE Thus, by placing a # at the start of an existing configuration line, - you can make it a comment and it will be treated as if it weren't there. + you can make it a comment and it will be treated as if it weren't there. This is called "commenting out" an option and can be useful. Removing the # again is called "uncommenting". @@ -235,11 +237,11 @@ II. FORMAT OF THE CONFIGURATION FILE Notes: - The User Manual URI is the single best source of information on + The User Manual URI is the single best source of information on Privoxy, and is used for help links from some of the internal CGI pages. The manual itself is normally packaged with the binary distributions, so you probably want to set this to a locally - installed copy. + installed copy. Examples: @@ -263,7 +265,7 @@ II. FORMAT OF THE CONFIGURATION FILE   user-manual  file://///some-server/some-path/privoxy-&p-version;/user-manual/ - --> + --> The best all purpose solution is simply to put the full local PATH to where the User Manual is @@ -279,7 +281,7 @@ II. FORMAT OF THE CONFIGURATION FILE (or the shortcut: http://p.p/user-manual/). - If the documentation is not on the local system, it can be accessed + If the documentation is not on the local system, it can be accessed from a remote server, as: @@ -293,7 +295,7 @@ II. FORMAT OF THE CONFIGURATION FILE file, because it is used while the config file is being read on start-up. - + ]]>
- + If set, this option should be the first option in the config file, because it is used while the config file is being read. @@ -325,7 +327,7 @@ II. FORMAT OF THE CONFIGURATION FILE Specifies: - A URL to be displayed in the error page that users will see if access to an untrusted page is denied. + A URL to be displayed in the error page that users will see if access to an untrusted page is denied. @@ -338,7 +340,7 @@ II. FORMAT OF THE CONFIGURATION FILE Default value: - Two example URLs are provided + Unset @@ -369,8 +371,8 @@ II. FORMAT OF THE CONFIGURATION FILE -@@trust-info-url http://www.example.com/why_we_block.html]]> -@@trust-info-url http://www.example.com/what_we_allow.html]]> +@@#trust-info-url http://www.example.com/why_we_block.html]]> +@@#trust-info-url http://www.example.com/what_we_allow.html]]> @@ -413,7 +415,7 @@ II. FORMAT OF THE CONFIGURATION FILE If both admin-address and proxy-info-url are unset, the whole "Local Privoxy Support" box on all generated pages will not be shown. - + @@ -462,10 +464,10 @@ II. FORMAT OF THE CONFIGURATION FILE If both admin-address and proxy-info-url are unset, the whole "Local Privoxy Support" box on all generated pages will not be shown. - + This URL shouldn't be blocked ;-) - + @@ -487,7 +489,7 @@ II. FORMAT OF THE CONFIGURATION FILE Privoxy can (and normally does) use a number of other files for additional configuration, help and logging. This section of the configuration file tells Privoxy - where to find those other files. + where to find those other files. @@ -531,16 +533,16 @@ II. FORMAT OF THE CONFIGURATION FILE No trailing /, please. - + --> @@ -668,10 +670,13 @@ actionsfile - default.action # Main actions file + match-all.action # Actions that are applied to all sites and maybe overruled later on. + + + default.action # Main actions file - user.action # User customizations + user.action # User customizations @@ -680,7 +685,7 @@ actionsfile Effect if unset: - No actions are taken at all. More or less neutral proxying. + No actions are taken at all. More or less neutral proxying. @@ -690,15 +695,15 @@ actionsfile Multiple actionsfile lines are permitted, and are in fact recommended! - + The default values are default.action, which is the main actions file maintained by the developers, and user.action, where you can make your personal additions. - - Actions files contain all the per site and per URL configuration for + + Actions files contain all the per site and per URL configuration for ad blocking, cookie management, privacy considerations, etc. - There is no point in using Privoxy without at + There is no point in using Privoxy without at least one actions file. @@ -712,6 +717,7 @@ actionsfile +@@actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.]]> @@actionsfile default.action # Main actions file]]> + +handle-as-empty-document. + + + + + Type of value: + + + 0 or 1 + + + + + Default value: + + 0 + + + + Effect if unset: + + + Privoxy returns a status 403(forbidden) for all blocked pages. + + + + + Effect if set: + + + Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document + and a status 403(Forbidden) for all other blocked pages. + + + + + Notes: + + + This is a work-around for Firefox bug 492459: + + Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy. + + (https://bugzilla.mozilla.org/show_bug.cgi?id=492459) + As the bug has been fixed for quite some time this option should no longer + be needed and will be removed in a future release. Please speak up if you + have a reason why the option should be kept around. + + + + +@@#handle-as-empty-doc-returns-ok 1]]> + + + +enable-compression + + + Specifies: + + + Whether or not buffered content is compressed before delivery. + + + + + Type of value: + + + 0 or 1 + + + + + Default value: + + 0 + + + + Effect if unset: + + + Privoxy does not compress buffered content. + + + + + Effect if set: + + + Privoxy compresses buffered content before delivering it to the client, + provided the client supports it. + + + + + Notes: + + + This directive is only supported if Privoxy has been compiled with + FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB. + + + Compressing buffered content is mainly useful if Privoxy and the + client are running on different systems. If they are running on the + same system, enabling compression is likely to slow things down. + If you didn't measure otherwise, you should assume that it does + and keep this option disabled. + + + Privoxy will not compress buffered content below a certain length. + + + + +@@#enable-compression 1]]> + + + +compression-level + + + Specifies: + + + The compression level that is passed to the zlib library when compressing buffered content. + + + + + Type of value: + + + Positive number ranging from 0 to 9. + + + + + Default value: + + 1 + + + + Notes: + + + Compressing the data more takes usually longer than compressing + it less or not compressing it at all. Which level is best depends + on the connection between Privoxy and the client. If you can't + be bothered to benchmark it for yourself, you should stick with + the default and keep compression disabled. + + + If compression is disabled, the compression level is irrelevant. @@ -2469,12 +3168,87 @@ forward-socks4, forward-socks4a and forward-socks5 Examples: - socket-timeout 180 + + # Best speed (compared to the other levels) + compression-level 1 + # Best compression + compression-level 9 + # No compression. Only useful for testing as the added header + # slightly increases the amount of data that has to be sent. + # If your benchmark shows that using this compression level + # is superior to using no compression at all, the benchmark + # is likely to be flawed. + compression-level 0 + -@@socket-timeout 180]]> +@@#compression-level 1]]> + + + +client-header-order + + + Specifies: + + + The order in which client headers are sorted before forwarding them. + + + + + Type of value: + + + Client header names delimited by spaces or tabs + + + + + Default value: + + None + + + + Notes: + + + By default &my-app; leaves the client headers in the order they + were sent by the client. Headers are modified in-place, new headers + are added at the end of the already existing headers. + + + The header order can be used to fingerprint client requests + independently of other headers like the User-Agent. + + + This directive allows to sort the headers differently to better + mimic a different User-Agent. Client headers will be emitted + in the order given, headers whose name isn't explicitly specified + are added at the end. + + + Note that sorting headers in an uncommon way will make fingerprinting + actually easier. Encrypted headers are not affected by this directive. + + + + +@@#client-header-order Host \ +# User-Agent \ +# Accept \ +# Accept-Language \ +# Accept-Encoding \ +# Proxy-Connection,\ +# Referer,Cookie \ +# If-Modified-Since \ +# Cache-Control \ +# Content-Length \ +# Content-Type +]]> @@ -2504,11 +3278,11 @@ forward-socks4, forward-socks4a and forward-socks5 - + activity-animation 1 - + ]]> @@ -2517,26 +3291,27 @@ forward-socks4, forward-socks4a and forward-socks5 @@]]> If log-messages is set to 1, - Privoxy will log messages to the console - window: + Privoxy copies log messages to the console + window. + The log detail depends on the debug directive. @@#log-messages 1]]> - + log-messages 1 - + ]]> @@]]> - + If log-buffer-size is set to 1, the size of the log buffer, i.e. the amount of memory used for the log messages displayed in the console window, will be limited to log-max-lines (see below). @@ -2551,11 +3326,11 @@ forward-socks4, forward-socks4a and forward-socks5 - + log-buffer-size 1 - + ]]> @@ -2571,11 +3346,11 @@ forward-socks4, forward-socks4a and forward-socks5 - + log-max-lines 200 - + ]]> @@ -2592,11 +3367,11 @@ forward-socks4, forward-socks4a and forward-socks5 - + log-highlight-messages 1 - + ]]> @@ -2611,11 +3386,11 @@ forward-socks4, forward-socks4a and forward-socks5 - + log-font-name Comic Sans MS - + ]]> @@ -2630,18 +3405,18 @@ forward-socks4, forward-socks4a and forward-socks5 - + log-font-size 8 - + ]]> @@]]> - + show-on-task-bar controls whether or not Privoxy will appear as a button on the Task bar when minimized: @@ -2651,11 +3426,11 @@ forward-socks4, forward-socks4a and forward-socks5 - + show-on-task-bar 0 - + ]]> @@ -2672,11 +3447,11 @@ forward-socks4, forward-socks4a and forward-socks5 - + close-button-minimizes 1 - + ]]> @@ -2694,11 +3469,11 @@ forward-socks4, forward-socks4a and forward-socks5 - + #hide-console - + ]]>