Rebuild HTML docs
authorFabian Keil <fk@fabiankeil.de>
Thu, 8 Jun 2017 13:10:42 +0000 (13:10 +0000)
committerFabian Keil <fk@fabiankeil.de>
Thu, 8 Jun 2017 13:10:42 +0000 (13:10 +0000)
Sponsored by: Robert Klemme

16 files changed:
doc/webserver/developer-manual/documentation.html
doc/webserver/developer-manual/index.html
doc/webserver/developer-manual/newrelease.html
doc/webserver/faq/configuration.html
doc/webserver/faq/contact.html
doc/webserver/faq/copyright.html
doc/webserver/faq/general.html
doc/webserver/faq/index.html
doc/webserver/faq/misc.html
doc/webserver/index.html
doc/webserver/privoxy-index.html
doc/webserver/user-manual/actions-file.html
doc/webserver/user-manual/appendix.html
doc/webserver/user-manual/config.html
doc/webserver/user-manual/copyright.html
doc/webserver/user-manual/index.html

index 0c7c9c2..2a05f2e 100644 (file)
                 <td><span class="emphasis"><i class=
                 "EMPHASIS">p-version</i></span>: the <span class=
                 "APPLICATION">Privoxy</span> version string, e.g.
-                <span class="QUOTE">"3.0.26"</span>.</td>
+                <span class="QUOTE">"3.0.27"</span>.</td>
               </tr>
               <tr>
                 <td><span class="emphasis"><i class=
index 907170f..36be1f9 100644 (file)
@@ -19,8 +19,8 @@
       "https://www.privoxy.org/user-manual/copyright.html" target=
       "_top">Copyright</a> � 2001-2016 by <a href="https://www.privoxy.org/"
       target="_top">Privoxy Developers</a></sub><br></p>
-      <p class="PUBDATE">$Id: developer-manual.sgml,v 2.81 2016/08/26
-      12:32:19 fabiankeil Exp $<br></p>
+      <p class="PUBDATE">$Id: developer-manual.sgml,v 2.82 2017/01/23
+      12:59:45 fabiankeil Exp $<br></p>
       <div>
         <div class="ABSTRACT">
           <a name="AEN9" id="AEN9"></a>
@@ -31,7 +31,7 @@
           the team. Note that it's currently out of date and may not be
           entirely correct. As always, patches are welcome.</p>
           <p>Please note that this document is constantly evolving. This copy
-          represents the state at the release of version 3.0.26. You can find
+          represents the state at the release of version 3.0.27. You can find
           the latest version of the this manual at <a href=
           "https://www.privoxy.org/developer-manual/" target=
           "_top">https://www.privoxy.org/developer-manual/</a>. Please have a
index a5dc71a..04edd94 100644 (file)
@@ -618,7 +618,7 @@ for-privoxy-version=3.0.11</pre>
           <tr>
             <td>
               <pre class="PROGRAMLISTING">
-              debchange -v 3.0.26-stable-1 "New upstream version"</pre>
+              debchange -v 3.0.27-UNRELEASED-1 "New upstream version"</pre>
             </td>
           </tr>
         </table>
@@ -632,7 +632,7 @@ for-privoxy-version=3.0.11</pre>
           </tr>
         </table>
         <p>This will create <tt class=
-        "FILENAME">../privoxy_3.0.26-stable-1_i386.deb</tt> which can be
+        "FILENAME">../privoxy_3.0.27-UNRELEASED-1_i386.deb</tt> which can be
         uploaded. To upload the package to Sourceforge, simply issue</p>
         <table border="0" bgcolor="#E0E0E0" width="100%">
           <tr>
@@ -786,7 +786,7 @@ for-privoxy-version=3.0.11</pre>
       column, and click <tt class="LITERAL">Add Release</tt>. You will then
       need to create a new release for your package, using the format of
       <tt class="LITERAL">$VERSION ($CODE_STATUS)</tt>, e.g. <span class=
-      "emphasis"><i class="EMPHASIS">3.0.26 (beta)</i></span>.</p>
+      "emphasis"><i class="EMPHASIS">3.0.27 (beta)</i></span>.</p>
       <p>Now just follow the prompts. Be sure to add any appropriate Release
       notes. You should see your freshly uploaded packages in <span class=
       "QUOTE">"Step 2. Add Files To This Release"</span>. Check the
