From 46174e1f222d671ce9aab072e6174499756911ed Mon Sep 17 00:00:00 2001 From: hal9 Date: Sun, 11 Nov 2007 16:33:22 +0000 Subject: [PATCH] New html version of user manual. --- doc/webserver/user-manual/actions-file.html | 20 +- doc/webserver/user-manual/appendix.html | 18 +- doc/webserver/user-manual/config.html | 123 ++++++------ doc/webserver/user-manual/configuration.html | 17 +- doc/webserver/user-manual/copyright.html | 2 +- doc/webserver/user-manual/filter-file.html | 2 +- doc/webserver/user-manual/index.html | 34 ++-- doc/webserver/user-manual/installation.html | 8 +- doc/webserver/user-manual/quickstart.html | 48 +++-- doc/webserver/user-manual/startup.html | 4 +- doc/webserver/user-manual/templates.html | 28 ++- doc/webserver/user-manual/whatsnew.html | 187 +++++++++++++++++++ 12 files changed, 356 insertions(+), 135 deletions(-) diff --git a/doc/webserver/user-manual/actions-file.html b/doc/webserver/user-manual/actions-file.html index 09b7230a..f7a2172e 100644 --- a/doc/webserver/user-manual/actions-file.html +++ b/doc/webserver/user-manual/actions-file.html @@ -259,7 +259,7 @@ CLASS="FILENAME" >

8.1. Finding the Right Mix

8.2. How to Edit

8.4.1. The Domain Pattern

8.4.2. The Path Pattern

# Tag every request with the User-Agent header
-{+client-header-filter{user-agent}}
+{+client-header-tagger{user-agent}}
 /
     
# Tag every request with the declared content type
-{+client-header-tagger{content-type}}
+{+server-header-tagger{content-type}}
 /

8.5.39. Summary

8.7.1. default.action

8.7.2. user.action

14.2. Privoxy's Internal Pages

Short cuts. Turn off, then on:

trustfile above.) +> below.)

If you use the trust mechanism, it is a good idea to write up some on-line @@ -578,7 +578,7 @@ CLASS="VARIABLELIST" >Specifies:

The directory where the other configuration files are located

The directory where the other configuration files are located.

Type of value:
/", please +>, please.

Specifies:

An alternative directory where the templates are loaded from

An alternative directory where the templates are loaded from.

Type of value:
Notes:

Privoxy's original templates are usually overwritten - with each update. Use this option to relocate customized templates - that should be kept. Note that template variables might change - between updates and templates are not guaranteed to work with +> Privoxy's original templates are usually + overwritten with each update. Use this option to relocate customized + templates that should be kept. As template variables might change + between updates, you shouldn't expect templates to work with Privoxy releases other than the one - they were part of. + they were part of, though.

Specifies:

The directory where all logging takes place (i.e. where The directory where all logging takes place + (i.e. where logfile and +> and jarfile are located) +> are located).

/", please +>, please.

- The default values include standard.action, which is used for internal - purposes and should be loaded, default.action, which is the - standard.action, which is used + for internal purposes and should be loaded, default.action, + which is the "main" actions file maintained by the developers, and @@ -869,7 +879,7 @@ CLASS="FILENAME"

- Actions files are where all the per site and per URL configuration is done for + Actions files contain all the per site and per URL configuration for ad blocking, cookie management, privacy considerations, etc. There is no point in using or privoxy.log (Windows)

privoxy.log (Windows).

Effect if unset:
or privoxy.jar (Windows)

privoxy.jar (Windows).

Effect if unset:

The reporting of fatal errors (i.e. ones which causes - Privoxy to exit) is always on and cannot be disabled. -

If you want to use CLF (Common Log Format), you should set "debug @@ -1543,7 +1540,7 @@ CLASS="VARIABLELIST" >Specifies:

Whether to run only one server thread +> Whether to run only one server thread.

Notes:

This option is only there for debugging purposes and you should never - need to use it. This option is only there for debugging purposes. + Privoxy users don't read - documentation, this feature has been disabled by default. + documentation, this feature is disabled by default.

Note that you must have compiled

This option may be removed in future releases as it has been obsoleted +> This option will be removed in future releases as it has been obsoleted by the more general header taggers.

