Rebuild to catch up with recent changes.
[privoxy.git] / doc / webserver / user-manual / config.html
index 6214cb8..b34f636 100644 (file)
@@ -260,8 +260,12 @@ CLASS="SCREEN"
 >
   </P
 ><P
->   The User Manual is then available to anyone with access to the proxy, by 
-   following the built-in URL: <TT
+>   The User Manual is then available to anyone with access to
+   <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>, by following the built-in URL:
+   <TT
 CLASS="LITERAL"
 >http://config.privoxy.org/user-manual/</TT
 >
@@ -379,7 +383,7 @@ CLASS="EMPHASIS"
 >trustfile</I
 ></SPAN
 ></A
-> above.)
+> below.)
    </P
 ><P
 >    If you use the trust mechanism, it is a good idea to write up some on-line
@@ -411,7 +415,10 @@ CLASS="VARIABLELIST"
 >Specifies:</DT
 ><DD
 ><P
->    An email address to reach the proxy administrator.
+>    An email address to reach the <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> administrator.
    </P
 ></DD
 ><DT
@@ -571,7 +578,7 @@ CLASS="VARIABLELIST"
 >Specifies:</DT
 ><DD
 ><P
->The directory where the other configuration files are located</P
+>The directory where the other configuration files are located.</P
 ></DD
 ><DT
 >Type of value:</DT
@@ -616,7 +623,7 @@ CLASS="QUOTE"
 CLASS="LITERAL"
 >/</TT
 >"</SPAN
->, please
+>, please.
    </P
 ></DD
 ></DL
@@ -639,7 +646,7 @@ CLASS="VARIABLELIST"
 >Specifies:</DT
 ><DD
 ><P
->An alternative directory where the templates are loaded from</P
+>An alternative directory where the templates are loaded from.</P
 ></DD
 ><DT
 >Type of value:</DT
@@ -663,10 +670,18 @@ CLASS="VARIABLELIST"
 >Notes:</DT
 ><DD
 ><P
->    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.
+>    <SPAN
+CLASS="APPLICATION"
+>Privoxy's</SPAN
+> 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
+    <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> releases other than the one
+    they were part of, though.
    </P
 ></DD
 ></DL
@@ -689,14 +704,15 @@ CLASS="VARIABLELIST"
 >Specifies:</DT
 ><DD
 ><P
->    The directory where all logging takes place (i.e. where <TT
+>    The directory where all logging takes place
+    (i.e. where <TT
 CLASS="FILENAME"
 >logfile</TT
-> and 
+> and
     <TT
 CLASS="FILENAME"
 >jarfile</TT
-> are located) 
+> are located).
    </P
 ></DD
 ><DT
@@ -742,7 +758,7 @@ CLASS="QUOTE"
 CLASS="LITERAL"
 >/</TT
 >"</SPAN
->, please
+>, please.
    </P
 ></DD
 ></DL
@@ -844,9 +860,15 @@ CLASS="LITERAL"
    </P
 ><P
 > 
-    The default values include standard.action, which is used for internal
-    purposes and should be loaded, default.action, which is the
-    <SPAN
+    The default values include <TT
+CLASS="FILENAME"
+>standard.action</TT
+>, which is used
+    for internal purposes and should be loaded, <TT
+CLASS="FILENAME"
+>default.action</TT
+>,
+    which is the <SPAN
 CLASS="QUOTE"
 >"main"</SPAN
 > actions file maintained by the developers, and
@@ -857,7 +879,7 @@ CLASS="FILENAME"
    </P
 ><P
 > 
-    Actions files are where all the per site and per URL configuration is done 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 <SPAN
 CLASS="APPLICATION"
@@ -963,7 +985,7 @@ HREF="appendix.html#REGEX"
 >regular expressions</A
 >. These rules permit
     powerful changes on the content of Web pages, and optionally the headers
-    as well, e.g., you could disable your favorite JavaScript annoyances,
+    as well, e.g., you could try to disable your favorite JavaScript annoyances,
     re-write the actual displayed text, or just have some fun 
     playing buzzword bingo with web pages.
    </P
@@ -1060,16 +1082,16 @@ CLASS="emphasis"
 CLASS="EMPHASIS"
 >or</I
 ></SPAN
-> privoxy.log (Windows)</P
+> privoxy.log (Windows).</P
 ></DD
 ><DT
 >Effect if unset:</DT
 ><DD
 ><P
->    No log file is used, all log messages go to the console (<TT
+>    Logging is disabled unless <TT
 CLASS="LITERAL"
->STDERR</TT
->).
+>--no-daemon</TT
+> mode is used.
    </P
 ></DD
 ><DT
@@ -1086,9 +1108,22 @@ CLASS="LITERAL"
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > (e.g., it's not blocking an ad you
-    think it should block) but in most cases you probably will never look at
-    it. For this reason, it is disabled by default. For troubleshooting
-    purposes, you will have to explicitly enable it.
+    think it should block) and it can help you to monitor what your browser
+    is doing.
+   </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
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> 3.0.7 and later.
+  </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.
    </P
 ><P
 >    Your logfile will grow indefinitely, and you will probably want to
