Just regenerating to get fresh version in place of very dated versions.

[privoxy.git] / doc / webserver / user-manual / filter-file.html

diff --git a/doc/webserver/user-manual/filter-file.html b/doc/webserver/user-manual/filter-file.html
index d9a382f..2ca2bb5 100644 (file)
--- a/doc/webserver/user-manual/filter-file.html
+++ b/doc/webserver/user-manual/filter-file.html
@@ -4,10 +4,10 @@
 >The Filter File</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.64
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
 "><LINK
 REL="HOME"
-TITLE="Privoxy User Manual"
+TITLE="Privoxy 3.1.1 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="Actions Files"
@@ -28,6 +28,7 @@ ALINK="#0000FF"
 ><DIV
 CLASS="NAVHEADER"
 ><TABLE
+SUMMARY="Header navigation table"
 WIDTH="100%"
 BORDER="0"
 CELLPADDING="0"
@@ -36,7 +37,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy User Manual</TH
+>Privoxy 3.1.1 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -45,6 +46,7 @@ ALIGN="left"
 VALIGN="bottom"
 ><A
 HREF="actions-file.html"
+ACCESSKEY="P"
 >Prev</A
 ></TD
 ><TD
@@ -58,6 +60,7 @@ ALIGN="right"
 VALIGN="bottom"
 ><A
 HREF="templates.html"
+ACCESSKEY="N"
 >Next</A
 ></TD
 ></TR
@@ -70,9 +73,7 @@ CLASS="SECT1"
 ><H1
 CLASS="SECT1"
 ><A
-NAME="FILTER-FILE"
->9. The Filter File</A
-></H1
+NAME="FILTER-FILE">9. The Filter File</H1
 ><P
 > All text substitutions that can be invoked through the
  <TT
@@ -119,34 +120,52 @@ CLASS="QUOTE"
 HREF="actions-file.html"
 >actions files</A
 >, the
- filter file is organized in sections, which are called <I
+ filter file is organized in sections, which are called <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >filters</I
+></SPAN
 >
  here. Each filter consists of a heading line, that starts with the
- <I
+ <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >keyword</I
+></SPAN
 > <TT
 CLASS="LITERAL"
 >FILTER:</TT
 >, followed by
- the filter's <I
+ the filter's <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >name</I
+></SPAN
 >, and a short (one line) 
- <I
+ <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >description</I
+></SPAN
 > of what it does. Below that line
- come the <I
+ come the <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >jobs</I
+></SPAN
 >, i.e. lines that define the actual
  text substitutions. By convention, the name of a filter
- should describe what the filter <I
+ should describe what the filter <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >eliminates</I
+></SPAN
 >. The
  comment is used in the <A
 HREF="http://config.privoxy.org/"
@@ -212,7 +231,7 @@ CLASS="LITERAL"
 > operator. If you are familiar with Perl, you
  will find this to be quite intuitive, and may want to look at the
  <A
-HREF="http://www.oesterhelt.org/pcrs/pcrs.1.html"
+HREF="http://www.oesterhelt.org/pcrs/pcrs.3.html"
 TARGET="_top"
 >PCRS man page</A
 >
@@ -254,9 +273,7 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="AEN2902"
->9.1. Filter File Tutorial</A
-></H2
+NAME="AEN3018">9.1. Filter File Tutorial</H2
 ><P
 > Now, let's complete our <SPAN
 CLASS="QUOTE"
@@ -286,9 +303,12 @@ CLASS="SCREEN"
 ></TABLE
 ></P
 ><P
-> But wait! Didn't the comment say that <I
+> But wait! Didn't the comment say that <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >all</I
+></SPAN
 > occurrences
  of <SPAN
 CLASS="QUOTE"
@@ -385,9 +405,12 @@ CLASS="QUOTE"
  matches <SPAN
 CLASS="QUOTE"
 >"&#60;script"</SPAN
->, followed by <I
+>, followed by <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >any</I
+></SPAN
 > text, i.e.
  it matches the whole page, from the start of the first &#60;script&#62; tag.</P
 ><P
@@ -399,18 +422,24 @@ CLASS="LITERAL"
 CLASS="QUOTE"
 >"document.referrer"</SPAN
 >. The dot needed to
- be <I
+ be <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >escaped</I
+></SPAN
 >, i.e. preceded by a backslash, to take away its
  special meaning as a joker, and make it just a regular dot. So far, the meaning is:
  Match from the start of the first &#60;script&#62; tag in a the page, up to, and including,
  the text <SPAN
 CLASS="QUOTE"
 >"document.referrer"</SPAN
->, if <I
+>, if <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >both</I
+></SPAN
 > are present
  in the page (and appear in that order).</P
 ><P
@@ -449,9 +478,12 @@ CLASS="QUOTE"
  text in between <SPAN
 CLASS="QUOTE"
 >"&#60;script"</SPAN
-> and the <I
+> and the <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >first</I
+></SPAN
 > occurrence
  of <SPAN
 CLASS="QUOTE"
@@ -460,9 +492,12 @@ CLASS="QUOTE"
 CLASS="LITERAL"
 >.*</TT
 > will
