Recommit to include Gerry.
[privoxy.git] / doc / webserver / user-manual / index.html
index d60408c..80b286a 100644 (file)
@@ -1,17 +1,19 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
 <HTML
 ><HEAD
 ><TITLE
->Privoxy 3.0.4 User Manual</TITLE
+>Privoxy 3.0.8 User Manual</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
-"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="NEXT"
 TITLE="Introduction"
 HREF="introduction.html"><LINK
 REL="STYLESHEET"
 TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
 ><BODY
 CLASS="ARTICLE"
 BGCOLOR="#EEEEEE"
@@ -27,15 +29,15 @@ CLASS="TITLEPAGE"
 CLASS="TITLE"
 ><A
 NAME="AEN2"
-></A
->Privoxy 3.0.4 User Manual</H1
+>Privoxy 3.0.8 User Manual</A
+></H1
 ><P
 CLASS="PUBDATE"
 > <SUB
 > <A
 HREF="copyright.html"
 >Copyright</A
-> © 2001 - 2004 by 
+> © 2001 - 2007 by 
  <A
 HREF="http://www.privoxy.org/"
 TARGET="_top"
@@ -45,59 +47,50 @@ TARGET="_top"
 ><BR></P
 ><P
 CLASS="PUBDATE"
->$Id: user-manual.sgml,v 2.14 2006/08/29 10:59:36 hal9 Exp $<BR></P
+>$Id: user-manual.sgml,v 2.53 2008/01/19 15:03:05 hal9 Exp $<BR></P
 ><DIV
 ><DIV
 CLASS="ABSTRACT"
+><P
+></P
 ><A
 NAME="AEN9"
 ></A
 ><P
-></P
-><P
 >  The <I
 CLASS="CITETITLE"
->User Manual</I
+>Privoxy User Manual</I
 > gives users information on how to
   install, configure and use <A
 HREF="http://www.privoxy.org/"
 TARGET="_top"
-><SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-></A
+>Privoxy</A
 >.
  </P
 ><P
-> <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> is a web proxy with advanced filtering
- capabilities for protecting privacy, modifying web page content, managing
- cookies, controlling access, and removing ads, banners, pop-ups and other
- obnoxious Internet junk. <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> has a very
- flexible configuration and can be customized to suit individual needs and
- tastes. <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> has application for both
- stand-alone systems and multi-user networks.</P
+> Privoxy is a non-caching
+ <A
+HREF="http://en.wikipedia.org/wiki/Proxy_server"
+TARGET="_top"
+>web proxy</A
+>
+ with advanced filtering capabilities for enhancing privacy,
+ modifying web page data, managing HTTP
+ <A
+HREF="http://en.wikipedia.org/wiki/Browser_cookie"
+TARGET="_top"
+>cookies</A
+>, 
+ controlling access, and removing ads, banners, pop-ups and other obnoxious
+ 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.</P
 ><P
-> <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> is based on <SPAN
-CLASS="APPLICATION"
->Internet
- Junkbuster</SPAN
-> (tm).</P
+> Privoxy is based on Internet Junkbuster (tm).</P
 ><P
 >  You can find the latest version of the <I
 CLASS="CITETITLE"
->User Manual</I
+>Privoxy User Manual</I
 > at  <A
 HREF="http://www.privoxy.org/user-manual/"
 TARGET="_top"
@@ -152,12 +145,12 @@ HREF="installation.html#INSTALLATION-PACKAGES"
 ><DT
 >2.1.1. <A
 HREF="installation.html#INSTALLATION-PACK-RPM"
->Red Hat, SuSE and Conectiva RPMs</A
+>Red Hat and Fedora RPMs</A
 ></DT
 ><DT
 >2.1.2. <A
 HREF="installation.html#INSTALLATION-DEB"
->Debian</A
+>Debian and Ubuntu</A
 ></DT
 ><DT
 >2.1.3. <A
@@ -167,7 +160,7 @@ HREF="installation.html#INSTALLATION-PACK-WIN"
 ><DT
 >2.1.4. <A
 HREF="installation.html#INSTALLATION-PACK-BINTGZ"
->Solaris, NetBSD, FreeBSD, HP-UX</A
+>Solaris</A
 ></DT
 ><DT
 >2.1.5. <A
@@ -186,6 +179,11 @@ HREF="installation.html#INSTALLATION-AMIGA"
 ></DT
 ><DT
 >2.1.8. <A
+HREF="installation.html#INSTALLATION-TBZ"
+>FreeBSD</A
+></DT
+><DT
+>2.1.9. <A
 HREF="installation.html#INSTALLATTION-GENTOO"
 >Gentoo</A
 ></DT
