initial load of upstream version 1.06.32
[xmlrpc-c] / tools / turbocharger / README
1 XML-RPC Turbocharger (Experimental)
2 ===================================
3
4 This a hacked copy of mod_gzip. In addition to the usual "gzip" encoding,
5 it also handles "deflate" encoding.
6
7 When used in conjuction with the xmlrpc-c client, this should reduce your
8 outbound XML-RPC network traffic by an amazing amount--compression ratios
9 of 10:1 and 30:1 are not unheard of. If you're clever, you should be able
10 to use this with just about any Apache-based XML-RPC server.
11
12 You can find the standard distribution of mod_gzip here:
13
14   http://www.remotecommunications.com/apache/mod_gzip/
15
16 The hacked distribution is installed and used in exactly the same fashion
17 as the regular distribution. There's one extra logging directive available:
18
19   %{mod_gzip_compression_format}n   Compression format chosen by client.
20
21 Go read the mod_gzip documentation; it should all make sense.
22
23 If you want to discuss the XML-RPC Turbocharger, please sign up for the
24 xmlrpc-c-devel mailing list at:
25
26   http://xmlrpc-c.sourceforge.net/
27
28 This code is highly experimental, and may do some strange things. You'll
29 probably need to screw around with mod_gzip for a while until you get
30 everything to work. Don't run this on your production web server, OK?
31
32 Eric Kidd
33 eric.kidd@pobox.com
34
35 P.S. The Turbocharger appears to dump core in mod_gzip decides to serialize
36 a large response to disk. Do you see what I mean by "experimental" and
37 "don't run this on your production web server"? :-)