not recommended for environments - with untrusted users and is therefore disabled by default. + with untrusted users and as a lot of Privoxy + users don't read documentation, this feature is disabled by default.

Note that malicious client side code (e.g Java) is also @@ -2077,13 +2078,6 @@ CLASS="EMPHASIS" sure your browser is configured correctly.

As a lot of Privoxy users don't read - documentation, this feature has been disabled by default. -

Note that you must have compiled Privoxy

Please see the warnings in the FAQ that this proxy is not intended to be a substitute - for a firewall or to encourage anyone to defer addressing basic security - weaknesses. +> Please see the warnings in the FAQ that Privoxy + is not intended to be a substitute for a firewall or to encourage anyone + to defer addressing basic security weaknesses.

Multiple ACL lines are OK. @@ -2788,8 +2785,8 @@ WIDTH="90%" >

  forward   /                  caching-proxy.example-isp.net:8000
-  forward   .example-isp.net   .
forward / caching-proxy.isp.example.net:8000 + forward .isp.example.net .
  forward-socks4a   /              socks-gw.example.com:1080  www-cache.example-isp.net:8080
+>  forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
   forward           .example.com   .

To chain Privoxy and Tor, both running on the same system, you should use - the rule: +> To chain Privoxy and Tor, both running on the same system, you would use + something like:

Privoxy - at all. + at all. Of course this may actually be desired and there is no reason + to make these exceptions if you aren't sure you need them.

If you also want to be able to reach servers in your local network by @@ -3104,8 +3102,8 @@ CLASS="EMPHASIS" > users can see the internal content of all ISPs.

Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to - isp-b.net. Both run Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to + isp-b.example.org. Both run Privoxy. Their forwarding @@ -3122,7 +3120,7 @@ WIDTH="100%" >

  forward    /           .
-  forward    .isp-b.net  host-b:8118

  forward    /           .
-  forward    .isp-a.net  host-a:8118
squid locally, then chain as +> locally, then chaining as browser -> squid -> privoxysquid.conf.

You could just as well decide to only forward requests for Windows executables through - a virus-scanning parent proxy, say, on You could just as well decide to only forward requests you suspect + of leading to Windows executables through a virus-scanning parent proxy, + say, on antivir.example.com, port 8010:

Privoxy will disconnect from and hide the +> will disconnect from and hide the command console.

6.1. Controlling Privoxy with Your Web Browser

    Privoxy Menu

Privoxy with one click from your browser.

Note that several of the features described above are disabled by default + in Privoxy 3.0.7 beta and later. + Check the + configuration file to learn why + and in which cases it's safe to enable them again.

12.1. License

9.1. Filter File Tutorial


$Id: user-manual.sgml,v 2.39 2007/11/05 02:34:49 hal9 Exp $

$Id: user-manual.sgml,v 2.41 2007/11/11 16:32:11 hal9 Exp $

.

Privoxy is a +> Privoxy is a non-caching web proxy - with advanced filtering capabilities for protecting - privacy, modifying web page data, managing + with advanced filtering capabilities for enhancing privacy, + modifying web page data, managing HTTP cookies, controlling access, and removing ads, banners, pop-ups and other obnoxious - Internet junk. Privoxy has a very flexible configuration and can be + Internet junk. Privoxy has a flexible configuration and can be customized to suit individual needs and tastes. Privoxy has application for both stand-alone systems and multi-user networks.

2.1.4. Solaris, NetBSD, HP-UXSolaris
2.1.5.
6.1. Controlling Privoxy with Your Web Browser
8.1. Finding the Right Mix
8.2. How to Edit
8.4.1. The Domain Pattern
8.4.2. The Path Pattern
8.5.39. Summary
8.7.1. default.action
8.7.2. user.action
9.1. Filter File Tutorial
12.1. License
14.2. Privoxy's Internal Pages
Privoxy in.

Version 3.0.4 introduced full Version 3.0.5 beta introduced full Windows service @@ -306,7 +306,7 @@ CLASS="SECT3" CLASS="SECT3" >2.1.4. Solaris, NetBSD, HP-UX2.1.4. Solaris

Create a new directory, File Release Page, but if you're interested in stable releases only you don't - gain anything by using them.

