Various changes:
[privoxy.git] / doc / webserver / user-manual / appendix.html
index 4a9c95b..b02a254 100644 (file)
@@ -7,14 +7,16 @@ NAME="GENERATOR"
 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
 "><LINK
 REL="HOME"
-TITLE="Privoxy 3.1.1 User Manual"
+TITLE="Privoxy 3.0.4 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="See Also"
 HREF="seealso.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="SECT1"
 BGCOLOR="#EEEEEE"
@@ -34,7 +36,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy 3.1.1 User Manual</TH
+>Privoxy 3.0.4 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -66,13 +68,17 @@ CLASS="SECT1"
 ><H1
 CLASS="SECT1"
 ><A
-NAME="APPENDIX">14. Appendix</H1
+NAME="APPENDIX"
+></A
+>14. Appendix</H1
 ><DIV
 CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="REGEX">14.1. Regular Expressions</H2
+NAME="REGEX"
+></A
+>14.1. Regular Expressions</H2
 ><P
 > <SPAN
 CLASS="APPLICATION"
@@ -94,10 +100,9 @@ HREF="http://www.pcre.org/"
 TARGET="_top"
 >PCRE</A
 > and
- <A
-HREF="http://www.oesterhelt.org/pcrs/"
-TARGET="_top"
->PCRS</A
+ <SPAN
+CLASS="APPLICATION"
+>PCRS</SPAN
 > libraries.</P
 ><P
 > If you are reading this, you probably don't understand what <SPAN
@@ -321,7 +326,7 @@ BORDER="0"
 CLASS="emphasis"
 ><I
 CLASS="EMPHASIS"
->[]</I
+>[ ]</I
 ></SPAN
 > - Characters enclosed in brackets will be matched if
   any of the enclosed characters are encountered. For instance, <SPAN
@@ -355,7 +360,7 @@ BORDER="0"
 CLASS="emphasis"
 ><I
 CLASS="EMPHASIS"
->()</I
+>( )</I
 ></SPAN
 > - parentheses are used to group a sub-expression,
   or multiple sub-expressions.
@@ -475,7 +480,7 @@ CLASS="QUOTE"
 > in the path
  somewhere.</P
 ><P
-> A now something a little more complex:</P
+> And now something a little more complex:</P
 ><P
 > <SPAN
 CLASS="emphasis"
@@ -614,7 +619,7 @@ CLASS="LITERAL"
  another path statement with forward slashes. Anything in the square brackets 
  <SPAN
 CLASS="QUOTE"
->"[]"</SPAN
+>"[ ]"</SPAN
 > can be matched. This is using <SPAN
 CLASS="QUOTE"
 >"0-9"</SPAN
@@ -723,9 +728,9 @@ CLASS="APPLICATION"
 ><P
 > More reading on Perl Compatible Regular expressions: 
  <A
-HREF="http://www.perldoc.com/perl5.6/pod/perlre.html"
+HREF="http://perldoc.perl.org/perlre.html"
 TARGET="_top"
->http://www.perldoc.com/perl5.6/pod/perlre.html</A
+>http://perldoc.perl.org/perlre.html</A
 ></P
 ><P
 > For information on regular expression based substitutions and their applications
@@ -740,7 +745,9 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="AEN3474">14.2. <SPAN
+NAME="AEN4783"
+></A
+>14.2. <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
 >'s Internal Pages</H2
@@ -787,7 +794,9 @@ CLASS="APPLICATION"
    Privoxy main page: 
   </P
 ><A
-NAME="AEN3489"><BLOCKQUOTE
+NAME="AEN4798"
+></A
+><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
 ><P
 > 
@@ -818,7 +827,9 @@ CLASS="APPLICATION"
     editing of actions files:
   </P
 ><A
-NAME="AEN3497"><BLOCKQUOTE
+NAME="AEN4806"
+></A
+><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
 ><P
 > 
@@ -836,7 +847,9 @@ TARGET="_top"
     Show the source code version numbers:
   </P
 ><A
-NAME="AEN3502"><BLOCKQUOTE
+NAME="AEN4811"
+></A
+><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
 ><P
 > 
@@ -854,7 +867,9 @@ TARGET="_top"
    Show the browser's request headers:
   </P
 ><A
-NAME="AEN3507"><BLOCKQUOTE
+NAME="AEN4816"
+></A
+><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
 ><P
 > 
