Rebuild with latest changes.
[privoxy.git] / doc / webserver / user-manual / whatsnew.html
index 8967dc9..b894a66 100644 (file)
@@ -1,13 +1,13 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
 <HTML
 ><HEAD
 ><TITLE
 >What's New in this Release</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
-"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="HOME"
-TITLE="Privoxy 3.0.6 User Manual"
+TITLE="Privoxy 3.0.9 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="Installation"
@@ -17,7 +17,10 @@ TITLE="Quickstart to Using Privoxy"
 HREF="quickstart.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.6 User Manual</TH
+>Privoxy 3.0.9 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -76,12 +79,12 @@ CLASS="SECT1"
 CLASS="SECT1"
 ><A
 NAME="WHATSNEW"
-></A
->3. What's New in this Release</H1
+>3. What's New in this Release</A
+></H1
 ><P
 > There are many improvements and new features since <SPAN
 CLASS="APPLICATION"
->Privoxy 3.0.3</SPAN
+>Privoxy 3.0.8</SPAN
 >, the last stable release:</P
 ><P
 > <P
@@ -89,305 +92,180 @@ CLASS="APPLICATION"
 ><UL
 ><LI
 ><P
->    Multiple <A
-HREF="filter-file.html"
->filter files</A
-> can now be specified in <TT
-CLASS="FILENAME"
->config</TT
->. This allows for 
-    locally defined filters that can be maintained separately from the filters as
-    supplied by the developers, i.e. <TT
-CLASS="FILENAME"
->default.filter</TT
->.
+>    Added SOCKS5 support (with address resolution done by
+    the SOCKS5 server). Patch provided by Eric M. Hopper.
    </P
 ></LI
 ><LI
 ><P
->  
-   There are a number of new <A
-HREF="actions-file.html"
->actions</A
->:
-  </P
-><P
->  <P
-></P
-><UL
+>    The "blocked" CGI pages include a block reason that was
+    provided as argument to the last-applying block action.
+   </P
+></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#CONTENT-TYPE-OVERWRITE"
->content-type-overwrite</A
-></TT
->
-      </P
+>    If enable-edit-actions is disabled (the default since 3.0.7 beta)
+    the show-status page hides the edit buttons and explains why.
+    Previously the user would get the "this feature has been disabled"
+    message after using the edit button.
+   </P
 ></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#CRUNCH-CLIENT-HEADER"
->crunch-client-header</A
-></TT
->
-      </P
+>    Forbidden CONNECT requests are treated like blocks by default.
+    The now-pointless treat-forbidden-connects-like-blocks action
+    has been removed.
+   </P
 ></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#CRUNCH-IF-NONE-MATCH"
->crunch-if-none-match</A
-></TT
->
-      </P
+>    Not enabling limit-connect now allows CONNECT requests to all ports.
+    In previous versions it would only allow CONNECT requests to port 443.
+    Use +limit-connect{443} if you think you need the old default behaviour.
+   </P
 ></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#CRUNCH-SERVER-HEADER"
->crunch-server-header</A
-></TT
->
-      </P
+>    The CGI editor gets turned off after three edit requests with invalid
+    file modification timestamps. This makes life harder for attackers
+    who can leverage browser bugs to send fake Referers and intend to
+    brute-force edit URLs.
+   </P
 ></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#FILTER-CLIENT-HEADERS"
->filter-client-headers</A
-></TT
->
-      </P
+>    Action settings for multiple patterns in the same section are
+    shared in memory. As a result these sections take up less space
+    (and are loaded slightly faster). Problem reported by Franz Schwartau.
+   </P
 ></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#FILTER-SERVER-HEADERS"
->filter-server-headers</A
-></TT
->
-      </P
+>    Linear white space in HTTP headers will be normalized to single
+    spaces before parsing the header's content, headers split across
+    multiple lines get merged first.
+   </P
 ></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#FORCE-TEXT-MODE"
->force-text-mode</A
-></TT
->
-      </P
+>    Host information is gathered outside the main thread so it's less
+    likely to delay other incoming connections if the host is misconfigured.
+   </P
 ></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT"
