diff options
| author | Nick Mathewson <nickm@torproject.org> | 2007-07-16 16:23:36 +0000 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2007-07-16 16:23:36 +0000 |
| commit | 483c1e9017f4ac2ef4c0652e3402887578a265d6 (patch) | |
| tree | ffa37ee6712d23e8ca81fc3996127c4f5413d340 /doc | |
| parent | f4a6673758385b9ce27a9913060dbd864d937461 (diff) | |
| download | tor-483c1e9017f4ac2ef4c0652e3402887578a265d6.tar.gz tor-483c1e9017f4ac2ef4c0652e3402887578a265d6.zip | |
r13774@catbus: nickm | 2007-07-16 12:23:28 -0400
Tweaks on constrained socket buffers patch from coderman: Add a changelog; rename some variables; fix some long lines and whitespace; make ConstrainedSockSize a memunit; pass setsockopt a void.
svn:r10843
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/tor.1.in | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/doc/tor.1.in b/doc/tor.1.in index b66647dbdf..41a99fa5fb 100644 --- a/doc/tor.1.in +++ b/doc/tor.1.in @@ -102,30 +102,32 @@ Windows since that platform lacks getrlimit(). (Default: 1000) .LP .TP \fBConstrainedSockets \fR\fB0\fR|\fB1\fR\fP -If set, Tor will attempt to shrink the recv and xmit buffers for all +If set, Tor will tell the kernel to attempt to shrink the buffers for all sockets to the size specified in \fBConstrainedSockSize\fP. This is useful for virtual servers and other environments where system level TCP -buffers may be limited. If you encounter the "Error creating network -socket: No buffer space available" message you are likely experiencing +buffers may be limited. If you're on a virtual server, and you +encounter the "Error creating network +socket: No buffer space available" message, you are likely experiencing this problem. The preferred solution is to have the admin increase the buffer pool for -the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility. +the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility; this +configuration option is a second-resort. The DirPort option should also not be used if TCP buffers are scarce. The cached directory requests consume additional sockets which exacerbates the problem. -You should \fBnot\fP enable this feature unless you encounter the no buffer -space available issue. Reducing the TCP buffers affects window size for +You should \fBnot\fP enable this feature unless you encounter the "no buffer +space available" issue. Reducing the TCP buffers affects window size for for the TCP stream and will reduce throughput in proportion to round trip -time on long paths. +time on long paths. (Default: 0.) .LP .TP -\fBConstrainedSockSize \fR\fINUM\fP -When \fBConstrainedSockets\fP is enabled the recv and xmit buffers for +\fBConstrainedSockSize \fR\fIN\fR \fBbytes\fR|\fBKB\fP +When \fBConstrainedSockets\fP is enabled the receive and transmit buffers for all sockets will be set to this limit. Must be a value between 2048 -and 262144 in 1024 byte increments. Default of 8192 is recommended. +and 262144, in 1024 byte increments. Default of 8192 is recommended. .LP .TP \fBControlPort \fR\fIPort\fP |