Browse Source

new link for natdiscovery to turnutils, and newly generated man pages

Mészáros Mihály 9 years ago
parent
commit
8b987733ff
4 changed files with 61 additions and 6 deletions
  1. 1 1
      man/man1/turnadmin.1
  2. 1 1
      man/man1/turnserver.1
  3. 58 4
      man/man1/turnutils.1
  4. 1 0
      man/man1/turnutils_natdiscovery.1

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

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

+ 58 - 4
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] <STUN\-Server\-FQDN\-or\-IP\-address>
+
+.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
 

+ 1 - 0
man/man1/turnutils_natdiscovery.1

@@ -0,0 +1 @@
+turnutils.1