Various small updates for new actions, filterfiles, etc.
[privoxy.git] / doc / webserver / user-manual / config.html
index 06b0042..a25a894 100644 (file)
@@ -7,7 +7,7 @@ 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="Privoxy Configuration"
@@ -37,7 +37,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
@@ -73,7 +73,9 @@ CLASS="SECT1"
 ><H1
 CLASS="SECT1"
 ><A
-NAME="CONFIG">7. The Main Configuration File</H1
+NAME="CONFIG"
+></A
+>7. The Main Configuration File</H1
 ><P
 > Again, the main configuration file is named <TT
 CLASS="FILENAME"
@@ -136,7 +138,9 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="CONF-LOG-LOC">7.1. Configuration and Log File Locations</H2
+NAME="CONF-LOG-LOC"
+></A
+>7.1. Configuration and Log File Locations</H2
 ><P
 > <SPAN
 CLASS="APPLICATION"
@@ -160,7 +164,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="CONFDIR">7.1.1. confdir</H4
+NAME="CONFDIR"
+></A
+>7.1.1. confdir</H4
 ><P
 ></P
 ><DIV
@@ -242,7 +248,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="LOGDIR">7.1.2. logdir</H4
+NAME="LOGDIR"
+></A
+>7.1.2. logdir</H4
 ><P
 ></P
 ><DIV
@@ -316,7 +324,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="ACTIONSFILE">7.1.3. actionsfile</H4
+NAME="ACTIONSFILE"
+></A
+>7.1.3. actionsfile</H4
 ><A
 NAME="DEFAULT.ACTION"
 ></A
@@ -438,7 +448,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="FILTERFILE">7.1.4. filterfile</H4
+NAME="FILTERFILE"
+></A
+>7.1.4. filterfile</H4
 ><A
 NAME="DEFAULT.FILTER"
 ></A
@@ -453,7 +465,7 @@ CLASS="VARIABLELIST"
 ><P
 >    The <A
 HREF="filter-file.html"
->filter file</A
+>filter file(s)</A
 > to use
    </P
 ></DD
@@ -502,24 +514,31 @@ CLASS="REPLACEABLE"
 >Notes:</DT
 ><DD
 ><P
+>    Multiple <TT
+CLASS="LITERAL"
+>filterfiles</TT
+> lines are permitted.
+   </P
+><P
 >    The <A
 HREF="filter-file.html"
->filter file</A
-> contains content modification
+>filter files</A
+> contain content modification
     rules that use <A
 HREF="appendix.html#REGEX"
 >regular expressions</A
 >. These rules permit
-    powerful changes on the content of Web pages, e.g., you could disable your favorite
-    JavaScript annoyances, re-write the actual displayed text, or just have some
-    fun replacing <SPAN
+    powerful changes on the content of Web pages, and optionally the headers
+    as well, e.g., you could disable your favorite JavaScript annoyances,
+    re-write the actual displayed text, or just have some fun replacing
+    <SPAN
 CLASS="QUOTE"
 >"Microsoft"</SPAN
 > with <SPAN
 CLASS="QUOTE"
 >"MicroSuck"</SPAN
-> wherever
-    it appears on a Web page.
+> wherever it appears
+    on a Web page.
    </P
 ><P
 >    The
@@ -541,14 +560,14 @@ CLASS="REPLACEABLE"
 >name</I
 ></TT
 >)
-    to be defined in the filter file!
+    to be defined in a filter file!
    </P
 ><P
 >    A pre-defined filter file called <TT
 CLASS="FILENAME"
 >default.filter</TT
 > that contains
-    a bunch of handy filters for common problems is included in the distribution.
+    a number of useful filters for common problems is included in the distribution.
     See the section on the <TT
 CLASS="LITERAL"
 ><A
@@ -558,6 +577,13 @@ HREF="actions-file.html#FILTER"
 >
     action for a list.
    </P
+><P
+>    It is recommended to place any locally adapted filters into a separate
+    file, such as <TT
+CLASS="FILENAME"
+>user.filter</TT
+>.
+   </P
 ></DD
 ></DL
 ></DIV
@@ -567,7 +593,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="LOGFILE">7.1.5. logfile</H4
+NAME="LOGFILE"
+></A
+>7.1.5. logfile</H4
 ><P
 ></P
 ><DIV
@@ -615,9 +643,6 @@ CLASS="LITERAL"
 >Notes:</DT
 ><DD
 ><P
->    The windows version will additionally log to the console.
-   </P
-><P
 >    The logfile is where all logging and error messages are written. The level
     of detail and number of messages are set with the <TT
 CLASS="LITERAL"
@@ -673,7 +698,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="JARFILE">7.1.6. jarfile</H4
+NAME="JARFILE"
+></A
+>7.1.6. jarfile</H4
 ><P
 ></P
 ><DIV