@@ -220,10 +218,7 @@ HREF="whatsnew.html#UPGRADERSNOTE"
 ><DT
 >4. <A
 HREF="quickstart.html"
->Quickstart to Using <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-></A
+>Quickstart to Using Privoxy</A
 ></DT
 ><DD
 ><DL
@@ -237,17 +232,14 @@ HREF="quickstart.html#QUICKSTART-AD-BLOCKING"
 ><DT
 >5. <A
 HREF="startup.html"
->Starting <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-></A
+>Starting Privoxy</A
 ></DT
 ><DD
 ><DL
 ><DT
 >5.1. <A
 HREF="startup.html#START-REDHAT"
->Red Hat and Conectiva</A
+>Red Hat and Fedora</A
 ></DT
 ><DT
 >5.2. <A
@@ -256,41 +248,36 @@ HREF="startup.html#START-DEBIAN"
 ></DT
 ><DT
 >5.3. <A
-HREF="startup.html#START-SUSE"
->SuSE</A
-></DT
-><DT
->5.4. <A
 HREF="startup.html#START-WINDOWS"
 >Windows</A
 ></DT
 ><DT
->5.5. <A
+>5.4. <A
 HREF="startup.html#START-UNICES"
 >Solaris, NetBSD, FreeBSD, HP-UX and others</A
 ></DT
 ><DT
->5.6. <A
+>5.5. <A
 HREF="startup.html#START-OS2"
 >OS/2</A
 ></DT
 ><DT
->5.7. <A
+>5.6. <A
 HREF="startup.html#START-MACOSX"
 >Mac OSX</A
 ></DT
 ><DT
->5.8. <A
+>5.7. <A
 HREF="startup.html#START-AMIGAOS"
 >AmigaOS</A
 ></DT
 ><DT
->5.9. <A
+>5.8. <A
 HREF="startup.html#START-GENTOO"
 >Gentoo</A
 ></DT
 ><DT
->5.10. <A
+>5.9. <A
 HREF="startup.html#CMDOPTIONS"
 >Command Line Options</A
 ></DT
@@ -299,20 +286,14 @@ HREF="startup.html#CMDOPTIONS"
 ><DT
 >6. <A
 HREF="configuration.html"
-><SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> Configuration</A
+>Privoxy Configuration</A
 ></DT
 ><DD
 ><DL
 ><DT
 >6.1. <A
-HREF="configuration.html#AEN725"
->Controlling <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> with Your Web Browser</A
+HREF="configuration.html#AEN820"
+>Controlling Privoxy with Your Web Browser</A
 ></DT
 ><DT
 >6.2. <A
@@ -330,74 +311,79 @@ HREF="config.html"
 ><DL
 ><DT
 >7.1. <A
-HREF="config.html#CONF-LOG-LOC"
->Configuration and Log File Locations</A
+HREF="config.html#LOCAL-SET-UP"
+>Local Set-up Documentation</A
 ></DT
 ><DD
 ><DL
 ><DT
 >7.1.1. <A
-HREF="config.html#CONFDIR"
->confdir</A
+HREF="config.html#USER-MANUAL"
+>user-manual</A
 ></DT
 ><DT
 >7.1.2. <A
-HREF="config.html#LOGDIR"
->logdir</A
+HREF="config.html#TRUST-INFO-URL"
+>trust-info-url</A
 ></DT
 ><DT
 >7.1.3. <A
-HREF="config.html#ACTIONSFILE"
->actionsfile</A
+HREF="config.html#ADMIN-ADDRESS"
+>admin-address</A
 ></DT
 ><DT
 >7.1.4. <A
-HREF="config.html#FILTERFILE"
->filterfile</A
-></DT
-><DT
->7.1.5. <A
-HREF="config.html#LOGFILE"
->logfile</A
-></DT
-><DT
->7.1.6. <A
-HREF="config.html#JARFILE"
->jarfile</A
-></DT
-><DT
->7.1.7. <A
-HREF="config.html#TRUSTFILE"
->trustfile</A
+HREF="config.html#PROXY-INFO-URL"
+>proxy-info-url</A
 ></DT
 ></DL
 ></DD
 ><DT
 >7.2. <A
-HREF="config.html#LOCAL-SET-UP"
->Local Set-up Documentation</A
+HREF="config.html#CONF-LOG-LOC"
+>Configuration and Log File Locations</A
 ></DT
 ><DD
 ><DL
 ><DT
 >7.2.1. <A
