From 7ab824c8cf2cdb683253870ff2f54bbfd12223d4 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Tue, 15 Dec 2009 14:04:30 -0500 Subject: [PATCH] Document CircuitPriorityHalflife on the manpage --- doc/tor.1.in | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/tor.1.in b/doc/tor.1.in index 4bcab6d04d..721bbaa05e 100644 --- a/doc/tor.1.in +++ b/doc/tor.1.in @@ -419,6 +419,19 @@ ORPort. (Default: 1) \fBPreferTunneledDirConns \fR\fB0\fR|\fB1\fP If non-zero, we will avoid directory servers that don't support tunneled directory connections, when possible. (Default: 1) +.LP +.TP +\fBCircuitPriorityHalflife \fR\fBNUM\fB1\fP +If this value is set, we override the default algorithm for choosing which +circuit's cells to deliver or relay first. When the value is 0, we +round-robin between the active circuits on a connection, delivering one cell +from each in turn. When the value is positive, we prefer delivering cells +from whichever connection has the lowest weighted cell count, where cells are +weighted exponentially according to the supplied CircuitPrioirityHalflife +value (in seconds). If this option is not set at all, we use the behavior +recommended in the current consensus networkstatus. +This is an advanced option; you generally shouldn't have mess with it. +(Default: not set.) .SH CLIENT OPTIONS .PP