X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fsource%2Fuser-manual.sgml;h=ea67d35f29d4e7e6abf3b0b4ef598fb28b5713aa;hb=b13c15a5b84e9ca8e1477b16951262fb6f4b36ac;hp=8af6da9eb534069e99848acb9d5ffc38d5b07803;hpb=bb59003c7c0561d06a81589622165b0b36ca2b28;p=privoxy.git
diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index 8af6da9e..ea67d35f 100644
--- a/doc/source/user-manual.sgml
+++ b/doc/source/user-manual.sgml
@@ -11,7 +11,7 @@
-
+
@@ -24,6 +24,7 @@
+
Privoxy">
]>
- Copyright &my-copy; 2001-2009 by
+ Copyright &my-copy; 2001-2010 by
Privoxy Developers
-$Id: user-manual.sgml,v 2.96 2009/02/14 13:14:03 fabiankeil Exp $
+$Id: user-manual.sgml,v 2.127 2010/11/10 21:48:54 fabiankeil Exp $
@@ -436,143 +437,487 @@ 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.17 is a stable release.
+ The changes since 3.0.16 stable 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.
-
-
-
-
- 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.
-
-
-
+
- Passing invalid users or groups with the --user option
- didn't lead to program exit. Regression introduced in 3.0.7.
+ Fixed last-chunk-detection for responses where the content was small
+ enough to be read with the body, causing Privoxy to wait for the
+ end of the content until the server closed the connection.
+ Reported by "Karsten" in #3028326.
- 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.
+ Responses with status code 204 weren't properly detected as body-less
+ like RFC2616 mandates. Like the previous bug, this caused Privoxy
+ to wait for the end of the content until the server closed the connection.
+ Fixes #3022042 and #3025553, reported by a user with no visible name.
+ Most likely also fixes a bunch of other AJAX-related problem reports
+ that got closed in the past due to insufficient information and lack
+ of feedback.
- The standard.action file has been removed. Its content
- is now part of the default.action file.
+ Fixed an ACL bug that made it impossible to build a blacklist.
+ Usually the ACL directives are used in a whitelist, which worked
+ as expected, but blacklisting is still useful for public proxies
+ where one only needs to deny known abusers access.
- In some situations the logged content length was slightly too low.
+ Added LOG_LEVEL_RECEIVED to log the not-yet-parsed data read from the
+ network. This should make debugging various parsing issues a lot easier.
- 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".
+ The IPv6 code is enabled by default on Windows versions that support it.
+ Patch submitted by oCameLo in #2942729.
- The crunch reason has been moved to the beginning of the
- crunch message. For HTTP URLs, the protocol is logged as well.
+ In mingw32 versions, the user.filter file is reachable through the
+ GUI, just like default.filter is. Feature request 3040263.
- Log messages are shortened by not printing the thread id
- on its own (as opposed to putting it inside "Privoxy()".
+ Added the configure option --enable-large-file-support to set a few
+ defines that are required by platforms like GNU/Linux to support files
+ larger then 2GB. Mainly interesting for users without proper logfile
+ management.
- The config option socket-timeout has been added to control
- the time Privoxy waits for data to arrive on a socket.
+ Logging with "debug 16" no longer stops at the first nul byte which is
+ pretty useless. Non-printable characters are replaced with their hex value
+ so the result can't span multiple lines making parsing them harder then
+ necessary.
- 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.
+ Privoxy logs when reading an action, filter or trust file.
- Requests with invalid HTTP versions are rejected.
+ Fixed incorrect regression test markup which caused a test in
+ 3.0.16 to fail while Privoxy itself was working correctly.
+ While Privoxy accepts hide-referer, too, the action name is actually
+ hide-referrer which is also the name used one the final results page,
+ where the test expected the alias.
- The template symbol @date@ can be used to include a date(1)-like
- time string. Initial patch submitted by Endre Szabo.
+ CGI interface improvements:
+
+
+
+ In finish_http_response(), continue to add the 'Connection: close'
+ header if the client connection will not be kept alive.
+ Anonymously pointed out in #2987454.
+
+
+
+
+ Apostrophes in block messages no longer cause parse errors
+ when the blocked page is viewed with JavaScript enabled.
+ Reported by dg1727 in #3062296.
+
+
+
+
+ Fix a bunch of anchors that used underscores instead of dashes.
+
+
+
+
+ Allow to keep the client connection alive after crunching the previous request.
+ Already opened server connections can be kept alive, too.
+
+
+
+
+ In cgi_show_url_info(), don't forget to prefix URLs that only contain http:// or https:// in the path.
+ Fixes #2975765 reported by Adam Piggott.
+
+
+
+
+ Show the 404 CGI page if cgi_send_user_manual() is called while
+ local user manual delivery is disabled.
+
+
- Responses from shoutcast servers are accepted again.
- Problem reported and fix suggested by Stefan.
+ Action file improvements:
+
+
+
+ Enable user.filter by default. Suggested by David White in #3001830.
+
+
+
+
+ Block .sitestat.com/. Reported by johnd16 in #3002725.
+
+
+
+
+ Block .atemda.com/. Reported by johnd16 in #3002723.
+
+
+
+
+ Block js.adlink.net/. Reported by johnd16 in #3002720.
+
+
+
+
+ Block .analytics.yahoo.com/. Reported by johnd16 in #3002713.
+
+
+
+
+ Block sb.scorecardresearch.com, too. Reported by dg1727 in #2992652.
+
+
+
+
+ Fix problems noticed on Yahoo mail and news pages.
+
+
+
+
+ Remove the too broad yahoo section, only keeping the
+ fast-redirects exception as discussed on ijbswa-devel@.
+
+
+
+
+ Don't block adesklets.sourceforge.net. Reported in #2974204.
+
+
+
+
+ Block chartbeat ping tracking. Reported in #2975895.
+
+
+
+
+ Tag CSS and image requests with cautious and medium settings, too.
+
+
+
+
+ Don't handle view.atdmt.com as image. It's used for click-throughs
+ so users should be able to "go there anyway".
+ Reported by Adam Piggott in #2975927.
+
+
+
+
+ Also let the refresh-tags filter remove invalid refresh tags where
+ the 'url=' part is missing. Anonymously reported in #2986382.
+ While at it, update the description to mention the fact that only
+ refresh tags with refresh times above 9 seconds are covered.
+
+
+
+
+ javascript needs to be blocked with +handle-as-empty-document to
+ work around Firefox bug 492459. So move .js blockers from
+ +block{Might be a web-bug.} -handle-as-empty-document
+ to
+ +block{Might be a web-bug.} +handle-as-empty-document
+
+
+
+
+ ijbswa-Feature Requests-3006719 - Block 160x578 Banners.
+
+
+
+
+ Block another omniture tracking domain
+
+
+
+
+ Added a range-requests tagger.
+
+
+
+
+ Added two sections to get Flickr's Ajax interface working with
+ default pre-settings. If you change the configuration to block
+ cookies by default, you'll need additional exceptions.
+ Reported by Mathias Homann in #3101419 and by Patrick on ijbswa-users@
+
+
- 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).
+ Documentation improvements:
+
+
+
+ Explicitly mention how to match all URLs.
+
+
+
+
+ Consistently recommend socks5 in the Tor FAQ entry and mention
+ its advantage compared to socks4a. Reported by David in #2960129.
+
+
+
+
+ Slightly improve the explanation of why filtering may appear
+ slower than it is.
+
+
+
+
+ Grammar fixes for the ACL section.
+
+
- 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.
+ Privoxy-Log-Parser improvements:
+
+
+
+ Also gather statistics for blocked and redirected requests.
+
+
+
+
+ Provide the percentage of keep-alive offers the client accepted.
+
+
+
+
+ Add a --url-statistics-threshold option.
+
+
+
+
+ Also gather statistics for ressources, methods, and HTTP versions
+ used by the client.
+
+
+
+
+ Add a --host-statistics-threshold option to also gather
+ statistics about how many request where made per host.
+
+
+
+
+ Fix a bug in handle_loglevel_header() where a 'scan: ' got lost.
+
+
+
+
+ Add a --shorten-thread-ids option to replace the thread id with
+ a decimal number.
+
+
+
+
+ Accept and ignore: Looks like we got the last chunk together
+ with the server headers. We better stop reading.
+
+
+
+
+ Accept and ignore: Continue hack in da house.
+
+
+
+
+ Accept and higlight: Rejecting connection from 10.0.0.2.
+ Maximum number of connections reached.
+
+
+
+
+ Accept and highlight: Loading actions file: /usr/local/etc/privoxy/default.action
+
+
+
+
+ Accept and highlight: Loading filter file: /usr/local/etc/privoxy/default.filter
+
+
+
+
+ Accept and highlight: Killed all-caps Host header line: HOST: bestproxydb.com
+
+
+
+
+ Accept and highlight: Reducing expected bytes to 0. Marking
+ the server socket tainted after throwing 4 bytes away.
+
+
+
+
+ Accept: Merged multiple header lines to: 'X-FORWARDED-PROTO: http X-HOST: 127.0.0.1'
+
+
- 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.
+ Code cleanups:
+
+
+
+ Remove the next member from the client_state struct. Only the main
+ thread needs access to all client states so give it its own struct.
+
+
+
+
+ Garbage-collect request_contains_null_bytes().
+
+
+
+
+ Ditch redundant code in unload_configfile().
+
+
+
+
+ Ditch LogGetURLUnderCursor() which doesn't seem to be used anywhere.
+
+
+
+
+ In write_socket(), remove the write-only variable write_len in
+ an ifdef __OS2__ block. Spotted by cppcheck.
+
+
+
+
+ In connect_to(), don't declare the variable 'flags' on OS/2 where
+ it isn't used. Spotted by cppcheck.
+
+
+
+
+ Limit the scope of various variables. Spotted by cppcheck.
+
+
+
+
+ In add_to_iob(), turn an interestingly looking for loop into a
+ boring while loop.
+
+
+
+
+ Code cleanup in preparation for external filters.
+
+
+
+
+ In listen_loop(), mention the socket on which we accepted the
+ connection, not just the source IP address.
+
+
+
+
+ In write_socket(), also log the socket we're writing to.
+
+
+
+
+ In log_error(), assert that escaped characters get logged
+ completely or not at all.
+
+
+
+
+ In log_error(), assert that ival and sval have reasonable values.
+ There's no reason not to abort() if they don't.
+
+
+
+
+ Remove an incorrect cgi_error_unknown() call in a
+ cannnot-happen-situation in send_crunch_response().
+
+
+
+
+ Clean up white-space in http_response definition and
+ move the crunch_reason to the beginning.
+
+
+
+
+ Turn http_response.reason into an enum and rename it
+ to http_response.crunch_reason.
+
+
+
+
+ Silence a 'gcc (Debian 4.3.2-1.1) 4.3.2' warning on i686 GNU/Linux.
+
+
- The mingw32 version's task bar icon is crossed out and
- the color changed to gray if Privoxy is toggled off.
+ GNUmakefile improvements:
+
+
+
+ Use $(SSH) instead of ssh, so one only needs to specify a username once.
+
+
+
+
+ Removed references to the action feedback thingy that hasn't been
+ working for years.
+
+
+
+
+ Consistently use shell.sourceforge.net instead of shell.sf.net so
+ one doesn't need to check server fingerprints twice.
+
+
+
+
+ Removed GNUisms in the webserver and webactions targets so they
+ work with standard tar.
+
+
-
- For a more detailed list of changes please have a look at the ChangeLog.
-
@@ -2196,12 +2541,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
@@ -2210,6 +2555,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
+ (<, >).
+
@@ -2259,6 +2610,32 @@ for details.
+
+ /
+
+
+ Matches any URL because there's no requirement for either the
+ domain or the path to match anything.
+
+
+
+
+ :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
@@ -2724,6 +3101,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.
+
@@ -3911,9 +4291,10 @@ problem-host.example.com
Filtering requires buffering the page content, which may appear to
slow down page rendering since nothing is displayed until all content has
- passed the filters. (It does not really take longer, but seems that way
- since the page is not incrementally displayed.) This effect will be more
- noticeable on slower connections.
+ passed the filters. (The total time until the page is completely rendered
+ doesn't change much, but it may be perceived as slower since the page is
+ not incrementally displayed.)
+ This effect will be more noticeable on slower connections.
Rolling your own
@@ -5220,7 +5601,7 @@ new action
reset-to-request-time overwrites the value of the
Last-Modified: header with the current time. You could use
this option together with
- hided-if-modified-since
+ hide-if-modified-since
to further customize your random range.
@@ -8502,6 +8883,102 @@ In file: user.action [ View ][ Edit ]