New html version of user manual.
[privoxy.git] / doc / webserver / user-manual / configuration.html
index 7b77fcd..d75573b 100644 (file)
@@ -1,13 +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.64
-"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="HOME"
-TITLE="Privoxy User Manual"
+TITLE="Privoxy 3.0.7 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="Starting Privoxy"
@@ -17,7 +17,9 @@ TITLE="The Main Configuration File"
 HREF="config.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"
@@ -28,6 +30,7 @@ ALINK="#0000FF"
 ><DIV
 CLASS="NAVHEADER"
 ><TABLE
+SUMMARY="Header navigation table"
 WIDTH="100%"
 BORDER="0"
 CELLPADDING="0"
@@ -36,7 +39,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy User Manual</TH
+>Privoxy 3.0.7 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -45,6 +48,7 @@ ALIGN="left"
 VALIGN="bottom"
 ><A
 HREF="startup.html"
+ACCESSKEY="P"
 >Prev</A
 ></TD
 ><TD
@@ -58,6 +62,7 @@ ALIGN="right"
 VALIGN="bottom"
 ><A
 HREF="config.html"
+ACCESSKEY="N"
 >Next</A
 ></TD
 ></TR
@@ -71,10 +76,7 @@ CLASS="SECT1"
 CLASS="SECT1"
 ><A
 NAME="CONFIGURATION"
->7. <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> Configuration</A
+>6. Privoxy Configuration</A
 ></H1
 ><P
 >  All <SPAN
@@ -93,11 +95,8 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="AEN305"
->7.1. Controlling <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> with Your Web Browser</A
+NAME="AEN790"
+>6.1. Controlling Privoxy with Your Web Browser</A
 ></H2
 ><P
 > <SPAN
@@ -124,9 +123,12 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
-> <H3
+> <H2
 CLASS="BRIDGEHEAD"
->Privoxy Menu</H3
+><A
+NAME="AEN798"
+></A
+>    Privoxy Menu</H2
 ><P
 ></P
 ><TABLE
@@ -177,6 +179,15 @@ TARGET="_top"
 >
  </TD
 ></TR
+><TR
+><TD
+>          &#9642;  <A
+HREF="http://www.privoxy.org/   3.0.7/user-manual/"
+TARGET="_top"
+>Documentation</A
+>
+ </TD
+></TR
 ></TBODY
 ></TABLE
 ><P
@@ -187,11 +198,11 @@ TARGET="_top"
 ></TABLE
 ><P
 > This should be self-explanatory. Note the first item leads to an editor for the
- <SPAN
-CLASS="QUOTE"
->"actions list"</SPAN
->, which is where the ad, banner, cookie,
- and URL blocking magic is configured as well as other advanced features of
+ <A
+HREF="actions-file.html"
+>actions files</A
+>, which is where the ad, banner,
cookie, and URL blocking magic is configured as well as other advanced features of
  <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
@@ -215,7 +226,11 @@ CLASS="APPLICATION"
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > continues 
- to run as a proxy in this case, but all filtering is disabled. There
+ to run as a proxy in this case, but all manipulation is disabled, i.e.
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> acts like a normal forwarding proxy. There
  is even a toggle <A
 HREF="appendix.html#BOOKMARKLETS"
 >Bookmarklet</A
@@ -225,6 +240,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"
@@ -232,7 +260,7 @@ CLASS="SECT2"
 CLASS="SECT2"
 ><A
 NAME="CONFOVERVIEW"
->7.2. Configuration Files Overview</A
+>6.2. Configuration Files Overview</A
 ></H2
 ><P
 > For Unix, *BSD and Linux, all configuration files are located in
@@ -257,9 +285,12 @@ CLASS="APPLICATION"
 ><UL
 ><LI
 ><P
->     The main configuration file is named <A
+>     The <A
 HREF="config.html"
->config</A
+>main configuration file</A
+> is named <TT
+CLASS="FILENAME"
+>config</TT
 >
      on Linux, Unix, BSD, OS/2, and AmigaOS and <TT
 CLASS="FILENAME"
@@ -276,12 +307,18 @@ CLASS="FILENAME"
 > (the main <A
 HREF="actions-file.html"
 >actions file</A
->) is used to define
-    the default settings for various <SPAN
+>)
+    is used to define which <SPAN
 CLASS="QUOTE"
 >"actions"</SPAN
-> relating to images, banners, 
-    pop-ups, access restrictions, banners and cookies.
+> 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.
    </P
 ><P
 >    Multiple actions files may be defined in <TT
@@ -289,20 +326,21 @@ 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
-> are probably best applied in
+> (which you will most probably want
+    to define sooner or later) are probably best applied in
     <TT
 CLASS="FILENAME"
 >user.action</TT
->, which should be preserved across
+>, where you can preserve them across
     upgrades. <TT
 CLASS="FILENAME"
 >standard.action</TT
-> is also included. This is mostly 
-    for <SPAN
+> is only for
+    <SPAN
 CLASS="APPLICATION"
 >Privoxy's</SPAN
 > internal use.
@@ -311,23 +349,23 @@ CLASS="APPLICATION"
 >    
     There is also a web based editor that can be accessed from
     <A
-HREF="http://config.privoxy.org/show-status/"
+HREF="http://config.privoxy.org/show-status"
 TARGET="_top"
->http://config.privoxy.org/show-status/</A
+>http://config.privoxy.org/show-status</A
 >
     (Shortcut: <A
-HREF="http://p.p/show-status/"
+HREF="http://p.p/show-status"
 TARGET="_top"
->http://p.p/show-status/</A
+>http://p.p/show-status</A
 >) for the
     various actions files. 
    </P
 ></LI
 ><LI
 ><P
->    <TT
-CLASS="FILENAME"
->default.filter</TT
+>    <SPAN
+CLASS="QUOTE"
+>"Filter files"</SPAN
 > (the <A
 HREF="filter-file.html"
 >filter
@@ -335,12 +373,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
@@ -348,7 +405,7 @@ CLASS="LITERAL"
 >#</TT
 >"</SPAN
 > character to denote a
- comment (the rest of the line will be ignored) angd understand line continuation
+ comment (the rest of the line will be ignored) and understand line continuation
  through placing a backslash ("<TT
 CLASS="LITERAL"
 >\</TT
@@ -362,12 +419,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
@@ -392,9 +446,12 @@ 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. 
@@ -411,6 +468,7 @@ CLASS="NAVFOOTER"
 ><HR
 ALIGN="LEFT"
 WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
 WIDTH="100%"
 BORDER="0"
 CELLPADDING="0"
@@ -422,6 +480,7 @@ ALIGN="left"
 VALIGN="top"
 ><A
 HREF="startup.html"
+ACCESSKEY="P"
 >Prev</A
 ></TD
 ><TD
@@ -430,6 +489,7 @@ ALIGN="center"
 VALIGN="top"
 ><A
 HREF="index.html"
+ACCESSKEY="H"
 >Home</A
 ></TD
 ><TD
@@ -438,6 +498,7 @@ ALIGN="right"
 VALIGN="top"
 ><A
 HREF="config.html"
+ACCESSKEY="N"
 >Next</A
 ></TD
 ></TR
@@ -446,10 +507,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"