Rebuild docs
[privoxy.git] / doc / webserver / user-manual / config.html
index b9b4ef3..0b94a9e 100644 (file)
@@ -8,7 +8,7 @@
   <link rel="PREVIOUS" title="Privoxy Configuration" href="configuration.html">
   <link rel="NEXT" title="Actions Files" href="actions-file.html">
   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <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" text="#000000" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -30,8 +30,7 @@
     <p>By default, the main configuration file is named <tt class="FILENAME">config</tt>, with the exception of
     Windows, where it is named <tt class="FILENAME">config.txt</tt>. Configuration lines consist of an initial keyword
     followed by a list of values, all separated by whitespace (any number of spaces or tabs). For example:</p>
-    <p class="LITERALLAYOUT"><tt class="LITERAL">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">confdir
-    /etc/privoxy</i></span></tt></p>
+    <p class="LITERALLAYOUT">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">confdir /etc/privoxy</i></span></p>
     <p>Assigns the value <tt class="LITERAL">/etc/privoxy</tt> to the option <tt class="LITERAL">confdir</tt> and thus
     indicates that the configuration directory is named <span class="QUOTE">"/etc/privoxy/"</span>.</p>
     <p>All options in the config file except for <tt class="LITERAL">confdir</tt> and <tt class="LITERAL">logdir</tt>
@@ -78,7 +77,7 @@
               <table border="0" bgcolor="#E0E0E0" width="90%">
                 <tr>
                   <td>
-                    <pre class="SCREEN">��user-manual��/usr/share/doc/privoxy/user-manual</pre>
+                    <pre class="SCREEN">  user-manual  /usr/share/doc/privoxy/user-manual</pre>
                   </td>
                 </tr>
               </table>
@@ -89,7 +88,7 @@
               <table border="0" bgcolor="#E0E0E0" width="90%">
                 <tr>
                   <td>
-                    <pre class="SCREEN">��user-manual��http://example.com/privoxy/user-manual/</pre>
+                    <pre class="SCREEN">  user-manual  http://example.com/privoxy/user-manual/</pre>
                   </td>
                 </tr>
               </table>
               <table border="0" bgcolor="#E0E0E0" width="90%">
                 <tr>
                   <td>
-                    <pre class="SCREEN">
-                    forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
+                    <pre class=
+                    "SCREEN">  forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
   forward           .example.com   .</pre>
                   </td>
                 </tr>
                 <tr>
                   <td>
                     <pre class="SCREEN">  forward         192.168.*.*/     .
-  forward            10.*.*.*/     .
-  forward           127.*.*.*/     .</pre>
+  forward          10.*.*.*/       .
+  forward         127.*.*.*/       .</pre>
                   </td>
                 </tr>
               </table>
         <p>Now, your users can set their browser's proxy to use either host-a or host-b and be able to browse the
         internal content of both isp-a and isp-b.</p>
         <p>If you intend to chain <span class="APPLICATION">Privoxy</span> and <span class="APPLICATION">squid</span>
-        locally, then chaining as <tt class="LITERAL">browser -&gt; squid -&gt; privoxy</tt> is the recommended
+        locally, then chaining as <tt class="LITERAL">browser -&#62; squid -&#62; privoxy</tt> is the recommended
         way.</p>
         <p>Assuming that <span class="APPLICATION">Privoxy</span> and <span class="APPLICATION">squid</span> run on the
         same box, your <span class="APPLICATION">squid</span> configuration could then look like this:</p>
             <dt>Notes:</dt>
             <dd>
               <p>This directive was added as a work-around for Firefox bug 492459: <span class="QUOTE">"Websites are no
-              longer rendered if SSL requests for JavaScripts are blocked by a proxy."</span> (<a href=
+              longer rendered if SSL requests for JavaScripts are blocked by a proxy."</span> ( <a href=
               "https://bugzilla.mozilla.org/show_bug.cgi?id=492459" target=
               "_top">https://bugzilla.mozilla.org/show_bug.cgi?id=492459</a>), the bug has been fixed for quite some
               time, but this directive is also useful to make it harder for websites to detect whether or not resources
                   <td>
                     <pre class="SCREEN">    # Best speed (compared to the other levels)
     compression-level 1
+
     # Best compression
     compression-level 9
