rebuild docs
[privoxy.git] / doc / webserver / user-manual / index.html
index 9d77fbe..4dc8812 100644 (file)
@@ -2,7 +2,7 @@
 <HTML
 ><HEAD
 ><TITLE
->Privoxy 3.0.11 User Manual</TITLE
+>Privoxy 3.0.27 User Manual</TITLE
 ><META
 NAME="GENERATOR"
 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
@@ -32,7 +32,7 @@ CLASS="TITLEPAGE"
 CLASS="TITLE"
 ><A
 NAME="AEN2"
->Privoxy 3.0.11 User Manual</A
+>Privoxy 3.0.27 User Manual</A
 ></H1
 ><P
 CLASS="PUBDATE"
@@ -40,9 +40,9 @@ CLASS="PUBDATE"
 > <A
 HREF="copyright.html"
 >Copyright</A
-> © 2001-2009 by 
+> © 2001-2017 by
  <A
-HREF="http://www.privoxy.org/"
+HREF="https://www.privoxy.org/"
 TARGET="_top"
 >Privoxy Developers</A
 >
@@ -50,7 +50,7 @@ TARGET="_top"
 ><BR></P
 ><P
 CLASS="PUBDATE"
->$Id: user-manual.sgml,v 2.100 2009/02/19 17:14:11 fabiankeil Exp $<BR></P
+>$Id: user-manual.sgml,v 2.221 2017/05/20 09:27:54 fabiankeil Exp $<BR></P
 ><DIV
 ><DIV
 CLASS="ABSTRACT"
@@ -65,39 +65,54 @@ CLASS="CITETITLE"
 >Privoxy User Manual</I
 > gives users information on how to
   install, configure and use <A
-HREF="http://www.privoxy.org/"
+HREF="https://www.privoxy.org/"
 TARGET="_top"
 >Privoxy</A
 >.
  </P
 ><P
-> Privoxy is a non-caching
- <A
-HREF="http://en.wikipedia.org/wiki/Proxy_server"
+> Privoxy is a non-caching web proxy with advanced filtering capabilities
+ for enhancing privacy, modifying web page data and HTTP headers, controlling
+ access, and removing ads and other obnoxious Internet junk. Privoxy has a
+ flexible configuration and can be customized to suit individual needs and tastes.
+ It has application for both stand-alone systems and multi-user networks.</P
+><P
+> Privoxy is Free Software and licensed under the GNU GPLv2.</P
+><P
+> Privoxy is an associated project of Software in the Public Interest (SPI).</P
+><P
+> Helping hands and donations are welcome:
+ <P
+></P
+><UL
+><LI
+><P
+>      <A
+HREF="https://www.privoxy.org/faq/general.html#PARTICIPATE"
 TARGET="_top"
->web proxy</A
+>https://www.privoxy.org/faq/general.html#PARTICIPATE</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
+></LI
+><LI
 ><P
-> Privoxy is based on Internet Junkbuster (tm).</P
+>     <A
+HREF="https://www.privoxy.org/faq/general.html#DONATE"
+TARGET="_top"
+>https://www.privoxy.org/faq/general.html#DONATE</A
+>
+    </P
+></LI
+></UL
+></P
 ><P
 >  You can find the latest version of the <I
 CLASS="CITETITLE"
 >Privoxy User Manual</I
 > at  <A
-HREF="http://www.privoxy.org/user-manual/"
+HREF="https://www.privoxy.org/user-manual/"
 TARGET="_top"
->http://www.privoxy.org/user-manual/</A
+>https://www.privoxy.org/user-manual/</A
 >.
   Please see the <A
 HREF="contact.html"
@@ -147,48 +162,38 @@ HREF="installation.html#INSTALLATION-PACKAGES"
 ><DL
 ><DT
 >2.1.1. <A
-HREF="installation.html#INSTALLATION-PACK-RPM"
->Red Hat and Fedora RPMs</A
-></DT
-><DT
->2.1.2. <A
 HREF="installation.html#INSTALLATION-DEB"
 >Debian and Ubuntu</A
 ></DT
 ><DT
->2.1.3. <A
+>2.1.2. <A
 HREF="installation.html#INSTALLATION-PACK-WIN"
 >Windows</A
 ></DT
 ><DT
->2.1.4. <A
-HREF="installation.html#INSTALLATION-PACK-BINTGZ"
->Solaris</A
-></DT
-><DT
->2.1.5. <A
+>2.1.3. <A
 HREF="installation.html#INSTALLATION-OS2"
 >OS/2</A
 ></DT
 ><DT
