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.
pull/1119/head
Molly Miller 3 years ago committed by GitHub
parent af4f190a94
commit bc1678cc52
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      README.turnadmin
  2. 4
      README.turnserver
  3. 2
      README.turnutils
  4. 31
      man/man1/turnadmin.1
  5. 50
      man/man1/turnserver.1
  6. 31
      man/man1/turnutils.1

@ -245,4 +245,4 @@ to see the man page.
AUTHORS
See [AUTHORS](AUTHORS.md)
See the AUTHORS.md file in the coturn source distribution.

@ -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.

@ -448,4 +448,4 @@ SEE ALSO
AUTHORS
See [AUTHORS](AUTHORS.md)
See the AUTHORS.md file in the coturn source distribution.

@ -347,33 +347,4 @@ https://groups.google.com/forum/?fromgroups=#!forum/turn\-server\-project\-rfc57
.SS AUTHORS
Oleg Moskalenko <mom040267@gmail.com>
.PP
Gabor Kovesdan http://kovesdan.org/
.PP
Daniel Pocock http://danielpocock.com/
.PP
John Selbie (jselbie@gmail.com)
.PP
Lee Sylvester <lee@designrealm.co.uk>
.PP
Erik Johnston <erikj@openmarket.com>
.PP
Roman Lisagor <roman@demonware.net>
.PP
Vladimir Tsanev <tsachev@gmail.com>
.PP
Po\-sheng Lin <personlin118@gmail.com>
.PP
Peter Dunkley <peter.dunkley@acision.com>
.PP
Mutsutoshi Yoshimoto <mutsutoshi.yoshimoto@mixi.co.jp>
.PP
Federico Pinna <fpinna@vivocha.com>
.PP
Bradley T. Hughes <bradleythughes@fastmail.fm>
.PP
Mihály Mészáros <misi@majd.eu>
.SS ACTIVE MAINTAINERS
Mihály Mészáros <misi@majd.eu>
See the AUTHORS.md file in the coturn source distribution.

@ -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 <mom040267@gmail.com>
.PP
Gabor Kovesdan http://kovesdan.org/
.PP
Daniel Pocock http://danielpocock.com/
.PP
John Selbie (jselbie@gmail.com)
.PP
Lee Sylvester <lee@designrealm.co.uk>
.PP
Erik Johnston <erikj@openmarket.com>
.PP
Roman Lisagor <roman@demonware.net>
.PP
Vladimir Tsanev <tsachev@gmail.com>
.PP
Po\-sheng Lin <personlin118@gmail.com>
.PP
Peter Dunkley <peter.dunkley@acision.com>
.PP
Mutsutoshi Yoshimoto <mutsutoshi.yoshimoto@mixi.co.jp>
.PP
Federico Pinna <fpinna@vivocha.com>
.PP
Bradley T. Hughes <bradleythughes@fastmail.fm>
.RE
.PP
Mihály Mészáros <misi@majd.eu>
.SS ACTIVE MAINTAINERS
Mihály Mészáros <misi@majd.eu>
See the AUTHORS.md file in the coturn source distribution.

@ -641,33 +641,4 @@ https://groups.google.com/forum/?fromgroups=#!forum/turn\-server\-project\-rfc57
.SS AUTHORS
Oleg Moskalenko <mom040267@gmail.com>
.PP
Gabor Kovesdan http://kovesdan.org/
.PP
Daniel Pocock http://danielpocock.com/
.PP
John Selbie (jselbie@gmail.com)
.PP
Lee Sylvester <lee@designrealm.co.uk>
.PP
Erik Johnston <erikj@openmarket.com>
.PP
Roman Lisagor <roman@demonware.net>
.PP
Vladimir Tsanev <tsachev@gmail.com>
.PP
Po\-sheng Lin <personlin118@gmail.com>
.PP
Peter Dunkley <peter.dunkley@acision.com>
.PP
Mutsutoshi Yoshimoto <mutsutoshi.yoshimoto@mixi.co.jp>
.PP
Federico Pinna <fpinna@vivocha.com>
.PP
Bradley T. Hughes <bradleythughes@fastmail.fm>
.PP
Mihály Mészáros <misi@majd.eu>
.SS ACTIVE MAINTAINERS
Mihály Mészáros <misi@majd.eu>
See the AUTHORS.md file in the coturn source distribution.

Loading…
Cancel
Save