Rebuild user-manual with enable-accept-filter documentation
authorFabian Keil <fk@fabiankeil.de>
Mon, 26 Jun 2017 12:16:47 +0000 (12:16 +0000)
committerFabian Keil <fk@fabiankeil.de>
Mon, 26 Jun 2017 12:16:47 +0000 (12:16 +0000)
Sponsored by: Robert Klemme

doc/webserver/user-manual/actions-file.html
doc/webserver/user-manual/appendix.html
doc/webserver/user-manual/config.html
doc/webserver/user-manual/index.html

index 970b20f..dfcddf5 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="AEN2892" id="AEN2892"></a>
+          <a name="AEN2924" id="AEN2924"></a>
           <p><b>Table 1. Default Configurations</b></p>
           <table border="1" frame="border" rules="all" class="CALSTABLE">
             <col width="1*" title="C1">
index f1cb35b..fc871c0 100644 (file)
       either.</p>
       <ul>
         <li>
-          <p>Privoxy main page:</p><a name="AEN6067" id="AEN6067"></a>
+          <p>Privoxy main page:</p><a name="AEN6099" id="AEN6099"></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="AEN6075" id=
-          "AEN6075"></a>
+          viewing and editing of actions files:</p><a name="AEN6107" id=
+          "AEN6107"></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="AEN6080" id=
-          "AEN6080"></a>
+          <p>Show the source code version numbers:</p><a name="AEN6112" id=
+          "AEN6112"></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="AEN6085" id=
-          "AEN6085"></a>
+          <p>Show the browser's request headers:</p><a name="AEN6117" id=
+          "AEN6117"></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="AEN6090"
-          id="AEN6090"></a>
+          <p>Show which actions apply to a URL and why:</p><a name="AEN6122"
+          id="AEN6122"></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=
-          "AEN6098" id="AEN6098"></a>
+          "AEN6130" id="AEN6130"></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="AEN6102" id=
-          "AEN6102"></a>
+          <p>Short cuts. Turn off, then on:</p><a name="AEN6134" id=
+          "AEN6134"></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="AEN6105" id="AEN6105"></a>
+          </blockquote><a name="AEN6137" id="AEN6137"></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 293d332..ca35aab 100644 (file)
           </dl>
         </div>
       </div>
+      <div class="SECT3">
+        <h4 class="SECT3"><a name="ENABLE-ACCEPT-FILTER" id=
+        "ENABLE-ACCEPT-FILTER">7.6.11. enable-accept-filter</a></h4>
+        <div class="VARIABLELIST">
+          <dl>
+            <dt>Specifies:</dt>
+            <dd>
+              <p>Whether or not Privoxy should use an accept filter</p>
+            </dd>
+            <dt>Type of value:</dt>
+            <dd>
+              <p><tt class="REPLACEABLE"><i>0 or 1</i></tt></p>
+            </dd>
+            <dt>Default value:</dt>
+            <dd>
+              <p>0</p>
+            </dd>
+            <dt>Effect if unset:</dt>
+            <dd>
+              <p>No accept filter is enabled.</p>
+            </dd>
+            <dt>Notes:</dt>
+            <dd>
+              <p>Accept filters reduce the number of context switches by not
+              passing sockets for new connections to Privoxy until a complete
+              HTTP request is available.</p>
+              <p>As a result, Privoxy can process the whole request right
+              away without having to wait for additional data first.</p>
+              <p>For this option to work, Privoxy has to be compiled with
+              FEATURE_ACCEPT_FILTER and the operating system has to support
+              it (which may require loading a kernel module).</p>
+              <p>Currently accept filters are only supported on FreeBSD-based
+              systems. Check the <a href=
+              "https://www.freebsd.org/cgi/man.cgi?query=accf_http" target=
+              "_top">accf_http(9) man page</a> to learn how to enable the
+              support in the operating system.</p>
+            </dd>
+            <dt>Examples:</dt>
+            <dd>
+              <p>enable-accept-filter 1</p>
+            </dd>
+          </dl>
+        </div>
+      </div>
       <div class="SECT3">
         <h4 class="SECT3"><a name="HANDLE-AS-EMPTY-DOC-RETURNS-OK" id=
-        "HANDLE-AS-EMPTY-DOC-RETURNS-OK">7.6.11.
+        "HANDLE-AS-EMPTY-DOC-RETURNS-OK">7.6.12.
         handle-as-empty-doc-returns-ok</a></h4>
         <div class="VARIABLELIST">
           <dl>
       </div>
       <div class="SECT3">
         <h4 class="SECT3"><a name="ENABLE-COMPRESSION" id=
-        "ENABLE-COMPRESSION">7.6.12. enable-compression</a></h4>
+        "ENABLE-COMPRESSION">7.6.13. enable-compression</a></h4>
         <div class="VARIABLELIST">
           <dl>
             <dt>Specifies:</dt>
       </div>
       <div class="SECT3">
         <h4 class="SECT3"><a name="COMPRESSION-LEVEL" id=