index 3f1c67a..091ce62 100644 (file)
@@ -92,7 +92,7 @@
       "_top">enable-edit-actions</a>).</p>
     </div>
     <div class="SECT2">
-      <h3 class="SECT2"><a name="AEN418" id="AEN418">3.4. There are several
+      <h3 class="SECT2"><a name="AEN420" id="AEN420">3.4. There are several
       different <span class="QUOTE">"actions"</span> files. What are the
       differences?</a></h3>
       <p>Please have a look at the <a href="../user-manual/actions-file.html"
index e64160d..8a207ad 100644 (file)
 
           debug&nbsp;&nbsp;4096&nbsp;#&nbsp;Startup&nbsp;banner&nbsp;and&nbsp;warnings.<br>
 
-          debug&nbsp;&nbsp;8192&nbsp;#&nbsp;Non-fatal&nbsp;errors</p>
+          debug&nbsp;&nbsp;8192&nbsp;#&nbsp;Non-fatal&nbsp;errors<br>
+          debug&nbsp;65536&nbsp;#&nbsp;Log&nbsp;applying&nbsp;actions</p>
           <p>If you are having trouble with a filter, please additionally
           enable</p>
           <p class="LITERALLAYOUT">
           debug&nbsp;&nbsp;&nbsp;&nbsp;64&nbsp;#&nbsp;debug&nbsp;regular&nbsp;expression&nbsp;filters</p>If
-          you are using Privoxy 3.0.17 or later and suspect that it
-          interprets the request or the response incorrectly, please enable
+          you suspect that Privoxy interprets the request or the response
+          incorrectly, please enable
           <p class="LITERALLAYOUT">
           debug&nbsp;32768&nbsp;#&nbsp;log&nbsp;all&nbsp;data&nbsp;read&nbsp;from&nbsp;the&nbsp;network</p>
           <p>It's easy for us to ignore log messages that aren't relevant but
index 428024e..79b9440 100644 (file)
@@ -45,7 +45,7 @@
     and modified as appropriate for <span class=
     "APPLICATION">Privoxy</span>.</p>
     <div class="SECT2">
-      <h2 class="SECT2"><a name="AEN1505" id="AEN1505">7.1. License</a></h2>
+      <h2 class="SECT2"><a name="AEN1507" id="AEN1507">7.1. License</a></h2>
       <p><span class="APPLICATION">Privoxy</span> is free software; you can
       redistribute it and/or modify it under the terms of the <i class=
       "CITETITLE">GNU General Public License</i>, version 2, as published by
@@ -58,7 +58,7 @@
       "_top"><i class="CITETITLE">license</i></a> for details.</p>
     </div>
     <div class="SECT2">
-      <h2 class="SECT2"><a name="AEN1514" id="AEN1514">7.2. History</a></h2>
+      <h2 class="SECT2"><a name="AEN1516" id="AEN1516">7.2. History</a></h2>
       <p>A long time ago, there was the <span class="APPLICATION">Internet
       Junkbuster</span>, by Anonymous Coders and Junkbusters Corporation.
       This saved many users a lot of pain in the early days of web
index c1500b5..9fdbcd8 100644 (file)
         <p><span class="APPLICATION">Privoxy</span> is an associated project
         of <a href="http://www.spi-inc.org/" target="_top">Software in the
         Public Interest (SPI)</a>, which allows us to receive tax-deductible
-        donations in the United States. If you want to donate through SPI,
-        please use <a href="http://www.spi-inc.org/donations" target=
-        "_top">SPI's donation page</a> to see what the options are.</p>
+        donations in the United States. You can <a href=
+        "https://www.spi-inc.org/projects/privoxy/" target="_top">donate via
+        Paypal</a> and <a href=
+        "https://co.clickandpledge.com/advanced/default.aspx?wid=34115"
+        target="_top">Click &amp; Pledge</a>. For details, please have a look
+        at <a href="http://www.spi-inc.org/donations" target="_top">SPI's
+        general donation page</a>.</p>
         <p>You can also donate to Privoxy using a bank account or a "Paypal"
         address:</p>
         <p class="LITERALLAYOUT">
index 9a2eb32..fe42935 100644 (file)
@@ -18,7 +18,7 @@
       <p class="PUBDATE"><sub><a href="copyright.html">Copyright</a> �
       2001-2016 by <a href="https://www.privoxy.org/" target="_top">Privoxy
       Developers</a></sub><br></p>