@@ -729,7 +756,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="TRUSTFILE">7.1.7. trustfile</H4
+NAME="TRUSTFILE"
+></A
+>7.1.7. trustfile</H4
 ><P
 ></P
 ><DIV
@@ -773,7 +802,7 @@ CLASS="EMPHASIS"
 >Effect if unset:</DT
 ><DD
 ><P
->    The whole trust mechanism is turned off.
+>    The entire trust mechanism is turned off.
    </P
 ></DD
 ><DT
@@ -794,24 +823,71 @@ CLASS="EMPHASIS"
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > will only allow
-    access to sites that are named in the trustfile. 
-    You can also mark sites as trusted referrers (with <TT
+    access to sites that are specified in the trustfile. Sites can be listed 
+    in one of two ways:
+   </P
+><P
+>    Prepending a <TT
+CLASS="LITERAL"
+>~</TT
+> character limits access to this site 
+    only (and any sub-paths within this site), e.g. 
+    <TT
+CLASS="LITERAL"
+>~www.example.com</TT
+>. 
+   </P
+><P
+>    Or, you can designate sites as <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>trusted referrers</I
+></SPAN
+>, by
+    prepending the name with a <TT
 CLASS="LITERAL"
 >+</TT
->), with
-    the effect that access to untrusted sites will be granted, if a link from a
-    trusted referrer was used.
-    The link target will then be added to the <SPAN
+> character. The effect is that
+    access to untrusted sites will be granted -- but only if a link from this
+    trusted referrer was used. The link target will then be added to the
+    <SPAN
 CLASS="QUOTE"
 >"trustfile"</SPAN
->.
-    Possible applications include limiting Internet access for children.
+> so that future, direct accesses will be granted.
+    Sites added via this mechanism do not become trusted referrers themselves
+    (i.e. they are added with a <TT
+CLASS="LITERAL"
+>~</TT
+> designation).
    </P
 ><P
->    If you use <TT
+>    If you use the <TT
 CLASS="LITERAL"
 >+</TT
-> operator in the trust file, it may grow considerably over time.
+> operator in the trust file, it may grow 
+    considerably over time.
+   </P
+><P
+>    It is recommended that <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> be compiled with
+    the <TT
+CLASS="LITERAL"
+>--disable-force</TT
+>, <TT
+CLASS="LITERAL"
+>--disable-toggle</TT
+> and
+    <TT
+CLASS="LITERAL"
+> --disable-editor</TT
+> options, if this feature is to be
+    used.
+   </P
+><P
+>    Possible applications include limiting Internet access for children.
    </P
 ></DD
 ></DL
@@ -823,7 +899,9 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="LOCAL-SET-UP">7.2. Local Set-up Documentation</H2
+NAME="LOCAL-SET-UP"
+></A
+>7.2. Local Set-up Documentation</H2
 ><P
 >    If you intend to operate <SPAN
 CLASS="APPLICATION"
@@ -837,7 +915,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="USER-MANUAL">7.2.1. user-manual</H4
+NAME="USER-MANUAL"
+></A
+>7.2.1. user-manual</H4
 ><P
 ></P
 ><DIV
@@ -920,7 +1000,49 @@ WIDTH="90%"
 ><TD
 ><PRE
 CLASS="SCREEN"
->user-manual  file:///usr/share/doc/privoxy-3.1.1/user-manual/</PRE
+>  user-manual  file:///usr/share/doc/privoxy-3.0.4/user-manual/</PRE
+></TD
+></TR
+></TABLE
+>
+  </P
+><P
+>   Windows, in local filesystem, <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>must</I
+></SPAN
+> use forward slash notation:
+  </P
+><P
+>   <TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="90%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+>  user-manual  file:/c:/some-dir/privoxy-3.0.4/user-manual/</PRE
+></TD
+></TR
+></TABLE
+>
+  </P
+><P
+>   Windows, UNC notation (with forward slashes):
+  </P
+><P
+>   <TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="90%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+>  user-manual  file://///some-server/some-path/privoxy-3.0.4/user-manual/</PRE
 ></TD
 ></TR
 ></TABLE
@@ -941,7 +1063,7 @@ WIDTH="90%"
 ><TD
 ><PRE
 CLASS="SCREEN"
->user-manual  http://local-webserver/privoxy-user-manual/</PRE
+>  user-manual  http://local-webserver/privoxy-user-manual/</PRE
 ></TD
 ></TR
 ></TABLE
@@ -988,7 +1110,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="TRUST-INFO-URL">7.2.2. trust-info-url</H4
+NAME="TRUST-INFO-URL"
+></A
+>7.2.2. trust-info-url</H4
 ><P
 ></P
 ><DIV
