Browse Source

docs fixes

mom040267 11 years ago
parent
commit
5050bea600
7 changed files with 31 additions and 21 deletions
  1. 2 1
      ChangeLog
  2. 6 5
      README.turnserver
  3. 12 6
      examples/etc/turnserver.conf
  4. 1 1
      man/man1/turnadmin.1
  5. 7 6
      man/man1/turnserver.1
  6. 1 1
      man/man1/turnutils.1
  7. 2 1
      src/apps/relay/mainrelay.c

+ 2 - 1
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 <[email protected]>
 Version 4.3.1.2 'Tolomei':

+ 6 - 5
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.

+ 12 - 6
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
 

+ 1 - 1
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 

+ 7 - 6
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

+ 1 - 1
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

+ 2 - 1
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>	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"