X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=541c562d6a9b968306fcbba5de6fa2c2750e5671;hp=818cc42e6e6f9babf4ddf5ffa90f39f2d88d0daf;hb=70b9ed04dec24ef32a00a14dbe2a1556275e9bd3;hpb=49c572318ab271afcab1c50b8c6340fc260cf0b5
diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index 818cc42e..541c562d 100644
--- a/doc/source/user-manual.sgml
+++ b/doc/source/user-manual.sgml
@@ -11,7 +11,7 @@
-
+
@@ -34,9 +34,9 @@
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 2.100 2009/02/19 17:14:11 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.
========================================================================
@@ -55,12 +55,12 @@
- Copyright &my-copy; 2001-2009 by
+ Copyright &my-copy; 2001-2010 by
Privoxy Developers
-$Id: user-manual.sgml,v 2.100 2009/02/19 17:14:11 fabiankeil Exp $
+$Id: user-manual.sgml,v 2.121 2010/02/15 15:30:13 fabiankeil Exp $
@@ -437,154 +437,439 @@ How to install the binary packages depends on your operating system:
What's New in this Release
- There are only a few improvements and new features since
- Privoxy 3.0.10, the last stable release:
+ Privoxy 3.0.16 is a stable release.
+ The changes since 3.0.15 beta are:
- On most platforms, outgoing connections can be kept alive and
- reused if the server supports it. Whether or not this improves
- things depends on the connection.
+ 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.
- When dropping privileges, membership in supplementary groups
- is given up as well. Not doing that can lead to Privoxy running
- with more rights than necessary and violates the principle of
- least privilege. Users of the --user option are advised to update.
- Thanks to Matthias Drochner for reporting the problem,
- providing the initial patch and testing the final version.
+ 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.
- Passing invalid users or groups with the --user option
- didn't lead to program exit. Regression introduced in 3.0.7.
+ Added optional support for FreeBSD's accf_http(9). Use the
+ configure option --enable-accept-filter to enable it.
- The match all section has been moved from default.action
- to a new file called match-all.action. As a result the
- default.action no longer needs to be touched by the user
- and can be safely overwritten by updates.
+ Added fancier Privoxy icons for win32. Contributed by Jeff H.
- The standard.action file has been removed. Its content
- is now part of the default.action file.
+ In daemon mode, fd 0, 1 and 2 are bound to /dev/null.
- In some situations the logged content length was slightly too low.
+ 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.
- Crunched requests are logged with their own log level.
- If you used "debug 1" in the past, you'll probably want
- to additionally enable "debug 1024", otherwise only passed
- requests will be logged. If you only care about crunched
- requests, simply replace "debug 1" with "debug 1024".
+ 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.
- The crunch reason has been moved to the beginning of the
- crunch message. For HTTP URLs, the protocol is logged as well.
+ 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.
- Log messages are shortened by printing the thread id on its
- own (as opposed to putting it inside the string "Privoxy()").
+ 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.
- The config option socket-timeout has been added to control
- the time Privoxy waits for data to arrive on a socket.
+ 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'.
- 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.
+ Accepts quoted expiration dates even though RFC 2109 10.1.2
+ doesn't seem to allow them. Reported anonymously.
- Requests with invalid HTTP versions are rejected.
+ Don't try to forget connections if connection sharing is disabled.
+ This wasn't a real problem but caused an unnecessary log message.
- The template symbol @date@ can be used to include a date(1)-like
- time string. Initial patch submitted by Endre Szabo.
+ The still undocumented --enable-extended-host-patterns configure
+ option has a better description.
- Responses from shoutcast servers are accepted again.
- Problem reported and fix suggested by Stefan.
+ Fixed an error message that would claim a write to the server
+ failed when actually writing to the client failed.
- 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).
+ Log the crunch reason before trying to write to the client.
+ The log is easier to read that way.
- A "clear log" view option was added to the mingw32 version
- to clear out all of the lines in the Privoxy log window.
- Based on a patch submitted by T Ford.
+ Several log messages about client connections also mention
+ the socket number.
- The mingw32 version uses "critical sections" now, which prevents
- log message corruption under load. As a side effect, the
- "no thread-safe PRNG" warning could be removed as well.
+ handle-as-empty-document no longer depends on the image blocking
+ code being enabled.
- The mingw32 version's task bar icon is crossed out and
- the color changed to gray if Privoxy is toggled off.
+ Privoxy-Log-Parser is roughly 40% faster in highlighting mode.
+
+
+
+
+ uagen, a Firefox User-Agent generator for Privoxy and Mozilla
+ browsers has been imported and is available in the tarballs
+ tools directory.
+
+
+
+
+ The scripts in the tools directory treat unknown parameters
+ as fatal errors.
- This release marks a departure for Privoxy development.
+ 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:
+
- Previously, odd numbered releases were considered beta versions and
- were only released at the end of the development cycle when the code
- was already believed to be stable. Usually it was, so the stable release
- contained pretty much the same code, but got a higher version number.
- In the future we intend to release several snapshots between stable releases.
- There will probably still be about two stable releases per year,
- but hopefully about six snapshots instead of the two betas we have now.
- The intentions is to make testing without CVS access easier.
+
+
+
+ Added IPv6 support. Thanks to Petr Pisar who not only provided
+ the initial patch but also helped a lot with the integration.
+
+
+
+
+ Added client-side keep-alive support.
+
+
+
+
+ The connection sharing code is only used if the connection-sharing
+ option is enabled.
+
+
+
+
+ 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.
+
+
+
+
+ The max-client-connections option has been added to restrict
+ the number of client connections below a value enforced by
+ the operating system.
+
+
+
+
+ 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.
+
+
+
+
+ Setting keep-alive-timeout to 0 disables keep-alive support. Previously
+ Privoxy would claim to allow persistence but not reuse the connection.
+
+
+
+
+ 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.
+
+
+
+
+ Fixed a crash on some Windows versions when header randomization
+ is enabled and the date couldn't be parsed.
+
+
+
+
+ Privoxy's keep-alive timeout for the current connection is reduced
+ to the one specified in the client's Keep-Alive header.
+
+
+
+
+ For HTTP/1.1 requests, Privoxy implies keep-alive support by not
+ setting any Connection header instead of using 'Connection: keep-alive'.
+
+
+
+
+ If the socket isn't reusable, Privoxy doesn't temporarily waste
+ a socket slot to remember the connection.
+
+
+
+
+ If keep-alive support is disabled but compiled in, the client's
+ Keep-Alive header is removed.
+
+
+
+
+ Fixed a bug on mingw32 where downloading large files failed if
+ keep-alive support was enabled.
+
+
+
+
+ Fixed a bug that (at least theoretically) could cause log
+ timestamps to be occasionally off by about a second.
+
+
+
+
+ The configure script respects the $PATH variable when searching
+ for groups and id.
+
+
+
+
+ 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.
+
+
+
+
+ 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.
+
+
+
+
+ Error messages in case of connection timeouts use the right
+ HTTP status code.
+
+
+
+
+ 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.
+
+
+
+
+ The error messages in case of server-connection timeouts or
+ prematurely closed server connections are now template-based.
+
+
+
+
+ If zlib support isn't compiled in, Privoxy no longer tries to
+ filter compressed content unless explicitly asked to do so.
+
+
+
+
+ In case of connections that are denied based on ACL directives,
+ the memory used for the client IP is no longer leaked.
+
+
+
+
+ Fixed another small memory leak if the client request times out
+ while waiting for client headers other than the request line.
+
+
+
+
+ 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.
+
+
+
+
+ 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
+
+
+
+
+ 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.
+
+
+
+
+ More reliable detection of prematurely closed client sockets
+ with keep-alive enabled.
+
+
+
+
+ FEATURE_CONNECTION_KEEP_ALIVE is decoupled from
+ FEATURE_CONNECTION_SHARING and now available on
+ all platforms.
+
+
+
+
+ Improved handling of POST requests on reused connections.
+ Should fix problems with stalled connections after submitting
+ form data with some browser configurations.
+
+
+
+
+ Fixed various latency calculation issues.
+
+
+
+
+ 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
+
+
+
+
+ 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.
+
+
+
+
+ Compiles again on platforms such as OpenBSD and systems
+ using earlier glibc version that don't support AI_ADDRCONFIG.
+ Anonymously submitted in #2872591.
+
+
+
+
+ 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.
+
+
+
+
+ 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().
+
+
+
+
+ Already timed-out connections are no longer temporarily remembered.
+ They weren't reused anyway, but wasted a socket slot.
+
+
+
+
+ len refers to the number of bytes actually read which might
+ differ from the ones received. Adjust log messages accordingly.
+
+
+
+
+ The optional JavaScript on the CGI page uses encodeURIComponent()
+ instead of escape() which doesn't encode all characters that matter.
+ Anonymously reported in #2832722.
+
+
+
+
+ Fix gcc45 warnings in decompress_iob().
+
+
+
+
+ Various log message improvements.
+
+
+
+
+ Privoxy-Regression-Test supports redirect tests.
+
+
+
+
+ Privoxy-Log-Parser can gather some connection statistics.
+
+
+
+
+
@@ -2207,12 +2492,12 @@ for details.
Generally, an URL pattern has the form
- <domain>/<path>, where both the
- <domain> and <path> are
- optional. (This is why the special / pattern matches all
- URLs). Note that the protocol portion of the URL pattern (e.g.
- http://) should not be included in
- the pattern. This is assumed already!
+ <domain><port>/<path>, where the
+ <domain>, the <port>
+ and the <path> are optional. (This is why the special
+ / pattern matches all URLs). Note that the protocol
+ portion of the URL pattern (e.g. http://) should
+ not be included in the pattern. This is assumed already!
The pattern matching syntax is different for the domain and path parts of
@@ -2221,6 +2506,12 @@ for details.
Regular
Expressions (POSIX 1003.2).
+
+ The port part of a pattern is a decimal port number preceded by a colon
+ (:). If the domain part contains a numerical IPv6 address,
+ it has to be put into angle brackets
+ (<, >).
+
@@ -2270,6 +2561,23 @@ for details.
+
+ :8000/
+
+
+ Matches any URL pointing to TCP port 8000.
+
+
+
+
+ <2001:db8::1>/
+
+
+ Matches any URL with the host address 2001:db8::1.
+ (Note that the real URL uses plain brackets, not angle brackets.)
+
+
+ index.html
@@ -2735,6 +3043,9 @@ for details.
HTTP headers are, you definitely don't need to worry about this
one.
+
+ Headers added by this action are not modified by other actions.
+
@@ -8513,6 +8824,69 @@ In file: user.action [ View ][ Edit ]