->2.1.6. <A
+>2.1.4. <A
 HREF="installation.html#INSTALLATION-MAC"
 >Mac OS X</A
 ></DT
 ><DT
->2.1.7. <A
-HREF="installation.html#INSTALLATION-AMIGA"
->AmigaOS</A
+>2.1.5. <A
+HREF="installation.html#OS-X-INSTALL-FROM-PACKAGE"
+>Installation from ready-built package</A
 ></DT
 ><DT
->2.1.8. <A
-HREF="installation.html#INSTALLATION-TBZ"
->FreeBSD</A
+>2.1.6. <A
+HREF="installation.html#OS-X-INSTALL-FROM-SOURCE"
+>Installation from source</A
 ></DT
 ><DT
->2.1.9. <A
-HREF="installation.html#INSTALLATTION-GENTOO"
->Gentoo</A
+>2.1.7. <A
+HREF="installation.html#INSTALLATION-FREEBSD"
+>FreeBSD</A
 ></DT
 ></DL
 ></DD
@@ -241,13 +246,13 @@ HREF="startup.html"
 ><DL
 ><DT
 >5.1. <A
-HREF="startup.html#START-REDHAT"
->Red Hat and Fedora</A
+HREF="startup.html#START-DEBIAN"
+>Debian</A
 ></DT
 ><DT
 >5.2. <A
-HREF="startup.html#START-DEBIAN"
->Debian</A
+HREF="startup.html#START-FREEBSD"
+>FreeBSD and ElectroBSD</A
 ></DT
 ><DT
 >5.3. <A
@@ -257,7 +262,7 @@ HREF="startup.html#START-WINDOWS"
 ><DT
 >5.4. <A
 HREF="startup.html#START-UNICES"
->Solaris, NetBSD, FreeBSD, HP-UX and others</A
+>Generic instructions for Unix derivates (Solaris, NetBSD, HP-UX etc.)</A
 ></DT
 ><DT
 >5.5. <A
@@ -271,16 +276,6 @@ HREF="startup.html#START-MACOSX"
 ></DT
 ><DT
 >5.7. <A
-HREF="startup.html#START-AMIGAOS"
->AmigaOS</A
-></DT
-><DT
->5.8. <A
-HREF="startup.html#START-GENTOO"
->Gentoo</A
-></DT
-><DT
->5.9. <A
 HREF="startup.html#CMDOPTIONS"
 >Command Line Options</A
 ></DT
@@ -295,7 +290,7 @@ HREF="configuration.html"
 ><DL
 ><DT
 >6.1. <A
-HREF="configuration.html#AEN790"
+HREF="configuration.html#CONTROL-WITH-WEBBROWSER"
 >Controlling Privoxy with Your Web Browser</A
 ></DT
 ><DT
@@ -360,26 +355,31 @@ HREF="config.html#TEMPLDIR"
 ></DT
 ><DT
 >7.2.3. <A
+HREF="config.html#TEMPORARY-DIRECTORY"
+>temporary-directory</A
+></DT
+><DT
+>7.2.4. <A
 HREF="config.html#LOGDIR"
 >logdir</A
 ></DT
 ><DT
->7.2.4. <A
+>7.2.5. <A
 HREF="config.html#ACTIONSFILE"
 >actionsfile</A
 ></DT
 ><DT
->7.2.5. <A
+>7.2.6. <A
 HREF="config.html#FILTERFILE"
 >filterfile</A
 ></DT
 ><DT
->7.2.6. <A
+>7.2.7. <A
 HREF="config.html#LOGFILE"
 >logfile</A
 ></DT
 ><DT
->7.2.7. <A
+>7.2.8. <A
 HREF="config.html#TRUSTFILE"
 >trustfile</A
 ></DT
@@ -456,6 +456,16 @@ HREF="config.html#ACLS"
 HREF="config.html#BUFFER-LIMIT"
 >buffer-limit</A
 ></DT
+><DT
+>7.4.9. <A
+HREF="config.html#ENABLE-PROXY-AUTHENTICATION-FORWARDING"
+>enable-proxy-authentication-forwarding</A
+></DT
+><DT
+>7.4.10. <A
+HREF="config.html#TRUSTED-CGI-REFERER"
+>trusted-cgi-referer</A
+></DT
 ></DL
 ></DD
 ><DT
@@ -473,7 +483,7 @@ HREF="config.html#FORWARD"
 ><DT
 >7.5.2. <A
 HREF="config.html#SOCKS"
