Rebuild for 3.0.17 stable
[privoxy.git] / doc / webserver / user-manual / appendix.html
index 8b4b698..c3f69d7 100644 (file)
@@ -1,20 +1,23 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
 <HTML
 ><HEAD
 ><TITLE
 >Appendix</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
-"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="HOME"
-TITLE="Privoxy 3.0.5 User Manual"
+TITLE="Privoxy 3.0.17 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="See Also"
 HREF="seealso.html"><LINK
 REL="STYLESHEET"
 TYPE="text/css"
-HREF="../p_doc.css">
+HREF="../p_doc.css"><META
+HTTP-EQUIV="Content-Type"
+CONTENT="text/html;
+charset=ISO-8859-1">
 <LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
 </head
 ><BODY
@@ -36,7 +39,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy 3.0.5 User Manual</TH
+>Privoxy 3.0.17 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -69,16 +72,16 @@ CLASS="SECT1"
 CLASS="SECT1"
 ><A
 NAME="APPENDIX"
-></A
->14. Appendix</H1
+>14. Appendix</A
+></H1
 ><DIV
 CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
 NAME="REGEX"
-></A
->14.1. Regular Expressions</H2
+>14.1. Regular Expressions</A
+></H2
 ><P
 > <SPAN
 CLASS="APPLICATION"
@@ -745,9 +748,9 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="AEN4920"
-></A
->14.2. Privoxy's Internal Pages</H2
+NAME="AEN5545"
+>14.2. Privoxy's Internal Pages</A
+></H2
 ><P
 > Since <SPAN
 CLASS="APPLICATION"
@@ -791,7 +794,7 @@ CLASS="APPLICATION"
    Privoxy main page: 
   </P
 ><A
-NAME="AEN4934"
+NAME="AEN5559"
 ></A
 ><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
@@ -824,7 +827,7 @@ CLASS="APPLICATION"
     editing of actions files:
   </P
 ><A
-NAME="AEN4942"
+NAME="AEN5567"
 ></A
 ><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
@@ -844,7 +847,7 @@ TARGET="_top"
     Show the source code version numbers:
   </P
 ><A
-NAME="AEN4947"
+NAME="AEN5572"
 ></A
 ><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
@@ -864,7 +867,7 @@ TARGET="_top"
    Show the browser's request headers:
   </P
 ><A
-NAME="AEN4952"
+NAME="AEN5577"
 ></A
 ><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
@@ -884,7 +887,7 @@ TARGET="_top"
    Show which actions apply to a URL and why:
   </P
 ><A
-NAME="AEN4957"
+NAME="AEN5582"
 ></A
 ><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
@@ -901,14 +904,22 @@ TARGET="_top"
 ><LI
 ><P
 >  
-   Toggle Privoxy on or off. In this case, <SPAN
+   Toggle Privoxy on or off. This feature can be turned off/on in the main 
+   <TT
+CLASS="FILENAME"
+>config</TT
+> file. When toggled <SPAN
+CLASS="QUOTE"
+>"off"</SPAN
+>, <SPAN
 CLASS="QUOTE"
 >"Privoxy"</SPAN
-> continues 
-   to run, but only as a pass-through proxy, with no actions taking place:
+>
+   continues to run, but only as a pass-through proxy, with no actions taking
+   place:
   </P
 ><A
-NAME="AEN4963"
+NAME="AEN5590"
 ></A
 ><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
@@ -925,7 +936,7 @@ TARGET="_top"
 >   Short cuts. Turn off, then on: 
   </P
 ><A
-NAME="AEN4967"
+NAME="AEN5594"
 ></A
 ><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
@@ -939,7 +950,7 @@ TARGET="_top"
    </P
 ></BLOCKQUOTE
 ><A
-NAME="AEN4970"
+NAME="AEN5597"
 ></A
 ><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
