From 37e01aa0ee434c20c270b669587a4419279a9c7e Mon Sep 17 00:00:00 2001
From: Fabian Keil <fk@fabiankeil.de>
Date: Mon, 26 Jun 2017 12:15:27 +0000
Subject: [PATCH] Rebuild the user manual with listen-backlog documentation
Sponsored by: Robert Klemme
---
doc/webserver/developer-manual/coding.html | 8 +--
doc/webserver/developer-manual/index.html | 4 +-
doc/webserver/user-manual/actions-file.html | 2 +-
doc/webserver/user-manual/appendix.html | 26 ++++----
doc/webserver/user-manual/config.html | 70 ++++++++++++++++++---
doc/webserver/user-manual/index.html | 16 ++---
6 files changed, 91 insertions(+), 35 deletions(-)
diff --git a/doc/webserver/developer-manual/coding.html b/doc/webserver/developer-manual/coding.html
index 800fa834..3dd280e0 100644
--- a/doc/webserver/developer-manual/coding.html
+++ b/doc/webserver/developer-manual/coding.html
@@ -1129,10 +1129,10 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;</pre>
</tr>
</table>
<p><span class="emphasis"><i class="EMPHASIS">Note:</i></span> This
- declares the rcs variables that should be added to the
- "show-proxy-args" page. If this is a brand new creation by you, you are
- free to change the "Copyright" section to represent the rights you wish
- to maintain.</p>
+ declares the rcs variables that should be added to the "show-version"
+ page. If this is a brand new creation by you, you are free to change
+ the "Copyright" section to represent the rights you wish to
+ maintain.</p>
<p><span class="emphasis"><i class="EMPHASIS">Note:</i></span> The
formfeed character that is present right after the comment flower box
is handy for (X|GNU)Emacs users to skip the verbiage and get to the
diff --git a/doc/webserver/developer-manual/index.html b/doc/webserver/developer-manual/index.html
index 36be1f97..fccfc66c 100644
--- a/doc/webserver/developer-manual/index.html
+++ b/doc/webserver/developer-manual/index.html
@@ -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.82 2017/01/23
- 12:59:45 fabiankeil Exp $<br></p>
+ <p class="PUBDATE">$Id: developer-manual.sgml,v 2.83 2017/06/08
+ 13:08:39 fabiankeil Exp $<br></p>
<div>
<div class="ABSTRACT">
<a name="AEN9" id="AEN9"></a>
diff --git a/doc/webserver/user-manual/actions-file.html b/doc/webserver/user-manual/actions-file.html
index 401c1778..970b20f5 100644
--- a/doc/webserver/user-manual/actions-file.html
+++ b/doc/webserver/user-manual/actions-file.html
@@ -100,7 +100,7 @@
<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="AEN2859" id="AEN2859"></a>
+ <a name="AEN2892" id="AEN2892"></a>
<p><b>Table 1. Default Configurations</b></p>
<table border="1" frame="border" rules="all" class="CALSTABLE">
<col width="1*" title="C1">
diff --git a/doc/webserver/user-manual/appendix.html b/doc/webserver/user-manual/appendix.html
index 42b24a2a..f1cb35b9 100644
--- a/doc/webserver/user-manual/appendix.html
+++ b/doc/webserver/user-manual/appendix.html
@@ -280,7 +280,7 @@
either.</p>
<ul>
<li>
- <p>Privoxy main page:</p><a name="AEN6034" id="AEN6034"></a>
+ <p>Privoxy main page:</p><a name="AEN6067" id="AEN6067"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/" target=
"_top">http://config.privoxy.org/</a></p>
@@ -292,32 +292,32 @@
</li>
<li>
<p>Show information about the current configuration, including
- viewing and editing of actions files:</p><a name="AEN6042" id=
- "AEN6042"></a>
+ viewing and editing of actions files:</p><a name="AEN6075" id=
+ "AEN6075"></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="AEN6047" id=
- "AEN6047"></a>
+ <p>Show the source code version numbers:</p><a name="AEN6080" id=
+ "AEN6080"></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="AEN6052" id=
- "AEN6052"></a>
+ <p>Show the browser's request headers:</p><a name="AEN6085" id=
+ "AEN6085"></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="AEN6057"
- id="AEN6057"></a>
+ <p>Show which actions apply to a URL and why:</p><a name="AEN6090"
+ id="AEN6090"></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>
@@ -329,17 +329,17 @@
<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=
- "AEN6065" id="AEN6065"></a>
+ "AEN6098" id="AEN6098"></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="AEN6069" id=
- "AEN6069"></a>
+ <p>Short cuts. Turn off, then on:</p><a name="AEN6102" id=
+ "AEN6102"></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="AEN6072" id="AEN6072"></a>
+ </blockquote><a name="AEN6105" id="AEN6105"></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>
diff --git a/doc/webserver/user-manual/config.html b/doc/webserver/user-manual/config.html
index a5920cee..293d332b 100644
--- a/doc/webserver/user-manual/config.html
+++ b/doc/webserver/user-manual/config.html
@@ -2333,9 +2333,63 @@
</dl>
</div>
</div>
+ <div class="SECT3">
+ <h4 class="SECT3"><a name="LISTEN-BACKLOG" id=
+ "LISTEN-BACKLOG">7.6.10. listen-backlog</a></h4>
+ <div class="VARIABLELIST">
+ <dl>
+ <dt>Specifies:</dt>
+ <dd>
+ <p>Connection queue length requested from the operating
+ system.</p>
+ </dd>
+ <dt>Type of value:</dt>
+ <dd>
+ <p><tt class="REPLACEABLE"><i>Number.</i></tt></p>
+ </dd>
+ <dt>Default value:</dt>
+ <dd>
+ <p>128</p>
+ </dd>
+ <dt>Effect if unset:</dt>
+ <dd>
+ <p>A connection queue length of 128 is requested from the
+ operating system.</p>
+ </dd>
+ <dt>Notes:</dt>
+ <dd>
+ <p>Under high load incoming connection may queue up before
+ Privoxy gets around to serve them. The queue length is limitted
+ by the operating system. Once the queue is full, additional
+ connections are dropped before Privoxy can accept and serve
+ them.</p>
+ <p>Increasing the queue length allows Privoxy to accept more
+ incomming connections that arrive roughly at the same time.</p>
+ <p>Note that Privoxy can only request a certain queue length,
+ whether or not the requested length is actually used depends on
+ the operating system which may use a different length
+ instead.</p>
+ <p>On many operating systems a limit of -1 can be specified to
+ instruct the operating system to use the maximum queue length
+ allowed. Check the listen man page to see if your platform
+ allows this.</p>
+ <p>On some platforms you can use "netstat -Lan -p tcp" to see
+ the effective queue length.</p>
+ <p>Effectively using a value above 128 usually requires
+ changing the system configuration as well. On FreeBSD-based
+ system the limit is controlled by the kern.ipc.soacceptqueue
+ sysctl.</p>
+ </dd>
+ <dt>Examples:</dt>
+ <dd>
+ <p>listen-backlog 4096</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.10.
+ "HANDLE-AS-EMPTY-DOC-RETURNS-OK">7.6.11.
handle-as-empty-doc-returns-ok</a></h4>
<div class="VARIABLELIST">
<dl>
@@ -2382,7 +2436,7 @@
</div>
<div class="SECT3">
<h4 class="SECT3"><a name="ENABLE-COMPRESSION" id=
- "ENABLE-COMPRESSION">7.6.11. enable-compression</a></h4>
+ "ENABLE-COMPRESSION">7.6.12. enable-compression</a></h4>
<div class="VARIABLELIST">
<dl>
<dt>Specifies:</dt>
@@ -2425,7 +2479,7 @@
</div>
<div class="SECT3">
<h4 class="SECT3"><a name="COMPRESSION-LEVEL" id=
- "COMPRESSION-LEVEL">7.6.12. compression-level</a></h4>
+ "COMPRESSION-LEVEL">7.6.13. compression-level</a></h4>
<div class="VARIABLELIST">
<dl>
<dt>Specifies:</dt>
@@ -2479,7 +2533,7 @@
</div>
<div class="SECT3">
<h4 class="SECT3"><a name="CLIENT-HEADER-ORDER" id=
- "CLIENT-HEADER-ORDER">7.6.13. client-header-order</a></h4>
+ "CLIENT-HEADER-ORDER">7.6.14. client-header-order</a></h4>
<div class="VARIABLELIST">
<dl>
<dt>Specifies:</dt>
@@ -2517,7 +2571,7 @@
</div>
<div class="SECT3">
<h4 class="SECT3"><a name="CLIENT-SPECIFIC-TAG" id=
- "CLIENT-SPECIFIC-TAG">7.6.14. client-specific-tag</a></h4>
+ "CLIENT-SPECIFIC-TAG">7.6.15. client-specific-tag</a></h4>
<div class="VARIABLELIST">
<dl>
<dt>Specifies:</dt>
@@ -2600,7 +2654,7 @@
</div>
<div class="SECT3">
<h4 class="SECT3"><a name="CLIENT-TAG-LIFETIME" id=
- "CLIENT-TAG-LIFETIME">7.6.15. client-tag-lifetime</a></h4>
+ "CLIENT-TAG-LIFETIME">7.6.16. client-tag-lifetime</a></h4>
<div class="VARIABLELIST">
<dl>
<dt>Specifies:</dt>
@@ -2658,7 +2712,7 @@
</div>
<div class="SECT3">
<h4 class="SECT3"><a name="TRUST-X-FORWARDED-FOR" id=
- "TRUST-X-FORWARDED-FOR">7.6.16. trust-x-forwarded-for</a></h4>
+ "TRUST-X-FORWARDED-FOR">7.6.17. trust-x-forwarded-for</a></h4>
<div class="VARIABLELIST">
<dl>
<dt>Specifies:</dt>
@@ -2727,7 +2781,7 @@
</div>
<div class="SECT3">
<h4 class="SECT3"><a name="RECEIVE-BUFFER-SIZE" id=
- "RECEIVE-BUFFER-SIZE">7.6.17. receive-buffer-size</a></h4>
+ "RECEIVE-BUFFER-SIZE">7.6.18. receive-buffer-size</a></h4>
<div class="VARIABLELIST">
<dl>
<dt>Specifies:</dt>
diff --git a/doc/webserver/user-manual/index.html b/doc/webserver/user-manual/index.html
index c25dc20d..10a79603 100644
--- a/doc/webserver/user-manual/index.html
+++ b/doc/webserver/user-manual/index.html
@@ -245,20 +245,22 @@
<dt>7.6.9. <a href=
"config.html#MAX-CLIENT-CONNECTIONS">max-client-connections</a></dt>
<dt>7.6.10. <a href=
- "config.html#HANDLE-AS-EMPTY-DOC-RETURNS-OK">handle-as-empty-doc-returns-ok</a></dt>
+ "config.html#LISTEN-BACKLOG">listen-backlog</a></dt>
<dt>7.6.11. <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.12. <a href=
- "config.html#COMPRESSION-LEVEL">compression-level</a></dt>
+ "config.html#ENABLE-COMPRESSION">enable-compression</a></dt>
<dt>7.6.13. <a href=
- "config.html#CLIENT-HEADER-ORDER">client-header-order</a></dt>
+ "config.html#COMPRESSION-LEVEL">compression-level</a></dt>
<dt>7.6.14. <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.15. <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.16. <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.17. <a href=
+ "config.html#TRUST-X-FORWARDED-FOR">trust-x-forwarded-for</a></dt>
+ <dt>7.6.18. <a href=
"config.html#RECEIVE-BUFFER-SIZE">receive-buffer-size</a></dt>
</dl>
</dd>
--
2.49.0