->forward-socks4, forward-socks4a and forward-socks5</A
+>forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</A
 ></DT
 ><DT
 >7.5.3. <A
@@ -485,35 +495,114 @@ HREF="config.html#ADVANCED-FORWARDING-EXAMPLES"
 HREF="config.html#FORWARDED-CONNECT-RETRIES"
 >forwarded-connect-retries</A
 ></DT
+></DL
+></DD
+><DT
+>7.6. <A
+HREF="config.html#MISC"
+>Miscellaneous</A
+></DT
+><DD
+><DL
 ><DT
->7.5.5. <A
+>7.6.1. <A
 HREF="config.html#ACCEPT-INTERCEPTED-REQUESTS"
 >accept-intercepted-requests</A
 ></DT
 ><DT
->7.5.6. <A
+>7.6.2. <A
 HREF="config.html#ALLOW-CGI-REQUEST-CRUNCHING"
 >allow-cgi-request-crunching</A
 ></DT
 ><DT
->7.5.7. <A
+>7.6.3. <A
 HREF="config.html#SPLIT-LARGE-FORMS"
 >split-large-forms</A
 ></DT
 ><DT
->7.5.8. <A
+>7.6.4. <A
 HREF="config.html#KEEP-ALIVE-TIMEOUT"
 >keep-alive-timeout</A
 ></DT
 ><DT
->7.5.9. <A
+>7.6.5. <A
+HREF="config.html#TOLERATE-PIPELINING"
+>tolerate-pipelining</A
+></DT
+><DT
+>7.6.6. <A
+HREF="config.html#DEFAULT-SERVER-TIMEOUT"
+>default-server-timeout</A
+></DT
+><DT
+>7.6.7. <A
+HREF="config.html#CONNECTION-SHARING"
+>connection-sharing</A
+></DT
+><DT
+>7.6.8. <A
 HREF="config.html#SOCKET-TIMEOUT"
 >socket-timeout</A
 ></DT
+><DT
+>7.6.9. <A
+HREF="config.html#MAX-CLIENT-CONNECTIONS"
+>max-client-connections</A
+></DT
+><DT
+>7.6.10. <A
+HREF="config.html#LISTEN-BACKLOG"
+>listen-backlog</A
+></DT
+><DT
+>7.6.11. <A
+HREF="config.html#ENABLE-ACCEPT-FILTER"
+>enable-accept-filter</A
+></DT
+><DT
+>7.6.12. <A
+HREF="config.html#HANDLE-AS-EMPTY-DOC-RETURNS-OK"
+>handle-as-empty-doc-returns-ok</A
+></DT
+><DT
+>7.6.13. <A
+HREF="config.html#ENABLE-COMPRESSION"
+>enable-compression</A
+></DT
+><DT
+>7.6.14. <A
+HREF="config.html#COMPRESSION-LEVEL"
+>compression-level</A
+></DT
+><DT
+>7.6.15. <A
+HREF="config.html#CLIENT-HEADER-ORDER"
+>client-header-order</A
+></DT
+><DT
+>7.6.16. <A
+HREF="config.html#CLIENT-SPECIFIC-TAG"
+>client-specific-tag</A
+></DT
+><DT
+>7.6.17. <A
+HREF="config.html#CLIENT-TAG-LIFETIME"
+>client-tag-lifetime</A
+></DT
+><DT
+>7.6.18. <A
+HREF="config.html#TRUST-X-FORWARDED-FOR"
+>trust-x-forwarded-for</A
+></DT
+><DT
+>7.6.19. <A
+HREF="config.html#RECEIVE-BUFFER-SIZE"
+>receive-buffer-size</A
+></DT
 ></DL
 ></DD
 ><DT
->7.6. <A
+>7.7. <A
 HREF="config.html#WINDOWS-GUI"
 >Windows GUI Options</A
 ></DT
@@ -528,12 +617,12 @@ HREF="actions-file.html"
 ><DL
 ><DT
 >8.1. <A
-HREF="actions-file.html#AEN2302"
+HREF="actions-file.html#RIGHT-MIX"
 >Finding the Right Mix</A
 ></DT
 ><DT
 >8.2. <A
-HREF="actions-file.html#AEN2309"
+HREF="actions-file.html#HOW-TO-EDIT"
 >How to Edit</A
 ></DT
 ><DT
@@ -550,18 +639,28 @@ HREF="actions-file.html#AF-PATTERNS"
 ><DL
 ><DT
 >8.4.1. <A