->handle-as-empty-document</A
-></TT
->
-      </P
+>    New config option "hostname" to use a hostname other than
+    the one returned by the operating system. Useful to speed-up responses
+    for CGI requests on misconfigured systems. Requested by Max Khon.
+   </P
 ></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#HIDE-ACCEPT-LANGUAGE"
->hide-accept-language</A
-></TT
->
-      </P
+>    The CGI editor supports the "disable all filters of this type"
+    directives "-client-header-filter", "-server-header-filter",
+    "-client-header-tagger" and "-server-header-tagger".
+   </P
 ></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#HIDE-CONTENT-DISPOSITION"
->hide-content-disposition</A
-></TT
->
-      </P
+>    Fixed false-positives with the link-by-url filter and URLs that
+    contain the pattern "/jump/".
+   </P
 ></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#HIDE-IF-MODIFIED-SINCE"
->hide-if-modified-since</A
-></TT
->
-      </P
+>    The less-download-windows filter no longer messes
+    "Content-Type: application/x-shockwave-flash" headers up.
+   </P
 ></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#INSPECT-JPEGS"
->inspect-jpegs</A
-></TT
->
-      </P
+>    In the show-url-info page's "Final results" section active and
+    inactive actions are listed separately. Patch provided by Lee.
+   </P
 ></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#OVERWRITE-LAST-MODIFIED"
->overwrite-last-modified</A
-></TT
->
-      </P
+>    The GNUmakefile supports the DESTDIR variable. Patch for
+    the install target submitted by Radoslaw Zielinski.
+   </P
 ></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#REDIRECT"
->redirect</A
-></TT
->
-      </P
+>    Embedding the content of configuration files in the show-status
+    page is significantly faster now. For a largish action file (1 MB)
+    a speedup of about 2450 times has been measured. This is mostly
+    interesting if you are using large action files or regularly use
+    Privoxy-Regression-Test while running Privoxy through Valgrind,
+    for stock configuration files it doesn't really matter.
+   </P
 ></LI
 ><LI
 ><P
->       <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#TREAT-FORBIDDEN-CONNECTS-LIKE-BLOCKS"
->treat-forbidden-connects-like-blocks</A
-></TT
->
-      </P
+>    If zlib support is unavailable and there are content
+    filters active but the prevent-compression action is disabled,
+    the show-url-info page includes a warning that compression
+    might prevent filtering.
+   </P
 ></LI
-></UL
->
-  </P
+><LI
 ><P
->     In addition, <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#FAST-REDIRECTS"
->fast-redirects</A
-></TT
->
-     has been significantly improved with enhanced syntax.
-  </P
+>    The show-url-info page provides an OpenSearch Description that
+    allows to access the page through browser search plugins.
+   </P
+></LI
+><LI
 ><P
->     And <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#HIDE-REFERRER"
->hide-referrer</A
-></TT
->
-     has a new option, <TT
-CLASS="LITERAL"
->conditional block</TT
->.
+>    The obsolete kill-popups action has been removed as the
+    PCRS-based popup filters can do the same and are slightly
+    less unreliable.
    </P
 ></LI
 ><LI
 ><P
->    <SPAN
-CLASS="APPLICATION"
->MS-Windows</SPAN
-> versions can now be 
-    <A
-HREF="installation.html#INSTALLATION-PACK-WIN"
->installed and 
-    started as a <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->Windows service</I
-></SPAN
-></A
->.
+>    The inspect-jpegs action has been removed.
    </P
 ></LI
 ><LI
 ><P
->    <TT
-CLASS="FILENAME"
->config</TT
-> has two new options: 
-    <A
-HREF="config.html#ENABLE-REMOTE-HTTP-TOGGLE"
->enable-remote-http-toggle</A
->, 
-    and <A
-HREF="config.html#FORWARDED-CONNECT-RETRIES"
->forwarded-connect-retries</A
->.
+>    The send-wafer and send-vanilla-wafer actions have been removed.
+    They weren't particular useful and their behaviour could be emulated
+    with add-header anyway.
    </P
+></LI
+><LI
 ><P