-HREF="config.html#USER-MANUAL"
->user-manual</A
+HREF="config.html#CONFDIR"
+>confdir</A
 ></DT
 ><DT
 >7.2.2. <A
-HREF="config.html#TRUST-INFO-URL"
->trust-info-url</A
+HREF="config.html#TEMPLDIR"
+>templdir</A
 ></DT
 ><DT
 >7.2.3. <A
-HREF="config.html#ADMIN-ADDRESS"
->admin-address</A
+HREF="config.html#LOGDIR"
+>logdir</A
 ></DT
 ><DT
 >7.2.4. <A
-HREF="config.html#PROXY-INFO-URL"
->proxy-info-url</A
+HREF="config.html#ACTIONSFILE"
+>actionsfile</A
+></DT
+><DT
+>7.2.5. <A
+HREF="config.html#FILTERFILE"
+>filterfile</A
+></DT
+><DT
+>7.2.6. <A
+HREF="config.html#LOGFILE"
+>logfile</A
+></DT
+><DT
+>7.2.7. <A
+HREF="config.html#JARFILE"
+>jarfile</A
+></DT
+><DT
+>7.2.8. <A
+HREF="config.html#TRUSTFILE"
+>trustfile</A
 ></DT
 ></DL
 ></DD
@@ -444,16 +430,26 @@ HREF="config.html#ENABLE-REMOTE-TOGGLE"
 ></DT
 ><DT
 >7.4.4. <A
+HREF="config.html#ENABLE-REMOTE-HTTP-TOGGLE"
+>enable-remote-http-toggle</A
+></DT
+><DT
+>7.4.5. <A
 HREF="config.html#ENABLE-EDIT-ACTIONS"
 >enable-edit-actions</A
 ></DT
 ><DT
->7.4.5. <A
+>7.4.6. <A
+HREF="config.html#ENFORCE-BLOCKS"
+>enforce-blocks</A
+></DT
+><DT
+>7.4.7. <A
 HREF="config.html#ACLS"
 >ACLs: permit-access and deny-access</A
 ></DT
 ><DT
->7.4.6. <A
+>7.4.8. <A
 HREF="config.html#BUFFER-LIMIT"
 >buffer-limit</A
 ></DT
@@ -481,6 +477,26 @@ HREF="config.html#SOCKS"
 HREF="config.html#ADVANCED-FORWARDING-EXAMPLES"
 >Advanced Forwarding Examples</A
 ></DT
+><DT
+>7.5.4. <A
+HREF="config.html#FORWARDED-CONNECT-RETRIES"
+>forwarded-connect-retries</A
+></DT
+><DT
+>7.5.5. <A
+HREF="config.html#ACCEPT-INTERCEPTED-REQUESTS"
+>accept-intercepted-requests</A
+></DT
+><DT
+>7.5.6. <A
+HREF="config.html#ALLOW-CGI-REQUEST-CRUNCHING"
+>allow-cgi-request-crunching</A
+></DT
+><DT
+>7.5.7. <A
+HREF="config.html#SPLIT-LARGE-FORMS"
+>split-large-forms</A
+></DT
 ></DL
 ></DD
 ><DT
@@ -499,18 +515,18 @@ HREF="actions-file.html"
 ><DL
 ><DT
 >8.1. <A
-HREF="actions-file.html#AEN1897"
+HREF="actions-file.html#AEN2274"
 >Finding the Right Mix</A
 ></DT
 ><DT
 >8.2. <A
-HREF="actions-file.html#AEN1904"
+HREF="actions-file.html#AEN2281"
 >How to Edit</A
 ></DT
 ><DT
 >8.3. <A
 HREF="actions-file.html#ACTIONS-APPLY"
->How Actions are Applied to URLs</A
+>How Actions are Applied to Requests</A
 ></DT
 ><DT
 >8.4. <A
@@ -521,14 +537,19 @@ HREF="actions-file.html#AF-PATTERNS"
 ><DL
 ><DT
 >8.4.1. <A
-HREF="actions-file.html#AEN1978"
+HREF="actions-file.html#AEN2372"
 >The Domain Pattern</A
 ></DT
 ><DT
 >8.4.2. <A
-HREF="actions-file.html#AEN2040"
+HREF="actions-file.html#AEN2448"
 >The Path Pattern</A
 ></DT
+><DT
+>8.4.3. <A
+HREF="actions-file.html#TAG-PATTERN"
+>The Tag Pattern</A
+></DT
 ></DL
 ></DD
 ><DT
@@ -550,121 +571,126 @@ HREF="actions-file.html#BLOCK"
 ></DT
 ><DT
 >8.5.3. <A