+
     # No compression. Only useful for testing as the added header
     # slightly increases the amount of data that has to be sent.
     # If your benchmark shows that using this compression level
     # is superior to using no compression at all, the benchmark
     # is likely to be flawed.
-    compression-level 0
-    </pre>
+    compression-level 0</pre>
                   </td>
                 </tr>
               </table>
                     <pre class="SCREEN">    # Define a couple of tags, the described effect requires action sections
     # that are enabled based on CLIENT-TAG patterns.
     client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
-    disable-content-filters Disable content-filters but do not affect other actions
-    </pre>
+    disable-content-filters Disable content-filters but do not affect other actions</pre>
                   </td>
                 </tr>
               </table>
                 <tr>
                   <td>
                     <pre class="SCREEN">      # Increase the time to life for temporarily enabled tags to 3 minutes
-      client-tag-lifetime 180
-    </pre>
+      client-tag-lifetime 180</pre>
                   </td>
                 </tr>
               </table>
                   <td>
                     <pre class="SCREEN">      # Allow systems that can reach Privoxy to provide the client
       # IP address with a X-Forwarded-For header.
-      trust-x-forwarded-for 1
-    </pre>
+      trust-x-forwarded-for 1</pre>
                   </td>
                 </tr>
               </table>
                 <tr>
                   <td>
                     <pre class="SCREEN">      # Increase the receive buffer size
-      receive-buffer-size 32768
-    </pre>
+      receive-buffer-size 32768</pre>
                   </td>
                 </tr>
               </table>
       interface:</p><a name="ACTIVITY-ANIMATION" id="ACTIVITY-ANIMATION"></a>
       <p>If <span class="QUOTE">"activity-animation"</span> is set to 1, the <span class="APPLICATION">Privoxy</span>
       icon will animate when <span class="QUOTE">"Privoxy"</span> is active. To turn off, set to 0.</p>
-      <p class="LITERALLAYOUT"><tt class="LITERAL">&nbsp;&nbsp;<span class="emphasis"><i class=
-      "EMPHASIS">activity-animation 1</i></span><br>
-      &nbsp;&nbsp;&nbsp;</tt></p><a name="LOG-MESSAGES" id="LOG-MESSAGES"></a>
+      <p class="LITERALLAYOUT">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">activity-animation
+      1</i></span></p><a name="LOG-MESSAGES" id="LOG-MESSAGES"></a>
       <p>If <span class="QUOTE">"log-messages"</span> is set to 1, <span class="APPLICATION">Privoxy</span> copies log
       messages to the console window. The log detail depends on the <a href="config.html#DEBUG">debug</a>
       directive.</p>
-      <p class="LITERALLAYOUT"><tt class="LITERAL">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">log-messages
-      1</i></span><br>
-      &nbsp;&nbsp;&nbsp;</tt></p><a name="LOG-BUFFER-SIZE" id="LOG-BUFFER-SIZE"></a>
+      <p class="LITERALLAYOUT">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">log-messages
+      1</i></span></p><a name="LOG-BUFFER-SIZE" id="LOG-BUFFER-SIZE"></a>
       <p>If <span class="QUOTE">"log-buffer-size"</span> is set to 1, the size of the log buffer, i.e. the amount of
       memory used for the log messages displayed in the console window, will be limited to <span class=
       "QUOTE">"log-max-lines"</span> (see below).</p>
       <p>Warning: Setting this to 0 will result in the buffer to grow infinitely and eat up all your memory!</p>
-      <p class="LITERALLAYOUT"><tt class="LITERAL">&nbsp;&nbsp;<span class="emphasis"><i class=
-      "EMPHASIS">log-buffer-size 1</i></span><br>
-      &nbsp;&nbsp;&nbsp;</tt></p><a name="LOG-MAX-LINES" id="LOG-MAX-LINES"></a>
+      <p class="LITERALLAYOUT">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">log-buffer-size
+      1</i></span></p><a name="LOG-MAX-LINES" id="LOG-MAX-LINES"></a>
       <p><span class="APPLICATION">log-max-lines</span> is the maximum number of lines held in the log buffer. See
       above.</p>