-        "COMPRESSION-LEVEL">7.6.13. compression-level</a></h4>
+        "COMPRESSION-LEVEL">7.6.14. compression-level</a></h4>
         <div class="VARIABLELIST">
           <dl>
             <dt>Specifies:</dt>
       </div>
       <div class="SECT3">
         <h4 class="SECT3"><a name="CLIENT-HEADER-ORDER" id=
-        "CLIENT-HEADER-ORDER">7.6.14. client-header-order</a></h4>
+        "CLIENT-HEADER-ORDER">7.6.15. client-header-order</a></h4>
         <div class="VARIABLELIST">
           <dl>
             <dt>Specifies:</dt>
       </div>
       <div class="SECT3">
         <h4 class="SECT3"><a name="CLIENT-SPECIFIC-TAG" id=
-        "CLIENT-SPECIFIC-TAG">7.6.15. client-specific-tag</a></h4>
+        "CLIENT-SPECIFIC-TAG">7.6.16. client-specific-tag</a></h4>
         <div class="VARIABLELIST">
           <dl>
             <dt>Specifies:</dt>
       </div>
       <div class="SECT3">
         <h4 class="SECT3"><a name="CLIENT-TAG-LIFETIME" id=
-        "CLIENT-TAG-LIFETIME">7.6.16. client-tag-lifetime</a></h4>
+        "CLIENT-TAG-LIFETIME">7.6.17. client-tag-lifetime</a></h4>
         <div class="VARIABLELIST">
           <dl>
             <dt>Specifies:</dt>
       </div>
       <div class="SECT3">
         <h4 class="SECT3"><a name="TRUST-X-FORWARDED-FOR" id=
-        "TRUST-X-FORWARDED-FOR">7.6.17. trust-x-forwarded-for</a></h4>
+        "TRUST-X-FORWARDED-FOR">7.6.18. trust-x-forwarded-for</a></h4>
         <div class="VARIABLELIST">
           <dl>
             <dt>Specifies:</dt>
       </div>
       <div class="SECT3">
         <h4 class="SECT3"><a name="RECEIVE-BUFFER-SIZE" id=
-        "RECEIVE-BUFFER-SIZE">7.6.18. receive-buffer-size</a></h4>
+        "RECEIVE-BUFFER-SIZE">7.6.19. receive-buffer-size</a></h4>
         <div class="VARIABLELIST">
           <dl>
             <dt>Specifies:</dt>
index 10a7960..8d123ea 100644 (file)
                 <dt>7.6.10. <a href=
                 "config.html#LISTEN-BACKLOG">listen-backlog</a></dt>
                 <dt>7.6.11. <a href=
-                "config.html#HANDLE-AS-EMPTY-DOC-RETURNS-OK">handle-as-empty-doc-returns-ok</a></dt>
+                "config.html#ENABLE-ACCEPT-FILTER">enable-accept-filter</a></dt>
                 <dt>7.6.12. <a href=
-                "config.html#ENABLE-COMPRESSION">enable-compression</a></dt>
+                "config.html#HANDLE-AS-EMPTY-DOC-RETURNS-OK">handle-as-empty-doc-returns-ok</a></dt>
                 <dt>7.6.13. <a href=
-                "config.html#COMPRESSION-LEVEL">compression-level</a></dt>
+                "config.html#ENABLE-COMPRESSION">enable-compression</a></dt>
                 <dt>7.6.14. <a href=
-                "config.html#CLIENT-HEADER-ORDER">client-header-order</a></dt>
+                "config.html#COMPRESSION-LEVEL">compression-level</a></dt>
                 <dt>7.6.15. <a href=
-                "config.html#CLIENT-SPECIFIC-TAG">client-specific-tag</a></dt>
+                "config.html#CLIENT-HEADER-ORDER">client-header-order</a></dt>
                 <dt>7.6.16. <a href=
-                "config.html#CLIENT-TAG-LIFETIME">client-tag-lifetime</a></dt>
+                "config.html#CLIENT-SPECIFIC-TAG">client-specific-tag</a></dt>
                 <dt>7.6.17. <a href=
-                "config.html#TRUST-X-FORWARDED-FOR">trust-x-forwarded-for</a></dt>
+                "config.html#CLIENT-TAG-LIFETIME">client-tag-lifetime</a></dt>
                 <dt>7.6.18. <a href=
+                "config.html#TRUST-X-FORWARDED-FOR">trust-x-forwarded-for</a></dt>
+                <dt>7.6.19. <a href=
                 "config.html#RECEIVE-BUFFER-SIZE">receive-buffer-size</a></dt>
               </dl>
             </dd>