X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fp-config.sgml;h=b2c49b86dd3d16a60faccf820fb55ff911d54177;hp=8cef79706cb6b1e6c46c2b59ebd412eef2ad1195;hb=b5bd6be64ef5f1f7a4e6ecd881d9a05595a42ce3;hpb=8855a031e62cf14ac96b06e773f8bad01d3a4e25
diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index 8cef7970..b2c49b86 100644
--- a/doc/source/p-config.sgml
+++ b/doc/source/p-config.sgml
@@ -3,9 +3,9 @@
Purpose : Used with other docs and files only.
- $Id: p-config.sgml,v 2.21 2007/11/07 18:50:39 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.35 2009/01/13 16:44:32 fabiankeil Exp $
- Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
See LICENSE.
========================================================================
@@ -95,10 +95,10 @@
Sample Configuration File for Privoxy v&p-version;
- $Id: p-config.sgml,v 2.21 2007/11/07 18:50:39 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.35 2009/01/13 16:44:32 fabiankeil Exp $
-Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
+Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
@@ -604,8 +604,7 @@ II. FORMAT OF THE CONFIGURATION FILE
The directory where all logging takes place
- (i.e. where logfile and
- jarfile are located).
+ (i.e. where the logfile is located).
@@ -668,9 +667,6 @@ actionsfile
Default values:
-
- standard.action # Internal purposes, no editing recommended
- default.action # Main actions file
@@ -695,9 +691,8 @@ 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 main actions file maintained by the developers, and
+ 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.
@@ -717,7 +712,6 @@ actionsfile
-@@actionsfile standard.action # Internal purpose, recommended]]>
@@actionsfile default.action # Main actions file]]>
The logfile is where all logging and error messages are written. The level
of detail and number of messages are set with the debug
@@ -851,15 +838,14 @@ actionsfile
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.
+ 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 3.0.7 and later only log fatal
+ errors by default.
+
+
+ For most troubleshooting purposes, you will have to change that,
+ please refer to the debugging section for details.
Your logfile will grow indefinitely, and you will probably want to
@@ -867,19 +853,6 @@ 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 (on Unix, default user id is privoxy).
@@ -888,60 +861,7 @@ fk 2007-11-07
-@@#logfile logfile]]>
-
-
-
-
-jarfile
-
-
-
- Specifies:
-
-
- The file to store intercepted cookies in
-
-
-
-
- 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.
-
-
-
-
- Notes:
-
-
- The jarfile may grow to ridiculous sizes over time.
-
-
- If debug 8 (show header parsing) is enabled, cookies are
- 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.
-
-
-
-
-
-@@#jarfile jarfile]]>
+@@logfile logfile]]>
@@ -1047,8 +967,7 @@ fk 2007-11-07
Specifies:
- Key values that determine what information gets logged to the
- logfile.
+ Key values that determine what information gets logged.
@@ -1061,14 +980,14 @@ fk 2007-11-07
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).
@@ -1080,20 +999,20 @@ fk 2007-11-07
- 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 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 # 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
@@ -1102,24 +1021,23 @@ fk 2007-11-07
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, 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).
-
- If you want to use CLF (Common Log Format), you should set debug
+ If you are used to the more verbose settings, simply enable the debug lines
+ below again.
+
+
+ If you want to use pure CLF (Common Log Format), you should set debug
512ONLY and not enable anything else.
@@ -1127,13 +1045,19 @@ fk 2007-11-07
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]]>
@@ -1184,6 +1108,62 @@ fk 2007-11-07
@@#single-threaded]]>
+
+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.
+
+
+
+
+
+@@#hostname hostname.example.org]]>
+
+
@@ -1516,7 +1496,6 @@ fk 2007-11-07
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
@@ -1916,7 +1895,7 @@ ACLs: permit-access and deny-access
-forward-socks4 and forward-socks4a
+forward-socks4, forward-socks4a and forward-socks5
@@ -1938,13 +1917,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
+ 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
+ port parameters are TCP ports,
+ i.e. integer values from 1 to 65535
@@ -1973,6 +1955,9 @@ 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.
+
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
@@ -2365,11 +2350,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.
@@ -2393,6 +2378,106 @@ forward-socks4 and forward-socks4a
@@split-large-forms 0]]>
+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 reused.
+
+
+
+
+ Notes:
+
+
+ This option has no effect if Privoxy
+ has been compiled without keep-alive support.
+
+
+
+
+ Examples:
+
+
+ keep-alive-timeout 300
+
+
+
+
+@@keep-alive-timeout 300]]>
+
+
+
+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 180 seconds is used.
+
+
+
+
+ Examples:
+
+
+ socket-timeout 180
+
+
+
+
+@@socket-timeout 180]]>
+
+
+