<!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-version "3.0.16">
<!entity p-status "stable">
<!entity % p-authors-formal "INCLUDE"> <!-- include additional text, etc -->
<!entity % p-not-stable "IGNORE">
<!entity % p-supp-userman "IGNORE"> <!-- Omit some from supported.sgml -->
<!entity my-copy "©"> <!-- kludge for docbook2man -->
<!entity % draft "IGNORE"> <!-- WIP stuff -->
+<!entity % seealso-extra "INCLUDE"> <!-- extra stuff from seealso.sgml -->
<!entity my-app "<application>Privoxy</application>">
]>
<!--
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 2.94 2009/02/14 11:50:31 fabiankeil Exp $
+ $Id: user-manual.sgml,v 2.121 2010/02/15 15:30:13 fabiankeil Exp $
- Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2010 Privoxy Developers http://www.privoxy.org/
See LICENSE.
========================================================================
<subscript>
<!-- Completely the wrong markup, but very little is allowed -->
<!-- in this part of an article. FIXME -->
- <link linkend="copyright">Copyright</link> &my-copy; 2001-2009 by
+ <link linkend="copyright">Copyright</link> &my-copy; 2001-2010 by
<ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
</subscript>
</pubdate>
-<pubdate>$Id: user-manual.sgml,v 2.94 2009/02/14 11:50:31 fabiankeil Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 2.121 2010/02/15 15:30:13 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>
- There are only a few improvements and new features since
- <application>Privoxy 3.0.10</application>, the last stable release:
+ <application>Privoxy 3.0.16</application> is a stable release.
+ The changes since 3.0.15 beta are:
</para>
<para>
<itemizedlist>
<listitem>
<para>
- The mingw32 version uses mutex locks now which prevents
- log message corruption under load. As a side effect,
- the "no thread-safe PRNG" warning could be removed as well.
+ Added the config file option handle-as-empty-doc-returns-ok to
+ work around Firefox bug #492459, which causes Firefox to hang
+ if JavaScripts are blocked in certain situations. The option is
+ enabled in the default config file.
</para>
</listitem>
<listitem>
<para>
- Support for remote toggling is controlled by the configure
- option --disable-toggle only. In previous versions it also
- depended on the action editor and thus configuring with the
- --disable-editor option would disable remote toggling support
- as well.
+ Added the config file option default-server-timeout to control the
+ assumed default server timeout. Since Privoxy no longer returns
+ an error message for connection resets on reused client connections,
+ assuming larger server timeout values appears to actually work
+ pretty well as long as connections aren't shared.
</para>
</listitem>
<listitem>
<para>
- The hide-forwarded-for-headers action has been replaced with
- the change-x-forwarded-for{} action which can also be used to
- add X-Forwarded-For headers. The latter functionality already
- existed in Privoxy versions prior to 3.0.7 but has been removed
- as it was often used unintentionally (by not using the
- hide-forwarded-for-headers action).
+ Added optional support for FreeBSD's accf_http(9). Use the
+ configure option --enable-accept-filter to enable it.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Added fancier Privoxy icons for win32. Contributed by Jeff H.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In daemon mode, fd 0, 1 and 2 are bound to /dev/null.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Resolve localhost using whatever address family the operating
+ system feels like. Previous betas would try to use IPv4 as this
+ is what most users expect, but this didn't work reliable on
+ GNU/Linux systems.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In the action lists on CGI pages, actions and their parameters are
+ no longer separated with a space. The action file parser doesn't
+ actually allow this and will throw an invalid syntax error if actions
+ and parameters in the action files are separated. Not adding the
+ spaces means copy and pasting CGI output into the action files works.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The default keep-alive timeout has been reduced to 5 seconds to work
+ around hangs in clients that treat the proxy like any other host and
+ stop allowing any new connections if the "maximum number of
+ connections per host" is reached.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Several webbug URLs that look like they are leading to images are now
+ blocked as image instead of empty documents. Doing the latter causes
+ WebKit-based clients to show a "missing image" icon which may mess up
+ the layout.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The no-such-domain template if used if for DNS resolution
+ problems with FEATURE_IPV6_SUPPORT enabled. Previously the
+ connect-failed template was used. Reported by 'zebul666'.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Accepts quoted expiration dates even though RFC 2109 10.1.2
+ doesn't seem to allow them. Reported anonymously.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Don't try to forget connections if connection sharing is disabled.
+ This wasn't a real problem but caused an unnecessary log message.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The still undocumented --enable-extended-host-patterns configure
+ option has a better description.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fixed an error message that would claim a write to the server
+ failed when actually writing to the client failed.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Log the crunch reason before trying to write to the client.
+ The log is easier to read that way.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Several log messages about client connections also mention
+ the socket number.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ handle-as-empty-document no longer depends on the image blocking
+ code being enabled.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Privoxy-Log-Parser is roughly 40% faster in highlighting mode.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ uagen, a Firefox User-Agent generator for Privoxy and Mozilla
+ browsers has been imported and is available in the tarballs
+ tools directory.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The scripts in the tools directory treat unknown parameters
+ as fatal errors.
</para>
</listitem>
</itemizedlist>
</para>
<para>
- For a more detailed list of changes please have a look at the ChangeLog.
+ If you missed the previous two beta versions, you may also be
+ interested in the additional changes 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>
+ <listitem>
+ <para>
+ 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>
+ More reliable detection of prematurely closed client sockets
+ with keep-alive enabled.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ FEATURE_CONNECTION_KEEP_ALIVE is decoupled from
+ FEATURE_CONNECTION_SHARING and now available on
+ all platforms.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ 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>
+ Fixed various latency calculation issues.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ 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>
+ 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>
+ 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>
+ 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>
+ 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>
+ 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>
+
<!-- ~~~~~ New section ~~~~~ -->
<sect2 id="upgradersnote">
</para>
</listitem>
- <listitem>
- <para>
- The <quote>filter-client-headers</quote> and
- <quote>filter-server-headers</quote> actions that were introduced with
- <application>Privoxy 3.0.5</application> to apply content filters to
- the headers have been removed and replaced with new actions.
- See the <link
- linkend="whatsnew">What's New section</link> above.
- </para>
- </listitem>
-
-
<!--
<listitem>
<para>
<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>
<quote>HTTP headers</quote> are, you definitely don't need to worry about this
one.
</para>
+ <para>
+ Headers added by this action are not modified by other actions.
+ </para>
</listitem>
</varlistentry>
<quote>reset-to-request-time</quote> overwrites the value of the
<quote>Last-Modified:</quote> header with the current time. You could use
this option together with
- <literal><link linkend="hide-if-modified-since">hided-if-modified-since</link></literal>
+ <literal><link linkend="hide-if-modified-since">hide-if-modified-since</link></literal>
to further customize your random range.
</para>
<para>
+<link linkend="SET-IMAGE-BLOCKER">set-image-blocker{pattern}</link> \
}
/ # Match all URLs
+ </screen>
</para>
<para>
The default behavior is now set.
</para>
+</sect3>
+<sect3>
<title>default.action</title>
<para>
USA
$Log: user-manual.sgml,v $
+ Revision 2.121 2010/02/15 15:30:13 fabiankeil
+ Mention the use of the no-such-domain template for DNS problems with FEATURE_IPV6_SUPPORT enabled.
+
+ Revision 2.120 2010/02/13 17:38:39 fabiankeil
+ Update entities for 3.0.16 stable.
+
+ Revision 2.119 2010/02/13 16:37:37 fabiankeil
+ Update 'What's new?' section.
+
+ Revision 2.118 2010/02/11 13:59:48 fabiankeil
+ Mention that the headers added by the add-header action aren't modified by other actions.
+
+ Revision 2.117 2010/01/11 12:56:04 fabiankeil
+ Bump copyright range as p-config.sgml's copyright line is only used in the config file.
+
+ Revision 2.116 2009/11/15 14:24:12 fabiankeil
+ Prepare to generate docs for 3.0.16 UNRELEASED.
+
+ Revision 2.115 2009/10/10 06:19:34 fabiankeil
+ Ditch a duplicated 'since'.
+
+ Revision 2.114 2009/10/10 05:51:48 fabiankeil
+ Update "What's new" section.
+
+ 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.
+
+ Revision 2.100 2009/02/19 17:14:11 fabiankeil
+ - Copy the release cycle description from announce.txt into
+ the "What's New" section.
+ - Stop referring to the ChangeLog for a "complete list of changes".
+ The "What's New" section already contains the complete list.
+
+ Revision 2.99 2009/02/19 02:20:22 hal9
+ Make some links in seealso conditional. Man page is now privoxy only links.
+
+ Revision 2.98 2009/02/16 17:10:33 fabiankeil
+ Fix entry about shortened log messages. Noticed by Lee.
+
+ Revision 2.97 2009/02/14 18:01:00 fabiankeil
+ Import ChangeLog.
+
+ Revision 2.96 2009/02/14 13:14:03 fabiankeil
+ Unbreak syntax.
+
+ Revision 2.95 2009/02/14 12:51:26 fabiankeil
+ Mention match-all.action in the "Actions Files Tutorial" section.
+
Revision 2.94 2009/02/14 11:50:31 fabiankeil
Some indentation fixes.
projects / privoxy.git / blobdiff