protocol docs

[hippotat.git] / docs / settings.rst

diff --git a/docs/settings.rst b/docs/settings.rst
index e4cef04d7341d0a4322116870cc9b42621ef6c84..f900673389eaeff4b429f1341cf723418bc17419 100644 (file)
--- a/docs/settings.rst
+++ b/docs/settings.rst
@@ -65,13 +65,22 @@ value is obtained, it is (silently) reduced to the limit value.
 ``max_batch_down``
   Size limit for response payloads.
 
-  On client, incoming response bodies are limited to this plus
-  a fixed constant metadata overhead of 10000 bytes.
-  Server uses minimum of client and server value (old servers
-  just uses server's value).
+  On client, incoming response bodies are limited to this (plus
+  a fixed constant metadata overhead).
+  Server uses minimum of client's and server's configured values
+  (old servers just use server's value).
 
   [``65536`` (bytes); ``LIMIT``: ``262144``]
 
+``max_batch_up``
+  Size limit for request upbound payloads.  On client, used directly,
+  with ``LIMIT`` applied.
+
+  On server, only ``LIMIT`` is relevant, and must be at least the
+  client's configured value (checked).
+
+  [``4000`` (bytes); ``LIMIT``: ``262144``]
+
 ``max_queue_time``
   Discard packets after they have been queued this long
   waiting for http.
@@ -107,7 +116,8 @@ target_requests_outstanding
 Ordinary settings, used by both, not client-specific
 ----------------------------------------------------
 
-These are not looked up in the client-specific config sections.
+On the server these are forbidden in the client-specific config
+sections.
 
 ``addrs``
   Public IP (v4 or v6) address(es) of the server; space-separated.
@@ -142,14 +152,6 @@ These are not looked up in the client-specific config sections.
   Must match exactly at each end - *this is not checked*.
   [``1500`` (bytes)]
 
-``ifname_server``
-  | Virtual interface name on the server.  [``shippo%d``]
-  | Any ``%d`` is interpolated (by the kernel).
-
-``ifname_client``
-  | Virtual interface name on the client.  [``hippo%d``]
-  | Any ``%d`` is interpolated (by the kernel).
-
   
 Ordinary settings, used by server only
 --------------------------------------
@@ -162,6 +164,10 @@ Ordinary settings, used by server only
   this period after the client leaves the first network.
   [``300`` (s)]
 
+``ifname_server``
+  | Virtual interface name on the server.  [``shippo%d``]
+  | Any ``%d`` is interpolated (by the kernel).
+
 
 Ordinary settings, used by client only
 --------------------------------------
@@ -173,9 +179,6 @@ Ordinary settings, used by client only
   Client will hold off sending more requests than this to
   server even if it has data to send.  [``6``]
 
-``max_batch_up``
-  Size limit for request upbound payloads. [``4000`` (bytes)]
-
 ``success_report_interval``
   If nonzero, report success periodically.  Otherwise just
   report it when we first have success.  [``3600`` (s)]
@@ -194,3 +197,7 @@ Ordinary settings, used by client only
   end, space-separated.  Routes to those will be created on
   the client.  ``vrelay`` is included implicitly.
   [CIDR syntax, space separated; default: none]
+
+``ifname_client``
+  | Virtual interface name on the client.  [``hippo%d``]
+  | Any ``%d`` is interpolated (by the kernel).