@@ -872,7 +887,9 @@ TARGET="_top"
    Show which actions apply to a URL and why:
   </P
 ><A
-NAME="AEN3512"><BLOCKQUOTE
+NAME="AEN4821"
+></A
+><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
 ><P
 > 
@@ -894,7 +911,9 @@ CLASS="QUOTE"
    to run, but only as a pass-through proxy, with no actions taking place:
   </P
 ><A
-NAME="AEN3518"><BLOCKQUOTE
+NAME="AEN4827"
+></A
+><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
 ><P
 > 
@@ -909,7 +928,9 @@ TARGET="_top"
 >   Short cuts. Turn off, then on: 
   </P
 ><A
-NAME="AEN3522"><BLOCKQUOTE
+NAME="AEN4831"
+></A
+><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
 ><P
 > 
@@ -921,7 +942,9 @@ TARGET="_top"
    </P
 ></BLOCKQUOTE
 ><A
-NAME="AEN3525"><BLOCKQUOTE
+NAME="AEN4834"
+></A
+><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
 ><P
 > 
@@ -942,7 +965,9 @@ CLASS="SECT3"
 ><H3
 CLASS="SECT3"
 ><A
-NAME="BOOKMARKLETS">14.2.1. Bookmarklets</H3
+NAME="BOOKMARKLETS"
+></A
+>14.2.1. Bookmarklets</H3
 ><P
 > Below are some <SPAN
 CLASS="QUOTE"
@@ -1024,15 +1049,6 @@ TARGET="_top"
 ><LI
 ><P
 >    <A
-HREF="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(window.open('http://www.privoxy.org/actions/index.php?url='+escape(location.href),'Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"
-TARGET="_top"
->Privoxy - Submit Actions File Feedback</A
->
-   </P
-></LI
-><LI
-><P
->    <A
 HREF="javascript:void(window.open('http://config.privoxy.org/show-url-info?url='+escape(location.href),'Why').focus());"
 TARGET="_top"
 >Privoxy - Why?</A
@@ -1056,7 +1072,9 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="CHAIN">14.3. Chain of Events</H2
+NAME="CHAIN"
+></A
+>14.3. Chain of Events</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
@@ -1084,7 +1102,11 @@ CLASS="APPLICATION"
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > traps any request for its own internal CGI 
-   pages (e.g http://p.p/) and sends the CGI page back to the browser.
+   pages (e.g <A
+HREF="http://p.p/"
+TARGET="_top"
+>http://p.p/</A
+>) and sends the CGI page back to the browser.
   </P
 ></LI
 ><LI
@@ -1227,13 +1249,10 @@ CLASS="QUOTE"
    <TT
 CLASS="FILENAME"
 >default.filter</TT
->) are processed against the buffered
-   content. Filters are applied in the order they are specified in the
-   <TT
-CLASS="FILENAME"
->default.filter</TT
-> file. Animated GIFs, if present, are
-   reduced to either the first or last frame, depending on the action
+> and any other filter files) are
+   processed against the buffered content. Filters are applied in the order
+   they are specified in one of the filter files. Animated GIFs, if present,
+   are reduced to either the first or last frame, depending on the action
    setting.The entire page, which is now filtered, is then sent by
    <SPAN
 CLASS="APPLICATION"
@@ -1264,7 +1283,7 @@ CLASS="APPLICATION"
 ></LI
 ><LI
 ><P
->   As the browser receives the now (probably filtered) page content, it 
+>   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
@@ -1280,7 +1299,9 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="ACTIONSANAT">14.4. Anatomy of an Action</H2
+NAME="ACTIONSANAT"
+></A
+>14.4. Anatomy of an Action</H2
 ><P
 > The way <SPAN
 CLASS="APPLICATION"
@@ -1357,10 +1378,7 @@ CLASS="QUOTE"
 >"+filter"</SPAN
 ></A
 > action) from
- the <TT
-CLASS="FILENAME"
->default.filter</TT
-> file since this is handled very
+ one of the filter files since this is handled very
  differently and not so easy to trap! It also will not tell you about any other
  URLs that may be embedded within the URL you are testing. For instance, images
  such as ads are expressed as URLs within the raw page source of HTML pages. So