- only span the text up to the <I
+ only span the text up to the <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >first</I
+></SPAN
 > <SPAN
 CLASS="QUOTE"
 >"&#60;/script&#62;"</SPAN
@@ -507,9 +542,12 @@ CLASS="LITERAL"
  <TT
 CLASS="LITERAL"
 >"Not Your Business!"</TT
-> (<I
+> (<SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >including</I
+></SPAN
 >
  the quotation marks!), followed by the text remembered as <TT
 CLASS="LITERAL"
@@ -551,7 +589,7 @@ WIDTH="100%"
 CLASS="SCREEN"
 ># The status bar is for displaying link targets, not pointless blahblah
 #
-s/window\.status\s*=\s*['"].*?['"]/dUmMy=1/ig</PRE
+s/window\.status\s*=\s*(['"]).*?\1/dUmMy=1/ig</PRE
 ></TD
 ></TR
 ></TABLE
@@ -585,11 +623,35 @@ CLASS="LITERAL"
 > construct means: <SPAN
 CLASS="QUOTE"
 >"a single
- <I
+ <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >or</I
+></SPAN
 > a double quote"</SPAN
->.</P
+>. Finally, <TT
+CLASS="LITERAL"
+>\1</TT
+> is
+ a backreference to the first parenthesis just like <TT
+CLASS="LITERAL"
+>$1</TT
+> above,
+ with the difference that in the <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>pattern</I
+></SPAN
+>, a backslash indicates
+ a backreference, whereas in the <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>substitute</I
+></SPAN
+>, it's the dollar.</P
 ><P
 > So what does this job do? It replaces assignments of single- or double-quoted
  strings to the <SPAN
@@ -611,7 +673,7 @@ WIDTH="100%"
 CLASS="SCREEN"
 ># Kill OnUnload popups. Yummy. Test: http://www.zdnet.com/zdsubs/yahoo/tree/yfs.html
 #
-s/(&#60;body .*)onunload(.*&#62;)/$1never$2/iU</PRE
+s/(&#60;body [^&#62;]*)onunload(.*&#62;)/$1never$2/iU</PRE
 ></TD
 ></TR
 ></TABLE
@@ -623,9 +685,12 @@ HREF="http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113/events.html#Even
 TARGET="_top"
 >OnUnload
  event binding</A
-> in the HTML DOM was a <I
+> in the HTML DOM was a <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >CRIME</I
+></SPAN
 >.
  When I close a browser window, I want it to close and die. Basta.
  This job replaces the <SPAN
@@ -643,7 +708,20 @@ CLASS="LITERAL"
 CLASS="LITERAL"
 >i</TT
 > option makes the pattern matching
- case-insensitive.</P
+ case-insensitive. Also note that ungreedy matching alone doesn't always guarantee
+ a minimal match: In the first parenthesis, we had to use <TT
+CLASS="LITERAL"
+>[^&#62;]*</TT
+>
+ instead of <TT
+CLASS="LITERAL"
+>.*</TT
+> to prevent the match from exceeding the 
+ &#60;body&#62; tag if it doesn't contain <SPAN
+CLASS="QUOTE"
+>"OnUnload"</SPAN
+>, but the page's
+ content does.</P
 ><P
 > The last example is from the fun department:</P
 ><P
@@ -677,7 +755,7 @@ CLASS="QUOTE"
 CLASS="QUOTE"
 >"microsoft"</SPAN
 >
- in the page. This prevents links to microsoft.com from being messed, while
+ in the page. This prevents links to microsoft.com from being trashed, while
  still replacing the word everywhere else.</P
 ><P
 > <TABLE
@@ -692,6 +770,8 @@ CLASS="SCREEN"
 #
 s* industry[ -]leading \
 |  cutting[ -]edge \
+|  customer[ -]focused \
+|  market[ -]driven \
 |  award[ -]winning # Comments are OK, too! \
 |  high[ -]performance \
 |  solutions[ -]based \
@@ -709,7 +789,7 @@ s* industry[ -]leading \
 CLASS="LITERAL"
 >x</TT
 > option in this job turns on extended syntax, and allows for
- e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting.</P
+ e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting. </P
 ><P
 > You get the idea?</P
 ></DIV
@@ -719,6 +799,7 @@ CLASS="NAVFOOTER"
 ><HR
 ALIGN="LEFT"
 WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
 WIDTH="100%"
 BORDER="0"
 CELLPADDING="0"
@@ -730,6 +811,7 @@ ALIGN="left"
 VALIGN="top"
 ><A
 HREF="actions-file.html"
+ACCESSKEY="P"
 >Prev</A
 ></TD
 ><TD
@@ -738,6 +820,7 @@ ALIGN="center"
 VALIGN="top"
 ><A
 HREF="index.html"
+ACCESSKEY="H"
 >Home</A
 ></TD
 ><TD
@@ -746,6 +829,7 @@ ALIGN="right"
 VALIGN="top"
 ><A
 HREF="templates.html"
+ACCESSKEY="N"
 >Next</A
 ></TD
 ></TR