+HREF="actions-file.html#CLIENT-HEADER-FILTER"
+>client-header-filter</A
+></DT
+><DT
+>8.5.4. <A
+HREF="actions-file.html#CLIENT-HEADER-TAGGER"
+>client-header-tagger</A
+></DT
+><DT
+>8.5.5. <A
 HREF="actions-file.html#CONTENT-TYPE-OVERWRITE"
 >content-type-overwrite</A
 ></DT
 ><DT
->8.5.4. <A
+>8.5.6. <A
 HREF="actions-file.html#CRUNCH-CLIENT-HEADER"
 >crunch-client-header</A
 ></DT
 ><DT
->8.5.5. <A
+>8.5.7. <A
 HREF="actions-file.html#CRUNCH-IF-NONE-MATCH"
 >crunch-if-none-match</A
 ></DT
 ><DT
->8.5.6. <A
+>8.5.8. <A
 HREF="actions-file.html#CRUNCH-INCOMING-COOKIES"
 >crunch-incoming-cookies</A
 ></DT
 ><DT
->8.5.7. <A
+>8.5.9. <A
 HREF="actions-file.html#CRUNCH-SERVER-HEADER"
 >crunch-server-header</A
 ></DT
 ><DT
->8.5.8. <A
+>8.5.10. <A
 HREF="actions-file.html#CRUNCH-OUTGOING-COOKIES"
 >crunch-outgoing-cookies</A
 ></DT
 ><DT
->8.5.9. <A
+>8.5.11. <A
 HREF="actions-file.html#DEANIMATE-GIFS"
 >deanimate-gifs</A
 ></DT
 ><DT
->8.5.10. <A
+>8.5.12. <A
 HREF="actions-file.html#DOWNGRADE-HTTP-VERSION"
 >downgrade-http-version</A
 ></DT
 ><DT
->8.5.11. <A
+>8.5.13. <A
 HREF="actions-file.html#FAST-REDIRECTS"
 >fast-redirects</A
 ></DT
 ><DT
->8.5.12. <A
+>8.5.14. <A
 HREF="actions-file.html#FILTER"
 >filter</A
 ></DT
 ><DT
->8.5.13. <A
-HREF="actions-file.html#FILTER-CLIENT-HEADERS"
->filter-client-headers</A
-></DT
-><DT
->8.5.14. <A
-HREF="actions-file.html#FILTER-SERVER-HEADERS"
->filter-server-headers</A
-></DT
-><DT
 >8.5.15. <A
 HREF="actions-file.html#FORCE-TEXT-MODE"
 >force-text-mode</A
 ></DT
 ><DT
 >8.5.16. <A
+HREF="actions-file.html#FORWARD-OVERRIDE"
+>forward-override</A
+></DT
+><DT
+>8.5.17. <A
 HREF="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT"
 >handle-as-empty-document</A
 ></DT
 ><DT
->8.5.17. <A
+>8.5.18. <A
 HREF="actions-file.html#HANDLE-AS-IMAGE"
 >handle-as-image</A
 ></DT
 ><DT
->8.5.18. <A
+>8.5.19. <A
 HREF="actions-file.html#HIDE-ACCEPT-LANGUAGE"
 >hide-accept-language</A
 ></DT
 ><DT
->8.5.19. <A
+>8.5.20. <A
 HREF="actions-file.html#HIDE-CONTENT-DISPOSITION"
 >hide-content-disposition</A
 ></DT
 ><DT
->8.5.20. <A
+>8.5.21. <A
 HREF="actions-file.html#HIDE-IF-MODIFIED-SINCE"
 >hide-if-modified-since</A
 ></DT
 ><DT
->8.5.21. <A
+>8.5.22. <A
 HREF="actions-file.html#HIDE-FORWARDED-FOR-HEADERS"
 >hide-forwarded-for-headers</A
 ></DT
 ><DT
->8.5.22. <A
+>8.5.23. <A
 HREF="actions-file.html#HIDE-FROM-HEADER"
 >hide-from-header</A
 ></DT
 ><DT
->8.5.23. <A
+>8.5.24. <A
 HREF="actions-file.html#HIDE-REFERRER"
 >hide-referrer</A
 ></DT
 ><DT
->8.5.24. <A
+>8.5.25. <A
 HREF="actions-file.html#HIDE-USER-AGENT"
 >hide-user-agent</A
 ></DT
 ><DT
->8.5.25. <A
+>8.5.26. <A
 HREF="actions-file.html#INSPECT-JPEGS"
 >inspect-jpegs</A
 ></DT
 ><DT
