From 2e5c0f2f3cacf225779d16021b2635b0e8d57551 Mon Sep 17 00:00:00 2001 From: mom040267 Date: Tue, 22 Jul 2014 19:16:18 +0000 Subject: [PATCH] man page fix --- README.turnserver | 31 ++++++++++++++++++------------- man/man1/turnadmin.1 | 2 +- man/man1/turnserver.1 | 33 +++++++++++++++++++-------------- man/man1/turnutils.1 | 2 +- 4 files changed, 39 insertions(+), 29 deletions(-) diff --git a/README.turnserver b/README.turnserver index 1db6f032..566a40d5 100644 --- a/README.turnserver +++ b/README.turnserver @@ -83,13 +83,14 @@ User database settings: -b, --userdb User database file name (default - turnuserdb.conf), for long-term credentials mechanism only. - This user file database is being dynamically checked while the turnserver - is working, and the user accounts can be changed dynamically by - editing the database. + This user file database is being dynamically checked while the + turnserver is working, and the user accounts can be changed + dynamically by editing the database. -e, --psql-userdb User database connection string for PostgreSQL. - This database can be used for long-term and short-term credentials mechanisms, - and it can store the secret value for secret-based timed authentication in TURN RESP API. + This database can be used for long-term and short-term + credentials mechanisms, and it can store the secret value + for secret-based timed authentication in TURN RESP API. The connection string format is like that: "host= dbname= user= password= connect_timeout=" @@ -97,14 +98,16 @@ User database settings: Or: - "postgresql://username:password@hostname:port/databasename" (for 9.x or newer Postgres). + "postgresql://username:password@hostname:port/databasename" + (for 9.x or newer Postgres). See the INSTALL file for more explanations and examples. Also, see http://www.PostgreSQL.org for full PostgreSQL documentation. -M, --mysql-userdb User database connection string for MySQL or MariaDB. - This database can be used for long-term and short-term credentials mechanisms, - and it can store the secret value for secret-based timed authentication in TURN RESP API. + This database can be used for long-term and short-term + credentials mechanisms, and it can store the secret value for + secret-based timed authentication in TURN RESP API. The connection string format is like that: "host= dbname= user= password= connect_timeout=" @@ -114,19 +117,21 @@ User database settings: for full MySQL documentation. -J, --mongo-userdb User database connection string for MongoDB. - This database can be used for long-term and short-term credentials mechanisms, - and it can store the secret value for secret-based timed authentication in TURN RESP API. + This database can be used for long-term and short-term + credentials mechanisms, and it can store the secret value + for secret-based timed authentication in TURN RESP API. The connection string format is like that: - "mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]" + "mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]] [/[database][?options]]" See the INSTALL file for more explanations and examples. Also, see http://docs.mongodb.org/manual/ for full MongoDB documentation. -N, --redis-userdb User database connection string for Redis. - This database can be used for long-term and short-term credentials mechanisms, - and it can store the secret value for secret-based timed authentication in TURN RESP API. + This database can be used for long-term and short-term + credentials mechanisms, and it can store the secret + value for secret-based timed authentication in TURN RESP API. The connection string format is like that: "ip= dbname= password= connect_timeout=" diff --git a/man/man1/turnadmin.1 b/man/man1/turnadmin.1 index 7eb719d0..0c5f98e7 100644 --- a/man/man1/turnadmin.1 +++ b/man/man1/turnadmin.1 @@ -1,5 +1,5 @@ .\" Text automatically generated by txt2man -.TH TURN 1 "15 July 2014" "" "" +.TH TURN 1 "22 July 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 46fe5c28..f204d431 100644 --- a/man/man1/turnserver.1 +++ b/man/man1/turnserver.1 @@ -1,5 +1,5 @@ .\" Text automatically generated by txt2man -.TH TURN 1 "15 July 2014" "" "" +.TH TURN 1 "22 July 2014" "" "" .SH GENERAL INFORMATION The \fBTURN Server\fP project contains the source code of a TURN server and TURN client @@ -134,15 +134,16 @@ User database settings: \fB\-b\fP, \fB\-\-userdb\fP User database file name (default \- turnuserdb.conf), for long\-term credentials mechanism only. -This user file database is being dynamically checked while the \fIturnserver\fP -is working, and the user accounts can be changed dynamically by -editing the database. +This user file database is being dynamically checked while the +\fIturnserver\fP is working, and the user accounts can be changed +dynamically by editing the database. .TP .B \fB\-e\fP, \fB\-\-psql\-userdb\fP User database connection string for PostgreSQL. -This database can be used for long\-term and short\-term credentials mechanisms, -and it can store the secret value for secret\-based timed authentication in TURN RESP API. +This database can be used for long\-term and short\-term +credentials mechanisms, and it can store the secret value +for secret\-based timed authentication in TURN RESP API. The connection string format is like that: .RS .PP @@ -151,7 +152,8 @@ The connection string format is like that: .PP Or: .PP -"postgresql://username:password@hostname:port/databasename" (for 9.x or newer Postgres). +"postgresql://username:password@hostname:port/databasename" +(for 9.x or newer Postgres). See the INSTALL file for more explanations and examples. .PP Also, see http://www.PostgreSQL.org for full PostgreSQL documentation. @@ -160,8 +162,9 @@ Also, see http://www.PostgreSQL.org for full PostgreSQL documentation. .B \fB\-M\fP, \fB\-\-mysql\-userdb\fP User database connection string for MySQL or MariaDB. -This database can be used for long\-term and short\-term credentials mechanisms, -and it can store the secret value for secret\-based timed authentication in TURN RESP API. +This database can be used for long\-term and short\-term +credentials mechanisms, and it can store the secret value for +secret\-based timed authentication in TURN RESP API. The connection string format is like that: .RS .PP @@ -175,12 +178,13 @@ for full MySQL documentation. .B \fB\-J\fP, \fB\-\-mongo\-userdb\fP User database connection string for MongoDB. -This database can be used for long\-term and short\-term credentials mechanisms, -and it can store the secret value for secret\-based timed authentication in TURN RESP API. +This database can be used for long\-term and short\-term +credentials mechanisms, and it can store the secret value +for secret\-based timed authentication in TURN RESP API. The connection string format is like that: .RS .PP -"mongodb://[username:password@]host1[:port1][,host2[:port2],\.\.\.[,hostN[:portN]]][/[database][?\fIoptions\fP]]" +"mongodb://[username:password@]host1[:port1][,host2[:port2],\.\.\.[,hostN[:portN]]] [/[database][?\fIoptions\fP]]" See the INSTALL file for more explanations and examples. .PP Also, see http://docs.mongodb.org/manual/ @@ -190,8 +194,9 @@ for full MongoDB documentation. .B \fB\-N\fP, \fB\-\-redis\-userdb\fP User database connection string for Redis. -This database can be used for long\-term and short\-term credentials mechanisms, -and it can store the secret value for secret\-based timed authentication in TURN RESP API. +This database can be used for long\-term and short\-term +credentials mechanisms, and it can store the secret +value for secret\-based timed authentication in TURN RESP API. The connection string format is like that: .RS .PP diff --git a/man/man1/turnutils.1 b/man/man1/turnutils.1 index 68f1c3d5..1d1ceae0 100644 --- a/man/man1/turnutils.1 +++ b/man/man1/turnutils.1 @@ -1,5 +1,5 @@ .\" Text automatically generated by txt2man -.TH TURN 1 "15 July 2014" "" "" +.TH TURN 1 "22 July 2014" "" "" .SH GENERAL INFORMATION A set of turnutils_* programs provides some utility functionality to be used