Rebuild for 3.0.17 stable
[privoxy.git] / doc / webserver / user-manual / configuration.html
index e4bbe09..f8a58c1 100644 (file)
@@ -1,12 +1,13 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
 <HTML
 ><HEAD
 ><TITLE
 >Privoxy Configuration</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="HOME"
-TITLE="Privoxy User Manual"
+TITLE="Privoxy 3.0.17 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="Starting Privoxy"
@@ -16,7 +17,12 @@ TITLE="The Main Configuration File"
 HREF="config.html"><LINK
 REL="STYLESHEET"
 TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+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
 CLASS="SECT1"
 BGCOLOR="#EEEEEE"
@@ -27,6 +33,7 @@ ALINK="#0000FF"
 ><DIV
 CLASS="NAVHEADER"
 ><TABLE
+SUMMARY="Header navigation table"
 WIDTH="100%"
 BORDER="0"
 CELLPADDING="0"
@@ -35,7 +42,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy User Manual</TH
+>Privoxy 3.0.17 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -44,6 +51,7 @@ ALIGN="left"
 VALIGN="bottom"
 ><A
 HREF="startup.html"
+ACCESSKEY="P"
 >Prev</A
 ></TD
 ><TD
@@ -57,6 +65,7 @@ ALIGN="right"
 VALIGN="bottom"
 ><A
 HREF="config.html"
+ACCESSKEY="N"
 >Next</A
 ></TD
 ></TR
@@ -70,10 +79,7 @@ CLASS="SECT1"
 CLASS="SECT1"
 ><A
 NAME="CONFIGURATION"
->6. <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> Configuration</A
+>6. Privoxy Configuration</A
 ></H1
 ><P
 >  All <SPAN
@@ -92,11 +98,8 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="AEN501"
->6.1. Controlling <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> with Your Web Browser</A
+NAME="AEN921"
+>6.1. Controlling Privoxy with Your Web Browser</A
 ></H2
 ><P
 > <SPAN
@@ -123,9 +126,12 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
-> <H3
+> <H2
 CLASS="BRIDGEHEAD"
->Privoxy Menu</H3
+><A
+NAME="AEN929"
+></A
+>    Privoxy Menu</H2
 ><P
 ></P
 ><TABLE
@@ -176,6 +182,15 @@ TARGET="_top"
 >
  </TD
 ></TR
+><TR
+><TD
+>          &#9642;  <A
+HREF="http://www.privoxy.org/3.0.17/user-manual/"
+TARGET="_top"
+>Documentation</A
+>
+ </TD
+></TR
 ></TBODY
 ></TABLE
 ><P
@@ -228,6 +243,19 @@ CLASS="APPLICATION"
 >Privoxy</SPAN
 > with one click from
  your browser.</P
+><P
+> Note that several of the features described above are disabled by default
+ in <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> 3.0.7 beta and later.
+ Check the
+ <A
+HREF="config.html"
+TARGET="_top"
+>configuration file</A
+> to learn why
+ and in which cases it's safe to enable them again.</P
 ></DIV
 ><DIV
 CLASS="SECT2"
@@ -247,9 +275,7 @@ CLASS="FILENAME"
  <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> executable.  The name
- and number of configuration files has changed from previous versions, and is
- subject to change as development progresses.</P
+> executable. </P
 ><P
 > The installed defaults provide a reasonable starting point, though 
  some settings may be aggressive by some standards. For the time being, the
@@ -278,22 +304,24 @@ CLASS="FILENAME"
 ><P
 >    <TT
 CLASS="FILENAME"
->default.action</TT
-> (the main <A
-HREF="actions-file.html"
->actions file</A
->)
-    is used to define which <SPAN
+>match-all.action</TT
+> is used to define which <SPAN
 CLASS="QUOTE"
 >"actions"</SPAN
-> relating to banner-blocking, images, pop-ups,
-    content modification, cookie handling etc should be applied by default. It also defines many
-    exceptions (both positive and negative) from this default set of actions that enable 
-    <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> to selectively eliminate the junk, and only the junk, on
-    as many websites as possible.
+>
+    relating to banner-blocking, images, pop-ups, content modification, cookie handling
+    etc should be applied by default. It should be the first actions file loaded.
+   </P
+><P
+>    <TT
+CLASS="FILENAME"
+>default.action</TT
+> defines many exceptions (both positive and negative)
+    from the default set of actions that's configured in <TT
+CLASS="FILENAME"
+>match-all.action</TT
+>.
+    It should be the second actions file loaded and shouldn't be edited by the user.
    </P
 ><P
 >    Multiple actions files may be defined in <TT