->    And there is improved handling of the <A
-HREF="config.html#USER-MANUAL"
->user-manual</A
->
-    option, for placing documentation and help files on the local system.
+>    Privoxy-Regression-Test has been significantly improved.
    </P
 ></LI
 ><LI
 ><P
->    There are six new <A
-HREF="actions-file.html#FILTER"
->filters</A
->.
+>    Most sections in the default.action file contain tests for
+    Privoxy-Regression-Test to verify that they are working as intended.
    </P
 ></LI
 ><LI
 ><P
->    Actions files problems and suggestions are now being directed to: 
-    <A
-HREF="http://sourceforge.net/tracker/?group_id=11118&atid=460288"
-TARGET="_top"
->http://sourceforge.net/tracker/?group_id=11118&#38;atid=460288</A
->.
-    Please use this to report such configuration related problems as missed
-    ads, sites that don't function properly due to one action or another, 
-    innocent images being blocked, etc.
+>    Parts of Privoxy have been refactored to increase maintainability.
    </P
 ></LI
 ><LI
 ><P
->    In addition, there are numerous bug fixes and significant enhancements,
-    including error pages should no longer be cached if the problem is fixed,
-    much better DNS error handling, various logging improvements, and 
-    configuration updates for better ad blocking and junk elimination.
+>    Building with zlib (if available) is done by default.
    </P
 ></LI
 ></UL
 ></P
+><P
+> For a more detailed list of changes please have a look at the ChangeLog.</P
 ><DIV
 CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
 NAME="UPGRADERSNOTE"
-></A
->3.1. Note to Upgraders</H2
+>3.1. Note to Upgraders</A
+></H2
 ><P
 > A quick list of things to be aware of before upgrading from earlier 
  versions of <SPAN
@@ -400,189 +278,116 @@ CLASS="APPLICATION"
 ><UL
 ><LI
 ><P
->  
-    Some installers may remove earlier versions completely, including 
-    configuration files. Save any important configuration files!
+>   The recommended way to upgrade <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> is to backup your old 
+   configuration files, install the new ones, verify that <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+   is working correctly and finally merge back your changes using
+   <SPAN
+CLASS="APPLICATION"
+>diff</SPAN
+> and maybe <SPAN
+CLASS="APPLICATION"
+>patch</SPAN
+>.
   </P
-></LI
-><LI
 ><P
->  
-   On the other hand, other installers may not overwrite any existing configuration 
-   files, thinking you will want to do that. You may want to manually check 
-   your saved files against the newer versions to see if the improvements have
-   merit, or whether there are new options that you may want to consider.
-   There are a number of new features, but most won't be available unless 
-   these features are incorporated into your configuration somehow.
+>   There are a number of new features in each <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> release and
+   most of them have to be explicitly enabled in the configuration
+   files. Old configuration files obviously don't do that and due
+   to syntax changes using old configuration files with a new
+   <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> isn't always possible anyway.
   </P
 ></LI
 ><LI
 ><P
->     See the full documentation on 
-     <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#FAST-REDIRECTS"
->fast-redirects</A
-></TT
->
-     which has changed syntax, and will require adjustments to local configs, 
-     such as <TT
-CLASS="FILENAME"
->user.action</TT
->. You must reference the new 
-     syntax: 
-   </P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="90%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->  { +fast-redirects{check-decoded-url} }
-   .example.com
-   mybank.com
-   .google.</PRE
-></TD
-></TR
-></TABLE
-></P
+>  
+    Note that some installers remove earlier versions completely,
+    including configuration files, therefore you should really save
+    any important configuration files!
+  </P
 ></LI
 ><LI
 ><P
->     The <TT
-CLASS="FILENAME"
->jarfile</TT
->, 
-     <A
-HREF="http://en.wikipedia.org/wiki/Browser_cookie"
-TARGET="_top"
->cookie</A
-> logger, is off by default now.
-    </P
+>  
+   On the other hand, other installers don't overwrite existing configuration 
+   files, thinking you will want to do that yourself.
+  </P
 ></LI
 ><LI
 ><P
 >  