@@ -1103,23 +1138,11 @@ CLASS="COMMAND"
 > script has been included.
    </P
 ><P
->    On SuSE Linux systems, you can place a line like <SPAN
-CLASS="QUOTE"
->"/var/log/privoxy.*
-    +1024k 644 nobody.nogroup"</SPAN
-> in <TT
-CLASS="FILENAME"
->/etc/logfiles</TT
->, with
-    the effect that cron.daily will automatically archive, gzip, and empty the
-    log, when it exceeds 1M size.
-   </P
-><P
 >    Any log files must be writable by whatever user <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
 >
-    is being run as (default on UNIX, user id is <SPAN
+    is being run as (on Unix, default user id is <SPAN
 CLASS="QUOTE"
 >"privoxy"</SPAN
 >).
@@ -1173,7 +1196,7 @@ CLASS="emphasis"
 CLASS="EMPHASIS"
 >or</I
 ></SPAN
-> privoxy.jar (Windows)</P
+> privoxy.jar (Windows).</P
 ></DD
 ><DT
 >Effect if unset:</DT
@@ -1190,7 +1213,10 @@ CLASS="EMPHASIS"
    </P
 ><P
 >    If debug 8 (show header parsing) is enabled, cookies are
-    written to the logfile with the rest of the headers.
+    also written to the logfile with the rest of the headers.
+    Therefore this option isn't very useful and may be removed
+    in future releases. Please report to the developers if you
+    are still using it.
    </P
 ></DD
 ></DL
@@ -1470,19 +1496,6 @@ CLASS="EMPHASIS"
     
    </P
 ><P
->    The reporting of <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->fatal</I
-></SPAN
-> errors (i.e. ones which causes 
-    <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> to exit) is always on and cannot be disabled.
-   </P
-><P
 >    If you want to use CLF (Common Log Format), you should set <SPAN
 CLASS="QUOTE"
 >"debug
@@ -1527,7 +1540,7 @@ CLASS="VARIABLELIST"
 >Specifies:</DT
 ><DD
 ><P
->    Whether to run only one server thread
+>    Whether to run only one server thread.
    </P
 ></DD
 ><DT
@@ -1566,8 +1579,8 @@ CLASS="EMPHASIS"
 >Notes:</DT
 ><DD
 ><P
->    This option is only there for debug purposes and you should never
-    need to use it. <SPAN
+>    This option is only there for debugging purposes.
+    <SPAN
 CLASS="emphasis"
 ><I
 CLASS="EMPHASIS"
@@ -1681,7 +1694,7 @@ HREF="config.html#ACLS"
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > to untrusted users, you will
-    also want to turn off the <TT
+    also want to make sure that the following actions are disabled:  <TT
 CLASS="LITERAL"
 ><A
 HREF="config.html#ENABLE-EDIT-ACTIONS"
@@ -1695,7 +1708,6 @@ HREF="config.html#ENABLE-REMOTE-TOGGLE"
 >enable-remote-toggle</A
 ></TT
 >
-    options!
    </P
 ></DD
 ><DT
@@ -1780,20 +1792,11 @@ CLASS="APPLICATION"
 CLASS="QUOTE"
 >"toggled off"</SPAN
 > mode, i.e. mostly behave like a normal,
-    content-neutral proxy where all ad blocking, filtering, etc are disabled. See
-    <TT
+    content-neutral proxy with both ad blocking and content filtering
+    disabled. See <TT
 CLASS="LITERAL"
 >enable-remote-toggle</TT
-> below. This is not really useful
-    anymore, since toggling is much easier via <A
-HREF="http://config.privoxy.org/toggle"
-TARGET="_top"
->the web interface</A
-> than via
-    editing the <TT
-CLASS="FILENAME"
->conf</TT
-> file.
+> below.
    </P
 ><P
 >    The windows version will only display the toggle icon in the system tray
@@ -1855,8 +1858,7 @@ TARGET="_top"
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > 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.
    </P
 ><P
 >    Access to the toggle feature can <SPAN
@@ -1888,14 +1890,18 @@ CLASS="EMPHASIS"
 >not recommended</I
 ></SPAN
 >
-    for multi-user environments with untrusted users. Because of 
-    the obvious security implications, this feature is off by default.
-    Note that malicious client side code (e.g JavaScript) is also potentially
-    capable of changing <SPAN
+    for multi-user environments with untrusted users.
+   </P
+><P
+>    Note that malicious client side code (e.g Java) is also
+    capable of using this option.
+   </P
+><P
+>    As a lot of <SPAN
 CLASS="APPLICATION"
->Privoxy's</SPAN
-> intended
-    behavior.
+>Privoxy</SPAN
+> users don't read
+    documentation, this feature is disabled by default.
    </P
 ><P
 >    Note that you must have compiled <SPAN
@@ -1969,11 +1975,11 @@ CLASS="APPLICATION"
 >Privoxy</SPAN
 > in a environment with trusted clients,
     you may enable this feature at your discretion. Note that malicious client
-    side code (e.g JavaScript) is also potentially capable of changing
-    <SPAN
-CLASS="APPLICATION"
->Privoxy's</SPAN
-> intended behavior.
+    side code (e.g Java) is also capable of using this feature.
+   </P
+><P
+>    This option will be removed in future releases as it has been obsoleted
+    by the more general header taggers.
    </P
 ></DD
 ></DL
@@ -2049,20 +2055,27 @@ CLASS="QUOTE"
 CLASS="LITERAL"
 >listen-address</TT
 > above) can