-      <p class="PUBDATE">$Id: faq.sgml,v 2.131 2016/08/26 12:27:34 fabiankeil
+      <p class="PUBDATE">$Id: faq.sgml,v 2.135 2017/03/27 10:22:27 fabiankeil
       Exp $<br></p>
       <div>
         <div class="ABSTRACT">
@@ -52,7 +52,7 @@
             </li>
           </ul>
           <p>Please note that this document is a work in progress. This copy
-          represents the state at the release of version 3.0.26. You can find
+          represents the state at the release of version 3.0.27. You can find
           the latest version of the document at <a href=
           "https://www.privoxy.org/faq/" target=
           "_top">https://www.privoxy.org/faq/</a>. Please see the <a href=
             these <span class="QUOTE">"actions"</span>.</a></dt>
             <dt>3.3. <a href="configuration.html#ACTCONFIG">How are actions
             files configured? What is the easiest way to do this?</a></dt>
-            <dt>3.4. <a href="configuration.html#AEN418">There are several
+            <dt>3.4. <a href="configuration.html#AEN420">There are several
             different <span class="QUOTE">"actions"</span> files. What are
             the differences?</a></dt>
             <dt>3.5. <a href="configuration.html#GETUPDATES">Where can I get
         History</a></dt>
         <dd>
           <dl>
-            <dt>7.1. <a href="copyright.html#AEN1505">License</a></dt>
-            <dt>7.2. <a href="copyright.html#AEN1514">History</a></dt>
+            <dt>7.1. <a href="copyright.html#AEN1507">License</a></dt>
+            <dt>7.2. <a href="copyright.html#AEN1516">History</a></dt>
           </dl>
         </dd>
       </dl>
index 6aa2bb0..93154cf 100644 (file)
       Privoxy <span class="QUOTE">"crunches"</span> ads, but also its own
       internal CGI pages. What is a <span class=
       "QUOTE">"crunch"</span>?</a></h3>
-      <p>A <span class="QUOTE">"crunch"</span> simply means <span class=
+      <p>A <span class="QUOTE">"crunch"</span> means <span class=
       "APPLICATION">Privoxy</span> intercepted <span class=
       "emphasis"><i class="EMPHASIS">something</i></span>, nothing more.
       Often this is indeed ads or banners, but <span class=
index 28e70b7..3444ff2 100644 (file)
@@ -42,7 +42,7 @@
             </li>
           </ul>
           <p>The most recent release is <a href="announce.txt" target=
-          "_top">3.0.26 (stable)</a>.</p>
+          "_top">3.0.27 (UNRELEASED)</a>.</p>
         </div>
       </div>
       <hr>
index 039be7c..c2155fe 100644 (file)
@@ -16,7 +16,7 @@
     <div class="TITLEPAGE">
       <h1 class="TITLE"><a name="AEN2" id="AEN2">Privoxy - The Privacy
       Enhancing Proxy</a></h1>
-      <h2 class="SUBTITLE">Project Index Page v3.0.26</h2>
+      <h2 class="SUBTITLE">Project Index Page v3.0.27</h2>
       <div>
         <div class="ABSTRACT">
           <a name="AEN5" id="AEN5"></a>
     <div class="SECT1">
       <hr>
       <h2 class="SECT1"><a name="AEN61" id="AEN61"></a></h2>
-      <p><sub>Copyright © 2001-2016 by Privoxy Developers</sub></p>
+      <p><sub>Copyright © 2001-2017 by Privoxy Developers</sub></p>
     </div>
   </div>
 </body>
index 68cf2b6..401c177 100644 (file)
         <p>The default profiles, and their associated actions, as pre-defined
         in <tt class="FILENAME">default.action</tt> are:</p>
         <div class="TABLE">
-          <a name="AEN2829" id="AEN2829"></a>
+          <a name="AEN2859" id="AEN2859"></a>
           <p><b>Table 1. Default Configurations</b></p>
           <table border="1" frame="border" rules="all" class="CALSTABLE">
             <col width="1*" title="C1">
               page named <span class="QUOTE">"index.html"</span> regardless
               of path which in this case can have one or more <span class=
               "QUOTE">"/'s"</span>. And this one must contain exactly