-HREF="actions-file.html#AEN2400"
->The Domain Pattern</A
+HREF="actions-file.html#HOST-PATTERN"
+>The Host Pattern</A
 ></DT
 ><DT
 >8.4.2. <A
-HREF="actions-file.html#AEN2476"
+HREF="actions-file.html#PATH-PATTERN"
 >The Path Pattern</A
 ></DT
 ><DT
 >8.4.3. <A
 HREF="actions-file.html#TAG-PATTERN"
->The Tag Pattern</A
+>The Request Tag Pattern</A
+></DT
+><DT
+>8.4.4. <A
+HREF="actions-file.html#NEGATIVE-TAG-PATTERNS"
+>The Negative Request Tag Patterns</A
+></DT
+><DT
+>8.4.5. <A
+HREF="actions-file.html#CLIENT-TAG-PATTERN"
+>The Client Tag Pattern</A
 ></DT
 ></DL
 ></DD
@@ -639,107 +738,117 @@ HREF="actions-file.html#DOWNGRADE-HTTP-VERSION"
 ></DT
 ><DT
 >8.5.14. <A
+HREF="actions-file.html#EXTERNAL-FILTER"
+>external-filter</A
+></DT
+><DT
+>8.5.15. <A
 HREF="actions-file.html#FAST-REDIRECTS"
 >fast-redirects</A
 ></DT
 ><DT
->8.5.15. <A
+>8.5.16. <A
 HREF="actions-file.html#FILTER"
 >filter</A
 ></DT
 ><DT
->8.5.16. <A
+>8.5.17. <A
 HREF="actions-file.html#FORCE-TEXT-MODE"
 >force-text-mode</A
 ></DT
 ><DT
->8.5.17. <A
+>8.5.18. <A
 HREF="actions-file.html#FORWARD-OVERRIDE"
 >forward-override</A
 ></DT
 ><DT
->8.5.18. <A
+>8.5.19. <A
 HREF="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT"
 >handle-as-empty-document</A
 ></DT
 ><DT
->8.5.19. <A
+>8.5.20. <A
 HREF="actions-file.html#HANDLE-AS-IMAGE"
 >handle-as-image</A
 ></DT
 ><DT
->8.5.20. <A
+>8.5.21. <A
 HREF="actions-file.html#HIDE-ACCEPT-LANGUAGE"
 >hide-accept-language</A
 ></DT
 ><DT
->8.5.21. <A
+>8.5.22. <A
 HREF="actions-file.html#HIDE-CONTENT-DISPOSITION"
 >hide-content-disposition</A
 ></DT
 ><DT
->8.5.22. <A
+>8.5.23. <A
 HREF="actions-file.html#HIDE-IF-MODIFIED-SINCE"
 >hide-if-modified-since</A
 ></DT
 ><DT
->8.5.23. <A
+>8.5.24. <A
 HREF="actions-file.html#HIDE-FROM-HEADER"
 >hide-from-header</A
 ></DT
 ><DT
->8.5.24. <A
+>8.5.25. <A
 HREF="actions-file.html#HIDE-REFERRER"
 >hide-referrer</A
 ></DT
 ><DT
->8.5.25. <A
+>8.5.26. <A
 HREF="actions-file.html#HIDE-USER-AGENT"
 >hide-user-agent</A
 ></DT
 ><DT
->8.5.26. <A
+>8.5.27. <A
 HREF="actions-file.html#LIMIT-CONNECT"
 >limit-connect</A
 ></DT
 ><DT
->8.5.27. <A
+>8.5.28. <A
+HREF="actions-file.html#LIMIT-COOKIE-LIFETIME"
+>limit-cookie-lifetime</A
+></DT
+><DT
+>8.5.29. <A
 HREF="actions-file.html#PREVENT-COMPRESSION"
 >prevent-compression</A
 ></DT
 ><DT
->8.5.28. <A
+>8.5.30. <A
 HREF="actions-file.html#OVERWRITE-LAST-MODIFIED"
 >overwrite-last-modified</A
 ></DT
 ><DT
->8.5.29. <A
+>8.5.31. <A
 HREF="actions-file.html#REDIRECT"
 >redirect</A
 ></DT
 ><DT
->8.5.30. <A
+>8.5.32. <A
 HREF="actions-file.html#SERVER-HEADER-FILTER"
 >server-header-filter</A
 ></DT
 ><DT