@@ -963,8 +974,8 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="BOOKMARKLETS"
-></A
->14.2.1. Bookmarklets</H3
+>14.2.1. Bookmarklets</A
+></H3
 ><P
 > Below are some <SPAN
 CLASS="QUOTE"
@@ -1010,7 +1021,7 @@ CLASS="QUOTE"
 ><LI
 ><P
 >    <A
-HREF="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=enabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"
+HREF="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&#38;set=enabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"
 TARGET="_top"
 >Privoxy - Enable</A
 >
@@ -1019,7 +1030,7 @@ TARGET="_top"
 ><LI
 ><P
 >    <A
-HREF="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=disabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"
+HREF="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&#38;set=disabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"
 TARGET="_top"
 >Privoxy - Disable</A
 >
@@ -1028,7 +1039,7 @@ TARGET="_top"
 ><LI
 ><P
 >    <A
-HREF="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=toggle','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"
+HREF="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&#38;set=toggle','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"
 TARGET="_top"
 >Privoxy - Toggle Privoxy</A
 > (Toggles between enabled and disabled)
@@ -1070,14 +1081,15 @@ CLASS="SECT2"
 CLASS="SECT2"
 ><A
 NAME="CHAIN"
-></A
->14.3. Chain of Events</H2
+>14.3. Chain of Events</A
+></H2
 ><P
-> Let's take a quick look at the basic sequence of events when a web page is 
- requested by your browser and <SPAN
+> Let's take a quick look at how some of <SPAN
 CLASS="APPLICATION"
->Privoxy</SPAN
-> is on duty:</P
+>Privoxy's</SPAN
+> 
+ core features are triggered, and the ensuing sequence of events when a web
+ page is requested by your browser:</P
 ><P
 > <P
 ></P
@@ -1127,12 +1139,22 @@ CLASS="QUOTE"
 >"+handle-as-image"</SPAN
 ></A
 > 
-   is then checked and if it does not match, an 
+   and 
+   <A
+HREF="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT"
+><SPAN
+CLASS="QUOTE"
+>"+handle-as-empty-document"</SPAN
+></A
+>
+   are then checked, and if there is no match, an 
    HTML <SPAN
 CLASS="QUOTE"
 >"BLOCKED"</SPAN
-> page is sent back. Otherwise, if it does match,
-   an image is returned. The type of image depends on the setting of <A
+> page is sent back to the browser. Otherwise, if
+   it does match, an image is returned for the former, and an empty text
+   document for the latter. The type of image would depend on the setting of
+   <A
 HREF="actions-file.html#SET-IMAGE-BLOCKER"
 ><SPAN
 CLASS="QUOTE"
@@ -1179,8 +1201,8 @@ CLASS="QUOTE"
 ></LI
 ><LI
 ><P
->   Now the web server starts sending its response back (i.e. typically a web page and related 
-   data).
+>   Now the web server starts sending its response back (i.e. typically a web
+   page).
   </P
 ></LI
 ><LI
@@ -1214,26 +1236,13 @@ CLASS="QUOTE"
 ></LI
 ><LI
 ><P
->   If the <A
-HREF="actions-file.html#KILL-POPUPS"
-><SPAN
-CLASS="QUOTE"
->"+kill-popups"</SPAN
-></A
->
-   action applies, and it is an HTML or JavaScript document, the popup-code in the
-   response is filtered on-the-fly as it is received.
-  </P
-></LI
-><LI
-><P
->   If a <A
+>   If any <A
 HREF="actions-file.html#FILTER"
 ><SPAN
 CLASS="QUOTE"
 >"+filter"</SPAN
 ></A
->
+> action
    or <A
 HREF="actions-file.html#DEANIMATE-GIFS"
 ><SPAN
@@ -1257,13 +1266,13 @@ CLASS="APPLICATION"
 > back to your browser. 
   </P
 ><P