-      <p class="LITERALLAYOUT"><tt class="LITERAL">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">log-max-lines
-      200</i></span><br>
-      &nbsp;&nbsp;&nbsp;</tt></p><a name="LOG-HIGHLIGHT-MESSAGES" id="LOG-HIGHLIGHT-MESSAGES"></a>
+      <p class="LITERALLAYOUT">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">log-max-lines
+      200</i></span></p><a name="LOG-HIGHLIGHT-MESSAGES" id="LOG-HIGHLIGHT-MESSAGES"></a>
       <p>If <span class="QUOTE">"log-highlight-messages"</span> is set to 1, <span class="APPLICATION">Privoxy</span>
       will highlight portions of the log messages with a bold-faced font:</p>
-      <p class="LITERALLAYOUT"><tt class="LITERAL">&nbsp;&nbsp;<span class="emphasis"><i class=
-      "EMPHASIS">log-highlight-messages 1</i></span><br>
-      &nbsp;&nbsp;&nbsp;</tt></p><a name="LOG-FONT-NAME" id="LOG-FONT-NAME"></a>
+      <p class="LITERALLAYOUT">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">log-highlight-messages
+      1</i></span></p><a name="LOG-FONT-NAME" id="LOG-FONT-NAME"></a>
       <p>The font used in the console window:</p>
-      <p class="LITERALLAYOUT"><tt class="LITERAL">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">log-font-name
-      Comic Sans MS</i></span><br>
-      &nbsp;&nbsp;&nbsp;</tt></p><a name="LOG-FONT-SIZE" id="LOG-FONT-SIZE"></a>
+      <p class="LITERALLAYOUT">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">log-font-name Comic Sans
+      MS</i></span></p><a name="LOG-FONT-SIZE" id="LOG-FONT-SIZE"></a>
       <p>Font size used in the console window:</p>
-      <p class="LITERALLAYOUT"><tt class="LITERAL">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">log-font-size
-      8</i></span><br>
-      &nbsp;&nbsp;&nbsp;</tt></p><a name="SHOW-ON-TASK-BAR" id="SHOW-ON-TASK-BAR"></a>
+      <p class="LITERALLAYOUT">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">log-font-size
+      8</i></span></p><a name="SHOW-ON-TASK-BAR" id="SHOW-ON-TASK-BAR"></a>
       <p><span class="QUOTE">"show-on-task-bar"</span> controls whether or not <span class="APPLICATION">Privoxy</span>
       will appear as a button on the Task bar when minimized:</p>
-      <p class="LITERALLAYOUT"><tt class="LITERAL">&nbsp;&nbsp;<span class="emphasis"><i class=
-      "EMPHASIS">show-on-task-bar 0</i></span><br>
-      &nbsp;&nbsp;&nbsp;</tt></p><a name="CLOSE-BUTTON-MINIMIZES" id="CLOSE-BUTTON-MINIMIZES"></a>
+      <p class="LITERALLAYOUT">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">show-on-task-bar
+      0</i></span></p><a name="CLOSE-BUTTON-MINIMIZES" id="CLOSE-BUTTON-MINIMIZES"></a>
       <p>If <span class="QUOTE">"close-button-minimizes"</span> is set to 1, the Windows close button will minimize
       <span class="APPLICATION">Privoxy</span> instead of closing the program (close with the exit option on the File
       menu).</p>
-      <p class="LITERALLAYOUT"><tt class="LITERAL">&nbsp;&nbsp;<span class="emphasis"><i class=
-      "EMPHASIS">close-button-minimizes 1</i></span><br>
-      &nbsp;&nbsp;&nbsp;</tt></p><a name="HIDE-CONSOLE" id="HIDE-CONSOLE"></a>
+      <p class="LITERALLAYOUT">&nbsp;&nbsp;<span class="emphasis"><i class="EMPHASIS">close-button-minimizes
+      1</i></span></p><a name="HIDE-CONSOLE" id="HIDE-CONSOLE"></a>
       <p>The <span class="QUOTE">"hide-console"</span> option is specific to the MS-Win console version of <span class=
       "APPLICATION">Privoxy</span>. If this option is used, <span class="APPLICATION">Privoxy</span> will disconnect
       from and hide the command console.</p>
-      <p class="LITERALLAYOUT"><tt class="LITERAL">&nbsp;&nbsp;#<span class="emphasis"><i class=
-      "EMPHASIS">hide-console</i></span><br>
-      &nbsp;&nbsp;&nbsp;</tt></p>
+      <p class="LITERALLAYOUT">&nbsp;&nbsp;#<span class="emphasis"><i class="EMPHASIS">hide-console</i></span></p>
     </div>
   </div>
   <div class="NAVFOOTER">