<!entity license SYSTEM "license.sgml">
<!entity p-authors SYSTEM "p-authors.sgml">
<!entity config SYSTEM "p-config.sgml">
-<!entity p-version "3.0.11">
-<!entity p-status "stable">
+<!entity p-version "3.0.15">
+<!entity p-status "beta">
<!entity % p-authors-formal "INCLUDE"> <!-- include additional text, etc -->
-<!entity % p-not-stable "IGNORE">
-<!entity % p-stable "INCLUDE">
+<!entity % p-not-stable "INCLUDE">
+<!entity % p-stable "IGNORE">
<!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
<!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
<!entity % p-readme "IGNORE">
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 2.101 2009/02/25 19:01:56 fabiankeil Exp $
+ $Id: user-manual.sgml,v 2.113 2009/10/10 05:48:55 fabiankeil Exp $
Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
See LICENSE.
</subscript>
</pubdate>
-<pubdate>$Id: user-manual.sgml,v 2.101 2009/02/25 19:01:56 fabiankeil Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 2.113 2009/10/10 05:48:55 fabiankeil Exp $</pubdate>
<!--
<sect1 label="1" id="introduction"><title>Introduction</title>
<para>
This documentation is included with the current &p-status; version of
- <application>Privoxy</application>, v.&p-version;<![%p-not-stable;[,
+ <application>Privoxy</application>, v.&p-version;<![%p-not-stable;[,
and is mostly complete at this point. The most up to date reference for the
time being is still the comments in the source files and in the individual
configuration files. Development of a new version is currently nearing
completion, and includes significant changes and enhancements over
- earlier versions. ]]>.
+ earlier versions]]>.
</para>
<!-- include only in non-stable versions -->
<sect1 id="whatsnew">
<title>What's New in this Release</title>
<para>
- <application>Privoxy 3.0.11</application> is mainly a bugfix release:
+ <application>Privoxy 3.0.15 beta</application> is a bug-fix release
+ for the previous beta. The changes since 3.0.14 are:
</para>
<para>
<itemizedlist>
<listitem>
<para>
- The socket-timeout option now also works on platforms whose
- select() implementation modifies the timeout structure.
- Previously the timeout was triggered even if the connection
- didn't stall. Reported by cyberpatrol.
+ In case of missing server data, no error message is send to the
+ client if the request arrived on a reused connection. The client
+ is then supposed to silently retry the request without bothering
+ the user. This should significantly reduce the frequency of the
+ "No server or forwarder data received" error message many users
+ reported.
</para>
</listitem>
<listitem>
<para>
- The Connection: keep-alive code properly deals with files
- larger than 2GB. Previously the connection was closed too
- early.
+ More reliable detection of prematurely closed client sockets
+ with keep-alive enabled.
</para>
</listitem>
<listitem>
<para>
- The content length for files above 2GB is logged correctly.
+ FEATURE_CONNECTION_KEEP_ALIVE is decoupled from
+ FEATURE_CONNECTION_SHARING and now available on
+ all platforms.
</para>
</listitem>
<listitem>
<para>
- The user-manual directive on the show-status page links to
- the documentation location specified with the directive,
- not to the Privoxy website.
+ Improved handling of POST requests on reused connections.
+ Should fix problems with stalled connections after submitting
+ form data with some browser configurations.
</para>
</listitem>
<listitem>
<para>
- The show-status page prints warnings about invalid directives
- on the same line as the directives themselves.
+ Fixed various latency calculation issues.
</para>
</listitem>
<listitem>
<para>
- Fixed several justified (but harmless) compiler warnings,
- mostly on 64 bit platforms.
+ Allows the client to pass NTLM authentication requests to a
+ forwarding proxy. This was already assumed and hinted to work
+ in 3.0.13 beta but actually didn't. Now it's confirmed to work
+ with IE, Firefox and Chrome.
+ Thanks to Francois Botha and Wan-Teh Chang
</para>
</listitem>
<listitem>
<para>
- The mingw32 version explicitly requests the default charset
- to prevent display problems with some fonts available on more
- recent Windows versions. Patch by Burberry.
+ Fixed a calculation problem if receiving the server headers
+ takes more than two reads, that could cause Privoxy to terminate
+ the connection prematurely. Reported by Oliver.
</para>
</listitem>
<listitem>
<para>
- The mingw32 version uses the Privoxy icon in the alt-tab
- windows. Patch by Burberry.
+ Compiles again on platforms such as OpenBSD and systems
+ using earlier glibc version that don't support AI_ADDRCONFIG.
+ Anonymously submitted in #2872591.
</para>
</listitem>
<listitem>
<para>
- The timestamp and the thread id is omitted in the "Fatal error"
- message box on mingw32.
+ A bunch of MS VC project files and Suse and Redhat RPM spec
+ files have been removed as they were no longer maintained for
+ quite some time.
</para>
</listitem>
<listitem>
<para>
- Fixed two related mingw32-only buffer overflows. Triggering
- them required control over the configuration file, therefore
- this isn't seen as a security issue.
+ Overly long action lines are properly rejected with a proper
+ error message. Previously they would be either rejected as
+ invalid or cause a core dump through abort().
</para>
</listitem>
<listitem>
<para>
- In verbose mode, or if the new option --show-skipped-tests
- is used, Privoxy-Regression-Test logs skipped tests and the
- skip reason.
+ Already timed-out connections are no longer temporarily remembered.
+ They weren't reused anyway, but wasted a socket slot.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ len refers to the number of bytes actually read which might
+ differ from the ones received. Adjust log messages accordingly.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The optional JavaScript on the CGI page uses encodeURIComponent()
+ instead of escape() which doesn't encode all characters that matter.
+ Anonymously reported in #2832722.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fix gcc45 warnings in decompress_iob().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Various log message improvements.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Privoxy-Regression-Test supports redirect tests.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Privoxy-Log-Parser can gather some connection statistics.
+ </para>
+ </listitem>
+ </itemizedlist>
+</para>
+
+<para>
+ If you missed the previous two beta versions, you may also be
+ interested in the additional changes since since 3.0.12, the
+ last stable release:
+</para>
+
+<para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Added IPv6 support. Thanks to Petr Pisar who not only provided
+ the initial patch but also helped a lot with the integration.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Added client-side keep-alive support.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The connection sharing code is only used if the connection-sharing
+ option is enabled.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The latency is taken into account when evaluating whether or not to
+ reuse a connection. This should significantly reduce the number of
+ connections problems several users reported.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The max-client-connections option has been added to restrict
+ the number of client connections below a value enforced by
+ the operating system.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ If the server doesn't specify how long the connection stays alive,
+ Privoxy errs on the safe side of caution and assumes it's only a second.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Setting keep-alive-timeout to 0 disables keep-alive support. Previously
+ Privoxy would claim to allow persistence but not reuse the connection.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Pipelined requests are less likely to be mistaken for the request
+ body of the previous request. Note that Privoxy still has no real
+ pipeline support and will either serialize pipelined requests or
+ drop them in which case the client has to resent them.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fixed a crash on some Windows versions when header randomization
+ is enabled and the date couldn't be parsed.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Privoxy's keep-alive timeout for the current connection is reduced
+ to the one specified in the client's Keep-Alive header.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ For HTTP/1.1 requests, Privoxy implies keep-alive support by not
+ setting any Connection header instead of using 'Connection: keep-alive'.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ If the socket isn't reusable, Privoxy doesn't temporarily waste
+ a socket slot to remember the connection.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ If keep-alive support is disabled but compiled in, the client's
+ Keep-Alive header is removed.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fixed a bug on mingw32 where downloading large files failed if
+ keep-alive support was enabled.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fixed a bug that (at least theoretically) could cause log
+ timestamps to be occasionally off by about a second.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The configure script respects the $PATH variable when searching
+ for groups and id.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Compressed content with extra fields couldn't be decompressed
+ and would get passed to the client unfiltered. This problem
+ has only be detected through statical analysis with clang as
+ nobody seems to be using extra fields anyway.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ If the server resets the Connection after sending only the headers
+ Privoxy forwards what it got to the client. Previously Privoxy
+ would deliver an error message instead.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Error messages in case of connection timeouts use the right
+ HTTP status code.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ If spawning a child to handle a request fails, the client
+ gets an error message and Privoxy continues to listen for
+ new requests right away.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The error messages in case of server-connection timeouts or
+ prematurely closed server connections are now template-based.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ If zlib support isn't compiled in, Privoxy no longer tries to
+ filter compressed content unless explicitly asked to do so.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In case of connections that are denied based on ACL directives,
+ the memory used for the client IP is no longer leaked.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fixed another small memory leak if the client request times out
+ while waiting for client headers other than the request line.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The client socket is kept open until the server socket has
+ been marked as unused. This should increase the chances that
+ the still-open connection will be reused for the client's next
+ request to the same destination. Note that this only matters
+ if connection-sharing is enabled.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A TODO list has been added to the source tarballs to give potential
+ volunteers a better idea of what the current goals are. Donations
+ are still welcome too: http://www.privoxy.org/faq/general.html#DONATE
</para>
</listitem>
</itemizedlist>
<para>
Generally, an URL pattern has the form
- <literal><domain>/<path></literal>, where both the
- <literal><domain></literal> and <literal><path></literal> are
- optional. (This is why the special <literal>/</literal> pattern matches all
- URLs). Note that the protocol portion of the URL pattern (e.g.
- <literal>http://</literal>) should <emphasis>not</emphasis> be included in
- the pattern. This is assumed already!
+ <literal><domain><port>/<path></literal>, where the
+ <literal><domain></literal>, the <literal><port></literal>
+ and the <literal><path></literal> are optional. (This is why the special
+ <literal>/</literal> pattern matches all URLs). Note that the protocol
+ portion of the URL pattern (e.g. <literal>http://</literal>) should
+ <emphasis>not</emphasis> be included in the pattern. This is assumed already!
</para>
<para>
The pattern matching syntax is different for the domain and path parts of
<ulink url="http://en.wikipedia.org/wiki/Regular_expressions"><quote>Regular
Expressions</quote></ulink> (POSIX 1003.2).
</para>
+<para>
+ The port part of a pattern is a decimal port number preceded by a colon
+ (<literal>:</literal>). If the domain part contains a numerical IPv6 address,
+ it has to be put into angle brackets
+ (<literal><</literal>, <literal>></literal>).
+</para>
<variablelist>
<varlistentry>
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><literal>:8000/</literal></term>
+ <listitem>
+ <para>
+ Matches any URL pointing to TCP port 8000.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal><2001:db8::1>/</literal></term>
+ <listitem>
+ <para>
+ Matches any URL with the host address <literal>2001:db8::1</literal>.
+ (Note that the real URL uses plain brackets, not angle brackets.)
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><literal>index.html</literal></term>
<listitem>
USA
$Log: user-manual.sgml,v $
+ Revision 2.113 2009/10/10 05:48:55 fabiankeil
+ Prepare for 3.0.15 beta.
+
+ Revision 2.112 2009/07/24 12:20:30 fabiankeil
+ Remove duplicated period.
+
+ Revision 2.111 2009/07/18 18:11:11 fabiankeil
+ Don't claim that NTLM should work when there are multiple reports that it doesn't.
+
+ Revision 2.110 2009/07/18 16:25:17 fabiankeil
+ Fix trailing whitespace.
+
+ Revision 2.109 2009/07/18 16:24:39 fabiankeil
+ Bump entities for 3.0.14 beta.
+
+ Revision 2.108 2009/07/18 15:49:23 fabiankeil
+ Add most of the changes in 3.0.14 to the "What's New" section.
+
+ Revision 2.107 2009/06/12 14:30:58 fabiankeil
+ Update entities for 3.0.13 beta.
+
+ Revision 2.106 2009/06/12 11:04:13 fabiankeil
+ Import ChangeLog for 3.0.13 beta.
+
+ Revision 2.105 2009/04/17 11:32:57 fabiankeil
+ Grammar and spelling fixes.
+
+ Revision 2.104 2009/04/17 11:27:49 fabiankeil
+ Petr Pisar's privoxy-3.0.12-ipv6-3.diff.
+
+ Revision 2.103 2009/03/21 10:49:05 fabiankeil
+ Merge updated ChangeLog.
+
+ Revision 2.102 2009/03/15 19:31:36 fabiankeil
+ Update "What's New in this Release" section.
+
Revision 2.101 2009/02/25 19:01:56 fabiankeil
Fix typo.
projects / privoxy.git / blobdiff