->   If neither <A
+>   If neither <A
 HREF="actions-file.html#FILTER"
 ><SPAN
 CLASS="QUOTE"
 >"+filter"</SPAN
 ></A
->
+> action
    or <A
 HREF="actions-file.html#DEANIMATE-GIFS"
 ><SPAN
@@ -1283,13 +1292,26 @@ CLASS="APPLICATION"
 >   As the browser receives the now (possibly filtered) page content, it 
    reads and then requests any URLs that may be embedded within the page
    source, e.g. ad images, stylesheets, JavaScript, other HTML documents (e.g.
-   frames), sounds, etc. For each of these objects, the browser issues a new
-   request. And each such request is in turn processed as above. Note that a
-   complex web page may have many such embedded URLs.
+   frames), sounds, etc. For each of these objects, the browser issues a
+   separate request (this is easily viewable in <SPAN
+CLASS="APPLICATION"
+>Privoxy's</SPAN
+>
+   logs). And each such request is in turn processed just as above. Note that a
+   complex web page will have many, many such embedded URLs. If these 
+   secondary requests are to a different server, then quite possibly a very 
+   differing set of actions is triggered.
   </P
 ></LI
 ></UL
 ></P
+><P
+> NOTE: This is somewhat of a simplistic overview of what happens with each URL
+ request. For the sake of brevity and simplicity, we have focused on 
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy's</SPAN
+> core features only.</P
 ></DIV
 ><DIV
 CLASS="SECT2"
@@ -1297,8 +1319,8 @@ CLASS="SECT2"
 CLASS="SECT2"
 ><A
 NAME="ACTIONSANAT"
-></A
->14.4. Troubleshooting: Anatomy of an Action</H2
+>14.4. Troubleshooting: Anatomy of an Action</A
+></H2
 ><P
 > The way <SPAN
 CLASS="APPLICATION"
@@ -1345,7 +1367,15 @@ HREF="appendix.html#BOOKMARKLETS"
 >the Bookmarklets</A
 > section on a quick 
  and easy way to do this (be sure to flush caches afterward!). Looking at the 
- logs is a good idea too.</P
+ logs is a good idea too. (Note that both the toggle feature and logging are 
+ enabled via <TT
+CLASS="FILENAME"
+>config</TT
+> file settings, and may need to be 
+ turned <SPAN
+CLASS="QUOTE"
+>"on"</SPAN
+>.)</P
 ><P
 > Another easy troubleshooting step to try is if you have done any
  customization of your installation, revert back to the installed
@@ -1410,7 +1440,7 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
-> Matches for http://google.com:
+> Matches for http://www.google.com:
 
  In file: default.action <SPAN
 CLASS="GUIBUTTON"
@@ -1420,61 +1450,19 @@ CLASS="GUIBUTTON"
 >[ Edit ]</SPAN
 >
 