, but there's no reason to use them unless you're interested in the + beta releases which are only available there.

FTP or - any protocols besides HTTP and HTTPS (SSL)! It won't work! + any protocols besides HTTP and HTTPS (SSL) unless you intend to prevent your + browser from using these protocols.

  • A default installation should provide a reasonable starting point for most. There will undoubtedly be occasions where you will want to adjust the configuration, but that can be dealt with as the need arises. Little - to no initial configuration is required in most cases. + to no initial configuration is required in most cases, you may want + to enable the + web-based action editor though. + Be sure to read the warnings first.

    See the

  • For easy access to Privoxy's most important controls, drag the provided - Bookmarklets into your browser's - personal toolbar. -

  • Please see the section Contacting the @@ -323,7 +318,7 @@ CLASS="QUOTE" CLASS="APPLICATION" >Privoxy to perform - some task relating to WWW transactions (i.e. web browsing). We tell + some task relating to HTTP transactions (i.e. web browsing). We tell Privoxyhttp://p.p/show-status). This - is an internal page, and does not require Internet access. Select the - appropriate

    Note that as of Privoxy 3.0.7 beta the + action editor is disabled by default. Check the + enable-edit-actions + section in the configuration file to learn why and in which + cases it's safe to enable again.

    If you decided to enable the action editor, select the appropriate + "actions" file, and click @@ -680,7 +690,7 @@ CLASS="GUIBUTTON" >

    Privoxy fills at run time. You can - edit the templates with a normal text editor, should you want to customize them. - ( fills at run time. It + is possible to edit the templates with a normal text editor, should you want + to customize them. (Not recommended for the casual userNot recommended for the casual + user). Note that - just like in configuration files, lines starting with ). Should you create your own custom templates, you should use + the config setting templdir + to specify an alternate location, so your templates do not get overwritten + during upgrades. +

    Note that just like in configuration files, lines starting + with # are - ignored when the templates are filled in.

    are ignored when the templates are filled in.

    The place-holders are of the form

    • Two new actions server-header-tagger + and client-header-tagger + that can be used to apply arbitrary "tags" to + each request's headers. These "tags" can then + subsequently be used by other actions, greatly increasing + Privoxy's flexibity and selectivity. See tag patterns for more on tags. + +

    • Header filtering can be done with dedicated header filters now. As a result the actions Privoxy 3.0.5 to apply the content filters to the headers as, well have been removed again. + See the new actions server-header-filter + and client-header-filter. +

    • There are four new options for the main config file: +

      • allow-cgi-request-crunching + which allows requests for Privoxy's internal CGI pages to be + blocked, redirected or (un)trusted like ordinary requests. +

      • split-large-forms + that will work around a browser bug that caused IE6 and IE7 to + ignore the Submit button on the Privoxy's edit-actions-for-url CGI + page. +

      • accept-intercepted-requests + which will combine Privoxy with any packet filter to create an intercepting + proxy for HTTP/1.1 requests (and for HTTP/1.0 requests with Host + header set) so that explicitly setting the browser's proxy settings + is not necessary. +

      • templdir + to designate an alternate location for Privoxy's own CGI templates + to make sure any locally customized templates aren't overwritten + during upgrades. +

    • A new command line option --pre-chroot-nslookup hostname to + intialize the resolver library before chroot'ing. On some systems this + reduces the number of files that must be copied into the chroot tree. + (Patch provided by Stephen Gildea) +

    • The forward-override action + allows changing of the forwarding settings based on client headers like the + User-Agent, or the request origin. +

    • The redirect action can now use regular + expression substitutions against the original URL. +

    • zlib support is now available as a compile + time option for compressed documents. +

    • Improve various filters, and add new ones. +

    • Include support for RFC 3253 so that Subversion works + with Privoxy. +

    • Logging can be turned on or off. +

    • A number of improvements to Privoxy's internal CGI pages, including the + use of favicons for error and control pages. +

    • Many bugfixes, memory leaks addressed, code improvements, and logging + improvments.

  • The "filter-client-headers" and + "filter-server-headers" actions that were introduced with + Privoxy 3.0.5 to apply the content filters to + the headers as, well have been removed and replaced with new actions. + See the What's New section above. +