-    modify its configuration for all users. This option is <SPAN
+    modify its configuration for all users.
+   </P
+><P
+>    This option is <SPAN
 CLASS="emphasis"
 ><I
 CLASS="EMPHASIS"
->not
-    recommended</I
+>not recommended</I
 ></SPAN
-> for multi-user environments with untrusted users 
-    and is therefore disabled by default. Note that malicious client side code
-    (e.g JavaScript) is also potentially capable of changing
-    <SPAN
+> for environments
+    with untrusted users and as a lot of <SPAN
 CLASS="APPLICATION"
->Privoxy's</SPAN
-> intended behavior.
+>Privoxy</SPAN
+>
+    users don't read documentation, this feature is disabled by default.
+   </P
+><P
+>    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.
    </P
 ><P
 >    Note that you must have compiled <SPAN
@@ -2335,9 +2348,12 @@ CLASS="EMPHASIS"
     option. 
    </P
 ><P
->    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 <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+    is not intended to be a substitute for a firewall or to encourage anyone
+    to defer addressing basic security weaknesses.
    </P
 ><P
 >    Multiple ACL lines are OK.
@@ -2769,8 +2785,8 @@ WIDTH="90%"
 ><TD
 ><PRE
 CLASS="SCREEN"
->  forward   /                  caching-proxy.example-isp.net:8000
-  forward   .example-isp.net   .</PRE
+>  forward   /                  caching-proxy.isp.example.net:8000
+  forward   .isp.example.net   .</PRE
 ></TD
 ></TR
 ></TABLE
@@ -2960,7 +2976,7 @@ WIDTH="90%"
 ><TD
 ><PRE
 CLASS="SCREEN"
->  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   .</PRE
 ></TD
 ></TR
@@ -2986,8 +3002,8 @@ CLASS="SCREEN"
 >
    </P
 ><P
->    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:
    </P
 ><P
 >    <TABLE
@@ -2998,7 +3014,7 @@ WIDTH="90%"
 ><TD
 ><PRE
 CLASS="SCREEN"
->  forward-socks4   /               127.0.0.1:9050 .</PRE
+>  forward-socks4a   /               127.0.0.1:9050 .</PRE
 ></TD
 ></TR
 ></TABLE
@@ -3008,8 +3024,9 @@ CLASS="SCREEN"
 >    The public <SPAN
 CLASS="APPLICATION"
 >Tor</SPAN
-> network can't be used to reach your local network,
-    therefore it's a good idea to make some exceptions:
+> 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:
    </P
 ><P
 >    <TABLE
@@ -3031,7 +3048,12 @@ CLASS="SCREEN"
 ><P
 >    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 <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+    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.
    </P
 ><P
 >    If you also want to be able to reach servers in your local network by
@@ -3080,8 +3102,8 @@ CLASS="EMPHASIS"
 ></SPAN
 > users can see the internal content of all ISPs.</P
 ><P
-> 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 <SPAN
+> 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 <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
 >. Their forwarding
@@ -3098,7 +3120,7 @@ WIDTH="100%"
 ><PRE
 CLASS="SCREEN"
 >  forward    /           .
-  forward    .isp-b.net  host-b:8118</PRE
+  forward    .isp-b.example.net  host-b:8118</PRE
 ></TD
 ></TR
 ></TABLE
@@ -3115,7 +3137,7 @@ WIDTH="100%"
 ><PRE
 CLASS="SCREEN"
 >  forward    /           .
-  forward    .isp-a.net  host-a:8118</PRE
+  forward    .isp-a.example.org  host-a:8118</PRE
 ></TD
 ></TR
 ></TABLE
@@ -3132,7 +3154,7 @@ CLASS="APPLICATION"
  <SPAN
 CLASS="APPLICATION"
 >squid</SPAN
-> locally, then chain as 
+> locally, then chaining as 
  <TT
 CLASS="LITERAL"
 >browser -&#62; squid -&#62; privoxy</TT
@@ -3186,8 +3208,9 @@ CLASS="FILENAME"
 >squid.conf</TT
 >.</P
 ><P
-> You could just as well decide to only forward requests for Windows executables through
- a virus-scanning parent proxy, say, on <TT
+> 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 <TT
 CLASS="LITERAL"
 >antivir.example.com</TT
 >, port 8010:</P
@@ -3284,7 +3307,7 @@ CLASS="QUOTE"
     that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
    </P
 ><P
->    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.
    </P
@@ -3537,14 +3560,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.
@@ -3844,7 +3867,7 @@ CLASS="APPLICATION"
  <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> will disconnect from and hide  the
+> will disconnect from and hide the
  command console.</P
 ><P
 > <TT