-   What constitutes a <SPAN
-CLASS="QUOTE"
->"default"</SPAN
-> configuration has changed, 
-   and you may want to review which actions are <SPAN
-CLASS="QUOTE"
->"on"</SPAN
-> by 
-   default. This is primarily a matter of emphasis, but some features 
-   you may have been used to, may now be <SPAN
-CLASS="QUOTE"
->"off"</SPAN
-> by default.
-   There are also a number of new actions and filters you may want to
-   consider, most of which are not fully incorporated into the default
-   settings as yet (see above).
+   <TT
+CLASS="FILENAME"
+>standard.action</TT
+> now only includes the enabled actions.
+   Not all actions as before.
   </P
 ></LI
 ><LI
 ><P
->    The default actions setting is now <TT
-CLASS="LITERAL"
->Cautious</TT
->. Previous
-    releases had a default setting of <TT
-CLASS="LITERAL"
->Medium</TT
->. Experienced
-    users may want to adjust this, as it is fairly conservative by <SPAN
+>   In the default configuration only fatal errors are logged now.
+   You can change that in the <A
+HREF="config.html#DEBUG"
+>debug section</A
+>
+   of the configuration file. You may also want to enable more verbose
+   logging until you verified that the new <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
->
-    standards and past practices. See <A
-HREF="http://config.privoxy.org/edit-actions-list?f=default"
-TARGET="_top"
->    http://config.privoxy.org/edit-actions-list?f=default</A
->. New users
-    should try the default settings for a while before turning up the volume.
-   </P
-></LI
-><LI
-><P
->    The default setting has filtering turned <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->off</I
-></SPAN
->, which
-    subsequently means that compression is <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->on</I
-></SPAN
->. Remember
-    that filtering does not work on compressed pages, so if you use, or want to
-    use, filtering, you will need to force compression off. Example:
-   </P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="90%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->  { +<A
-HREF="actions-file.html#FILTER"
->filter</A
->{google}  +<A
-HREF="actions-file.html#PREVENT-COMPRESSION"
->prevent-compression</A
-> }
-   .google.</PRE
-></TD
-></TR
-></TABLE
->
-   </P
-><P
->    Or if you use a number of filters, or filter many sites, you may just want
-    to turn off compression for all sites in
-    <TT
-CLASS="FILENAME"
->default.action</TT
-> (or
-    <TT
-CLASS="FILENAME"
->user.action</TT
->). 
-   </P
+> version is working
+   as expected.
+  </P
 ></LI
 ><LI
 ><P
->   Also, <A
-HREF="actions-file.html#SESSION-COOKIES-ONLY"
->session-cookies-only</A
-> is 
-   off by default now. If you've liked this feature in the past, you may want 
-   to turn it back on in <TT
-CLASS="FILENAME"
->user.action</TT
-> now.
-  </P
+>     Three other config file settings are now off by default: 
+     <A
+HREF="config.html#ENABLE-REMOTE-TOGGLE"
+>enable-remote-toggle</A
+>,
+     <A
+HREF="config.html#ENABLE-REMOTE-HTTP-TOGGLE"
+>enable-remote-http-toggle</A
+>,
+     and  <A
+HREF="config.html#ENABLE-EDIT-ACTIONS"
+>enable-edit-actions</A
+>. 
+     If you use or want these, you will need to explicitly enable them, and
+     be aware of the security issues involved. 
+    </P
 ></LI
 ><LI
 ><P
->   
-   Some installers may not automatically start
-   <SPAN
+>    The <SPAN
+CLASS="QUOTE"
+>"filter-client-headers"</SPAN
+> and
+    <SPAN
+CLASS="QUOTE"
+>"filter-server-headers"</SPAN
+> actions that were introduced with
+    <SPAN
 CLASS="APPLICATION"
->Privoxy</SPAN
-> after installation.
-  </P
+>Privoxy 3.0.5</SPAN
+> to apply content filters to
+    the headers  have been removed and replaced with new actions.
+    See the <A
+HREF="whatsnew.html"
+>What's New section</A
+> above.
+   </P
 ></LI
 ></UL
 ></P