->8.5.31. <A
+>8.5.33. <A
 HREF="actions-file.html#SERVER-HEADER-TAGGER"
 >server-header-tagger</A
 ></DT
 ><DT
->8.5.32. <A
+>8.5.34. <A
 HREF="actions-file.html#SESSION-COOKIES-ONLY"
 >session-cookies-only</A
 ></DT
 ><DT
->8.5.33. <A
+>8.5.35. <A
 HREF="actions-file.html#SET-IMAGE-BLOCKER"
 >set-image-blocker</A
 ></DT
 ><DT
->8.5.34. <A
-HREF="actions-file.html#AEN4107"
+>8.5.36. <A
+HREF="actions-file.html#SUMMARY"
 >Summary</A
 ></DT
 ></DL
@@ -758,17 +867,17 @@ HREF="actions-file.html#ACT-EXAMPLES"
 ><DL
 ><DT
 >8.7.1. <A
-HREF="actions-file.html#AEN4171"
+HREF="actions-file.html#MATCH-ALL"
 >match-all.action</A
 ></DT
 ><DT
 >8.7.2. <A
-HREF="actions-file.html#AEN4193"
+HREF="actions-file.html#DEFAULT-ACTION"
 >default.action</A
 ></DT
 ><DT
 >8.7.3. <A
-HREF="actions-file.html#AEN4306"
+HREF="actions-file.html#USER-ACTION"
 >user.action</A
 ></DT
 ></DL
@@ -784,7 +893,7 @@ HREF="filter-file.html"
 ><DL
 ><DT
 >9.1. <A
-HREF="filter-file.html#AEN4461"
+HREF="filter-file.html#FILTER-FILE-TUT"
 >Filter File Tutorial</A
 ></DT
 ><DT
@@ -792,6 +901,11 @@ HREF="filter-file.html#AEN4461"
 HREF="filter-file.html#PREDEFINED-FILTERS"
 >The Pre-defined Filters</A
 ></DT
+><DT
+>9.3. <A
+HREF="filter-file.html#EXTERNAL-FILTER-SYNTAX"
+>External filter syntax</A
+></DT
 ></DL
 ></DD
 ><DT
@@ -809,37 +923,47 @@ Requests</A
 ><DL
 ><DT
 >11.1. <A
+HREF="contact.html#SUFFICIENT-INFORMATION"
+>Please provide sufficient information</A
+></DT
+><DT
+>11.2. <A
 HREF="contact.html#CONTACT-SUPPORT"
 >Get Support</A
 ></DT
 ><DT
->11.2. <A
+>11.3. <A
 HREF="contact.html#REPORTING"
 >Reporting Problems</A
 ></DT
 ><DD
 ><DL
 ><DT
->11.2.1. <A
+>11.3.1. <A
 HREF="contact.html#CONTACT-ADS"
 >Reporting Ads or Other Configuration Problems</A
 ></DT
 ><DT
->11.2.2. <A
+>11.3.2. <A
 HREF="contact.html#CONTACT-BUGS"
 >Reporting Bugs</A
 ></DT
 ></DL
 ></DD
 ><DT
->11.3. <A
-HREF="contact.html#CONTACT-FEATURE"
->Request New Features</A
+>11.4. <A
+HREF="contact.html#SECURITY-CONTACT"
+>Reporting security problems</A
 ></DT
 ><DT
->11.4. <A
-HREF="contact.html#CONTACT-OTHER"
->Other</A
+>11.5. <A
+HREF="contact.html#MAILING-LISTS"
+>Mailing Lists</A
+></DT
+><DT
+>11.6. <A
+HREF="contact.html#SF-TRACKERS"
+>SourceForge support trackers</A
 ></DT
 ></DL
 ></DD
@@ -852,7 +976,7 @@ HREF="copyright.html"
 ><DL
 ><DT
 >12.1. <A
-HREF="copyright.html#AEN4935"
+HREF="copyright.html#LICENSE"
 >License</A
 ></DT
 ><DT
@@ -886,18 +1010,9 @@ HREF="appendix.html#REGEX"
 ></DT
 ><DT
 >14.2. <A
-HREF="appendix.html#AEN5189"
+HREF="appendix.html#INTERNAL-PAGES"
 >Privoxy's Internal Pages</A
 ></DT
-><DD
-><DL
-><DT
->14.2.1. <A
-HREF="appendix.html#BOOKMARKLETS"
->Bookmarklets</A
-></DT
-></DL
-></DD
 ><DT
 >14.3. <A
 HREF="appendix.html#CHAIN"