@@ -301,24 +329,17 @@ CLASS="FILENAME"
 >config</TT
 >. These 
     are processed in the order they are defined. Local customizations and locally 
-    preferred exceptions to the default policies  as defined in
+    preferred exceptions to the default policies as defined in
     <TT
 CLASS="FILENAME"
->default.action</TT
+>match-all.action</TT
 > (which you will most probably want
-    to define sooner or later) are probably best applied in
-    <TT
+    to define sooner or later) are best applied in <TT
 CLASS="FILENAME"
 >user.action</TT
->, where you can preserve them across
-    upgrades. <TT
-CLASS="FILENAME"
->standard.action</TT
-> is for
-    <SPAN
-CLASS="APPLICATION"
->Privoxy's</SPAN
-> internal use.
+>,
+    where you can preserve them across upgrades. The file isn't installed by all
+    installers, but you can easily create it yourself with a text editor.
    </P
 ><P
 >    
@@ -338,9 +359,9 @@ TARGET="_top"
 ></LI
 ><LI
 ><P
->    <TT
-CLASS="FILENAME"
->default.filter</TT
+>    <SPAN
+CLASS="QUOTE"
+>"Filter files"</SPAN
 > (the <A
 HREF="filter-file.html"
 >filter
@@ -348,12 +369,31 @@ HREF="filter-file.html"
 >) can be used to re-write the raw page content, including
     viewable text as well as embedded HTML and JavaScript, and whatever else
     lurks on any given web page. The filtering jobs are only pre-defined here;
-    whether to apply them or not is up to the actions files.
+    whether to apply them or not is up to the actions files. 
+    <TT
+CLASS="FILENAME"
+>default.filter</TT
+> includes various filters made 
+    available for use by the developers. Some are much more intrusive than 
+    others, and all should be used with caution. You may define additional 
+    filter files in <TT
+CLASS="FILENAME"
+>config</TT
+> as you can with 
+    actions files. We suggest <TT
+CLASS="FILENAME"
+>user.filter</TT
+> for any 
+    locally defined filters or customizations.
    </P
 ></LI
 ></UL
 ></P
 ><P
+> The syntax of the configuration and filter files may change between different
+ Privoxy versions, unfortunately some enhancements cost backwards compatibility.
+ </P
+><P
 > All files use the <SPAN
 CLASS="QUOTE"
 >"<TT
@@ -375,12 +415,9 @@ CLASS="LITERAL"
 >#</TT
 > in front of an otherwise
  valid configuration line to prevent it from being interpreted is called "commenting
- out" that line.</P
+ out" that line. Blank lines are ignored.</P
 ><P
-> The actions files and <TT
-CLASS="FILENAME"
->default.filter</TT
-> 
+> The actions files and filter files  
  can use Perl style <A
 HREF="appendix.html#REGEX"
 >regular expressions</A
@@ -405,18 +442,13 @@ CLASS="APPLICATION"
 CLASS="QUOTE"
 >"wake up"</SPAN
 > requests
- must obviously be sent to the <I
+ must obviously be sent to the <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
 >old</I
+></SPAN
 > listening address.</P
-><P
-> While under development, the configuration content is subject to change. 
- The below documentation may not be accurate by the time you read this. 
- Also, what constitutes a <SPAN
-CLASS="QUOTE"
->"default"</SPAN
-> setting, may change, so 
- please check all your configuration files on important issues.</P
 ></DIV
 ></DIV
 ><DIV
@@ -424,6 +456,7 @@ CLASS="NAVFOOTER"
 ><HR
 ALIGN="LEFT"
 WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
 WIDTH="100%"
 BORDER="0"
 CELLPADDING="0"
@@ -435,6 +468,7 @@ ALIGN="left"
 VALIGN="top"
 ><A
 HREF="startup.html"
+ACCESSKEY="P"
 >Prev</A
 ></TD
 ><TD
@@ -443,6 +477,7 @@ ALIGN="center"
 VALIGN="top"
 ><A
 HREF="index.html"
+ACCESSKEY="H"
 >Home</A
 ></TD
 ><TD
@@ -451,6 +486,7 @@ ALIGN="right"
 VALIGN="top"
 ><A
 HREF="config.html"
+ACCESSKEY="N"
 >Next</A
 ></TD
 ></TR
@@ -459,10 +495,7 @@ HREF="config.html"
 WIDTH="33%"
 ALIGN="left"
 VALIGN="top"
->Starting <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-></TD
+>Starting Privoxy</TD
 ><TD
 WIDTH="34%"
 ALIGN="center"
@@ -478,4 +511,4 @@ VALIGN="top"
 ></DIV
 ></BODY
 ></HTML
->
\ No newline at end of file
+>