-              <span class="QUOTE">".html"</span> (but does not have to end
-              with that!).</p>
+              <span class="QUOTE">".html"</span> (and end with that!).</p>
             </dd>
             <dt><tt class=
             "LITERAL">.example.com/(.*/)(ads|banners?|junk)</tt></dt>
               "QUOTE">"banner"</span>, <span class="QUOTE">"banners"</span>
               (because of the <span class="QUOTE">"?"</span>) or <span class=
               "QUOTE">"junk"</span>. The path does not have to end in these
-              words, just contain them.</p>
+              words, just contain them. The path has to contain at least two
+              slashes (including the one at the beginning).</p>
             </dd>
             <dt><tt class=
             "LITERAL">.example.com/(.*/)(ads|banners?|junk)/.*\.(jpe?g|gif|png)$</tt></dt>
@@ -1156,6 +1156,25 @@ TAG:^RANGE-REQUEST$
                   </td>
                 </tr>
               </table>
+              <table border="0" bgcolor="#E0E0E0" width="90%">
+                <tr>
+                  <td>
+                    <pre class="SCREEN">
+                    # Tag all requests with the client IP address
+#
+# (Technically the client IP address isn't included in the
+# client headers but client-header taggers can set it anyway.
+# For details see the tagger in default.filter)
+{+client-header-tagger{client-ip-address}}
+/
+
+# Change forwarding settings for requests coming from address 10.0.0.1
+{+forward-override{forward-socks5 127.0.1.2:2222 .}}
+TAG:^IP-ADDRESS: 10\.0\.0\.1$
+     </pre>
+                  </td>
+                </tr>
+              </table>
             </dd>
           </dl>
         </div>
index 84ea687..42b24a2 100644 (file)
       either.</p>
       <ul>
         <li>
-          <p>Privoxy main page:</p><a name="AEN6002" id="AEN6002"></a>
+          <p>Privoxy main page:</p><a name="AEN6034" id="AEN6034"></a>
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/" target=
             "_top">http://config.privoxy.org/</a></p>
         </li>
         <li>
           <p>Show information about the current configuration, including
-          viewing and editing of actions files:</p><a name="AEN6010" id=
-          "AEN6010"></a>
+          viewing and editing of actions files:</p><a name="AEN6042" id=
+          "AEN6042"></a>
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/show-status" target=
             "_top">http://config.privoxy.org/show-status</a></p>
           </blockquote>
         </li>
         <li>
-          <p>Show the source code version numbers:</p><a name="AEN6015" id=
-          "AEN6015"></a>
+          <p>Show the source code version numbers:</p><a name="AEN6047" id=
+          "AEN6047"></a>
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/show-version" target=
             "_top">http://config.privoxy.org/show-version</a></p>
           </blockquote>
         </li>
         <li>
-          <p>Show the browser's request headers:</p><a name="AEN6020" id=
-          "AEN6020"></a>
+          <p>Show the browser's request headers:</p><a name="AEN6052" id=
+          "AEN6052"></a>
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/show-request" target=
             "_top">http://config.privoxy.org/show-request</a></p>
           </blockquote>
         </li>
         <li>
-          <p>Show which actions apply to a URL and why:</p><a name="AEN6025"
-          id="AEN6025"></a>
+          <p>Show which actions apply to a URL and why:</p><a name="AEN6057"
+          id="AEN6057"></a>
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/show-url-info" target=
             "_top">http://config.privoxy.org/show-url-info</a></p>
           <span class="QUOTE">"off"</span>, <span class=
           "QUOTE">"Privoxy"</span> continues to run, but only as a
           pass-through proxy, with no actions taking place:</p><a name=
-          "AEN6033" id="AEN6033"></a>
+          "AEN6065" id="AEN6065"></a>
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/toggle" target=
             "_top">http://config.privoxy.org/toggle</a></p>
           </blockquote>
-          <p>Short cuts. Turn off, then on:</p><a name="AEN6037" id=
-          "AEN6037"></a>
+          <p>Short cuts. Turn off, then on:</p><a name="AEN6069" id=
+          "AEN6069"></a>
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/toggle?set=disable" target=
             "_top">http://config.privoxy.org/toggle?set=disable</a></p>
-          </blockquote><a name="AEN6040" id="AEN6040"></a>
+          </blockquote><a name="AEN6072" id="AEN6072"></a>
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/toggle?set=enable" target=
             "_top">http://config.privoxy.org/toggle?set=enable</a></p>
index e4c0a71..a5920ce 100644 (file)
                     # Allow systems that can reach Privoxy to provide the client
       # IP address with a X-Forwarded-For header.
       trust-x-forwarded-for 1
