[tor-commits] [tor/master] doc: Man page entries for KIST

[nickm at torproject.org]

commit 06500171434dca543e3daf74ce7033a0aef3d199
Author: David Goulet <dgoulet at torproject.org>
Date:   Fri Sep 15 11:58:04 2017 -0400

    doc: Man page entries for KIST
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 doc/tor.1.txt | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index aec176705..d40643380 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -782,6 +782,36 @@ GENERAL OPTIONS
     option has been set to 1, it cannot be set back to 0 without
     restarting Tor. (Default: 0)
 
+[[Schedulers]] **Schedulers** **KIST**|**KISTLite**|**Vanilla**::
+    Specify the scheduler type that tor should use to handle outbound data on
+    channels. This is an ordered list by priority which means that the first
+    value will be tried first and if unavailable, the second one is tried and
+    so on. It is possible to change thse values at runtime.
+    (Default: KIST,KISTLite,Vanilla)
+ +
+    The possible scheduler types are:
++
+    KIST: Kernel Informed Socket Transport. Tor will use the kernel tcp
+    information stack per-socket to make an informed decision on if it should
+    send or not the data. (Only available on Linux)
++
+    KISTLite: Same as KIST but without kernel support which means that tor
+    will use all the same mecanics as KIST but without the TCP information the
+    kernel can provide.
++
+    Vanilla: The scheduler that tor has always used that is do as much as
+    possible or AMAP.
+
+[[KISTSchedRunInterval]] **KISTSchedRunInterval** __NUM__ **msec**::
+    If KIST or KISTLite is used in Schedulers option, this control at which
+    interval the scheduler tick is. If the value is 0 msec, the value is taken
+    from the consensus if possible else it will fallback to the default 10
+    msec. Maximum possible value is 100 msec. (Default: 0 msec)
+
+[[KISTSockBufSizeFactor]] **KISTSockBufSizeFactor** __NUM__::
+    If KIST is used in Schedulers, this is a multiplier of the per-socket
+    limit calculation of the KIST algorithm. (Default: 1.0)
+
 CLIENT OPTIONS
 --------------