From 5050bea60063a48d4d39ed2ad739f4f53a62dceb Mon Sep 17 00:00:00 2001 From: mom040267 Date: Sun, 7 Dec 2014 13:42:05 +0000 Subject: [PATCH] docs fixes --- ChangeLog | 3 ++- README.turnserver | 11 ++++++----- examples/etc/turnserver.conf | 18 ++++++++++++------ man/man1/turnadmin.1 | 2 +- man/man1/turnserver.1 | 13 +++++++------ man/man1/turnutils.1 | 2 +- src/apps/relay/mainrelay.c | 3 ++- 7 files changed, 31 insertions(+), 21 deletions(-) diff --git a/ChangeLog b/ChangeLog index ea3f77aa..0bd06874 100644 --- a/ChangeLog +++ b/ChangeLog @@ -2,7 +2,8 @@ Version 4.3.1.3 'Tolomei': - Reliability fixes (Issue 141 from rfc5766-turn-server). - HTTP/HTTPS echo fixed. - - external address mapping fixes for Amazon EC2. + - External address mapping fixes for Amazon EC2. + - Minor docs improvements. 11/23/2014 Oleg Moskalenko Version 4.3.1.2 'Tolomei': diff --git a/README.turnserver b/README.turnserver index ce6cdd12..31c2b5de 100644 --- a/README.turnserver +++ b/README.turnserver @@ -356,13 +356,14 @@ Options with required values: is behind A NAT. By default, this value is empty, and no address mapping is used. --m, --relay-threads Number of relay threads to handle the established connections +-m, --relay-threads Number of the relay threads to handle the established connections (in addition to authentication thread and the listener thread). - If set to 0 then application runs relay process in a single thread, + If explicitly set to 0 then application runs relay process in a single thread, in the same thread with the listener process (the authentication thread will - still be a separate thread). In older systems (before Linux kernel 3.9), - the number of UDP threads is always one threads per network listening endpoint - - unless "-m 0" or "-m 1" is set. + still be a separate thread). If not set, then a default optimal algorithm + will be employed (OS-dependent). In the older Linux systems + (before Linux kernel 3.9), the number of UDP threads is always one threads + per network listening endpoint - unless "-m 0" or "-m 1" is set. --min-port Lower bound of the UDP port range for relay endpoints allocation. diff --git a/examples/etc/turnserver.conf b/examples/etc/turnserver.conf index 4e1b8c45..5d35de87 100644 --- a/examples/etc/turnserver.conf +++ b/examples/etc/turnserver.conf @@ -125,15 +125,21 @@ #external-ip=60.70.80.92/172.17.19.102 -# Number of relay threads to handle the established connections +# Number of the relay threads to handle the established connections # (in addition to authentication thread and the listener thread). -# If set to 0 then application runs relay process in a single thread, -# in the same thread with the listener process (the authentication thread will -# still be a separate thread). +# If explicitly set to 0 then application runs relay process in a +# single thread, in the same thread with the listener process +# (the authentication thread will still be a separate thread). +# +# If this parameter is not set, then the default OS-dependent +# thread pattern algorithm will be employed. Usually the default +# algorithm is the most optimal, so you have to change this option +# only if you want to make some fine tweaks. # # In the older systems (Linux kernel before 3.9), -# the number of UDP threads is always one thread per network listening endpoint - -# including the auxiliary endpoints - unless 0 (zero) or 1 (one) value is set. +# the number of UDP threads is always one thread per network listening +# endpoint - including the auxiliary endpoints - unless 0 (zero) or +# 1 (one) value is set. # #relay-threads=0 diff --git a/man/man1/turnadmin.1 b/man/man1/turnadmin.1 index 462f111d..d460331c 100644 --- a/man/man1/turnadmin.1 +++ b/man/man1/turnadmin.1 @@ -1,5 +1,5 @@ .\" Text automatically generated by txt2man -.TH TURN 1 "23 November 2014" "" "" +.TH TURN 1 "06 December 2014" "" "" .SH GENERAL INFORMATION \fIturnadmin\fP is a TURN administration tool. This tool can be used to manage diff --git a/man/man1/turnserver.1 b/man/man1/turnserver.1 index dff14c15..b12d631a 100644 --- a/man/man1/turnserver.1 +++ b/man/man1/turnserver.1 @@ -1,5 +1,5 @@ .\" Text automatically generated by txt2man -.TH TURN 1 "23 November 2014" "" "" +.TH TURN 1 "06 December 2014" "" "" .SH GENERAL INFORMATION The \fBTURN Server\fP project contains the source code of a TURN server and TURN client @@ -527,13 +527,14 @@ By default, this value is empty, and no address mapping is used. .TP .B \fB\-m\fP, \fB\-\-relay\-threads\fP -Number of relay threads to handle the established connections +Number of the relay threads to handle the established connections (in addition to authentication thread and the listener thread). -If set to 0 then application runs relay process in a single thread, +If explicitly set to 0 then application runs relay process in a single thread, in the same thread with the listener process (the authentication thread will -still be a separate thread). In older systems (before Linux kernel 3.9), -the number of UDP threads is always one threads per network listening endpoint \- -unless "\fB\-m\fP 0" or "\fB\-m\fP 1" is set. +still be a separate thread). If not set, then a default optimal algorithm +will be employed (OS\-dependent). In the older Linux systems +(before Linux kernel 3.9), the number of UDP threads is always one threads +per network listening endpoint \- unless "\fB\-m\fP 0" or "\fB\-m\fP 1" is set. .TP .B \fB\-\-min\-port\fP diff --git a/man/man1/turnutils.1 b/man/man1/turnutils.1 index ac7083e0..ecd87d77 100644 --- a/man/man1/turnutils.1 +++ b/man/man1/turnutils.1 @@ -1,5 +1,5 @@ .\" Text automatically generated by txt2man -.TH TURN 1 "23 November 2014" "" "" +.TH TURN 1 "06 December 2014" "" "" .SH GENERAL INFORMATION A set of turnutils_* programs provides some utility functionality to be used diff --git a/src/apps/relay/mainrelay.c b/src/apps/relay/mainrelay.c index dfa6048a..5abf1bd8 100644 --- a/src/apps/relay/mainrelay.c +++ b/src/apps/relay/mainrelay.c @@ -398,7 +398,8 @@ static char Usage[] = "Usage: turnserver [options]\n" " --no-multicast-peers Disallow peers on well-known broadcast addresses (224.0.0.0 and above, and FFXX:*).\n" " -m, --relay-threads Number of relay threads to handle the established connections\n" " (in addition to authentication thread and the listener thread).\n" -" If set to 0 then application runs in single-threaded mode.\n" +" If explicitly set to 0 then application runs in single-threaded mode.\n" +" If not set then a default OS-dependent optimal algorithm will be employed.\n" " The default thread number is the number of CPUs.\n" " In older systems (pre-Linux 3.9) the number of UDP relay threads always equals\n" " the number of listening endpoints (unless -m 0 is set).\n"