Rebuild for 3.0.10
[privoxy.git] / doc / webserver / user-manual / config.html
index 0a59a42..94ec4c1 100644 (file)
@@ -7,7 +7,7 @@
 NAME="GENERATOR"
 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="HOME"
-TITLE="Privoxy 3.0.7 User Manual"
+TITLE="Privoxy 3.0.10 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="Privoxy Configuration"
@@ -17,7 +17,10 @@ TITLE="Actions Files"
 HREF="actions-file.html"><LINK
 REL="STYLESHEET"
 TYPE="text/css"
-HREF="../p_doc.css">
+HREF="../p_doc.css"><META
+HTTP-EQUIV="Content-Type"
+CONTENT="text/html;
+charset=ISO-8859-1">
 <LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
 </head
 ><BODY
@@ -39,7 +42,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy 3.0.7 User Manual</TH
+>Privoxy 3.0.10 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -1088,10 +1091,7 @@ CLASS="EMPHASIS"
 >Effect if unset:</DT
 ><DD
 ><P
->    Logging is disabled unless <TT
-CLASS="LITERAL"
->--no-daemon</TT
-> mode is used.
+>    No logfile is written.
    </P
 ></DD
 ><DT
@@ -1112,18 +1112,17 @@ CLASS="APPLICATION"
     is doing.
    </P
 ><P
->    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 <SPAN
+>    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, <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> 3.0.7 and later.
-  </P
+> 3.0.7 and later only log fatal
+    errors by default.
+   </P
 ><P
->    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.
+>    For most troubleshooting purposes, you will have to change that,
+    please refer to the debugging section for details.
    </P
 ><P
 >    Your logfile will grow indefinitely, and you will probably want to
@@ -1408,17 +1407,7 @@ CLASS="VARIABLELIST"
 >Specifies:</DT
 ><DD
 ><P
->    Key values that determine what information gets logged to the 
-    <A
-HREF="config.html#LOGFILE"
-><SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->logfile</I
-></SPAN
-></A
->.
+>    Key values that determine what information gets logged.
    </P
 ></DD
 ><DT
@@ -1431,13 +1420,13 @@ CLASS="EMPHASIS"
 >Default value:</DT
 ><DD
 ><P
->12289 (i.e.: URLs plus informational and warning messages)</P
+>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</P
 ></DD
 ><DT
 >Effect if unset:</DT
 ><DD
 ><P
->    Nothing gets logged.
+>    Default value is used (see above).
    </P
 ></DD
 ><DT
@@ -1455,20 +1444,22 @@ WIDTH="90%"
 ><TD
 ><PRE
 CLASS="PROGRAMLISTING"
->  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</PRE
+>  debug     1 # log each request destination (and the crunch reason if <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> intercepted the 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  2048 # CGI user interface
+  debug  4096 # Startup banner and warnings.
+  debug  8192 # Non-fatal errors</PRE
 ></TD
 ></TR
 ></TABLE
@@ -1487,16 +1478,28 @@ CLASS="LITERAL"
 CLASS="emphasis"
 ><I
 CLASS="EMPHASIS"
->1, 4096 and 8192 are highly recommended</I
+>1, 4096 and 8192 are recommended</I
 ></SPAN
 >
-    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).
+    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).
     
    </P
 ><P
->    If you want to use CLF (Common Log Format), you should set <SPAN
+>    <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> used to ship with the debug levels recommended above enabled by
+    default, but due to privacy concerns 3.0.7 and later are configured to
+    only log fatal errors.
+   </P
+><P
+>    If you are used to the more verbose settings, simply enable the debug lines
+    below again.
+   </P
+><P
+>    If you want to use pure CLF (Common Log Format), you should set <SPAN
 CLASS="QUOTE"
 >"debug
     512"</SPAN
@@ -1519,6 +1522,11 @@ CLASS="QUOTE"
 >"... [too long, truncated]"</SPAN
 >.
    </P
+><P
+>    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.
+   </P
 ></DD
 ></DL
 ></DIV
@@ -1592,6 +1600,72 @@ CLASS="EMPHASIS"
 ></DL
 ></DIV
 ></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="HOSTNAME"
+>7.3.3. hostname</A
+></H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+>    The hostname shown on the CGI pages.
+   </P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+>Text</P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+><SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>Unset</I
+></SPAN
+></P
+></DD
+><DT
+>Effect if unset:</DT
+><DD
+><P
+>    The hostname provided by the operating system is used.
+   </P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+>    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.
+   </P
+><P
+>    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.
+   </P
+><P
+>    Note that Privoxy does not validate the specified hostname value.
+   </P
+></DD
+></DL
+></DIV
+></DIV
 ></DIV
 ><DIV
 CLASS="SECT2"
@@ -2802,7 +2876,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="SOCKS"
->7.5.2. forward-socks4 and forward-socks4a</A
+>7.5.2. forward-socks4, forward-socks4a and forward-socks5</A
 ></H4
 ><A
 NAME="FORWARD-SOCKS4"
@@ -2861,30 +2935,32 @@ CLASS="REPLACEABLE"
 ><I
 >target_pattern</I
 ></TT
-> is a <A
+> is a
+    <A
 HREF="actions-file.html#AF-PATTERNS"
 >URL pattern</A
-> 
-    that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <TT
+> that specifies to which
+    requests (i.e. URLs) this forward rule shall apply. Use <TT
 CLASS="LITERAL"
 >/</TT
 > to
     denote <SPAN
 CLASS="QUOTE"
 >"all URLs"</SPAN
->.
-    <TT
+>. <TT
 CLASS="REPLACEABLE"
 ><I
 >http_parent</I
 ></TT
-> and <TT
+>
+    and <TT
 CLASS="REPLACEABLE"
 ><I
 >socks_proxy</I
 ></TT
 >
-    are IP addresses in dotted decimal notation or valid DNS names (<TT
+    are IP addresses in dotted decimal notation or valid DNS names
+    (<TT
 CLASS="REPLACEABLE"
 ><I
 >http_parent</I
@@ -2902,7 +2978,8 @@ CLASS="REPLACEABLE"
 ><I
 >port</I
 ></TT
-> parameters are TCP ports, i.e. integer values from 1 to 64535
+> parameters are TCP ports,
+    i.e. integer values from 1 to 65535
    </P
 ></DD
 ><DT
@@ -2942,6 +3019,12 @@ CLASS="LITERAL"
     server, while in SOCKS 4 it happens locally.
    </P
 ><P
+>    With <TT
+CLASS="LITERAL"
+>forward-socks5</TT
+> the DNS resolution will happen on the remote server as well.
+   </P
+><P
 >    If <TT
 CLASS="REPLACEABLE"
 ><I
@@ -3560,14 +3643,14 @@ CLASS="APPLICATION"
 > 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.
    </P
 ><P
 >    Enabling split-large-forms causes <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
 >
-    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.