@@ -1054,7 +1178,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="ADMIN-ADDRESS">7.2.3. admin-address</H4
+NAME="ADMIN-ADDRESS"
+></A
+>7.2.3. admin-address</H4
 ><P
 ></P
 ><DIV
@@ -1115,7 +1241,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="PROXY-INFO-URL">7.2.4. proxy-info-url</H4
+NAME="PROXY-INFO-URL"
+></A
+>7.2.4. proxy-info-url</H4
 ><P
 ></P
 ><DIV
@@ -1184,7 +1312,9 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="DEBUGGING">7.3. Debugging</H2
+NAME="DEBUGGING"
+></A
+>7.3. Debugging</H2
 ><P
 >  These options are mainly useful when tracing a problem.
   Note that you might also want to invoke
@@ -1202,7 +1332,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="DEBUG">7.3.1. debug</H4
+NAME="DEBUG"
+></A
+>7.3.1. debug</H4
 ><P
 ></P
 ><DIV
@@ -1334,7 +1466,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="SINGLE-THREADED">7.3.2. single-threaded</H4
+NAME="SINGLE-THREADED"
+></A
+>7.3.2. single-threaded</H4
 ><P
 ></P
 ><DIV
@@ -1402,7 +1536,9 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="ACCESS-CONTROL">7.4. Access Control and Security</H2
+NAME="ACCESS-CONTROL"
+></A
+>7.4. Access Control and Security</H2
 ><P
 >  This section of the config file controls the security-relevant aspects
   of <SPAN
@@ -1415,7 +1551,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="LISTEN-ADDRESS">7.4.1. listen-address</H4
+NAME="LISTEN-ADDRESS"
+></A
+>7.4.1. listen-address</H4
 ><P
 ></P
 ><DIV
@@ -1547,7 +1685,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="TOGGLE">7.4.2. toggle</H4
+NAME="TOGGLE"
+></A
+>7.4.2. toggle</H4
 ><P
 ></P
 ><DIV
@@ -1619,7 +1759,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="ENABLE-REMOTE-TOGGLE">7.4.3. enable-remote-toggle</H4
+NAME="ENABLE-REMOTE-TOGGLE"
+></A
+>7.4.3. enable-remote-toggle</H4
 ><P
 ></P
 ><DIV
@@ -1715,7 +1857,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="ENABLE-EDIT-ACTIONS">7.4.4. enable-edit-actions</H4
+NAME="ENABLE-EDIT-ACTIONS"
+></A
+>7.4.4. enable-edit-actions</H4
 ><P
 ></P
 ><DIV
@@ -1803,7 +1947,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="ACLS">7.4.5. ACLs: permit-access and deny-access</H4
+NAME="ACLS"
+></A
+>7.4.5. ACLs: permit-access and deny-access</H4
 ><A
 NAME="PERMIT-ACCESS"
 ></A
@@ -2091,7 +2237,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="BUFFER-LIMIT">7.4.6. buffer-limit</H4
+NAME="BUFFER-LIMIT"
+></A
+>7.4.6. buffer-limit</H4
 ><P
 ></P
 ><DIV
@@ -2176,7 +2324,9 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="FORWARDING">7.5. Forwarding</H2
+NAME="FORWARDING"
+></A
+>7.5. Forwarding</H2
 ><P
 > This feature allows routing of HTTP requests through a chain of
  multiple proxies.
@@ -2204,7 +2354,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="FORWARD">7.5.1. forward</H4
+NAME="FORWARD"
+></A
+>7.5.1. forward</H4
 ><P
 ></P
 ><DIV
@@ -2368,7 +2520,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="SOCKS">7.5.2. forward-socks4 and forward-socks4a</H4
+NAME="SOCKS"
+></A
+>7.5.2. forward-socks4 and forward-socks4a</H4
 ><A
 NAME="FORWARD-SOCKS4"
 ></A
@@ -2575,7 +2729,9 @@ CLASS="SECT3"
 ><H4
 CLASS="SECT3"
 ><A
-NAME="ADVANCED-FORWARDING-EXAMPLES">7.5.3. Advanced Forwarding Examples</H4
+NAME="ADVANCED-FORWARDING-EXAMPLES"
+></A
+>7.5.3. Advanced Forwarding Examples</H4
 ><P
 > If you have links to multiple ISPs that provide various special content 
  only to their subscribers, you can configure multiple <SPAN
@@ -2724,7 +2880,9 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="WINDOWS-GUI">7.6. Windows GUI Options</H2
+NAME="WINDOWS-GUI"
+></A
+>7.6. Windows GUI Options</H2
 ><P
 > <SPAN
 CLASS="APPLICATION"