@@ -1378,7 +1396,8 @@ HREF="http://google.com"
 TARGET="_top"
 >google.com</A
 >, 
- and look at it one section at a time:</P
+ and look at it one section at a time in a sample configuration (your real 
+ configuration may vary):</P
 ><P
 > <TABLE
 BORDER="0"
@@ -1398,38 +1417,63 @@ CLASS="GUIBUTTON"
 >[ Edit ]</SPAN
 >
 
-{-add-header 
- -block 
- -crunch-outgoing-cookies 
- -crunch-incoming-cookies 
- +deanimate-gifs{last} 
- -downgrade-http-version 
- +fast-redirects 
- -filter{popups} 
- -filter{fun} 
- -filter{shockwave-flash} 
- -filter{crude-parental} 
- +filter{html-annoyances} 
- +filter{js-annoyances} 
- +filter{content-cookies} 
- +filter{webbugs} 
- +filter{refresh-tags} 
- +filter{nimda} 
- +filter{banners-by-size} 
- +hide-forwarded-for-headers 
- +hide-from-header{block} 
- +hide-referer{forge} 
- -hide-user-agent 
- -handle-as-image 
- -kill-popups 
- -limit-connect 
- +prevent-compression 
- -send-vanilla-wafer 
- -send-wafer 
- +session-cookies-only 
- +set-image-blocker{pattern} }
+ {-add-header
+ -block
+ -content-type-overwrite
+ -crunch-client-header
+ -crunch-if-none-match
+ -crunch-incoming-cookies
+ -crunch-outgoing-cookies
+ -crunch-server-header
+ +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 }
  .google.com
 
@@ -1449,7 +1493,7 @@ CLASS="GUIBUTTON"
 ></TABLE
 ></P
 ><P
-> This tells us how we have defined our 
+> This is telling us how we have defined our 
  <A
 HREF="actions-file.html#ACTIONS"
 ><SPAN
@@ -1457,10 +1501,35 @@ CLASS="QUOTE"
 >"actions"</SPAN
 ></A
 >, and
- which ones match for our example, <SPAN
+ which ones match for our test case, <SPAN
 CLASS="QUOTE"
 >"google.com"</SPAN
->. The first listing
+>. 
+ Displayed is all the actions that are available to us. Remember,
+ the <TT
+CLASS="LITERAL"
+>+</TT
+> sign denotes <SPAN
+CLASS="QUOTE"
+>"on"</SPAN
+>. <TT
+CLASS="LITERAL"
+>-</TT
+>
+ denotes <SPAN
+CLASS="QUOTE"
+>"off"</SPAN
+>. So some are <SPAN
+CLASS="QUOTE"
+>"on"</SPAN
+> here, but many 
+ are <SPAN
+CLASS="QUOTE"
+>"off"</SPAN
+>. Each example we try may provide a slightly different
+ end result, depending on our configuration directives.</P
+><P
+> The first listing
  is any matches for the <TT
 CLASS="FILENAME"
 >standard.action</TT
@@ -1505,8 +1574,9 @@ CLASS="QUOTE"
 >"+session-cookies-only"</SPAN
 ></A
 >
- (i.e. not persistent). So we will allow persistent cookies for google. The
- second turns <SPAN
+ (i.e. not persistent). So we will allow persistent cookies for google, at
+ least that is how it is in this example. The second turns
+ <SPAN
 CLASS="emphasis"
 ><I
 CLASS="EMPHASIS"
@@ -1543,7 +1613,9 @@ CLASS="QUOTE"
 > Then, for our <TT
 CLASS="FILENAME"
 >user.action</TT
-> file, we again have no hits.</P
+> file, we again have no hits.
+ So there is nothing google-specific that we might have added to our own, local
+ configuration.</P
 ><P
 > And finally we pull it all together in the bottom section and summarize how
  <SPAN
@@ -1568,36 +1640,49 @@ WIDTH="100%"
 CLASS="SCREEN"
 >&#13; Final results:
  