+    </pre>
+                  </td>
+                </tr>
+              </table>
+            </dd>
+          </dl>
+        </div>
+      </div>
+      <div class="SECT3">
+        <h4 class="SECT3"><a name="RECEIVE-BUFFER-SIZE" id=
+        "RECEIVE-BUFFER-SIZE">7.6.17. receive-buffer-size</a></h4>
+        <div class="VARIABLELIST">
+          <dl>
+            <dt>Specifies:</dt>
+            <dd>
+              <p>The size of the buffer Privoxy uses to receive data from the
+              server.</p>
+            </dd>
+            <dt>Type of value:</dt>
+            <dd>
+              <p><tt class="REPLACEABLE"><i>Size in bytes</i></tt></p>
+            </dd>
+            <dt>Default value:</dt>
+            <dd>
+              <p>5000</p>
+            </dd>
+            <dt>Notes:</dt>
+            <dd>
+              <p>Increasing the receive-buffer-size increases Privoxy's
+              memory usage but can lower the number of context switches and
+              thereby reduce the cpu usage and potentially increase the
+              throughput.</p>
+              <p>This is mostly relevant for fast network connections and
+              large downloads that don't require filtering.</p>
+              <p>Reducing the buffer size reduces the amount of memory
+              Privoxy needs to handle the request but increases the number of
+              systemcalls and may reduce the throughput.</p>
+              <p>A dtrace command like: <span class="QUOTE">"sudo dtrace -n
+              'syscall::read:return /execname == "privoxy"/ { @[execname] =
+              llquantize(arg0, 10, 0, 5, 20); @m = max(arg0)}'"</span> can be
+              used to properly tune the receive-buffer-size. On systems
+              without dtrace, strace or truss may be used as less convenient
+              alternatives.</p>
+              <p>If the buffer is too large it will increase Privoxy's memory
+              footprint without any benefit. As the memory is (currently)
+              cleared before using it, a buffer that is too large can
+              actually reduce the throughput.</p>
+            </dd>
+            <dt>Examples:</dt>
+            <dd>
+              <table border="0" bgcolor="#E0E0E0" width="90%">
+                <tr>
+                  <td>
+                    <pre class="SCREEN">
+                    # Increase the receive buffer size
+      receive-buffer-size 32768
     </pre>
                   </td>
                 </tr>
index 0c2ef9f..3ef95c9 100644 (file)
@@ -559,6 +559,7 @@ Public License instead of this License.
       &nbsp;Gregory&nbsp;Seidman<br>
       &nbsp;Atman&nbsp;Sense<br>
       &nbsp;Chung-chieh&nbsp;Shan<br>
+      &nbsp;Johan&nbsp;Sintorn<br>
       &nbsp;Benjamin&nbsp;C.&nbsp;Wiley&nbsp;Sittler<br>
       &nbsp;Simon&nbsp;South<br>
       &nbsp;Dan&nbsp;Stahlke<br>
index 5825e3b..c25dc20 100644 (file)
@@ -17,9 +17,9 @@
       <h1 class="TITLE"><a name="AEN2" id="AEN2">Privoxy 3.0.27 User
       Manual</a></h1>
       <p class="PUBDATE"><sub><a href="copyright.html">Copyright</a> �
-      2001-2016 by <a href="https://www.privoxy.org/" target="_top">Privoxy
+      2001-2017 by <a href="https://www.privoxy.org/" target="_top">Privoxy
       Developers</a></sub><br></p>
-      <p class="PUBDATE">$Id: user-manual.sgml,v 2.217 2017/01/23 12:59:45
+      <p class="PUBDATE">$Id: user-manual.sgml,v 2.222 2017/05/20 09:28:11
       fabiankeil Exp $<br></p>
       <div>
         <div class="ABSTRACT">
                 "config.html#CLIENT-TAG-LIFETIME">client-tag-lifetime</a></dt>
                 <dt>7.6.16. <a href=
                 "config.html#TRUST-X-FORWARDED-FOR">trust-x-forwarded-for</a></dt>
+                <dt>7.6.17. <a href=
+                "config.html#RECEIVE-BUFFER-SIZE">receive-buffer-size</a></dt>
               </dl>
             </dd>
             <dt>7.7. <a href="config.html#WINDOWS-GUI">Windows GUI