From bc1678cc5263cb519c2fa772bafda02cb2a8e63b Mon Sep 17 00:00:00 2001 From: Molly Miller <33266253+sysvinit@users.noreply.github.com> Date: Wed, 7 Dec 2022 02:04:13 +0100 Subject: [PATCH] Regenerate manual pages from README files (#1117) This PR fixes some typos and formatting, and regenerates the manual pages from the README files. These changes were originally included in #1105, however I've split them out into a separate PR as requested. --- README.turnadmin | 2 +- README.turnserver | 4 ++-- README.turnutils | 2 +- man/man1/turnadmin.1 | 31 +-------------------------- man/man1/turnserver.1 | 50 +++++++++++-------------------------------- man/man1/turnutils.1 | 31 +-------------------------- 6 files changed, 18 insertions(+), 102 deletions(-) diff --git a/README.turnadmin b/README.turnadmin index ae0dbfd9..1ef67151 100644 --- a/README.turnadmin +++ b/README.turnadmin @@ -245,4 +245,4 @@ to see the man page. AUTHORS - See [AUTHORS](AUTHORS.md) + See the AUTHORS.md file in the coturn source distribution. diff --git a/README.turnserver b/README.turnserver index fdbb5288..c8a8dc63 100644 --- a/README.turnserver +++ b/README.turnserver @@ -290,7 +290,7 @@ Flags: also the path / on this port can be used as a health check --prometheus-username-labels Enable labeling prometheus traffic metrics with client usernames. Labeling with client usernames is - disabled by default, beacuse this may cause memory leaks when using + disabled by default, because this may cause memory leaks when using authentication with ephemeral usernames (e.g. TURN REST API). --prometheus-port Prometheus listener port (Default: 9641). @@ -1020,5 +1020,5 @@ https://groups.google.com/forum/?fromgroups=#!forum/turn-server-project-rfc5766- AUTHORS - See [AUTHORS](AUTHORS.md) + See the AUTHORS.md file in the coturn source distribution. diff --git a/README.turnutils b/README.turnutils index 956b0427..652b0175 100644 --- a/README.turnutils +++ b/README.turnutils @@ -448,4 +448,4 @@ SEE ALSO AUTHORS - See [AUTHORS](AUTHORS.md) + See the AUTHORS.md file in the coturn source distribution. diff --git a/man/man1/turnadmin.1 b/man/man1/turnadmin.1 index 641636d8..f09fa69c 100644 --- a/man/man1/turnadmin.1 +++ b/man/man1/turnadmin.1 @@ -347,33 +347,4 @@ https://groups.google.com/forum/?fromgroups=#!forum/turn\-server\-project\-rfc57 .SS AUTHORS -Oleg Moskalenko -.PP -Gabor Kovesdan http://kovesdan.org/ -.PP -Daniel Pocock http://danielpocock.com/ -.PP -John Selbie (jselbie@gmail.com) -.PP -Lee Sylvester -.PP -Erik Johnston -.PP -Roman Lisagor -.PP -Vladimir Tsanev -.PP -Po\-sheng Lin -.PP -Peter Dunkley -.PP -Mutsutoshi Yoshimoto -.PP -Federico Pinna -.PP -Bradley T. Hughes -.PP -Mihály Mészáros -.SS ACTIVE MAINTAINERS - -Mihály Mészáros +See the AUTHORS.md file in the coturn source distribution. diff --git a/man/man1/turnserver.1 b/man/man1/turnserver.1 index f6199727..9d2059b0 100644 --- a/man/man1/turnserver.1 +++ b/man/man1/turnserver.1 @@ -297,15 +297,18 @@ Use 1066 bits predefined DH TLS key. Default size of the key is 2066. .TP .B \fB\-\-no\-tlsv1\fP -Do not allow TLSv1/DTLSv1 protocol. +Set TLSv1_1/DTLSv1.2 as a minimum supported protocol version. +With openssl\-1.0.2 and below, do not allow TLSv1.2/DTLSv1.2 protocols. .TP .B \fB\-\-no\-tlsv1_1\fP -Do not allow TLSv1.1 protocol. +Set TLSv1_2/DTLSv1.2 as a minimum supported protocol version. +With openssl\-1.0.2 and below, do not allow TLSv1.1 protocol. .TP .B \fB\-\-no\-tlsv1_2\fP -Do not allow TLSv1.2/DTLSv1.2 protocol. +Set TLSv1_3/DTLSv1.2 as a minimum supported protocol version. +With openssl\-1.0.2 and below, do not allow TLSv1.2/DTLSv1.2 protocols. .TP .B \fB\-\-no\-udp\fP @@ -428,10 +431,7 @@ initially used by the session). Enable prometheus metrics. By default it is disabled. Would listen on port 9641 under the path /metrics also the path / on this port can be used as a health check -.TP -.B -\fB\-\-prometheus\-port\fP -Prometheus listener port (Default: 9641). +.RS .TP .B \fB\-\-prometheus\-username\-labels\fP @@ -442,6 +442,10 @@ authentication with ephemeral usernames (e.g. TURN REST API). .RE .TP .B +\fB\-\-prometheus\-port\fP +Prometheus listener port (Default: 9641). +.TP +.B \fB\-h\fP Help. .PP @@ -1314,34 +1318,4 @@ https://groups.google.com/forum/?fromgroups=#!forum/turn\-server\-project\-rfc57 .SS AUTHORS -Oleg Moskalenko -.PP -Gabor Kovesdan http://kovesdan.org/ -.PP -Daniel Pocock http://danielpocock.com/ -.PP -John Selbie (jselbie@gmail.com) -.PP -Lee Sylvester -.PP -Erik Johnston -.PP -Roman Lisagor -.PP -Vladimir Tsanev -.PP -Po\-sheng Lin -.PP -Peter Dunkley -.PP -Mutsutoshi Yoshimoto -.PP -Federico Pinna -.PP -Bradley T. Hughes -.RE -.PP -Mihály Mészáros -.SS ACTIVE MAINTAINERS - -Mihály Mészáros +See the AUTHORS.md file in the coturn source distribution. diff --git a/man/man1/turnutils.1 b/man/man1/turnutils.1 index 2657619b..23ce68bc 100644 --- a/man/man1/turnutils.1 +++ b/man/man1/turnutils.1 @@ -641,33 +641,4 @@ https://groups.google.com/forum/?fromgroups=#!forum/turn\-server\-project\-rfc57 .SS AUTHORS -Oleg Moskalenko -.PP -Gabor Kovesdan http://kovesdan.org/ -.PP -Daniel Pocock http://danielpocock.com/ -.PP -John Selbie (jselbie@gmail.com) -.PP -Lee Sylvester -.PP -Erik Johnston -.PP -Roman Lisagor -.PP -Vladimir Tsanev -.PP -Po\-sheng Lin -.PP -Peter Dunkley -.PP -Mutsutoshi Yoshimoto -.PP -Federico Pinna -.PP -Bradley T. Hughes -.PP -Mihály Mészáros -.SS ACTIVE MAINTAINERS - -Mihály Mészáros +See the AUTHORS.md file in the coturn source distribution.