- {-add-header
- -block
- -content-type-overwrite
- -crunch-client-header
- -crunch-if-none-match
- -crunch-incoming-cookies
- -crunch-outgoing-cookies
- -crunch-server-header
+ {+change-x-forwarded-for{block}
  +deanimate-gifs {last}
- -downgrade-http-version
  +fast-redirects {check-decoded-url}
- -filter {js-events}
- -filter {content-cookies}
- -filter {all-popups}
- -filter {banners-by-link}
- -filter {tiny-textforms}
- -filter {frameset-borders}
- -filter {demoronizer}
- -filter {shockwave-flash}
- -filter {quicktime-kioskmode}
- -filter {fun}
- -filter {crude-parental}
- -filter {site-specifics}
- +filter {js-annoyances}
- +filter {html-annoyances}
  +filter {refresh-tags}
- +filter {unsolicited-popups}
  +filter {img-reorder}
  +filter {banners-by-size}
  +filter {webbugs}
  +filter {jumping-windows}
  +filter {ie-exploits}
- -filter-client-headers
- -filter-server-headers
- -force-text-mode
- -handle-as-empty-document
- -handle-as-image
- -hide-accept-language
- -hide-content-disposition
- +hide-forwarded-for-headers
  +hide-from-header {block}
- -hide-if-modified-since
  +hide-referrer {forge}
- -hide-user-agent
- -inspect-jpegs
- -kill-popups
- -limit-connect
- -overwrite-last-modified
- +prevent-compression
- -redirect
- -send-vanilla-wafer
- -send-wafer
  +session-cookies-only
  +set-image-blocker {pattern}
- -treat-forbidden-connects-like-blocks }
 /
  
  { -session-cookies-only }
@@ -1649,6 +1637,8 @@ CLASS="SCREEN"
  
  -add-header
  -block
+ +change-x-forwarded-for{block} 
+ -client-header-filter{hide-tor-exit-notation}
  -content-type-overwrite
  -crunch-client-header
  -crunch-if-none-match
@@ -1658,38 +1648,49 @@ CLASS="SCREEN"
  +deanimate-gifs {last}
  -downgrade-http-version
  -fast-redirects
- +filter {js-annoyances}
- +filter {html-annoyances}
+ -filter {js-events}
+ -filter {content-cookies}
+ -filter {all-popups}
+ -filter {banners-by-link}
+ -filter {tiny-textforms}
+ -filter {frameset-borders}
+ -filter {demoronizer}
+ -filter {shockwave-flash}
+ -filter {quicktime-kioskmode}
+ -filter {fun}
+ -filter {crude-parental}
+ -filter {site-specifics}
+ -filter {js-annoyances}
+ -filter {html-annoyances}
  +filter {refresh-tags}
+filter {unsolicited-popups}
-filter {unsolicited-popups}
  +filter {img-reorder}
  +filter {banners-by-size}
  +filter {webbugs}
  +filter {jumping-windows}
  +filter {ie-exploits}
- -filter-client-headers
- -filter-server-headers
+ -filter {google}
+ -filter {yahoo}
+ -filter {msn}
+ -filter {blogspot}
+ -filter {no-ping}
  -force-text-mode
  -handle-as-empty-document
  -handle-as-image
  -hide-accept-language
  -hide-content-disposition
- +hide-forwarded-for-headers
  +hide-from-header {block}
  -hide-if-modified-since
  +hide-referrer {forge}
  -hide-user-agent
- -inspect-jpegs
- -kill-popups
  -limit-connect
  -overwrite-last-modified
+prevent-compression
-prevent-compression
  -redirect
- -send-vanilla-wafer
- -send-wafer
+ -server-header-filter{xml-to-html}
+ -server-header-filter{html-to-xml} 
  -session-cookies-only
- +set-image-blocker {pattern}
- -treat-forbidden-connects-like-blocks </PRE
+ +set-image-blocker {pattern} </PRE
 ></TD
 ></TR
 ></TABLE
@@ -1722,13 +1723,13 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
->&#13; { +block }
+>&#13; { +block{Domains starts with "ad"} }
   ad*.
 
- { +block }
+ { +block{Domain contains "ad"} }
   .ad.
 
- { +block +handle-as-image }
+ { +block{Doubleclick banner server} +handle-as-image }
   .[a-vx-z]*.doubleclick.net</PRE
 ></TD
 ></TR
@@ -1738,11 +1739,11 @@ CLASS="SCREEN"
 > We'll just show the interesting part here - the explicit matches. It is 
  matched three different times. Two <SPAN
 CLASS="QUOTE"
->"+block"</SPAN
+>"+block{}"</SPAN
 > sections, 
  and a <SPAN
 CLASS="QUOTE"
->"+block +handle-as-image"</SPAN
+>"+block{} +handle-as-image"</SPAN
 >,
  which is the expanded form of one of our aliases that had been defined as: 
  <SPAN
@@ -1770,7 +1771,7 @@ CLASS="QUOTE"
 HREF="actions-file.html#BLOCK"
 ><SPAN
 CLASS="QUOTE"
->"+block"</SPAN
+>"+block{}"</SPAN
 ></A
 >
  <SPAN
@@ -1822,6 +1823,8 @@ CLASS="GUIBUTTON"
 
  {-add-header 
   -block
+  +change-x-forwarded-for{block} 
+  -client-header-filter{hide-tor-exit-notation}
   -content-type-overwrite
   -crunch-client-header
   -crunch-if-none-match
@@ -1830,39 +1833,51 @@ CLASS="GUIBUTTON"
   -crunch-server-header
   +deanimate-gifs 
   -downgrade-http-version 
-  +fast-redirects{check-decoded-url}
-  +filter{html-annoyances} 
-  +filter{js-annoyances} 
-  +filter{kill-popups} 
-  +filter{webbugs} 
-  +filter{nimda} 
-  +filter{banners-by-size} 
-  +filter{hal} 
-  +filter{fun} 
-  -filter-client-headers
-  -filter-server-headers
+  +fast-redirects {check-decoded-url}
+  -filter {js-events}
+  -filter {content-cookies}
+  -filter {all-popups}
+  -filter {banners-by-link}
+  -filter {tiny-textforms}
+  -filter {frameset-borders}
+  -filter {demoronizer}
+  -filter {shockwave-flash}
+  -filter {quicktime-kioskmode}
+  -filter {fun}
+  -filter {crude-parental}
+  -filter {site-specifics}
+  -filter {js-annoyances}
+  -filter {html-annoyances}
+  +filter {refresh-tags}
+  -filter {unsolicited-popups}
+  +filter {img-reorder}
+  +filter {banners-by-size}
+  +filter {webbugs}
+  +filter {jumping-windows}
+  +filter {ie-exploits}
+  -filter {google}
+  -filter {yahoo}
+  -filter {msn}
+  -filter {blogspot}
+  -filter {no-ping}
   -force-text-mode
   -handle-as-empty-document
   -handle-as-image 
   -hide-accept-language
   -hide-content-disposition  
-  +hide-forwarded-for-headers 
   +hide-from-header{block} 
   +hide-referer{forge} 
   -hide-user-agent 
-  -inspect-jpegs
-  +kill-popups 
   -overwrite-last-modified
   +prevent-compression 
   -redirect
-  -send-vanilla-wafer 
-  -send-wafer 
+  -server-header-filter{xml-to-html}
+  -server-header-filter{html-to-xml} 
   +session-cookies-only 
-  +set-image-blocker{blank} 
-  -treat-forbidden-connects-like-blocks }
+  +set-image-blocker{blank} }
    /
 
- { +block +handle-as-image }
+ { +block{Path contains "ads".} +handle-as-image }
   /ads</PRE
 ></TD
 ></TR
@@ -1942,7 +1957,7 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
->&#13; { +block +handle-as-image }
+>&#13; { +block{Path starts with "ads".} +handle-as-image }
  /ads</PRE
 ></TD
 ></TR
@@ -2037,7 +2052,7 @@ CLASS="FILENAME"
 >, for local site
  exceptions. Note that when a simple domain pattern is used by itself (without
  the subsequent path portion), all sub-pages within that domain are included 
- automatcially in the scope of the action.</P
+ automatically in the scope of the action.</P
 ><P
 > Images that are inexplicably being blocked, may well be hitting the 
 <A
@@ -2098,13 +2113,13 @@ CLASS="LITERAL"
  <SPAN
 CLASS="QUOTE"
 >".com"</SPAN
->. This will effectively match any TLD with 
+>). This will effectively match any TLD with 
  <TT
 CLASS="LITERAL"
 >google</TT
 > in it, such as <TT
 CLASS="LITERAL"
->mail.google.de</TT
+>mail.google.de.</TT
 >, 
  just as an example.</P
 ><P