- -add-header 
- -block 
- -crunch-outgoing-cookies 
- -crunch-incoming-cookies 
- +deanimate-gifs{last} 
- -downgrade-http-version 
- -fast-redirects 
- -filter{popups} 
- -filter{fun} 
- -filter{shockwave-flash} 
- -filter{crude-parental} 
- +filter{html-annoyances} 
- +filter{js-annoyances} 
- +filter{content-cookies} 
- +filter{webbugs} 
- +filter{refresh-tags} 
- +filter{nimda} 
- +filter{banners-by-size} 
- +hide-forwarded-for-headers 
- +hide-from-header{block} 
- +hide-referer{forge} 
- -hide-user-agent 
- -handle-as-image 
- -kill-popups 
- -limit-connect 
- +prevent-compression 
- -send-vanilla-wafer 
+ -add-header
+ -block
+ -content-type-overwrite
+ -crunch-client-header
+ -crunch-if-none-match
+ -crunch-incoming-cookies
+ -crunch-outgoing-cookies
+ -crunch-server-header
+ +deanimate-gifs {last}
+ -downgrade-http-version
+ -fast-redirects
+ +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} </PRE
+ -session-cookies-only
+ +set-image-blocker {pattern}
+ -treat-forbidden-connects-like-blocks </PRE
 ></TD
 ></TR
 ></TABLE
@@ -1610,6 +1695,11 @@ CLASS="QUOTE"
 > and <SPAN
 CLASS="QUOTE"
 >"session-cookies-only"</SPAN
+>,
+ which are activated specifically for this site in our configuration, 
+ and thus show in the <SPAN
+CLASS="QUOTE"
+>"Final Results"</SPAN
 >.</P
 ><P
 > Now another example, <SPAN
@@ -1694,7 +1784,7 @@ CLASS="QUOTE"
 ><P
 > One last example. Let's try <SPAN
 CLASS="QUOTE"
->"http://www.rhapsodyk.net/adsl/HOWTO/"</SPAN
+>"http://www.example.net/adsl/HOWTO/"</SPAN
 >.
  This one is giving us problems. We are getting a blank page. Hmmm ...</P
 ><P
@@ -1706,7 +1796,7 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
->&#13; Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
+>&#13; Matches for http://www.example.net/adsl/HOWTO/:
 
  In file: default.action <SPAN
 CLASS="GUIBUTTON"
@@ -1717,12 +1807,16 @@ CLASS="GUIBUTTON"
 >
 
  {-add-header 
-  -block 
-  -crunch-incoming-cookies 
-  -crunch-outgoing-cookies 
+  -block
+  -content-type-overwrite
+  -crunch-client-header
+  -crunch-if-none-match
+  -crunch-incoming-cookies
+  -crunch-outgoing-cookies
+  -crunch-server-header
   +deanimate-gifs 
   -downgrade-http-version 
-  +fast-redirects 
+  +fast-redirects{check-decoded-url}
   +filter{html-annoyances} 
   +filter{js-annoyances} 
   +filter{kill-popups} 
@@ -1731,17 +1825,27 @@ CLASS="GUIBUTTON"
   +filter{banners-by-size} 
   +filter{hal} 
   +filter{fun} 
+  -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-referer{forge} 
   -hide-user-agent 
-  -handle-as-image 
+  -inspect-jpegs
   +kill-popups 
+  -overwrite-last-modified
   +prevent-compression 
+  -redirect
   -send-vanilla-wafer 
   -send-wafer 
   +session-cookies-only 
-  +set-image-blocker{blank} }
+  +set-image-blocker{blank} 
+  -treat-forbidden-connects-like-blocks }
    /
 
  { +block +handle-as-image }
@@ -1757,23 +1861,24 @@ CLASS="QUOTE"
 > is matching <SPAN
 CLASS="QUOTE"
 >"/ads"</SPAN
->! But 
- we did not want this at all! Now we see why we get the blank page. We could
- now add a new action below this that explicitly does <SPAN
+> in our 
+ configuration! But we did not want this at all! Now we see why we get the
+ blank page. We could now add a new action below this that explicitly 
+ <SPAN
 CLASS="emphasis"
 ><I
 CLASS="EMPHASIS"
->not</I
+>un</I
 ></SPAN
->
- block (<SPAN
+> blocks (<SPAN
 CLASS="QUOTE"
 >"{-block}"</SPAN
->) paths with <SPAN
+>) paths with
+ <SPAN
 CLASS="QUOTE"
 >"adsl"</SPAN
->. There are
- various ways to handle such exceptions. Example:</P
+> in them (remember, last match in the configuration wins).
There are various ways to handle such exceptions. Example:</P
 ><P
 > <TABLE
 BORDER="0"