From 8b987733ff8d6cdd07540b4d06760f9c982a4146 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A9sz=C3=A1ros=20Mih=C3=A1ly?= Date: Sat, 3 Sep 2016 01:19:36 +0200 Subject: [PATCH] new link for natdiscovery to turnutils, and newly generated man pages --- man/man1/turnadmin.1 | 2 +- man/man1/turnserver.1 | 2 +- man/man1/turnutils.1 | 62 +++++++++++++++++++++++++++++-- man/man1/turnutils_natdiscovery.1 | 1 + 4 files changed, 61 insertions(+), 6 deletions(-) create mode 120000 man/man1/turnutils_natdiscovery.1 diff --git a/man/man1/turnadmin.1 b/man/man1/turnadmin.1 index cf06d39..5011856 100644 --- a/man/man1/turnadmin.1 +++ b/man/man1/turnadmin.1 @@ -1,5 +1,5 @@ .\" Text automatically generated by txt2man -.TH TURN 1 "27 August 2016" "" "" +.TH TURN 1 "04 September 2016" "" "" .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 79ae91c..57b5529 100644 --- a/man/man1/turnserver.1 +++ b/man/man1/turnserver.1 @@ -1,5 +1,5 @@ .\" Text automatically generated by txt2man -.TH TURN 1 "27 August 2016" "" "" +.TH TURN 1 "04 September 2016" "" "" .SH GENERAL INFORMATION The \fBTURN Server\fP project contains the source code of a TURN server and TURN client diff --git a/man/man1/turnutils.1 b/man/man1/turnutils.1 index 06e4ccf..e905597 100644 --- a/man/man1/turnutils.1 +++ b/man/man1/turnutils.1 @@ -1,5 +1,5 @@ .\" Text automatically generated by txt2man -.TH TURN 1 "27 August 2016" "" "" +.TH TURN 1 "04 September 2016" "" "" .SH GENERAL INFORMATION A set of turnutils_* programs provides some utility functionality to be used @@ -34,16 +34,20 @@ The compiled binary image of this program is located in bin/ subdirectory. \fIturnutils_rfc5769check\fP: a utility that checks the correctness of the STUN/TURN protocol implementation. This utility is used only for the compilation check procedure, it is not copied to the installation destination. -.RE .PP - -.RS In the "examples/scripts" subdirectory, you will find the examples of command lines to be used to run the programs. The scripts are meant to be run from examples/ subdirectory, for example: .PP $ cd examples .PP $ ./scripts/secure_relay.sh +.TP +.B +5. +\fIturnutils_natdiscovery\fP: a utility that provides NAT behavior discovery +according RFC5780. This utility discovers the actual NAT Mapping and Filtering +behavior. Be aweare that at least two different listening IP addresses should +be configured to be able to work properly! .PP ===================================== .SS NAME @@ -360,6 +364,56 @@ Usage: .PP $ \fIturnutils_rfc5769check\fP .PP +===================================== +.SS NAME +\fB +\fBturnutils_natdiscovery \fP\- a utility that discovers NAT mapping and filtering +\fBbehavior according RFC5780. +\fB +.SS SYNOPSIS +.nf +.fam C + +$ \fIturnutils_natdiscovery\fP [\fIoptions\fP] + +.fam T +.fi +.fam T +.fi +.SS DESCRIPTION + +\fIturnutils_natdiscovery\fP discovers the NAT Mapping and Filtering behavior, to +determine if that NAT is currently using Endpoint\-Independent, +Address\-Dependent, or Address and Port\-Dependent Mapping and/or to determine if +that NAT is currently using Endpoint\-Independent, Address\-Dependent, or Address +and Port\-Dependent Filtering. +.PP +Use either \fB\-m\fP and/or \fB\-f\fP flag to discover NAT Mapping and/or Filtering. +.PP +Flags: +.TP +.B +\fB\-m\fP +NAT mapping behavior discovery +.TP +.B +\fB\-f\fP +NAT filtering behavior discovery +.PP +Options with required values: +.TP +.B +\fB\-p\fP +STUN server port (Default: 3478) +.TP +.B +\fB\-L\fP +Local address to use (optional) +.PP +Usage: +.PP +$ \fIturnutils_natdiscovery\fP \fB\-m\fP \fB\-f\fP stun.example.com +.PP =================================== .SH DOCS diff --git a/man/man1/turnutils_natdiscovery.1 b/man/man1/turnutils_natdiscovery.1 new file mode 120000 index 0000000..6996d67 --- /dev/null +++ b/man/man1/turnutils_natdiscovery.1 @@ -0,0 +1 @@ +turnutils.1 \ No newline at end of file