X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fp-config.sgml;h=b0b5f7af82ba9089f8c7136ce9c7149fef7e2c58;hp=50265291a5bd8ee78aa5b1ecaf65390cba6ad752;hb=7a99a61ab1a3ce0401821aedcd06eba19a698b2a;hpb=b101107b0df7aa3b6c4ab7df6c09f3b95e877b30 diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml index 50265291..b0b5f7af 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.16 2007/06/01 14:14:29 fabiankeil Exp $ + $Id: p-config.sgml,v 2.113 2015/01/24 16:42:13 fabiankeil Exp $ - Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/ + Copyright (C) 2001-2016 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. ]]> @@ -92,13 +94,13 @@ @@TITLE<!-- between the @@ is stripped by Makefile -->@@ - Sample Configuration File for Privoxy v&p-version; + Sample Configuration File for Privoxy &p-version; - $Id: p-config.sgml,v 2.16 2007/06/01 14:14:29 fabiankeil Exp $ + $Id: p-config.sgml,v 2.113 2015/01/24 16:42:13 fabiankeil Exp $ -Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/ +Copyright (C) 2001-2016 Privoxy Developers http://www.privoxy.org/ @@ -115,7 +117,8 @@ Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/ 3. DEBUGGING # 4. ACCESS CONTROL AND SECURITY # 5. FORWARDING # - 6. WINDOWS GUI OPTIONS # + 6. MISCELLANEOUS # + 7. WINDOWS GUI OPTIONS # # ################################################################# @@ -165,14 +168,14 @@ 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". Note that commenting out an option and leaving it at its default are two completely different things! Most options behave very - differently when unset. See the the "Effect if unset" explanation + differently when unset. See the "Effect if unset" explanation in each option's description for details. @@ -235,11 +238,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,22 +266,23 @@ 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 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/). - 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: @@ -292,7 +296,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. @@ -324,7 +328,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. @@ -337,7 +341,7 @@ II. FORMAT OF THE CONFIGURATION FILE Default value: - Two example URL are provided + Unset @@ -353,7 +357,7 @@ II. FORMAT OF THE CONFIGURATION FILE The value of this option only matters if the experimental trust mechanism has been - activated. (See trustfile above.) + activated. (See trustfile below.) If you use the trust mechanism, it is a good idea to write up some on-line @@ -368,8 +372,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]]> @@ -381,7 +385,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,11 +412,11 @@ 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. - + @@ -461,10 +465,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 ;-) - + @@ -486,7 +490,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. @@ -503,7 +507,7 @@ II. FORMAT OF THE CONFIGURATION FILE Specifies: - The directory where the other configuration files are located + The directory where the other configuration files are located. @@ -528,18 +532,8 @@ II. FORMAT OF THE CONFIGURATION FILE Notes: - No trailing /, please + No trailing /, please. - @@ -554,7 +548,7 @@ II. FORMAT OF THE CONFIGURATION FILE Specifies: - An alternative directory where the templates are loaded from + An alternative directory where the templates are loaded from. @@ -579,10 +573,12 @@ II. FORMAT OF THE CONFIGURATION FILE Notes: - 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. + Privoxy's original templates are usually + overwritten with each update. Use this option to relocate customized + templates that should be kept. As template variables might change + between updates, you shouldn't expect templates to work with + Privoxy releases other than the one + they were part of, though. @@ -592,6 +588,55 @@ II. FORMAT OF THE CONFIGURATION FILE + +temporary-directory + + + + Specifies: + + A directory where Privoxy can create temporary files. + + + + Type of value: + + Path name + + + + Default value: + + unset + + + + Effect if unset: + + No temporary files are created, external filters don't work. + + + + Notes: + + + To execute external filters, + Privoxy has to create temporary files. + This directive specifies the directory the temporary files should + be written to. + + + It should be a directory only Privoxy + (and trusted users) can access. + + + + + +@@#temporary-directory .]]> + + + logdir @@ -600,8 +645,8 @@ II. FORMAT OF THE CONFIGURATION FILE Specifies: - The directory where all logging takes place (i.e. where logfile and - jarfile are located) + The directory where all logging takes place + (i.e. where the logfile is located). @@ -627,7 +672,7 @@ II. FORMAT OF THE CONFIGURATION FILE Notes: - No trailing /, please + No trailing /, please. @@ -665,13 +710,13 @@ actionsfile - standard.action # Internal purposes, no editing recommended + match-all.action # Actions that are applied to all sites and maybe overruled later on. - default.action # Main actions file + default.action # Main actions file - user.action # User customizations + user.action # User customizations @@ -680,7 +725,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,22 +735,14 @@ actionsfile Multiple actionsfile lines are permitted, and are in fact recommended! - - The default values include standard.action, which is used for internal - purposes and should be loaded, default.action, which is the + + 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 are where all the per site and per URL configuration is done for - ad blocking, cookie management, privacy considerations, etc. - There is no point in using Privoxy without at - least one actions file. - - Note that since Privoxy 3.0.7, the complete filename, including the .action - extension has to be specified. The syntax change was necessary to be consistent - with the other file options and to allow previously forbidden characters. + Actions files contain all the per site and per URL configuration for + ad blocking, cookie management, privacy considerations, etc. @@ -713,8 +750,13 @@ actionsfile -@@actionsfile standard.action # Internal purpose, recommended]]> +@@actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.]]> @@actionsfile default.action # Main actions file]]> + @@actionsfile user.action # User customizations]]> @@ -762,8 +804,8 @@ 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, - re-write the actual displayed text, or just have some fun + 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. @@ -787,7 +829,7 @@ actionsfile @@filterfile default.filter]]> -@@#filterfile user.filter # User customizations]]> +@@filterfile user.filter # User customizations]]> @@ -812,105 +854,52 @@ actionsfile Default value: - logfile (Unix) or privoxy.log (Windows) + Unset (commented out). When activated: logfile (Unix) or privoxy.log (Windows). Effect if unset: - No log file is used, all log messages go to the console (STDERR). + No logfile is written. Notes: - The logfile is where all logging and error messages are written. The level 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. - - - Your logfile will grow indefinitely, and you will probably want to - periodically remove it. On Unix systems, you can do this with a cron job - (see man cron). For Red Hat, a logrotate - script has been included. - - - On SuSE Linux systems, you can place a line like /var/log/privoxy.* - +1024k 644 nobody.nogroup in /etc/logfiles, with - the effect that cron.daily will automatically archive, gzip, and empty the - log, when it exceeds 1M size. + think it should block) and it can help you to monitor what your browser + is doing. - Any log files must be writable by whatever user Privoxy - is being run as (default on UNIX, user id is privoxy). - - - - - -@@logfile logfile]]> - - - - -jarfile - - - - Specifies: - - - The file to store intercepted cookies in + Depending on the debug options below, the logfile may be a privacy risk + if third parties can get access to it. As most users will never look + at it, Privoxy only logs fatal errors by default. - - - - Type of value: - - File name, relative to logdir - - - - Default value: - - Unset (commented out). When activated: jarfile (Unix) or privoxy.jar (Windows) - - - - Effect if unset: - - Intercepted cookies are not stored in a dedicated log file. + For most troubleshooting purposes, you will have to change that, + please refer to the debugging section for details. - - - - Notes: - - The jarfile may grow to ridiculous sizes over time. + Any log files must be writable by whatever user Privoxy + is being run as (on Unix, default user id is privoxy). - If debug 8 (show header parsing) is enabled, cookies are - written to the logfile with the rest of the headers. + To prevent the logfile from growing indefinitely, it is recommended to + periodically rotate or shorten it. Many operating systems support log + rotation out of the box, some require additional software to do it. + For details, please refer to the documentation for your operating system. -@@#jarfile jarfile]]> +@@logfile logfile]]> @@ -954,14 +943,14 @@ actionsfile If you specify a trust file, Privoxy will only allow - access to sites that are specified in the trustfile. Sites can be listed + access to sites that are specified in the trustfile. Sites can be listed in one of two ways: - Prepending a ~ character limits access to this site - only (and any sub-paths within this site), e.g. + Prepending a ~ character limits access to this site + only (and any sub-paths within this site), e.g. ~www.example.com allows access to - ~www.example.com/features/news.html, etc. + ~www.example.com/features/news.html, etc. Or, you can designate sites as trusted referrers, by @@ -975,7 +964,7 @@ actionsfile made. - If you use the + operator in the trust file, it may grow + If you use the + operator in the trust file, it may grow considerably over time. @@ -987,7 +976,7 @@ actionsfile Possible applications include limiting Internet access for children. - + @@ -1016,8 +1005,7 @@ actionsfile Specifies: - Key values that determine what information gets logged to the - logfile. + Key values that determine what information gets logged. @@ -1030,14 +1018,14 @@ actionsfile Default value: - 12289 (i.e.: URLs plus informational and warning messages) + 0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged) Effect if unset: - Nothing gets logged. + Default value is used (see above). @@ -1049,20 +1037,22 @@ actionsfile - debug 1 # show each GET/POST/CONNECT request - debug 2 # show each connection status - debug 4 # show I/O status - debug 8 # show header parsing - debug 16 # log all data written to the network into the logfile - debug 32 # debug force feature - debug 64 # debug regular expression filters - debug 128 # debug redirects - debug 256 # debug GIF de-animation - debug 512 # Common Log Format - debug 1024 # debug kill pop-ups - debug 2048 # CGI user interface - debug 4096 # Startup banner and warnings. - debug 8192 # Non-fatal errors + debug 1 # Log the destination for each request &my-app; let through. See also debug 1024. + debug 2 # show each connection status + debug 4 # show I/O status + debug 8 # show header parsing + debug 16 # log all data written to the network + debug 32 # debug force feature + debug 64 # debug regular expression filters + debug 128 # debug redirects + debug 256 # debug GIF de-animation + debug 512 # Common Log Format + debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why. + debug 2048 # CGI user interface + debug 4096 # Startup banner and warnings. + debug 8192 # Non-fatal errors + debug 32768 # log all data read from the network + debug 65536 # Log the applying actions @@ -1071,18 +1061,17 @@ actionsfile A debug level of 1 is informative because it will show you each request - as it happens. 1, 4096 and 8192 are highly recommended - so that you will notice when things go wrong. The other levels are probably - only of interest if you are hunting down a specific problem. They can produce - a hell of an output (especially 16). - + as it happens. 1, 1024, 4096 and 8192 are recommended + so that you will notice when things go wrong. The other levels are + probably only of interest if you are hunting down a specific problem. + They can produce a hell of an output (especially 16). - The reporting of fatal errors (i.e. ones which causes - Privoxy to exit) is always on and cannot be disabled. + If you are used to the more verbose settings, simply enable the debug lines + below again. - If you want to use CLF (Common Log Format), you should set debug + If you want to use pure CLF (Common Log Format), you should set debug 512 ONLY and not enable anything else. @@ -1090,13 +1079,19 @@ actionsfile length of log messages. If it's reached, messages are logged truncated and marked with ... [too long, truncated]. + + Please don't file any support requests without trying to reproduce + the problem with increased debug level first. Once you read the log + messages, you may even be able to solve the problem on your own. + -@@debug 1 # show each GET/POST/CONNECT request]]> -@@debug 4096 # Startup banner and warnings]]> -@@debug 8192 # Errors - *we highly recommended enabling this*]]> +@@#debug 1 # Log the destination for each request &my-app; let through.]]> +@@#debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why.]]> +@@#debug 4096 # Startup banner and warnings]]> +@@#debug 8192 # Non-fatal errors]]> @@ -1108,20 +1103,20 @@ actionsfile Specifies: - Whether to run only one server thread + Whether to run only one server thread. Type of value: - None + 1 or 0 Default value: - Unset + 0 @@ -1137,14 +1132,70 @@ actionsfile Notes: - This option is only there for debug purposes and you should never - need to use it. It will drastically reduce performance. + This option is only there for debugging purposes. + It will drastically reduce performance. + + + + + +@@#single-threaded 1]]> + + + +hostname + + + + Specifies: + + + The hostname shown on the CGI pages. + + + + + Type of value: + + Text + + + + Default value: + + Unset + + + + Effect if unset: + + + The hostname provided by the operating system is used. + + + + + Notes: + + + On some misconfigured systems resolving the hostname fails or + takes too much time and slows Privoxy down. Setting a fixed hostname + works around the problem. + + + In other circumstances it might be desirable to show a hostname + other than the one returned by the operating system. For example + if the system has several different hostnames and you don't want + to use the first one. + + + Note that Privoxy does not validate the specified hostname value. -@@#single-threaded]]> +@@#hostname hostname.example.org]]> @@ -1170,7 +1221,7 @@ actionsfile Specifies: - The IP address and TCP port on which Privoxy will + The address and TCP port on which Privoxy will listen for client requests. @@ -1179,6 +1230,7 @@ actionsfile Type of value: [IP-Address]:Port + [Hostname]:Port @@ -1192,9 +1244,9 @@ actionsfile Effect if unset: - Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for - home users who run Privoxy on the same machine as - their browser. + Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable and + recommended for home users who run Privoxy on + the same machine as their browser. @@ -1210,18 +1262,61 @@ actionsfile will need to override the default. - If you leave out the IP address, Privoxy will - bind to all interfaces (addresses) on your machine and may become reachable - from the Internet. In that case, consider using access control lists (ACL's, see below), and/or - a firewall. + You can use this statement multiple times to make + Privoxy listen on more ports or more + IP addresses. Suitable if your operating system does not + support sharing IPv6 and IPv4 protocols + on the same socket. + + + If a hostname is used instead of an IP address, Privoxy + will try to resolve it to an IP address and if there are multiple, use the first + one returned. + + + If the address for the hostname isn't already known on the system + (for example because it's in /etc/hostname), this may result in DNS + traffic. + + + If the specified address isn't available on the system, or if the + hostname can't be resolved, Privoxy + will fail to start. + + + IPv6 addresses containing colons have to be quoted by brackets. + They can only be used if Privoxy has + been compiled with IPv6 support. If you aren't sure if your version + supports it, have a look at + http://config.privoxy.org/show-status. + + + Some operating systems will prefer IPv6 to IPv4 addresses even if the + system has no IPv6 connectivity which is usually not expected by the user. + Some even rely on DNS to resolve localhost which mean the "localhost" address + used may not actually be local. + + + It is therefore recommended to explicitly configure the intended IP address + instead of relying on the operating system, unless there's a strong reason not to. + + + If you leave out the address, Privoxy will bind to all + IPv4 interfaces (addresses) on your machine and may become reachable from the + Internet and/or the local network. Be aware that some GNU/Linux distributions + modify that behaviour without updating the documentation. Check for non-standard + patches if your Privoxy version behaves differently. + + + If you configure Privoxy to be reachable from the + network, consider using access control lists + (ACL's, see below), and/or a firewall. If you open Privoxy to untrusted users, you will - also want to turn off the enable-edit-actions and enable-remote-toggle - options! @@ -1237,6 +1332,16 @@ actionsfile listen-address 192.168.0.1:8118 + + + + Suppose you are running Privoxy on an + IPv6-capable machine and you want it to listen on the IPv6 address + of the loopback device: + + + + listen-address [::1]:8118 @@ -1285,15 +1390,8 @@ 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 - anymore, since toggling is much easier via the web interface than via - editing the conf file. - - - The windows version will only display the toggle icon in the system tray - if this option is present. + content-neutral proxy with both ad blocking and content filtering + disabled. See enable-remote-toggle below. @@ -1324,7 +1422,7 @@ actionsfile Default value: - 1 + 0 @@ -1340,26 +1438,33 @@ 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. - For the time being, access to the toggle feature can not be + Access to the toggle feature can not be controlled separately by ACLs or HTTP authentication, 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. + + 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 is disabled by default. + Note that you must have compiled Privoxy with - support for this feature, otherwise this option has no effect. + support for this feature, otherwise this option has no effect. -@@enable-remote-toggle 1]]> +@@enable-remote-toggle 0]]> @@ -1383,7 +1488,7 @@ actionsfile Default value: - 1 + 0 @@ -1404,16 +1509,20 @@ actionsfile the ongoing request, even if it is enabled in one of the action files. - If you are using Privoxy in a - multi-user environment or with untrustworthy clients and want to - enforce filtering, you will have to disable this option, - otherwise you can ignore it. + 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 capable of using this feature. + + + This option will be removed in future releases as it has been obsoleted + by the more general header taggers. -@@enable-remote-http-toggle 1]]> +@@enable-remote-http-toggle 0]]> @@ -1438,7 +1547,7 @@ actionsfile Default value: - 1 + 0 @@ -1453,22 +1562,32 @@ actionsfile Notes: - For the time being, access to the editor can not be + Access to the editor can not be 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. So this option is not - recommended for multi-user environments with untrusted users. + modify its configuration for all users. + + + This option is not recommended for environments + with untrusted users and as a lot of Privoxy + users don't read documentation, this feature is 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. Note that you must have compiled Privoxy with - support for this feature, otherwise this option has no effect. + support for this feature, otherwise this option has no effect. -@@enable-edit-actions 1]]> +@@enable-edit-actions 0]]> @@ -1565,23 +1684,41 @@ ACLs: permit-access and deny-access Type of value: - src_addr[/src_masklen] - [dst_addr[/dst_masklen]] + src_addr[:port][/src_masklen] + [dst_addr[:port][/dst_masklen]] - Where src_addr and - dst_addr are IP addresses in dotted decimal notation or valid - DNS names, and src_masklen and + Where src_addr and + dst_addr are IPv4 addresses in dotted decimal notation or valid + DNS names, port is a port + number, and src_masklen and dst_masklen are subnet masks in CIDR notation, i.e. integer values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole destination part are optional. + + If your system implements + RFC 3493, then + src_addr and dst_addr can be IPv6 addresses delimeted by + brackets, port can be a number + or a service name, and + src_masklen and + dst_masklen can be a number + from 0 to 128. + Default value: Unset + + If no port is specified, + any port will match. If no src_masklen or + src_masklen is given, the complete IP + address has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6). + @@ -1598,16 +1735,16 @@ ACLs: permit-access and deny-access Access controls are included at the request of ISPs and systems administrators, and are not usually needed by individual users. - For a typical home user, it will normally suffice to ensure that + For a typical home user, it will normally suffice to ensure that Privoxy only listens on the localhost (127.0.0.1) or internal (home) network address by means of the listen-address - option. + option. - Please see the warnings in the FAQ that this proxy is not intended to be a substitute - for a firewall or to encourage anyone to defer addressing basic security - weaknesses. + Please see the warnings in the FAQ that Privoxy + is not intended to be a substitute for a firewall or to encourage anyone + to defer addressing basic security weaknesses. Multiple ACL lines are OK. @@ -1630,6 +1767,13 @@ ACLs: permit-access and deny-access like *.org or partial domain names. If a DNS name resolves to multiple IP addresses, only the first one is used. + + Some systems allow IPv4 clients to connect to IPv6 server sockets. + Then the client's IPv4 address will be translated by the system into + IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4 + mapped IPv6 address). Privoxy can handle it + and maps such ACL addresses automatically. + Denying access to particular sites by ACL may have undesired side effects if the site in question is hosted on a machine which also hosts other sites @@ -1671,6 +1815,24 @@ ACLs: permit-access and deny-access deny-access 192.168.45.73 www.dirty-stuff.example.com + + Allow access from the IPv4 network 192.0.2.0/24 even if listening on + an IPv6 wild card address (not supported on all platforms): + + + + permit-access 192.0.2.0/24 + + + + This is equivalent to the following line even if listening on an + IPv4 address (not supported on all platforms): + + + + permit-access [::ffff:192.0.2.0]/120 + + @@ -1714,7 +1876,7 @@ ACLs: permit-access and deny-access For content filtering, i.e. the +filter and - +deanimate-gif actions, it is necessary that + +deanimate-gif actions, it is necessary that Privoxy buffers the entire document body. This can be potentially dangerous, since a server could just keep sending data indefinitely and wait for your RAM to exhaust -- with nasty consequences. @@ -1735,6 +1897,67 @@ ACLs: permit-access and deny-access @@buffer-limit 4096]]> + +enable-proxy-authentication-forwarding + + + Specifies: + + + Whether or not proxy authentication through &my-app; should work. + + + + + Type of value: + + 0 or 1 + + + + Default value: + + 0 + + + + Effect if unset: + + + Proxy authentication headers are removed. + + + + + Notes: + + + Privoxy itself does not support proxy authentication, but can + allow clients to authenticate against Privoxy's parent proxy. + + + By default Privoxy (3.0.21 and later) don't do that and remove + Proxy-Authorization headers in requests and Proxy-Authenticate + headers in responses to make it harder for malicious sites to + trick inexperienced users into providing login information. + + + If this option is enabled the headers are forwarded. + + + Enabling this option is not recommended if there is + no parent proxy that requires authentication or if the local network between + Privoxy and the parent proxy isn't trustworthy. If proxy authentication is + only required for some requests, it is recommended to use a client header filter + to remove the authentication headers for requests where they aren't needed. + + + + + +@@enable-proxy-authentication-forwarding 0]]> + + @@ -1787,12 +2010,12 @@ ACLs: permit-access and deny-access http_parent[:port] - where target_pattern is a URL pattern + where target_pattern is a URL pattern that specifies to which requests (i.e. URLs) this forward rule shall apply. Use / to denote all URLs. http_parent[:port] is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded, - optionally followed by its listening port (default: 8080). + optionally followed by its listening port (default: 8000). Use a single dot (.) to denote no forwarding. @@ -1818,6 +2041,16 @@ ACLs: permit-access and deny-access If http_parent is ., then requests are not forwarded to another HTTP proxy but are made directly to the web servers. + + http_parent can be a + numerical IPv6 address (if + RFC 3493 is + implemented). To prevent clashes with the port delimiter, the whole IP + address has to be put into brackets. On the other hand a target_pattern containing an IPv6 address + has to be put into angle brackets (normal brackets are reserved for + regular expressions already). + Multiple lines are OK, they are checked in sequence, and the last match wins. @@ -1841,19 +2074,37 @@ ACLs: permit-access and deny-access - forward / caching-proxy.example-isp.net:8000 - forward .example-isp.net . + forward / caching-proxy.isp.example.net:8000 + forward .isp.example.net . - - - + + Parent proxy specified by an IPv6 address: + + + + forward / [2001:DB8::1]:8000 + + + + Suppose your parent proxy doesn't support IPv6: + + + + forward / parent-proxy.example.org:8000 + forward ipv6-server.example.org . + forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> . + + + + + -forward-socks4 and forward-socks4a +forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t @@ -1875,13 +2126,16 @@ forward-socks4 and forward-socks4a http_parent[:port] - where target_pattern is a URL pattern - that specifies to which requests (i.e. URLs) this forward rule shall apply. Use / to - denote all URLs. - http_parent and socks_proxy - are IP addresses in dotted decimal notation or valid DNS names (http_parent - may be . to denote no HTTP forwarding), and the optional - port parameters are TCP ports, i.e. integer values from 1 to 64535 + where target_pattern is a + URL pattern that specifies to which + requests (i.e. URLs) this forward rule shall apply. Use / to + denote all URLs. http_parent + and socks_proxy + are IP addresses in dotted decimal notation or valid DNS names + (http_parent + may be . to denote no HTTP forwarding), and the optional + port parameters are TCP ports, + i.e. integer values from 1 to 65535 @@ -1910,6 +2164,26 @@ forward-socks4 and forward-socks4a is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS server, while in SOCKS 4 it happens locally. + + With forward-socks5 the DNS resolution will happen on the remote server as well. + + + forward-socks5t works like vanilla forward-socks5 but + lets &my-app; additionally use Tor-specific SOCKS extensions. Currently the only supported + SOCKS extension is optimistic data which can reduce the latency for the first request made + on a newly created connection. + + + socks_proxy and + http_parent can be a + numerical IPv6 address (if + RFC 3493 is + implemented). To prevent clashes with the port delimiter, the whole IP + address has to be put into brackets. On the other hand a target_pattern containing an IPv6 address + has to be put into angle brackets (normal brackets are reserved for + regular expressions already). + If http_parent is ., then requests are not forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through @@ -1928,7 +2202,7 @@ forward-socks4 and forward-socks4a - forward-socks4a / socks-gw.example.com:1080 www-cache.example-isp.net:8080 + forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080 forward .example.com . @@ -1940,20 +2214,26 @@ forward-socks4 and forward-socks4a forward-socks4 / socks-gw.example.com:1080 . - + - To chain Privoxy and Tor, both running on the same system, you should use - the rule: + To chain Privoxy and Tor, both running on the same system, you would use + something like: - forward-socks4 / 127.0.0.1:9050 . + forward-socks5t / 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: + + Note that if you got Tor through one of the bundles, you may + have to change the port from 9050 to 9150 (or even another one). + For details, please check the documentation on the + Tor website. + + + 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: @@ -1965,7 +2245,9 @@ 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. Of course this may actually be desired and there is no reason + to make these exceptions if you aren't sure you need them. If you also want to be able to reach servers in your local network by @@ -1988,15 +2270,15 @@ forward-socks4 and forward-socks4a Advanced Forwarding Examples - If you have links to multiple ISPs that provide various special content + If you have links to multiple ISPs that provide various special content only to their subscribers, you can configure multiple Privoxies which have connections to the respective ISPs to act as forwarders to each other, so that your users can see the internal content of all ISPs. - Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to - isp-b.net. Both run Privoxy. Their forwarding + Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to + isp-b.example.org. Both run Privoxy. Their forwarding configuration can look like this: @@ -2007,7 +2289,7 @@ forward-socks4 and forward-socks4a forward / . - forward .isp-b.net host-b:8118 + forward .isp-b.example.net host-b:8118 @@ -2018,7 +2300,7 @@ forward-socks4 and forward-socks4a forward / . - forward .isp-a.net host-a:8118 + forward .isp-a.example.org host-a:8118 @@ -2029,9 +2311,9 @@ forward-socks4 and forward-socks4a - If you intend to chain Privoxy and - squid locally, then chain as - browser -> squid -> privoxy is the recommended way. + If you intend to chain Privoxy and + squid locally, then chaining as + browser -> squid -> privoxy is the recommended way. @@ -2041,14 +2323,14 @@ forward-socks4 and forward-socks4a - # Define Privoxy as parent proxy (without ICP) - cache_peer 127.0.0.1 parent 8118 7 no-query + # Define Privoxy as parent proxy (without ICP) + cache_peer 127.0.0.1 parent 8118 7 no-query - # Define ACL for protocol FTP - acl ftp proto FTP + # Define ACL for protocol FTP + acl ftp proto FTP # Do not forward FTP requests to Privoxy - always_direct allow ftp + always_direct allow ftp # Forward all the rest to Privoxy never_direct allow all @@ -2060,14 +2342,15 @@ forward-socks4 and forward-socks4a - You could just as well decide to only forward requests for Windows executables through - a virus-scanning parent proxy, say, on antivir.example.com, port 8010: + You could just as well decide to only forward requests you suspect + of leading to Windows executables through a virus-scanning parent proxy, + say, on antivir.example.com, port 8010: forward / . - forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010 + forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010 @@ -2079,7 +2362,7 @@ forward-socks4 and forward-socks4a Specifies: - How often Privoxy retries if a forwarded connection request fails. + How often Privoxy retries if a forwarded connection request fails. @@ -2120,7 +2403,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. @@ -2138,6 +2421,11 @@ forward-socks4 and forward-socks4a @@forwarded-connect-retries 0]]> + + + +Miscellaneous + accept-intercepted-requests @@ -2177,7 +2465,10 @@ forward-socks4 and forward-socks4a If you don't trust your clients and want to force them to use Privoxy, enable this option and configure your packet filter to redirect outgoing - HTTP connections into Privoxy. + HTTP connections into Privoxy. + + + Note that intercepting encrypted connections (HTTPS) isn't supported. Make sure that Privoxy's own requests @@ -2298,11 +2589,11 @@ forward-socks4 and forward-socks4a Privoxy's CGI forms can lead to rather long URLs. This isn't a problem as far as the HTTP standard is concerned, but it can confuse clients with arbitrary - URL lenght limitations. + URL length limitations. Enabling split-large-forms causes Privoxy - to devide big forms into smaller ones to keep the URL length down. + to divide big forms into smaller ones to keep the URL length down. It makes editing a lot less convenient and you can no longer submit all changes at once, but at least it works around this browser bug. @@ -2326,92 +2617,826 @@ forward-socks4 and forward-socks4a @@split-large-forms 0]]> - - - - - - - - -Windows GUI Options - - Privoxy has a number of options specific to the - Windows GUI interface: - - - -@@]]> - - If activity-animation is set to 1, the - Privoxy icon will animate when - Privoxy is active. To turn off, set to 0. - - -@@#activity-animation 1]]> - - - - - activity-animation 1 - - - - -]]> +keep-alive-timeout + + + Specifies: + + + Number of seconds after which an open connection will no longer be reused. + + + + + Type of value: + + + Time in seconds. + + + + + Default value: + + None + + + + Effect if unset: + + + Connections are not kept alive. + + + + + Notes: + + + This option allows clients to keep the connection to &my-app; + alive. If the server supports it, &my-app; will keep + the connection to the server alive as well. Under certain + circumstances this may result in speed-ups. + + + By default, &my-app; will close the connection to the server if + the client connection gets closed, or if the specified timeout + has been reached without a new request coming in. This behaviour + can be changed with the connection-sharing option. + + + This option has no effect if Privoxy + has been compiled without keep-alive support. + + + Note that a timeout of five seconds as used in the default + configuration file significantly decreases the number of + connections that will be reused. The value is used because + some browsers limit the number of connections they open to + a single host and apply the same limit to proxies. This can + result in a single website grabbing all the + connections the browser allows, which means connections to + other websites can't be opened until the connections currently + in use time out. + + + Several users have reported this as a Privoxy bug, so the + default value has been reduced. Consider increasing it to + 300 seconds or even more if you think your browser can handle + it. If your browser appears to be hanging, it probably can't. + + + + + Examples: + + + keep-alive-timeout 300 + + + + +@@keep-alive-timeout 5]]> + - -@@]]> - - If log-messages is set to 1, - Privoxy will log messages to the console - window: - -@@#log-messages 1]]> - - - - - log-messages 1 - - - - -]]> +tolerate-pipelining + + + Specifies: + + + Whether or not pipelined requests should be served. + + + + + Type of value: + + + 0 or 1. + + + + + Default value: + + None + + + + Effect if unset: + + + If Privoxy receives more than one request at once, it terminates the + client connection after serving the first one. + + + + + Notes: + + + &my-app; currently doesn't pipeline outgoing requests, + thus allowing pipelining on the client connection is not + guaranteed to improve the performance. + + + By default &my-app; tries to discourage clients from pipelining + by discarding aggressively pipelined requests, which forces the + client to resend them through a new connection. + + + This option lets &my-app; tolerate pipelining. Whether or not + that improves performance mainly depends on the client configuration. + + + If you are seeing problems with pages not properly loading, + disabling this option could work around the problem. + + + + + Examples: + + + tolerate-pipelining 1 + + + + +@@tolerate-pipelining 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). - - - Warning: Setting this to 0 will result in the buffer to grow infinitely and - eat up all your memory! - +default-server-timeout + + + Specifies: + + + Assumed server-side keep-alive timeout if not specified by the server. + + + + + Type of value: + + + Time in seconds. + + + + + Default value: + + None + + + + Effect if unset: + + + Connections for which the server didn't specify the keep-alive + timeout are not reused. + + + + + Notes: + + + Enabling this option significantly increases the number of connections + that are reused, provided the keep-alive-timeout option + is also enabled. + + + While it also increases the number of connections problems + when &my-app; tries to reuse a connection that already has + been closed on the server side, or is closed while &my-app; + is trying to reuse it, this should only be a problem if it + happens for the first request sent by the client. If it happens + for requests on reused client connections, &my-app; will simply + close the connection and the client is supposed to retry the + request without bothering the user. + + + Enabling this option is therefore only recommended if the + connection-sharing option + is disabled. + + + It is an error to specify a value larger than the keep-alive-timeout value. + + + This option has no effect if Privoxy + has been compiled without keep-alive support. + + + + + Examples: + + + default-server-timeout 60 + + + + +@@#default-server-timeout 60]]> + -@@#log-buffer-size 1]]> - - - - - log-buffer-size 1 - - - - -]]> - -@@]]> - - log-max-lines is the maximum number of lines held +connection-sharing + + + Specifies: + + + Whether or not outgoing connections that have been kept alive + should be shared between different incoming connections. + + + + + Type of value: + + + 0 or 1 + + + + + Default value: + + None + + + + Effect if unset: + + + Connections are not shared. + + + + + Notes: + + + This option has no effect if Privoxy + has been compiled without keep-alive support, or if it's disabled. + + + + + Notes: + + + Note that reusing connections doesn't necessary cause speedups. + There are also a few privacy implications you should be aware of. + + + If this option is effective, outgoing connections are shared between + clients (if there are more than one) and closing the browser that initiated + the outgoing connection does no longer affect the connection between &my-app; + and the server unless the client's request hasn't been completed yet. + + + If the outgoing connection is idle, it will not be closed until either + Privoxy's or the server's timeout is reached. + While it's open, the server knows that the system running &my-app; is still + there. + + + If there are more than one client (maybe even belonging to multiple users), + they will be able to reuse each others connections. This is potentially + dangerous in case of authentication schemes like NTLM where only the + connection is authenticated, instead of requiring authentication for + each request. + + + If there is only a single client, and if said client can keep connections + alive on its own, enabling this option has next to no effect. If the client + doesn't support connection keep-alive, enabling this option may make sense + as it allows &my-app; to keep outgoing connections alive even if the client + itself doesn't support it. + + + You should also be aware that enabling this option increases the likelihood + of getting the "No server or forwarder data" error message, especially if you + are using a slow connection to the Internet. + + + This option should only be used by experienced users who + understand the risks and can weight them against the benefits. + + + + + Examples: + + + connection-sharing 1 + + + + +@@#connection-sharing 1]]> + + + +socket-timeout + + + Specifies: + + + Number of seconds after which a socket times out if + no data is received. + + + + + Type of value: + + + Time in seconds. + + + + + Default value: + + None + + + + Effect if unset: + + + A default value of 300 seconds is used. + + + + + Notes: + + + The default is quite high and you probably want to reduce it. + If you aren't using an occasionally slow proxy like Tor, reducing + it to a few seconds should be fine. + + + + + Examples: + + + socket-timeout 300 + + + + +@@socket-timeout 300]]> + + + +max-client-connections + + + Specifies: + + + Maximum number of client connections that will be served. + + + + + Type of value: + + + Positive number. + + + + + Default value: + + 128 + + + + Effect if unset: + + + Connections are served until a resource limit is reached. + + + + + Notes: + + + &my-app; creates one thread (or process) for every incoming client + connection that isn't rejected based on the access control settings. + + + If the system is powerful enough, &my-app; can theoretically deal with + several hundred (or thousand) connections at the same time, but some + operating systems enforce resource limits by shutting down offending + processes and their default limits may be below the ones &my-app; would + require under heavy load. + + + Configuring &my-app; to enforce a connection limit below the thread + or process limit used by the operating system makes sure this doesn't + happen. Simply increasing the operating system's limit would work too, + but if &my-app; isn't the only application running on the system, + you may actually want to limit the resources used by &my-app;. + + + If &my-app; is only used by a single trusted user, limiting the + number of client connections is probably unnecessary. If there + are multiple possibly untrusted users you probably still want to + additionally use a packet filter to limit the maximal number of + incoming connections per client. Otherwise a malicious user could + intentionally create a high number of connections to prevent other + users from using &my-app;. + + + Obviously using this option only makes sense if you choose a limit + below the one enforced by the operating system. + + + One most POSIX-compliant systems &my-app; can't properly deal with + more than FD_SETSIZE file descriptors at the same time and has to reject + connections if the limit is reached. This will likely change in a + future version, but currently this limit can't be increased without + recompiling &my-app; with a different FD_SETSIZE limit. + + + + + Examples: + + + max-client-connections 256 + + + + +@@#max-client-connections 256]]> + + + +handle-as-empty-doc-returns-ok + + + Specifies: + + + The status code Privoxy returns for pages blocked with + + +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 directive was added as 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), + the bug has been fixed for quite some time, but this directive is also useful + to make it harder for websites to detect whether or not resources are being + blocked. + + + + +@@#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. + + + + + Examples: + + + + # 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 + + + + + +@@#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 \ + DNT \ + If-Modified-Since \ + Cache-Control \ + Content-Length \ + Content-Type +]]> + + + + + + + + + + + +Windows GUI Options + + Privoxy has a number of options specific to the + Windows GUI interface: + + + +@@]]> + + If activity-animation is set to 1, the + Privoxy icon will animate when + Privoxy is active. To turn off, set to 0. + + +@@#activity-animation 1]]> + + + + + activity-animation 1 + + + + +]]> + + +@@]]> + + If log-messages is set to 1, + 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). + + + + Warning: Setting this to 0 will result in the buffer to grow infinitely and + eat up all your memory! + + +@@#log-buffer-size 1]]> + + + + + log-buffer-size 1 + + + + +]]> + + +@@]]> + + log-max-lines is the maximum number of lines held in the log buffer. See above. @@ -2419,11 +3444,11 @@ forward-socks4 and forward-socks4a - + log-max-lines 200 - + ]]> @@ -2440,11 +3465,11 @@ forward-socks4 and forward-socks4a - + log-highlight-messages 1 - + ]]> @@ -2459,11 +3484,11 @@ forward-socks4 and forward-socks4a - + log-font-name Comic Sans MS - + ]]> @@ -2478,18 +3503,18 @@ forward-socks4 and forward-socks4a - + log-font-size 8 - + ]]> @@]]> - + show-on-task-bar controls whether or not Privoxy will appear as a button on the Task bar when minimized: @@ -2499,11 +3524,11 @@ forward-socks4 and forward-socks4a - + show-on-task-bar 0 - + ]]> @@ -2520,11 +3545,11 @@ forward-socks4 and forward-socks4a - + close-button-minimizes 1 - + ]]> @@ -2534,7 +3559,7 @@ forward-socks4 and forward-socks4a The hide-console option is specific to the MS-Win console version of Privoxy. If this option is used, - Privoxy will disconnect from and hide the + Privoxy will disconnect from and hide the command console. @@ -2542,11 +3567,11 @@ forward-socks4 and forward-socks4a - + #hide-console - + ]]>