->8.5.26. <A
+>8.5.27. <A
 HREF="actions-file.html#KILL-POPUPS"
 >kill-popups<A
 NAME="KILL-POPUP"
@@ -672,53 +698,63 @@ NAME="KILL-POPUP"
 ></A
 ></DT
 ><DT
->8.5.27. <A
+>8.5.28. <A
 HREF="actions-file.html#LIMIT-CONNECT"
 >limit-connect</A
 ></DT
 ><DT
->8.5.28. <A
+>8.5.29. <A
 HREF="actions-file.html#PREVENT-COMPRESSION"
 >prevent-compression</A
 ></DT
 ><DT
->8.5.29. <A
+>8.5.30. <A
 HREF="actions-file.html#OVERWRITE-LAST-MODIFIED"
 >overwrite-last-modified</A
 ></DT
 ><DT
->8.5.30. <A
+>8.5.31. <A
 HREF="actions-file.html#REDIRECT"
 >redirect</A
 ></DT
 ><DT
->8.5.31. <A
+>8.5.32. <A
 HREF="actions-file.html#SEND-VANILLA-WAFER"
 >send-vanilla-wafer</A
 ></DT
 ><DT
->8.5.32. <A
+>8.5.33. <A
 HREF="actions-file.html#SEND-WAFER"
 >send-wafer</A
 ></DT
 ><DT
->8.5.33. <A
+>8.5.34. <A
+HREF="actions-file.html#SERVER-HEADER-FILTER"
+>server-header-filter</A
+></DT
+><DT
+>8.5.35. <A
+HREF="actions-file.html#SERVER-HEADER-TAGGER"
+>server-header-tagger</A
+></DT
+><DT
+>8.5.36. <A
 HREF="actions-file.html#SESSION-COOKIES-ONLY"
 >session-cookies-only</A
 ></DT
 ><DT
->8.5.34. <A
+>8.5.37. <A
 HREF="actions-file.html#SET-IMAGE-BLOCKER"
 >set-image-blocker</A
 ></DT
 ><DT
->8.5.35. <A
+>8.5.38. <A
 HREF="actions-file.html#TREAT-FORBIDDEN-CONNECTS-LIKE-BLOCKS"
 >treat-forbidden-connects-like-blocks</A
 ></DT
 ><DT
->8.5.36. <A
-HREF="actions-file.html#AEN3633"
+>8.5.39. <A
+HREF="actions-file.html#AEN4260"
 >Summary</A
 ></DT
 ></DL
@@ -737,12 +773,12 @@ HREF="actions-file.html#ACT-EXAMPLES"
 ><DL
 ><DT
 >8.7.1. <A
-HREF="actions-file.html#AEN3698"
+HREF="actions-file.html#AEN4325"
 >default.action</A
 ></DT
 ><DT
 >8.7.2. <A
-HREF="actions-file.html#AEN3864"
+HREF="actions-file.html#AEN4461"
 >user.action</A
 ></DT
 ></DL
@@ -758,7 +794,7 @@ HREF="filter-file.html"
 ><DL
 ><DT
 >9.1. <A
-HREF="filter-file.html#AEN3994"
+HREF="filter-file.html#AEN4616"
 >Filter File Tutorial</A
 ></DT
 ><DT
@@ -771,7 +807,7 @@ HREF="filter-file.html#PREDEFINED-FILTERS"
 ><DT
 >10. <A
 HREF="templates.html"
->Templates</A
+>Privoxy's Template Files</A
 ></DT
 ><DT
 >11. <A
@@ -820,16 +856,13 @@ HREF="contact.html#CONTACT-OTHER"
 ><DT
 >12. <A
 HREF="copyright.html"
-><SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> Copyright, License and History</A
+>Privoxy Copyright, License and History</A
 ></DT
 ><DD
 ><DL
 ><DT
 >12.1. <A
-HREF="copyright.html#AEN4394"
+HREF="copyright.html#AEN5089"
 >License</A
 ></DT
 ><DT
@@ -863,11 +896,8 @@ HREF="appendix.html#REGEX"
 ></DT
 ><DT
 >14.2. <A
-HREF="appendix.html#AEN4640"
-><SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->'s Internal Pages</A
+HREF="appendix.html#AEN5346"
+>Privoxy's Internal Pages</A
 ></DT
 ><DD
 ><DL
@@ -886,7 +916,7 @@ HREF="appendix.html#CHAIN"
 ><DT
 >14.4. <A
 HREF="appendix.html#ACTIONSANAT"
->Anatomy of an Action</A
+>Troubleshooting: Anatomy of an Action</A
 ></DT
 ></DL
 ></DD